======================
GuideBarMenu (hwx.gui)
======================

Clickable Menu that can be added to a GuideBar.

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

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

  +---------------+---------------+---------------+
  | anchorbutton_ | autohide_     | autoshow_     |
  +---------------+---------------+---------------+
  | icon_         | text_         |               |
  +---------------+---------------+---------------+

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

  +-----------------------------------------+
  | button_ (self, **kwds)                  |
  +-----------------------------------------+
  | checkBox_ (self, checked=False, **kwds) |
  +-----------------------------------------+

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

.. _anchorbutton:
.. method:: anchorbutton

The button in the guide bar associated with this menu.
    

.. _autohide:
.. method:: autohide

Determines whether to automatically hide or not.

.. _autoshow:
.. method:: autoshow

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

.. _icon:
.. method:: icon

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

.. _text:
.. method:: text

The text to display on the anchor button.
    

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

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

Adds a button to the Guide bar menu layout.

:param kwds: Any other properties needed to be set for the Button.
:type kwds: dict

:returns: The added button.
:rtype: Button


.. _checkBox:
.. method:: checkBox(self, checked=False, **kwds)

Adds a checkbox to the Guide bar menu layout.

:param checked: Determines whether the button is checked or not.
:type checked: bool
:param kwds: Any other properties needed to be set for the check box.
:type kwds: dict

:returns: The check box.
:rtype: Button