Vcl.Controls.TControlState

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

type TControlState = set of (csLButtonDown, csClicked, csPalette, csReadingState, csAlignmentNeeded, csFocusing, csCreating, csPaintCopy, csCustomPaint, csDestroyingHandle, csDocking, csDesignerHide, csPanning, csRecreating, csAligning, csGlassPaint, csPrintClient);

C++

typedef System::Set<Vcl_Controls__21, Vcl_Controls__21::csLButtonDown, Vcl_Controls__21::csPrintClient> TControlState;

Properties

Type Visibility Source Unit Parent
set
typedef
public
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls Vcl.Controls

Description

TControlState describes the current state of a control.


TControlState defines a set of flags used to define the state of a control:

Flag Meaning

csLButtonDown

The left mouse button was clicked and not yet released. This is set for all mouse-down events.

csClicked

The same as csLButtonDown, but only set if ControlStyle contains csClickEvents, meaning that mouse-down events are interpreted as clicks.

csPalette

The palette has changed and the control or one of its descendants has not finished adjusting by realizing its palette.

csReadingState

The control is reading its state from a stream.

csAlignmentNeeded

The control needs to realign itself when alignment is re-enabled.

csFocusing

The application is processing messages intended to give the control focus. This does not guarantee the control will receive focus, but prevents recursive calls.

csCreating

The control and/or its owner and subcontrols are being created. This flag clears when all have finished creating.

csPaintCopy

The control is being replicated, meaning a copy of the control is being painted. The ControlStyle flag csReplicatable must be set for this state to occur.

csCustomPaint

The control is processing custom paint messages.

csDestroyingHandle

The control's window is being destroyed.

csDocking

The control is being docked.

csPanning

Set if the control is actively being panned.

csRecreating

The control and/or its owner and subcontrols are being recreated. This flag clears when all have finished recreating.