mcs/class/Managed.Windows.Forms/System.Windows.Forms/Timer.cs

   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:
   8 //
   9 // The above copyright notice and this permission notice shall be
  10 // included in all copies or substantial portions of the Software.
  11 //
  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.
  19 //
  20 // Copyright (c) 2004 Novell, Inc.
  21 //
  22 // Authors:
  23 //      Jackson Harper (jackson@ximian.com)
  24
  25
  26 using System;
  27 using System.Threading;
  28 using System.ComponentModel;
  29
  30 namespace System.Windows.Forms {
  31         [DefaultProperty("Interval")]
  32         [DefaultEvent("Tick")]
  33         [ToolboxItemFilter("System.Windows.Forms", ToolboxItemFilterType.Allow)]
  34         public class Timer : Component {
  35
  36                 private bool enabled;
  37                 private int interval = 100;
  38                 private DateTime expires;
  39                 internal Thread thread;
  40                 internal bool Busy;
  41                 internal IntPtr window;
  42
  43 #if NET_2_0
  44                 object control_tag;
  45 #endif
  46                 internal static readonly int Minimum = 15;
  47
  48                 public Timer ()
  49                 {
  50                         enabled = false;
  51                 }
  52
  53                 public Timer (IContainer container) : this ()
  54                 {
  55                         container.Add (this);
  56                 }
  57
  58                 [DefaultValue (false)]
  59                 public virtual bool Enabled {
  60                         get {
  61                                 return enabled;
  62                         }
  63                         set {
  64                                 if (value != enabled) {
  65                                         enabled = value;
  66                                         if (value) {
  67                                                 // Use AddTicks so we get some rounding
  68                                                 expires = DateTime.UtcNow.AddMilliseconds (interval > Minimum ? interval : Minimum);
  69
  70                                                 thread = Thread.CurrentThread;
  71                                                 XplatUI.SetTimer (this);
  72                                         } else {
  73                                                 XplatUI.KillTimer (this);
  74                                                 thread = null;
  75                                         }
  76                                 }
  77                         }
  78                 }
  79
  80                 [DefaultValue (100)]
  81                 public int Interval {
  82                         get {
  83                                 return interval;
  84                         }
  85                         set {
  86                                 if (value <= 0)
  87 #if NET_2_0
  88                                         throw new ArgumentOutOfRangeException ("Interval", string.Format ("'{0}' is not a valid value for Interval. Interval must be greater than 0.", value));
  89 #else
  90                                         throw new ArgumentException (string.Format("'{0}' is not a valid value for Interval. Interval must be greater than 0.", value));
  91 #endif
  92
  93                                 if (interval == value) {
  94                                         return;
  95                                 }
  96
  97                                 interval = value;
  98
  99                                 // Use AddTicks so we get some rounding
 100                                 expires = DateTime.UtcNow.AddMilliseconds (interval > Minimum ? interval : Minimum);
 101
 102                                 if (enabled == true) {
 103                                         XplatUI.KillTimer (this);
 104                                         XplatUI.SetTimer (this);
 105                                 }
 106                         }
 107                 }
 108
 109 #if NET_2_0
 110                 [Localizable(false)]
 111                 [Bindable(true)]
 112                 [TypeConverter(typeof(StringConverter))]
 113                 [DefaultValue(null)]
 114                 [MWFCategory("Data")]
 115                 public object Tag {
 116                         get {
 117                                 return control_tag;
 118                         }
 119
 120                         set {
 121                                 control_tag = value;
 122                         }
 123                 }
 124 #endif
 125
 126                 public void Start ()
 127                 {
 128                         Enabled = true;
 129                 }
 130
 131                 public void Stop ()
 132                 {
 133                         Enabled = false;
 134                 }
 135
 136                 internal DateTime Expires {
 137                         get {
 138                                 return expires;
 139                         }
 140                 }
 141
 142                 public event EventHandler Tick;
 143
 144                 public override string ToString ()
 145                 {
 146                         return base.ToString () + ", Interval: " + Interval;
 147                 }
 148
 149                 internal void Update (DateTime update)
 150                 {
 151                         expires = update.AddMilliseconds (interval > Minimum ? interval : Minimum);
 152                 }
 153
 154                 internal void FireTick ()
 155                 {
 156                         OnTick (EventArgs.Empty);
 157                 }
 158
 159
 160                 protected virtual void OnTick (EventArgs e)
 161                 {
 162                         if (Tick != null)
 163                                 Tick (this, e);
 164                 }
 165
 166                 protected override void Dispose (bool disposing)
 167                 {
 168                         base.Dispose (disposing);
 169                         Enabled = false;
 170                 }
 171
 172                 internal void TickHandler (object sender, EventArgs e)
 173                 {
 174                         OnTick (e);
 175                 }
 176         }
 177 }
 178