TControl

Visual user interface element that can react to user input.

Inheritance

Level	Ancestor	Description
1	TObject	Ultimate ancestor in a class hierarchy
2	TBaseObject	A base class for objects that can be used instead of `TObject`.
3	TControl

Source

UserInterface.Control.pas (65)

Description

The size of a control can only be determined when it IsBoundToLayout which means that is has been inserted into a properly rooted control hierarchy for which the properties of the applicable rendering device are fully available. To control the size of a TControl when it is first displayed you can use TControl.Style.Width and TControl.Style.Height. Both can take the following values:

`TControlSize.Auto`	Automatically determine preferred size
`TControlSize.Available`	Use entire available size
`TControlSizeFixed`	Use a specified fixed size

Container controls specify the exact way they try to respect the specified size properties.

Fields

Scope	Visibility	Type	Name
Instance	private	TList<TControl>	FChildControls
Instance	private	TControl	FParentControl
Instance	private	TListeners	FListeners
Instance	private	TCaret	FCaret
Instance	private	TBoolean	FCaptionVisible
Instance	private	TBoolean	FIsEditor
Instance	private	TControlMode	FMode
Instance	private	TControlModes	FAllowedModes
Instance	private	TFocusability	FFocusability
Instance	private	TValuePath	FPath
Instance	private	TControlStyle	FStyle
Instance	protected	TText	FCaption
Instance	protected	TInteger32Rectangle	FBounds
Instance	public	TControlPurpose	Purpose
Instance	public	TBoolean	SuppressInvalidate

Methods

