======================
ActionDialog (hwx.gui)
======================

Dialog that pops up under the specified SpriteAction.

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

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

  +------------------------------------------------------------------+
  | classmethod get_ (cls)                                           |
  +------------------------------------------------------------------+
  | createContents_ (self)                                           |
  +------------------------------------------------------------------+
  | positionUnder_ (self, relativeTo, checkWasMoved=True, xoffset=0) |
  +------------------------------------------------------------------+
  | resize_ (self, width, height)                                    |
  +------------------------------------------------------------------+

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

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

Get singleton when dialog is implemented as a subclass

Used by associated Button/SpriteActions.

.. _createContents:
.. method:: createContents(self)

To be implemented in derived class.

.. _positionUnder:
.. method:: positionUnder(self, relativeTo, checkWasMoved=True, xoffset=0)

Positions the dialog under or over the relataveTo widget.

:param relativeTo: The widget to position relative to.
:type relativeTo: Widget
:param checkWasMoved: Determines whether to check if widget is moved or not.
:type checkWasMoved: bool
:param xoffset: The offset value for the widget for x-axis.
:type xoffset: int


.. _resize:
.. method:: resize(self, width, height)

Resize width/height of dialog.

This does not prevent the user from manually resizing like setting the
width/height does.