=========================
RibbonPageGroup (hwx.gui)
=========================

Logical grouping of SpriteActionGroups in a RibbonPage.

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

  +----------+
  | visible_ |
  +----------+

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

  +---------------------------------------------+
  | classmethod get_ (cls, name)                |
  +---------------------------------------------+
  | add_ (self, action, after=None, index=None) |
  +---------------------------------------------+
  | hide_ (self)                                |
  +---------------------------------------------+
  | isShown_ (self)                             |
  +---------------------------------------------+
  | remove_ (self, action)                      |
  +---------------------------------------------+
  | show_ (self)                                |
  +---------------------------------------------+

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

.. _visible:
.. property:: visible

The visibility of the RibbonPageGroup.

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

.. _get:
.. classmethod:: get(cls, name)

Gets the RibbonPageGroup with the specified name.

:param name: The RibbonPageGroup name to get.
:type name: str

:returns: The page group.
:rtype: RibbonPageGroup


.. _add:
.. method:: add(self, action, after=None, index=None)

Adds the SpriteAction/SpriteActionGroup.

:param action: The action to be added
:type action: str | SpriteAction | SpriteActionGroup
:param after: Determines whether to
           insert the specified item after the group or not.
:type after: str | SpriteAction | SpriteActionGroup
:param index: Index at which action needs to be inserted.
:type index: int


.. _hide:
.. method:: hide(self)

Hides the RibbonPageGroup.

.. _isShown:
.. method:: isShown(self)

Returns True if it shown, False otherwise.

.. _remove:
.. method:: remove(self, action)

"Removes the sprite action group from RibbonPageGroup.

:param action: The action to be removed.
:type action: SpriteActionGroup


.. _show:
.. method:: show(self)

Shows the RibbonPageGroup.