Scope	Visibility	Result	Name	Description
Instance	private		SetParentControl(Value: TControl)
Instance	private	TInteger32	GetLeft()
Instance	private		SetLeft(Value: TInteger32)
Instance	private	TInteger32	GetWidth()
Instance	private		SetWidth(Value: TInteger32)
Instance	private	TInteger32	GetTop()
Instance	private		SetTop(Value: TInteger32)
Instance	private	TInteger32	GetSide(Side: TSide)
Instance	private	TInteger32	GetHeight()
Instance	private		SetHeight(Value: TInteger32)
Instance	private		SetMode(Value: TControlMode)
Instance	private	TInteger32Size	GetSize()
Instance	private		SetSize(Value: TInteger32Size)
Instance	private		SetBounds(Value: TInteger32Rectangle)
Instance	private	TInteger32Rectangle	GetScreenBounds()
Instance	private	TInteger32Point	GetPosition()
Instance	private		SetPosition(Value: TInteger32Point)
Instance	private		SetIsEditor(Value: TBoolean)
Instance	private		SetAllowedModes(Value: TControlModes)
Instance	private		SetCaret(Value: TCaret)
Instance	private		SetPath(Value: TValuePath)
Instance	protected	TControl	GetActiveChildControl()
Instance	protected		SetActiveChildControl(Value: TControl)
Instance	protected	TControl	TopLevelWindow()
Instance	protected	TFocusability	GetFocusability()
Instance	protected		UpdateBounds(OldBounds: TInteger32Rectangle; NewBounds: TInteger32Rectangle)
Instance	protected		BoundsChanged(OldBounds: TInteger32Rectangle; NewBounds: TInteger32Rectangle)
Instance	protected		SizeChanged()
Instance	protected	TInteger32Rectangle	GetClippingBoundsForChild(Control: TControl)
Instance	protected	TInteger32Rectangle	GetContextMenuTargetBounds()	Returns the bounds the target of the context menu
Instance	protected		PaintChildControl(Canvas: TCanvas; Control: TControl)
Instance	protected		PaintFocusRectangle(Canvas: TCanvas; Rectangle: TInteger32Rectangle)
Instance	protected		RepaintOnFocusChange()
Instance	protected		RethinkScrollBars()
Instance	protected		ChildRethinksScrollBars(Child: TControl)
Instance	protected	TBoolean	Navigate(Direction: TNavigationDirection; KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoUp(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoDown(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoLeft(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoRight(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoForward()
Instance	protected	TBoolean	GoBackward()
Instance	protected	TBoolean	GoPageUp(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoPageDown(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoPageLeft(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoPageRight(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoVerticalHome(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoVerticalEnd(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoHorizontalHome(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoHorizontalEnd(KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	GoParent(KeyModifiers: TKeyModifiers)
Instance	protected	TControl	GetEditor()
Instance	protected	TBoolean	IsInlineEditing()
Instance	protected		StopInlineEditing(Successful: TBoolean)
Instance	protected	TInteger32Rectangle	GetEditorBounds()
Instance	protected		SetEditorValue(Value: TValue)
Instance	protected		ResetEditorValue()
Instance	protected		ScrollEditorIntoView()
Instance	protected	TBoolean	EditingCanBeStopped(Successful: TBoolean)
Instance	protected	TBoolean	StartEditing()
Instance	protected	TBoolean	StopEditing(Successful: TBoolean)
Instance	protected		QuitEditingMode(Successful: TBoolean)
Instance	protected	TText	GetCaption()
Instance	protected	TBoolean	GetCaptionVisible()
Instance	protected		CaptionChanged()
Instance	protected		SetCaption(Value: TText)
Instance	protected		SetCaptionVisible(Value: TBoolean)
Instance	protected		ChildControlAdded(Control: TControl)
Instance	protected		ChildControlRemoved(Control: TControl)
Instance	protected		SetChildControlVisible(Control: TControl; Visible: TBoolean; ListEndPoint: TListEndPoint)
Instance	protected	TValue	GetValue()
Instance	protected		SetValue(Value: TValue)
Instance	protected	TBoolean	HandleClipboardKey(Key: TKey; KeyModifiers: TKeyModifiers)
Instance	protected	TBoolean	HandleContextMenuKey(Event: TKeyDownEvent)
Instance	protected		FireValueChanged()
Instance	protected		FireDefaultActionExecuted()
Instance	protected		FireEvent(Event: TEvent)
Instance	protected		DescendantRequestsFocus(Descendant: TControl)
Instance	protected		DescendantRequestsFocusInComposition(Descendant: TControl)
Instance	protected		DescendantFiresEvent(Descendant: TControl; Event: TEvent)
Instance	protected		DescendantOpensControl(Descendant: TControl; Control: TControl; TransferFocus: TBoolean)
Instance	protected		DescendantOpensControlForValue(Descendant: TControl; Value: TValuePath; TransferFocus: TBoolean)
Instance	protected		HasBeenBoundToLayout()
Instance	protected		CopyCaretFromDescendant(Descendant: TControl)
Instance	protected		StyleChanged(Property_: TControlStyleProperty)
Instance	protected		DetermineStyle()
Instance	protected	TControl	ChildForMouseEvent(Event: TMouseEvent)
Instance	protected		AllowedModesChanged()
Instance	protected		DistributeEventDownHierarchy(Event: TEvent; Order: TTreeVerticalOrder; FreeEvent: TBoolean)
Instance	public		Create()
Instance	public		Destroy()
Instance	public	TBoolean	HandleEvent(Event: TEvent)
Instance	public		Paint(Canvas: TCanvas)
Instance	public		PaintChildren(Canvas: TCanvas)
Instance	public		PaintAll(Canvas: TCanvas)
Instance	public	TBoolean	IsBoundToLayout()	Returns `True` for a control when it has been inserted into a properly rooted control hierarchy for which the properties of the applicable rendering device are fully available
Instance	public	TControl	CreateToolbar()	Allows a control to return an assistent control to be placed on the toolbar
Instance	public	TControl	Embellish()
Instance	public	TBoolean	IsEmbellishment()
Instance	public	TBoolean	IsComposition()
Instance	public	TControl	GetEmbellishedControl()
Instance	public	TControl	GetRootEmbellishment()
Instance	public	TControl	RootComposition()
Instance	public	TBoolean	CompositeControlHasFocus()
Instance	public	TBoolean	ControlInCompositionHasFocus()
Instance	public	TBoolean	CompositionReceivesKeyboardInput()
Instance	public	TControl	RootControl()
Instance	public	TControl	RootOverlappedControl()
Instance	public	TBoolean	IsDynamicContainer()
Instance	public	TControl	GetChildOfDynamicContainer()
Instance	public	TDrawingResources	GetDrawingResources()
Instance	public	TClipBoard	GetClipBoard()
Instance	public	TKeyboardFocusManager	GetFocusManager()
Instance	public	TMouseManager	GetMouseManager()
Instance	public	TBoolean	IsMouseLeftDown()
Instance	public	TBoolean	ShouldCancelMouseCaptureAutomatically()
Instance	public		LayoutControls()
Instance	public	TInteger32Point	RelativeToScreen(Point: TInteger32Point)
Instance	public	TInteger32Point	ScreenToRelative(Point: TInteger32Point)
Instance	public	TMonitor	CreateNearestMonitor(Reference: TInteger32Point)
Instance	public	THintWindow	GetHintWindow()
Instance	public	TInteger32Size	GetPreferredSize(AvailableSize: TInteger32Size)	Returns the preferred size of this control
Instance	public	TInteger32Size	GetScrollSize(AvailableSize: TInteger32Size)	Returns the scroll extent of this control
Instance	public	TInteger32Size	ResolveStyleSize(AvailableSize: TInteger32Size)
Instance	public		MakeRectangleVisible(Rectangle: TInteger32Rectangle)
Instance	public		MakeRectangleVisibleForControl(Control: TControl; Rectangle: TInteger32Rectangle)
Instance	public	TInteger32Rectangle	GetVisibleRectangle()
Instance	public		VisibleRectangleChanged()
Instance	public	TInteger32Rectangle	GetVisibleRectangleForControl(Control: TControl)
Instance	public	TBoolean	HandlesNavigationDimension(NavigationDimension: TValidNavigationDimension)
Instance	public	TBoolean	HandleMouseEvent(Event: TMouseEvent)
Instance	public	TBoolean	DistributeMouseEventDownHierarchy(Event: TMouseEvent)
Instance	public	TBoolean	DistributeMouseEventUpHierarchy(Event: TMouseEvent)
Instance	public	TBoolean	MouseLeftDown(Event: TMouseButtonEvent)
Instance	public	TBoolean	MouseLeftUp(Event: TMouseButtonEvent)
Instance	public	TBoolean	MouseRightDown(Event: TMouseButtonEvent)
Instance	public	TBoolean	MouseRightUp(Event: TMouseButtonEvent)
Instance	public	TBoolean	MouseButton(Event: TMouseButtonEvent)
Instance	public	TBoolean	MouseWheel(Event: TMouseWheelEvent)
Instance	public	TBoolean	MouseMove(Event: TMouseMoveEvent)
Instance	public	TBoolean	MouseLeave(Event: TMouseLeaveEvent)
Instance	public	TCursor	GetCursorForPosition(Position: TInteger32Point)
Instance	public	TBoolean	HandleKeyboardEvent(Event: TKeyboardEvent)
Instance	public	TBoolean	ShouldForwardKeyboardEventDownChain(Event: TKeyboardEvent)
Instance	public	TBoolean	DistributeKeyboardEventThroughChain(Event: TKeyboardEvent)
Instance	public	TBoolean	DistributeKeyboardEventUpCompositionHierarchy(Event: TKeyboardEvent)
Instance	public	TBoolean	KeyDown(Event: TKeyDownEvent)
Instance	public	TBoolean	KeyUp(Event: TKeyUpEvent)
Instance	public	TBoolean	KeyPress(Event: TKeyPressEvent)
Instance	public	TBoolean	ShouldForwardKeyDownDownChain(Event: TKeyDownEvent)
Instance	public	TBoolean	ShouldForwardKeyUpDownChain(Event: TKeyUpEvent)
Instance	public	TBoolean	ShouldForwardKeyPressDownChain(Event: TKeyPressEvent)
Instance	public		GainedFocus()	Called when a control gains focus
Instance	public		LostFocus()	Called when a control loses focus
Instance	public		RequestFocus()
Instance	public		RequestFocusInComposition()
Instance	public		GainedFocusInComposition()
Instance	public		LostFocusInComposition()
Instance	public	TBoolean	HasFocus()
Instance	public	TBoolean	HasFocusInComposition()
Instance	public	TControl	ControlWithCompositionFocus()
Instance	public	TControl	ChildWithCompositionFocus()
Instance	public	TBoolean	ChildHasCompositionFocus(ChildControl: TControl)
Instance	public	TBoolean	CanReceiveFocus()
Instance	public	TBoolean	ControlInHierarchyCanReceiveFocus()
Instance	public	TControl	DefaultControlToFocus()
Instance	public	TControl	DefaultControlToNavigate()
Instance	public	TBoolean	ReceivesKeyboardInput()
Instance	public	TControl	NextInKeyboardInputChain()
Instance	public	TBoolean	HasAncestor(Control: TControl)
Instance	public	TBoolean	IsVisible()
Instance	public	TBoolean	IsChildVisible(Control: TControl)
Instance	public		MakeVisible()
Instance	public		Enter()
Instance	public		EnterFromTop(Fast: TBoolean)
Instance	public		EnterFromBottom(Fast: TBoolean)
Instance	public		EnterFromLeft(Fast: TBoolean)
Instance	public		EnterFromRight(Fast: TBoolean)
Instance	public	TControl	ChildWithPosition(Position: TInteger32Point)
Instance	public	TControl	DescendantWithPosition(Position: TInteger32Point)
Instance	public	TInteger32Point	ConvertPositionToChildPosition(Position: TInteger32Point; Child: TControl)
Instance	public	TInteger32Point	ConvertPositionFromChildPosition(Position: TInteger32Point; Child: TControl)
Instance	public	TInteger32Point	ConvertPositionToDescendantPosition(Position: TInteger32Point; Descendant: TControl)
Instance	public	TInteger32Point	Old_PositionRelativeTo(Ancestor: TControl)
Instance	public	TInteger32Point	PositionRelativeTo(Ancestor: TControl)
Instance	public		Invalidate()
Instance	public		InvalidateRectangle(Rectangle: TInteger32Rectangle)
Instance	public	TControl	GetDragControl(Position: TInteger32Point)
Instance	public	TDragSite	CreateDragSource(Control: TControl)	Creates a `TDragSite` for `Control`.
Instance	public	TDragSite	CreateDragTarget(Source: TDragSite; Position: TInteger32Point)	Creates a `TDragSite` for `Source` and `Position`.
Instance	public	TControlFactory	GetControlFactory()
Instance	public		OpenControl(Control: TControl; TransferFocus: TBoolean)
Instance	public		Old_OpenControlForValue(Value: TValue; TransferFocus: TBoolean)
Instance	public		OpenControlForValue(Path: TValuePath; TransferFocus: TBoolean)
Instance	public		CloseControl(Control: TControl)
Instance	public	TBoolean	IsOverlapped()
Instance	public		CloseAllShowing(Object_: TObject)
Instance	public	TBoolean	HierarchyContainsControl(Control: TControl)
Instance	public	TBoolean	CopyToClipboard()
Instance	public	TBoolean	CutToClipboard()
Instance	public	TBoolean	PasteFromClipboard()
Instance	public	TBoolean	Undo()
Instance	public	TBoolean	Redo()
Instance	public	TValuePath	GetFocusedObject()
Instance	public	TObjectSelection	GetObjectSelection()
Instance	public	TControl	FindFirstDescendant(Condition: TCondition<TControl>)
Instance	public	TControl	FindFirstSibling(Condition: TCondition<TControl>)
Instance	public	TBoolean	ControlIsAtSide(Control: TControl; Side: TSide)
Instance	public	TBoolean	ControlOverlapsAtSide(Control: TControl; Side: TSide)
Instance	public	TList<TControl>	FilterFocusableControlsAtSide(Controls: TList<TControl>; Side: TSide)
Instance	public	TList<TControl>	FilterOverlappingControlsAtSide(Controls: TList<TControl>; Side: TSide)
Instance	public	TList<TControl>	FilterClosestControlsAtSide(Controls: TList<TControl>; Side: TSide)
Instance	public	TControl	AncestorControlWithControlsAtSide(Side: TSide)
Instance	public	TControl	ControlAtSide(Controls: TList<TControl>; Side: TSide)
Instance	public	TControl	LeafControlAtSide(Control: TControl; Side: TSide)
Instance	public	TIterator<TControl>	CreateChildIterator()
Instance	public	TIterator<TControl>	CreateSubtreeIterator(Order: TTreeVerticalOrder)