==================
GuideBar (hwx.gui)
==================

A popup dialog.

It is typically used in a context to guide a user though the workflow.

Inherits:
  - :ref:`Container (hwx.gui)`

----------
Properties
----------

  +---------------+---------------+
  | activebutton_ | position_     |
  +---------------+---------------+

--------------
Public Methods
--------------

  +-----------------------------------------------------+
  | button_ (self, **kwds)                              |
  +-----------------------------------------------------+
  | buttonGroup_ (self, buttons, **kwds)                |
  +-----------------------------------------------------+
  | comboBox_ (self, **kwds)                            |
  +-----------------------------------------------------+
  | executeCreateandExitButton_ (self, command, **kwds) |
  +-----------------------------------------------------+
  | executePlayButton_ (self, command, **kwds)          |
  +-----------------------------------------------------+
  | exitButton_ (self, **kwds)                          |
  +-----------------------------------------------------+
  | legend_ (self, values, delayShow=False, **kwds)     |
  +-----------------------------------------------------+
  | menu_ (self, autoshow=True, autohide=True, **kwds)  |
  +-----------------------------------------------------+
  | resetButton_ (self, **kwds)                         |
  +-----------------------------------------------------+
  | toggleButton_ (self, **kwds)                        |
  +-----------------------------------------------------+
  | widget_ (self, widget, stretch=0)                   |
  +-----------------------------------------------------+

----------------
Property Details
----------------

.. _activebutton:
.. method:: activebutton

Returns or sets the button, whose help-text will be shown.
    

.. _position:
.. method:: position

Alignment relative to its captor:

- Floating
- TopLeft
- TopRight
- BottomLeft
- BottomRight
- BottomCenter
- RelativePosition

--------------
Method Details
--------------

.. _button:
.. method:: button(self, **kwds)

Adds a button to self.

:returns: The added button.
:rtype: Button


.. _buttonGroup:
.. method:: 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:
.. method:: 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


.. _executeCreateandExitButton:
.. method:: 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:
.. method:: 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:
.. method:: 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:
.. method:: 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, optional
:param kwds: Any other properties user wants to set for the legend.
:type kwds: dict

:returns: All the legends.
:rtype: Legend


.. _menu:
.. method:: 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:
.. method:: resetButton(self, **kwds)

Shortcut for creating a button that has the reset icon and calls
clearAllLists.

:returns: The new reset button.
:rtype: Button


.. _toggleButton:
.. method:: 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:
.. method:: 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, optional

:returns: The added widget.
:rtype: Widget