Unit 'ExtCtrls' Package
[Overview][Types][Classes][Procedures and functions][Index] [#lcl]

TCustomIdleTimer

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Implements the base class for TIdleTimer.

Declaration

Source position: extctrls.pp line 223

type TCustomIdleTimer = class(TCustomTimer)

protected

  procedure SetAutoEnabled(); virtual;

  

Sets the value for the AutoEnabled property.

  procedure DoOnIdle(); virtual;

  

Performs actions which execute the idle timer.

  procedure DoOnIdleEnd(); virtual;

  

DoOnIdleEnd performs actions when the idle state ends for the timer.

  procedure DoOnUserInput(); virtual;

  

DoOnUserInput performs the code for responding to user input.

  procedure Loaded; override;

  

Performs actions needed when the component has finished loading during LCL component streaming.

public

  constructor Create(); override;

  

Constructor for the class instance.

  destructor Destroy; override;

  

Destructor for the class instance.

  property AutoEnabled: Boolean; [rw]

  

Controls whether the idle timer can be automatically enabled or disabled.

  property AutoStartEvent: TIdleTimerAutoEvent; [rw]

  

AutoStartEvent - the event that triggers auto-start (either idle time-out or user input).

  property AutoEndEvent: TIdleTimerAutoEvent; [rw]

  

AutoEndEvent - the event that stops the timer by setting Enabled to False.

  property FireOnIdle: Boolean; [rw]

  

FireOnIdle - Boolean property determining whether the timer should fire when idle.

end;

Inheritance

TCustomIdleTimer

  

Implements the base class for TIdleTimer.

|

TCustomTimer

  

|

TObject

Description

TCustomIdleTimer is a TCustomTimer descendant which implements the base class for TIdleTimer. TCustomIdleTimer extends the ancestor class to use events which toggle the timer state. In addition, support is provided for adding and removing its event handlers in the global TApplication instance.

See also

TCustomTimer

TIdleTimer

  

Implements a timer to measure idle time between processes.

TApplication.AddOnIdleHandler

TApplication.AddOnIdleEndHandler

TApplication.AddOnUserInputHandler

TApplication.RemoveOnIdleHandler

TApplication.RemoveOnIdleEndHandler

TApplication.RemoveOnUserInputHandler



CT Web help

CodeTyphon Studio