# win.timer 库模块帮助文档

## win 成员列表 <a id="win" href="#win">&#x23;</a>

### win.timer <a id="win.timer" href="#win.timer">&#x23;</a>
定时管理器。  
此定时器依赖窗口消息循环，所以应当用于界面线程，  
或者在工作线程中使用 win.loopMessage 函数启动窗口消息循环。

### win.timer() <a id="win.timer" href="#win.timer">&#x23;</a>
[返回对象:winTimerObject](#winTimerObject)

### win.timer(winform,interval) <a id="win.timer" href="#win.timer">&#x23;</a>
创建定时器。  
如果不指定窗体对象,则创建一个 messageOnly 窗体作为父窗口。  
@interval 为可选参数，用于指定间隔时间,以毫秒为单位,默认为 100 毫秒

## winTimerObject 成员列表 <a id="winTimerObject" href="#winTimerObject">&#x23;</a>

### winTimerObject.disable() <a id="winTimerObject.disable" href="#winTimerObject.disable">&#x23;</a>
禁用定时器

### winTimerObject.enable(interval,count) <a id="winTimerObject.enable" href="#winTimerObject.enable">&#x23;</a>
启用定时器（创建 win.timer 对象默认会自动启用定时器）。  
可选使用参数 @interval 中指定新的间隔时间,以毫秒为单位,  
可选使用参数 @count 限定定时器执行次数,  
如果指定了有效执行次数,则定时器会立即执行一次 onTimer 函数,  
否则会先延时再执行 onTimer 函数

### winTimerObject.getInterval() <a id="winTimerObject.getInterval" href="#winTimerObject.getInterval">&#x23;</a>
读取定时器间隔时间

### winTimerObject.setInterval(1) <a id="winTimerObject.setInterval" href="#winTimerObject.setInterval">&#x23;</a>
修改定时器间隔时间,  
以毫秒为单位

## winTimerObject 事件列表 <a id="winTimerObjectEvent" href="#winTimerObjectEvent">&#x23;</a>

### winTimerObject.onEnd <a id="winTimerObject.onEnd" href="#winTimerObject.onEnd">&#x23;</a>

```aardio
winTimerObject.onEnd = function(){
	/*定时器停止时触发此事件*/
}
```

### winTimerObject.onTimer <a id="winTimerObject.onTimer" href="#winTimerObject.onTimer">&#x23;</a>

```aardio
winTimerObject.onTimer = function(){
	/*设置定时器触发函数,此函数不应返回任何值*/
}
```

