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
  32         public class Timer : Component {
  33
  34                 private bool enabled;
  35                 private IContainer container;
  36                 private int interval = 100;
  37                 private DateTime expires;
  38
  39                 internal static readonly int Minimum = 15;
  40
  41                 public Timer ()
  42                 {
  43                         enabled = false;
  44                 }
  45
  46                 public Timer (IContainer container) : this ()
  47                 {
  48                         container.Add (this);
  49                 }
  50
  51                 public bool Enabled {
  52                         get {
  53                                 return enabled;
  54                         }
  55                         set {
  56                                 if (value != enabled) {
  57                                         enabled = value;
  58                                         if (value) {
  59                                                 XplatUI.SetTimer (this);
  60                                         } else {
  61                                                 XplatUI.KillTimer (this);
  62                                         }
  63                                 }
  64                         }
  65                 }
  66
  67                 public int Interval {
  68                         get {
  69                                 return interval;
  70                         }
  71                         set {
  72                                 interval = value;
  73                                 // Use AddTicks so we get some rounding
  74                                 expires = DateTime.Now.AddMilliseconds (interval > Minimum ? interval : Minimum);
  75                         }
  76                 }
  77
  78                 public void Start ()
  79                 {
  80                         Enabled = true;
  81                 }
  82
  83                 public void Stop ()
  84                 {
  85                         Enabled = false;
  86                 }
  87
  88                 internal DateTime Expires {
  89                         get {
  90                                 return expires;
  91                         }
  92                 }
  93
  94                 public event EventHandler Tick;
  95
  96                 public override string ToString ()
  97                 {
  98                         return base.ToString () + ", Interval: " + Interval;
  99                 }
 100
 101                 internal void Update (DateTime update)
 102                 {
 103                         expires = update.AddMilliseconds (interval > Minimum ? interval : Minimum);
 104                 }
 105
 106                 internal void FireTick ()
 107                 {
 108                         OnTick (EventArgs.Empty);
 109                 }
 110
 111
 112                 protected virtual void OnTick (EventArgs e)
 113                 {
 114                         if (Tick != null)
 115                                 Tick (this, e);
 116                 }
 117
 118                 protected override void Dispose (bool disposing)
 119                 {
 120                         Enabled = false;
 121                 }
 122
 123                 private bool has_last_fire = false;
 124                 private DateTime last_fire;
 125
 126                 internal void TickHandler (object sender, EventArgs e)
 127                 {
 128                         OnTick (e);
 129                 }
 130         }
 131 }
 132