Sign in Join
FPDoc Onlineexperiment

TCustomIdleTimer class

In unit ExtCtrls

Implements the base class for TIdleTimer.

Declaration

pascal
TCustomIdleTimer = class(TCustomTimer)

Inheritance

  1. TCustomIdleTimer
  2. TCustomTimer
  3. TComponent
  4. TPersistent
  5. TObject

Descends from it: TIdleTimer

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
  • AddOnIdleHandler
  • AddOnIdleEndHandler
  • AddOnUserInputHandler
  • RemoveOnIdleHandler
  • RemoveOnIdleEndHandler
  • RemoveOnUserInputHandler

Properties

AutoEnabledpublicControls whether the idle timer can be automatically enabled or disabled.
AutoStartEventpublicAutoStartEvent - the event that triggers auto-start (either idle time-out or user input).
AutoEndEventpublicAutoEndEvent - the event that stops the timer by setting Enabled to False.
FireOnIdlepublicFireOnIdle - Boolean property determining whether the timer should fire when idle.

Methods

SetAutoEnabledprotectedSets the value for the AutoEnabled property.
DoOnIdleprotectedPerforms actions which execute the idle timer.
DoOnIdleEndprotectedDoOnIdleEnd performs actions when the idle state ends for the timer.
DoOnUserInputprotectedEnables or disables the timer when a user input event is received and AutoEnable is set to True.
LoadedprotectedPerforms actions needed when the component has finished loading during LCL component streaming.
CreatepublicConstructor for the class instance.
DestroypublicDestructor for the class instance.

Inherited

From TCustomTimer (11)

DoOnTimer Enabled Interval KillTimer OnStartTimer OnStopTimer OnTimer SetEnabled SetInterval SetOnTimer UpdateTimer

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.