[Overview][Types][Classes][Procedures and functions][Index] Reference for unit 'ExtCtrls' (#lcl)

TCustomSplitter

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TCustomSplitter : the base type for TSplitter

Declaration

Source position: extctrls.pp line 338

type TCustomSplitter = class(TCustomControl) end;

protected

  procedure CMEnabledChanged(); message;

  class procedure WSRegisterClass; override;

  

Registers this component class with the current WidgetSet.

  function AdaptAnchors();

  function CheckNewSize(); virtual;

  

CheckNewSize - ensure new size is appropriate: returns True if sucessful

  function CheckOffset(); virtual;

  function FindAlignControl;

  

FindAlignControl - returns the main alignment control

  function FindAlignOtherControl;

  

FindAlignOtherControl - returns another alignment control (the splitter may have to align two controls)

  procedure MouseDown(); override;

  

Handler for MouseDown events.

  procedure MouseEnter; override;

  

Invokes the OnMouseEnter handler.

  procedure MouseLeave; override;

  

  procedure MouseMove(); override;

  

Handler for MouseMove events.

  procedure MouseUp(); override;

  

Invokes the OnMouseUp handler.

  procedure Paint; override;

  

Override this method in your derived class with your own paint handler.

  procedure SetAlign(); override;

  procedure SetAnchors(); override;

  procedure SetResizeAnchor(); virtual;

  

  procedure SetResizeControl(); virtual;

  

  procedure StartSplitterMove();

  

StartSplitterMove - method for starting movement of the splitter, given the mouse position MouseXY

  procedure StopSplitterMove();

  procedure UpdateCursor; virtual;

public

  constructor Create(); override;

  

Create - constructor for TCustomSplitter: calls inherited Create then sets initial alignment, size and style

  procedure AnchorSplitter();

  

AnchorSplitter - anchor the splitter to Acontrol using the specified Kind of anchor

  property ResizeControl: TControl; [rw]

  

ResizeControl - the control that is to be re-sized with the splitter

  function GetOtherResizeControl;

  

GetOtherResizeControl - find out which other control is to be re-sized

  procedure MoveSplitter(); virtual;

  

MoveSplitter - by an amount specified by Offset

  procedure SetSplitterPosition();

  

SetSplitterPosition - to specified NewPosition

  function GetSplitterPosition;

  

GetSplitterPosition - returns the current position of the splitter

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property AutoSnap: Boolean; [rw]

  

AutoSnap - automatically snaps to a grid point or grid line in the Form designer

  property Beveled: Boolean; [rw]

  

Whether the edges of the splitter bar are bevelled

  property Cursor: TCursor;

  

The shape of the mouse pointer, when the mouse is over this control.

  property MinSize: Integer; [rw]

  

Minimum size for splitter - default 30 pixels

  property OnCanOffset: TCanOffsetEvent; [rw]

  property OnCanResize: TCanResizeEvent; [rw]

  

Event handler for receiving permission to resize

  property OnMoved: TNotifyEvent; [rw]

  

Event handler for occasion when splitter has moved

  property ResizeAnchor: TAnchorKind; [rw]

  

ResizeAnchor - the kind of anchor to be used for resizing

  property ResizeStyle: TResizeStyle; [rw]

  

Style for resizing - as a line, a pattern, full update, or none

Inheritance

TCustomSplitter

  

TCustomSplitter : the base type for TSplitter

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

TObject

Description

TCustomSplitter: the base type for TSplitter

A Splitter is a vertical or horizontal bar that can be placed on a panel or form, to separate sub-panels functionally and allow re-sizing of the constituent sub-panels

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

{ TCustomSplitter is a control for interactively resizing another control.
    It is a vertical or horizontal bar anchored to a side of a control.
    You can either set the Align property to alLeft (alRight,alTop,alBottom),
    then it will become a vertical bar, aligned to the left and when the user
    moves it with the mouse, the control to the left with the same Align=alLeft
    will be resized.
    The second more flexible possibility is to set the properties Align=alNone,
    AnchorSides and ResizeAnchor.
    }   
The latest version of this document can be found at lazarus-ccr.sourceforge.net.