TCustomSplitter class

In unit ExtCtrls

TCustomSplitter is the base type for TSplitter.

Declaration

pascal

TCustomSplitter = class(TCustomControl)

Inheritance

Descends from it: TLazDockSplitter TSplitter

Description

TCustomSplitter is a TCustomControl descendant which implements a control used to resize, position and align a control to which it is anchored. TCustomSplitter displays a vertical or a horizontal bar anchored to the side of another control. Use the Align property to specify the orientation for the splitter control, and the adjacent control to which it is attached. When the splitter is moved with the mouse, the adjacent control with the same Align value will be resized.

This class defines many of the basic properties for the children classes, such as positioning, sizing and alignment.

Another usage scenario allows setting the Align property to alNone, and using AnchorSides and ResizeAnchor.

TCustomSplitter is the base type for TSplitter.

Properties

`ResizeControl`	public	Contains the aligned control that is resized when the splitter is moved.
`Align`	public	Specifies the aligned edge for the splitter within its Parent and relative to ResizeControl.
`AutoSnap`	public	AutoSnap automatically moves the splitter to the zero position when split size becomes smaller than the value in MinSize.
`Beveled`	public	Indicates whether the edges of the splitter bar are beveled.
`Cursor`	public	The shape for the mouse pointer when the control is dragged.
`MinSize`	public	Minimum size for either of the anchored controls on opposing sides of the splitter.
`ResizeAnchor`	public	Indicates the orientation and alignment for the splitter control.
`ResizeStyle`	public	Display style used when the splitter control is moved.

Methods

`CMEnabledChanged`	protected	Handles the CM_ENABLEDCHANGED message.
`WSRegisterClass`	protected	Registers this component class with the current WidgetSet.
`AdaptAnchors`	protected	Adjust anchor settings to reflect the value in the Align property.
`CheckNewSize`	protected	Ensures the new size is acceptable for the aligned control on the splitter.
`CheckOffset`	protected	Signals the OnCanOffset event handler to determine the offset used when aligning the control, and the success or failure of the calculation.
`FindAlignControl`	protected	FindAlignControl returns the main alignment control for the splitter.
`FindAlignOtherControl`	protected	FindAlignOtherControl returns the other (secondary) alignment control for the splitter.
`MouseDown`	protected	Initiates the splitter movement operation.
`MouseEnter`	protected	Starts mouse capture and tracking for the control.
`MouseLeave`	protected	Perform actions when the mouse pointer exits the control.
`MouseMove`	protected	Applies a Shift+Drag operation for the splitter as a relative offset to the anchored control.
`MouseUp`	protected	Handles a mouse up event for the splitter control.
`Paint`	protected	Draws the splitter control.
`SetAlign`	protected	Sets the value for the Align property.
`SetAnchors`	protected	Sets the value for the Anchors property.
`SetResizeAnchor`	protected	Sets the value for the ResizeAnchor property.
`SetResizeControl`	protected	Sets the value for the ResizeControl property.
`StartSplitterMove`	protected	Method used to start a move operation for the splitter using the mouse position in MouseXY.
`StopSplitterMove`	protected	Performs actions when splitter movement is stopped at the specified mouse position.
`UpdateCursor`	protected	Updates the cursor shape to reflect the ResizeAnchor for the splitter.
`Create`	public	Constructor for the class instance.
`AnchorSplitter`	public	AnchorSplitter anchors the splitter to AControl using the specified Kind of anchor.
`GetOtherResizeControl`	public	Gets the adjacent anchored control that is resized when the splitter is moved.
`MoveSplitter`	public	Moves the splitter by an amount specified in Offset.
`SetSplitterPosition`	public	Changes the position for the splitter to the specified NewPosition.
`GetSplitterPosition`	public	GetSplitterPosition returns the current position of the splitter.

Events

`OnCanOffset`	public	Event handler signalled to calculate the offset when the splitter is dragged, and to accept or reject the offset value.
`OnCanResize`	public	Event handler signalled to determine if the splitter control can be resized / dragged / moved.
`OnMoved`	public	Event handler signalled when the splitter has been dragged / moved.