Splitter (hwx.gui)

A Splitter Widget.

A Splitter controls the relative size of the children widgets by modifying the boundary between them. Splitter widget allows to create and control a dynamic layout of resizeable and collapsible panes. This can be useful when the areas that the splitter divides have variable dimensions.

For example, the Demo dialog box shows a splitter between the text edit area and the run edit. When the mouse pointer is located in proximity of the splitter, it will change appearance.



Public Methods

addChildren (self, children)

destroy (self)

enableGlobalActions (self, enable)

getMousePosition (self)

getRelativeMousePosition (self)

hide (self)

saveAsPng (self, fname)

setF1HelpTopic (self, helptopic)

setProperties (self, kwds)

show (self)

Property Details

property collapsible

Returns and sets if the children can be resized down to size 0.

property opaqueResize

Updates the widgets when the side is being dragged.

property orientation

Specifies the orientation of the widget.

property sizes

A list of widths (horizontal) or heights(vertical) in pixels.

Method Details

addChildren(self, children)

Add child widgets/layouts into this widget.

Widget children get layed out using a VBoxLayout.

Typically, you’ll pass the parent/children into the constructor instead of calling this function directly.

param children

type children

list[Widget] | Layout


Deletes this and all its children.

enableGlobalActions(self, enable)

Sets the state of Global Actions.

Disable the global actions to get key events.

param enable

Determines whether to enable or disable global actions.

type enable



Returns the mouse position.


Returns the mouse position relative to this widget.


Hides the widget.

saveAsPng(self, fname)

Saves the widget as a .png file.

param fname

The file name for the .png

type fname



True if it was saved succesfully, False otherwise.



setF1HelpTopic(self, helptopic)

Popup web-browser helps when the user hits F1 when over this.

param helptopic

Topic name user needs help in.

type helptopic


setProperties(self, kwds)

Internal method called from constructors.


Shows the widget.