================
Dialog (hwx.gui)
================

A top-level window mostly used for short-term tasks and brief communications
with the user.

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

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

  +-----------+-----------+-----------+
  | caption_  | modal_    | position_ |
  +-----------+-----------+-----------+

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

  +------------------------------------------------------------------+
  | positionUnder_ (self, relativeTo, checkWasMoved=True, xoffset=0) |
  +------------------------------------------------------------------+

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

.. _caption:
.. method:: caption

The text displayed in the titlebar.
    

.. _modal:
.. method:: modal

Blocks input to other visible windows.
    

.. _position:
.. method:: position

The location within the main window.
    

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

.. _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, optional
:param xoffset: The offset value for the widget for x-axis.
:type xoffset: int, optional