A component that allows you to specify a cut that will split the Widget into two separate cells. Each cell can contain a Widget and can be resized using the grip area provided by the splitter.

To prevent the Splitter cells to become to small a minimum cell size can be provided to prevent them to be resized below that threshold.

Additionally, if both cells area cannot fit within the Splitter bounds the less dominant will be retracted.

See Also

Widget

Static Variables

Name Description

widget Parent Widget where the Splitter component is defined.

Declaration

Widget *widget

Variables

Name	Description
`min_cell_size`	Determine the minimum cell size in pixels.
Declaration int min_cell_size
`dynamic_resize`	Determine wether or not the cells are dynamically resized when the Splitter size changes.
Declaration bool dynamic_resize
`invert`	Invert the side of the Splitter main area (default left/up).
Declaration bool invert Note The oposite side will be retracted in case the Widget gets below the `min_cell_size`.
`grip_size`	Specify the size of the grip in pixels.
Declaration unsigned char grip_size

Functions

Name	Description
`cut`	Specify the Splitter cut in pixels.
Declaration void Split( int cut ) Parameters `cut`: Size of the cut in pixels.
`ResizeCells`	Resize the cells by providing a delta offset in pixels.
Declaration void ResizeCells( const ivec2 d ) Parameters `d`: Delta offset in pixels.
`ResizeCells`	Resize the cells by providing a delta offset in pixels optionally snapping it to the grip grid.
Declaration void ResizeCells( ivec2 d, bool snap ) Parameters `d`: Delta offset in pixels. `snap`: Determine wether or not the handle should be snapped to the grip grid.
`Resize`	Resize the Splitter.
Declaration void Resize( const ivec2 d ) Parameters `d`: Delta offset in pixels.
`Resize`	Resize the Splitter optinally snapping it to the nearst point on the grip grid.
Declaration void Resize( ivec2 d, bool snap ) Parameters `d`: Delta offset in pixels. `snap`: Determine wether or not the handle should be snapped to the grip grid.
`GetGrip`	Helper to retrieve the grip box.
Declaration quad GetGrip( void )

SplitterType

Constant value used to set a Splitter direction.

kColumn: Cut the Splitter vertically.
kRow: Cut the Splitter horizontally.