GuideBar (hwx.gui)¶
A popup dialog.
It is typically used in a context to guide a user though the workflow.
- Inherits:
Properties¶
Public Methods¶
buttonGroup (self, buttons, **kwds)
createContents (self)
executeCreateandExitButton (self, command, **kwds)
executePlayButton (self, command, **kwds)
exitButton (self, **kwds)
resetButton (self, **kwds)
toggleButton (self, **kwds)
widget (self, widget, stretch=0)
Property Details¶
- property activebutton¶
Returns or sets the button, whose help-text will be shown.
- property position¶
Alignment relative to its captor:
Floating
TopLeft
TopRight
BottomLeft
BottomRight
BottomCenter
RelativePosition
Method Details¶
- button(self, **kwds)¶
Adds a button to self.
- returns
The added button.
- rtype
Button
- buttonGroup(self, buttons, **kwds)¶
Groups all the buttons specified in a ButtonGroup.
- param buttons
List of buttons to be added to the group.
- type buttons
list[Button]
- param kwds
Any other properties needed to be set for the ButtonGroup.
- type kwds
dict
- returns
A ButtonGroup.
- rtype
ButtonGroup
- comboBox(self, **kwds)¶
Creates a new ComboButton and inserts it into self.
- param kwds
Any other properties user wants to set for the ComboButton.
- type kwds
dict
- returns
The new ComboButton.
- rtype
ComboButton
- createContents(self)¶
To be implemented in derived class.
- executeCreateandExitButton(self, command, **kwds)¶
Shortcut for creating green check button that executes the command, calls clearAllLists, then calls .pop().
- param command
Callback method to be called when the button is clicked.
- type command
callback
- returns
A check button.
- rtype
Button
- executePlayButton(self, command, **kwds)¶
Shortcut for creating a play button that executes the given command.
- param command
Callback method to be called when the button is clicked.
- type command
callback
- returns
The new play button.
- rtype
Button
- exitButton(self, **kwds)¶
Shortcut for creating a button that has the red x icon and pops the context.
- param kwds
Any other properties user wants to set for the exit button.
- type kwds
dict
- returns
The new exit button.
- rtype
Button
- legend(self, values, delayShow=False, **kwds)¶
Sets and returns the legends.
- param values
Legend widgets to be added in guide bar.
- type values
LegendWidget
- param delayShow
Determines whether to delay the showing of the legends or not.
- type delayShow
bool
- param kwds
Any other properties user wants to set for the legend.
- type kwds
dict
- returns
All the legends.
- rtype
Legend
- menu(self, autoshow=True, autohide=True, **kwds)¶
Creates a new menu button.
- param autoshow
Determines whether to automatically show the menu button or not.
- type autoshow
bool
- param autohide
Determines whether to automatically hide the menu button or not.
- type autohide
bool
- param kwds
Any other properties user wants to set for the menu button.
- type kwds
dict
- returns
A menu button.
- rtype
Button
- resetButton(self, **kwds)¶
Shortcut for creating a button that has the reset icon and calls clearAllLists.
- returns
The new reset button.
- rtype
Button
- toggleButton(self, **kwds)¶
Creates a new ToggleButton and inserted into self.
- param kwds
Any other properties user wants to set for the ToggleButton.
- type kwds
dict
- returns
The new ToggleButton.
- rtype
ToggleButton
- widget(self, widget, stretch=0)¶
Adds a widget to self.
- param widget
The widget to add to the layout. It is expected to be a child of the wrapped widget.
- type widget
Widget
- param stretch
The stretch value of the widget that will be added.
- type stretch
int
- returns
The added widget.
- rtype
Widget