comet.CDialog
*******************************************************************************

.. py:class:: comet.CDialog

This section describes all functions for the CDialog class.

For creating a dialog you need a dialog specification, which is a JSON string.
CDialog manages the dialog specification internally through the class functions, so there is no need for manual creating and editing.
To create a CDialog instance from either an existing specification string, or an empty dialog, use :py:func:`.dialog.create`.

Each control widget (checkbox, textfield, etc...) may appear multiple times in the specification, but must have a unique ID (string) within it's own type. Afterwards, the dialog specification is used to build the dialog when :py:meth:`.show` is called.
After the dialog has closed or an dialog event has been caught in a callback function, control results can be fetched using the *get*.. functions (:py:meth:`.getCheckBoxValue`, ...)

:priint-important:`IDs with the prefix '%!'' are reserved for internal use and must not be used for elements.`

.. warning::
	For technical reasons all *get* functions (e.g. :py:meth:`.getCheckBoxValue`) will return values for the last opened dialog, which is not necessarily the calling CDialog object.

.. seealso::
	:py:mod:`.dialog`

Methods
===============================================================================

.. automethod:: comet.CDialog.setTitle
.. automethod:: comet.CDialog.setSize
.. automethod:: comet.CDialog.addLabel
.. automethod:: comet.CDialog.addCheckBox
.. automethod:: comet.CDialog.addIntField
.. automethod:: comet.CDialog.addFloatField
.. automethod:: comet.CDialog.addTextField
.. automethod:: comet.CDialog.addMultilineTextField
.. automethod:: comet.CDialog.addMultilineTextInfo
.. automethod:: comet.CDialog.addDropDown
.. automethod:: comet.CDialog.addDefaultButtons
.. automethod:: comet.CDialog.show
.. automethod:: comet.CDialog.getConfirmingButton
.. automethod:: comet.CDialog.getCheckBoxValue
.. automethod:: comet.CDialog.getTextFieldValue
.. automethod:: comet.CDialog.getMultiLineTextFieldValue
.. automethod:: comet.CDialog.getFloatFieldValue
.. automethod:: comet.CDialog.getIntFieldValue
.. automethod:: comet.CDialog.getDropDownValue
.. automethod:: comet.CDialog.getSpecification