TSplitPanel

Base class for container controls that show splitters between controls to resize those controls.

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	Visual user interface element that can react to user input.
4	TPanel	Base class for a `TControl` that contains other controls.
5	TOpaquePanel	`TPanel` that fills its background with `Style.PanelBackground`
6	TSplitPanel

Source

UserInterface.Control.Panel.Split.pas (113)

Description

Each control is placed within its own panel which can be larger than the control itself, for instance, when it shows a caption for the control. PanelSize controls the size of the entire panel, ControlSize controls the size of the control itself. Whenever a TSplitPanel is resized it redistributes the size delta according to ResizeWeight.

The size of a panel is initially determined when it IsBoundToLayout. The TControl.Style size properties are interpreted as follows:

Property value	Control size	Resize weight
`TControlSize.Auto`	Preferred size	`0.0`
`TControlSize.Available`	Remaining size	`1.0`
`TControlSizeFixed`	Specified size	`0.0`

The remaining size is distributed evenly among all controls with TControlSize.Available.

Fields

Scope	Visibility	Type	Name
Instance	private	TInteger32	FSplitterRadius
Instance	private	TInteger32	FMouseOverSplitter
Instance	protected	TBoolean	Resizing
Instance	protected	TMouseSplitInformation	ResizeInformation
Instance	protected	TControl	PreviousActiveControl
Instance	protected	TCumulativeSizes	PanelSizes
Instance	protected	TList<TPanelInformation>	PanelInformations

Methods

Scope	Visibility	Result	Name
Instance	private		SetMouseOverSplitter(Value: TInteger32)
Instance	private		SetSplitterRadius(Value: TInteger32)
Instance	private	TInteger32	GetSplitterLocation(Index: TInteger32)
Instance	private	TInteger32	GetPanelSize(Index: TInteger32)
Instance	private		SetPanelSize(Index: TInteger32; Value: TInteger32)
Instance	private	TInteger32	GetControlSize(Index: TInteger32)
Instance	private		SetControlSize(Index: TInteger32; Value: TInteger32)
Instance	private	TInteger32	GetResizeWeight(Index: TInteger32)
Instance	private		SetResizeWeight(Index: TInteger32; Value: TInteger32)
Instance	private		SetPanelCount(Value: TInteger32)
Instance	private	TInteger32	GetPanelCount()
Instance	private		SetPanels(Index: TInteger32; Value: TControl)
Instance	private	TControl	GetPanels(Index: TInteger32)
Instance	private	TBoolean	GetGlueLast()
Instance	private		SetGlueLast(Value: TBoolean)
Instance	protected	TMouseSplitInformation	MouseSplitInformation(Position: TInteger32Point)
Instance	protected		SplitPanelInfo(Index: TInteger32)
Instance	protected	TSizableCumulativeSizes	CreatePanelSizes()
Instance	protected		HasBeenBoundToLayout()
Instance	protected		EvenlyDistributeSize(Size: TInteger32)
Instance	protected		ConfigurePanelResizeWeight(Index: TInteger32; Control: TControl)
Instance	protected		ConfigurePanelSize(Index: TInteger32; Control: TControl)
Instance	protected		ConfigurePanelSizes()
Instance	protected		StartResize(Splitter: TInteger32; Position: TInteger32Point)
Instance	protected		StopResize()
Instance	protected		MoveSplitter(Splitter: TInteger32; Position: TInteger32Point; Inplace: TBoolean)
Instance	protected		ResizeToPreferred(Splitter: TInteger32)
Instance	protected	TInteger32	MinimalSplitterLocation(Index: TInteger32)
Instance	protected	TInteger32	MaximalSplitterLocation(Index: TInteger32)
Instance	protected	TInteger32	SplitterWithLocation(Position: TInteger32Point)
Instance	protected	TInteger32	TrailingSize()
Instance	protected	TInteger32	ExtraPanelSize(Index: TInteger32)
Instance	protected	TInteger32	PanelWithLocation(Position: TInteger32Point)
Instance	protected	TInteger32Rectangle	CalculatePanelBounds(Index: TInteger32)
Instance	protected	TCursor	GetSplitCursorForXY(Position: TInteger32Point)
Instance	protected	TInteger32Rectangle	GetSplitterRectangle(Splitter: TInteger32)
Instance	protected		PaintHighlightedSplitter(Canvas: TCanvas; Splitter: TInteger32)
Instance	protected	TInteger32	GetPanelIndexWithButtonPanel(ButtonPanel: TSplitButtonPanel)
Instance	protected		DescendantFiresEvent(Descendant: TControl; Event: TEvent)
Instance	protected		LayoutPanel(Index: TInteger32)
Instance	protected	TControl	GetControlInFirstNonEmptyPanel()
Instance	public		Create()
Instance	public		Destroy()
Instance	public		Paint(Canvas: TCanvas)
Instance	public	TControl	Embellish()
Instance	public	TControl	Split(Index: TInteger32; SplitPanelClass: TSplitPanelClass)
Instance	public	TControl	ToggleCaption(Index: TInteger32)
Instance	public	TControl	ToggleTabPanel(Index: TInteger32)
Instance	public		ClosePanel(Index: TInteger32)
Instance	public		CloseEmptyPanels()
Instance	public		DeletePanel(Index: TInteger32)
Instance	public	TInteger32	PanelIndexOf(Control: TControl)
Instance	public		CloseControl(Control: TControl)
Instance	public	TControl	DefaultControlToFocus()
Instance	public	TControl	DefaultControlToNavigate()
Instance	public	TBoolean	MouseLeftDown(Event: TMouseButtonEvent)
Instance	public	TBoolean	MouseLeftUp(Event: TMouseButtonEvent)
Instance	public	TBoolean	MouseMove(Event: TMouseMoveEvent)
Instance	public	TBoolean	MouseLeave(Event: TMouseLeaveEvent)
Instance	public	TCursor	GetCursorForPosition(Position: TInteger32Point)
Instance	public	TControl	GetDragControl(Position: TInteger32Point)
Instance	public	TDragSite	CreateDragSource(Control: TControl)
Instance	public	TDragSite	CreateDragTarget(Source: TDragSite; Position: TInteger32Point)
Instance	public	TBoolean	IsDynamicContainer()