Skip to content

pbEnabled - cIdleHandler

Used to set and determine if the idle handler object is enabled (i.e., if it should send the OnIdle event)

Type: Property
Access: Read/Write
Data Type: Boolean
Parameters: None

Syntax

Property Boolean pbEnabled
Access Type Syntax
Read Access: Get pbEnabled to BooleanVariable
Write Access: Set pbEnabled to BooleanVariable/Value

Description

pbEnabled determines if the idle handler is enabled. If enabled, it will send the OnIdle event when the application's UI loop is about to "go idle".

By default, pbEnabled is set to false, therefore the OnIdle events are not sent. It is the programmer's responsibility to turn enable and disable the idle handler as needed. Do not assume that they will be automatically enabled when their parent is activated and, more importantly, do not assume that they are disabled when the parent object is deactivated.

See the cIdleHandler class for more information and a sample showing how to use an idle handler.