GuideBarMenu (hwx.gui)#

class GuideBarMenu(parent, autoshow=True, autohide=True, scrollbar=False, **kwds)#

Bases: Widget

Clickable Menu that can be added to a GuideBar.

Attribute Table#

Name

Type

anchorbutton

property

autohide

property

autoshow

property

enabled

property

icon

property

text

property

tooltip

property

visible

property

Method Table#

Name

Description

button (self, **kwds)

Adds a button to the Guide bar menu layout.

checkBox (self, checked=False, **kwds)

Adds a checkbox to the Guide bar menu layout.

widget (self, widget, stretch=0)

Adds a widget to self.

button(**kwds)#

Adds a button to the Guide bar menu layout.

Parameters:

kwds (dict) – Any other properties needed to be set for the Button.

Returns:

The added button.

Return type:

Button

widget(widget, stretch=0)#

Adds a widget to self.

Parameters:
  • widget (Widget) – The widget to add to the layout. It is expected to be a child of the wrapped widget.

  • stretch (int) – The stretch value of the widget that will be added.

Returns:

The added widget.

Return type:

Widget

checkBox(checked=False, **kwds)#

Adds a checkbox to the Guide bar menu layout.

Parameters:
  • checked (bool) – Determines whether the button is checked or not.

  • kwds (dict) – Any other properties needed to be set for the check box.

Returns:

The check box.

Return type:

Button

property autoshow#

Determines whether to automatically show the menu when its anchor button is clicked.

property anchorbutton#

The button in the guide bar associated with this menu.

property autohide: bool#

Determines whether the menu will close automatically if a menu item or item outside the menu is clicked or if a second menu is displayed.

property enabled#

Determines if the anchor button is enabled.

property icon#

The name of icon file or predefined icon to assigned to the anchor button.

property text#

The text to display on the anchor button.

property tooltip#

The Tooltip that appears while hovering mouse over the anchor button.

property visible#

The visibility of the GuideBarMenu.