TabWidget (hwx.gui)

NoteBook with tabs.

A NoteBook presents multiple mutually exclusive panes of content in the same area. It includes a tabbed control area with ‘text’ and a content area.

Inherits:

Properties

Public Methods

addChildren (self, children)

addTab (self, child, text=’’, icon=None)

destroy (self)

enableGlobalActions (self, enable)

getMousePosition (self)

getRelativeMousePosition (self)

hide (self)

insertTab (self, child, text=’’, icon=None, index=-1)

saveAsPng (self, fname)

setF1HelpTopic (self, helptopic)

setProperties (self, kwds)

show (self)

Property Details

property current

The current tab.

property flat

Gives the TabWidget a borderless appearance.

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

addTab(self, child, text='', icon=None)

Inserts a new tab with the specified child.

param child

The widget to be added to the tab.

type child

Widget

param text

The text to be displayed on the tab.

type text

str

param icon

The icon to be shown in the tab.

type icon

str

destroy(self)

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

bool

getMousePosition(self)

Returns the mouse position.

getRelativeMousePosition(self)

Returns the mouse position relative to this widget.

hide(self)

Hides the widget.

insertTab(self, child, text='', icon=None, index=- 1)

Inserts a new tab with the specified child.

param child

The widget to be added to the tab.

type child

Widget

param text

The text to be displayed on the tab.

type text

str

param icon

The icon to be shown in the tab.

type icon

str

param index

The index where to insert the tab.

type index

int

saveAsPng(self, fname)

Saves the widget as a .png file.

param fname

The file name for the .png

type fname

str

returns

True if it was saved succesfully, False otherwise.

rtype

bool

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

str

setProperties(self, kwds)

Internal method called from constructors.

show(self)

Shows the widget.