1 // Permission is hereby granted, free of charge, to any person obtaining
2 // a copy of this software and associated documentation files (the
3 // "Software"), to deal in the Software without restriction, including
4 // without limitation the rights to use, copy, modify, merge, publish,
5 // distribute, sublicense, and/or sell copies of the Software, and to
6 // permit persons to whom the Software is furnished to do so, subject to
7 // the following conditions:
9 // The above copyright notice and this permission notice shall be
10 // included in all copies or substantial portions of the Software.
12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 // Copyright (C) 2004-2006 Novell, Inc.
23 // Jordi Mas i Hernandez jordi@ximian.com
24 // Peter Dennis Bartok pbartok@novell.com
29 using System.ComponentModel;
30 using System.Drawing.Imaging;
31 using System.Drawing.Drawing2D;
32 using System.Runtime.InteropServices;
34 namespace System.Windows.Forms
36 [DefaultProperty ("Value")]
38 [DefaultBindingProperty ("Value")]
39 [ClassInterface (ClassInterfaceType.AutoDispatch)]
46 class ProgressBar : Control
48 #region Local Variables
53 internal DateTime start = DateTime.Now;
54 internal Rectangle client_area = new Rectangle ();
56 internal ProgressBarStyle style;
58 bool right_to_left_layout;
62 private static readonly Color defaultForeColor = SystemColors.Highlight;
64 #endregion // Local Variables
69 static object RightToLeftLayoutChangedEvent = new object ();
74 [EditorBrowsable (EditorBrowsableState.Never)]
75 public new event EventHandler BackColorChanged {
76 add { base.BackColorChanged += value; }
77 remove { base.BackColorChanged -= value; }
82 [EditorBrowsable (EditorBrowsableState.Never)]
83 public new event EventHandler BackgroundImageChanged {
84 add { base.BackgroundImageChanged += value; }
85 remove { base.BackgroundImageChanged -= value; }
90 [EditorBrowsable(EditorBrowsableState.Never)]
91 public new event EventHandler BackgroundImageLayoutChanged {
92 add { base.BackgroundImageLayoutChanged += value; }
93 remove { base.BackgroundImageLayoutChanged -= value; }
98 [EditorBrowsable (EditorBrowsableState.Never)]
99 public new event EventHandler CausesValidationChanged {
100 add { base.CausesValidationChanged += value; }
101 remove { base.CausesValidationChanged -= value; }
105 [EditorBrowsable (EditorBrowsableState.Never)]
106 public new event EventHandler DoubleClick {
107 add { base.DoubleClick += value; }
108 remove { base.DoubleClick -= value; }
112 [EditorBrowsable (EditorBrowsableState.Never)]
113 public new event EventHandler Enter {
114 add { base.Enter += value; }
115 remove { base.Enter -= value; }
119 [EditorBrowsable (EditorBrowsableState.Never)]
120 public new event EventHandler FontChanged {
121 add { base.FontChanged += value; }
122 remove { base.FontChanged -= value; }
127 [EditorBrowsable (EditorBrowsableState.Never)]
128 public new event EventHandler ForeColorChanged {
129 add { base.ForeColorChanged += value; }
130 remove { base.ForeColorChanged -= value; }
135 [EditorBrowsable (EditorBrowsableState.Never)]
136 public new event EventHandler ImeModeChanged {
137 add { base.ImeModeChanged += value; }
138 remove { base.ImeModeChanged -= value; }
142 [EditorBrowsable (EditorBrowsableState.Never)]
143 public new event KeyEventHandler KeyDown {
144 add { base.KeyDown += value; }
145 remove { base.KeyDown -= value; }
149 [EditorBrowsable (EditorBrowsableState.Never)]
150 public new event KeyPressEventHandler KeyPress {
151 add { base.KeyPress += value; }
152 remove { base.KeyPress -= value; }
156 [EditorBrowsable (EditorBrowsableState.Never)]
157 public new event KeyEventHandler KeyUp {
158 add { base.KeyUp += value; }
159 remove { base.KeyUp -= value; }
163 [EditorBrowsable (EditorBrowsableState.Never)]
164 public new event EventHandler Leave {
165 add { base.Leave += value; }
166 remove { base.Leave -= value; }
170 [EditorBrowsable(EditorBrowsableState.Never)]
172 public new event MouseEventHandler MouseDoubleClick {
173 add { base.MouseDoubleClick += value; }
174 remove { base.MouseDoubleClick -= value; }
178 [EditorBrowsable(EditorBrowsableState.Never)]
179 public new event EventHandler PaddingChanged {
180 add { base.PaddingChanged += value; }
181 remove { base.PaddingChanged -= value; }
186 [EditorBrowsable (EditorBrowsableState.Never)]
187 public new event PaintEventHandler Paint {
188 add { base.Paint += value; }
189 remove { base.Paint -= value; }
194 [EditorBrowsable (EditorBrowsableState.Never)]
195 public new event EventHandler RightToLeftChanged {
196 add { base.RightToLeftChanged += value; }
197 remove { base.RightToLeftChanged -= value; }
201 public new event EventHandler RightToLeftLayoutChanged {
202 add { Events.AddHandler (RightToLeftLayoutChangedEvent, value); }
203 remove { Events.RemoveHandler (RightToLeftLayoutChangedEvent, value); }
208 [EditorBrowsable (EditorBrowsableState.Never)]
209 public new event EventHandler TabStopChanged {
210 add { base.TabStopChanged += value; }
211 remove { base.TabStopChanged -= value; }
215 [EditorBrowsable (EditorBrowsableState.Never)]
216 public new event EventHandler TextChanged {
217 add { base.TextChanged += value; }
218 remove { base.TextChanged -= value; }
222 #region Public Constructors
230 base.Resize += new EventHandler (OnResizeTB);
232 SetStyle (ControlStyles.UserPaint |
233 ControlStyles.Selectable |
234 ControlStyles.ResizeRedraw |
237 | ControlStyles.UseTextForAccessibility
242 ForeColor = defaultForeColor;
245 #endregion // Public Constructors
247 #region Public Instance Properties
250 [EditorBrowsable (EditorBrowsableState.Never)]
251 public override bool AllowDrop
253 get { return base.AllowDrop; }
255 base.AllowDrop = value;
260 // Setting this property in MS .Net 1.1 does not have any visual effect and it
261 // does not fire a BackColorChanged event
263 [EditorBrowsable (EditorBrowsableState.Never)]
264 public override Color BackColor
266 get { return base.BackColor; }
267 set { base.BackColor = value; }
271 // Setting this property in MS .Net 1.1 does not have any visual effect and it
272 // does not fire a BackgroundImageChanged event
274 [EditorBrowsable (EditorBrowsableState.Never)]
275 public override Image BackgroundImage
277 get { return base.BackgroundImage; }
278 set { base.BackgroundImage = value; }
283 [EditorBrowsable(EditorBrowsableState.Never)]
284 public override ImageLayout BackgroundImageLayout {
285 get { return base.BackgroundImageLayout; }
286 set { base.BackgroundImageLayout = value; }
290 [EditorBrowsable (EditorBrowsableState.Never)]
291 public new bool CausesValidation
293 get { return base.CausesValidation; }
294 set { base.CausesValidation = value; }
297 protected override CreateParams CreateParams
299 get { return base.CreateParams; }
302 protected override ImeMode DefaultImeMode
304 get { return base.DefaultImeMode; }
307 protected override Size DefaultSize
309 get { return ThemeEngine.Current.ProgressBarDefaultSize; }
313 [EditorBrowsable(EditorBrowsableState.Never)]
314 protected override bool DoubleBuffered {
315 get { return base.DoubleBuffered; }
316 set { base.DoubleBuffered = value; }
319 // Setting this property in MS .Net 1.1 does not have any visual effect and it
320 // does not fire a FontChanged event
322 [EditorBrowsable (EditorBrowsableState.Never)]
323 public override Font Font
325 get { return base.Font; }
326 set { base.Font = value; }
330 // Setting this property in MS .Net 1.1 does not have any visual effect and it
331 // does not fire a FontChanged event
333 [EditorBrowsable (EditorBrowsableState.Never)]
334 public override Color ForeColor
336 get { return base.ForeColor; }
337 set { base.ForeColor = value; }
342 [EditorBrowsable (EditorBrowsableState.Never)]
343 public new ImeMode ImeMode
345 get { return base.ImeMode; }
346 set { base.ImeMode = value; }
349 [RefreshProperties(RefreshProperties.Repaint)]
358 throw new ArgumentException(
359 string.Format("Value '{0}' must be greater than or equal to 0.", value ));
366 [RefreshProperties(RefreshProperties.Repaint)]
374 throw new ArgumentException(
375 string.Format("Value '{0}' must be greater than or equal to 0.", value ));
383 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
385 [EditorBrowsable(EditorBrowsableState.Never)]
386 public new Padding Padding {
387 get { return base.Padding; }
388 set { base.Padding = value; }
392 [DefaultValue(false)]
393 [MonoTODO ("Layout is currently always from left to right")]
394 public virtual bool RightToLeftLayout {
395 get { return right_to_left_layout;}
397 if (right_to_left_layout != value) {
398 right_to_left_layout = value;
399 OnRightToLeftLayoutChanged (EventArgs.Empty);
407 [EditorBrowsable (EditorBrowsableState.Never)]
408 public override RightToLeft RightToLeft
410 get { return base.RightToLeft; }
411 set { base.RightToLeft = value; }
427 [DefaultValue (ProgressBarStyle.Blocks)]
428 [EditorBrowsable (EditorBrowsableState.Always)]
429 public ProgressBarStyle Style {
437 if (style == ProgressBarStyle.Marquee) {
438 if (marquee_timer == null) {
439 marquee_timer = new Timer ();
440 marquee_timer.Interval = 10;
441 marquee_timer.Tick += new EventHandler (marquee_timer_Tick);
443 marquee_timer.Start ();
445 if (marquee_timer != null) {
446 marquee_timer.Stop ();
452 void marquee_timer_Tick (object sender, EventArgs e)
457 int marquee_animation_speed = 100;
459 public int MarqueeAnimationSpeed {
461 return marquee_animation_speed;
465 marquee_animation_speed = value;
471 [EditorBrowsable (EditorBrowsableState.Never)]
472 public new bool TabStop
474 get { return base.TabStop; }
475 set { base.TabStop = value; }
479 [EditorBrowsable (EditorBrowsableState.Never)]
481 public override string Text
483 get { return base.Text; }
484 set { base.Text = value; }
495 if (value < Minimum || value > Maximum)
497 throw new ArgumentOutOfRangeException ("Value", string.Format("'{0}' is not a valid value for 'Value'. 'Value' should be between 'Minimum' and 'Maximum'", value));
499 throw new ArgumentException(string.Format("'{0}' is not a valid value for 'Value'. 'Value' should be between 'Minimum' and 'Maximum'", value));
507 #endregion // Protected Instance Properties
509 #region Public Instance Methods
511 protected override void CreateHandle ()
513 base.CreateHandle ();
516 public void Increment (int value)
518 int newValue = Value + value;
520 if (newValue < Minimum)
523 if (newValue > Maximum)
530 protected override void OnHandleCreated (EventArgs e)
532 base.OnHandleCreated (e);
538 protected override void OnBackColorChanged (EventArgs e)
540 base.OnBackColorChanged (e);
543 protected override void OnForeColorChanged (EventArgs e)
545 base.OnForeColorChanged (e);
548 protected override void OnHandleDestroyed (EventArgs e)
550 base.OnHandleDestroyed (e);
553 [EditorBrowsable(EditorBrowsableState.Advanced)]
554 protected virtual void OnRightToLeftLayoutChanged(EventArgs e)
556 EventHandler eh = (EventHandler) Events [RightToLeftLayoutChangedEvent];
562 public void PerformStep ()
564 if (Value >= Maximum)
567 Value = Maximum < Value + Step ? Maximum : Value + Step;
568 Refresh (); // FIXME - calculate delta and only expose that
572 [EditorBrowsable (EditorBrowsableState.Never)]
573 public override void ResetForeColor ()
575 ForeColor = defaultForeColor;
579 public override string ToString()
581 return string.Format ("{0}, Minimum: {1}, Maximum: {2}, Value: {3}",
582 GetType().FullName.ToString (),
588 #endregion // Public Instance Methods
590 #region Private Instance Methods
592 private void UpdateAreas ()
594 client_area.X = client_area.Y = 2;
595 client_area.Width = Width - 4;
596 client_area.Height = Height - 4;
599 private void OnResizeTB (Object o, EventArgs e)
601 if (Width <= 0 || Height <= 0)
605 Invalidate(); // Invalidate the full surface, blocks will not match
608 internal override void OnPaintInternal (PaintEventArgs pevent)
610 ThemeEngine.Current.DrawProgressBar (pevent.Graphics, pevent.ClipRectangle, this);