TCustomTimer class

In unit CustomTimer

Defines the base class for TTimer.

Declaration

pascal

TCustomTimer = class(TComponent)

Inheritance

TCustomTimer
TComponent
TPersistent
TObject

Descends from it: TCustomIdleTimer TTimer

Description

TCustomTimer is a TComponent descendant which specifies the base class for TTimer. TCustomTimer specifies the properties, methods, and events handlers used for timer classes in the LCL.

Use the Enabled property to indicate if the timer can be executed.

Use the Interval property to control the frequency of notification events from the executing timer class instance.

Use the OnTimer, OnStartTimer, and OnStopTimer event handlers to perform actions needed for the corresponding execution state in the timer class instance.

Do not create instances of TCustomTimer; use the TTimer descendant class in the ExtCtrls.pp unit.

Properties

`Enabled`	public	Indicates if the timer is ready to start.
`Interval`	public	The Interval (in milliseconds) for timer notifications.

Methods

`SetEnabled`	protected	Sets the value for the Enabled property.
`SetInterval`	protected	Sets the value for the Interval property.
`SetOnTimer`	protected	Sets the event handler for the OnTimer property.
`DoOnTimer`	protected	DoOnTimer signals the OnTimer event handler.
`UpdateTimer`	protected	Updates the Timer to reflect the current properties.
`KillTimer`	protected	Stops execution of the timer class instance.
`Loaded`	protected	Performs actions needed when LCL component streaming has been completed.
`Create`	public	Create - constructor for TCustomTimer: calls inherited Create, sets up handle and initializes timer interval.
`Destroy`	public	Destructor for the timer class instance.

Events

`OnTimer`	public	Event handler signalled when the Interval for the timer has elapsed.
`OnStartTimer`	public	Event handler signalled when the timer is started.
`OnStopTimer`	public	OnStopTimer - event handler for stopping the timer.

Inherited

From TComponent (73)

_AddRef _Release BeforeDestruction CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DefineProperties DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetChildren GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetParentComponent GetTypeInfo GetTypeInfoCount HasParent iicrGetComponent InsertComponent Invoke IsImplementorOf Loading Name Notification ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReadState ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetName SetParentComponent SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (5)

Assign AssignTo FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (37)

AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.