pandemonium_engine_docs/classes/class_confirmationdialog.rst

59 lines
2.6 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ConfirmationDialog.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ConfirmationDialog:
ConfirmationDialog
==================
**Inherits:** :ref:`AcceptDialog<class_AcceptDialog>` **<** :ref:`WindowDialog<class_WindowDialog>` **<** :ref:`Popup<class_Popup>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`EditorFileDialog<class_EditorFileDialog>`, :ref:`FileDialog<class_FileDialog>`, :ref:`ScriptCreateDialog<class_ScriptCreateDialog>`
Dialog for confirmation of actions.
Description
-----------
Dialog for confirmation of actions. This dialog inherits from :ref:`AcceptDialog<class_AcceptDialog>`, but has by default an OK and Cancel button (in host OS order).
To get cancel action, you can use:
::
get_cancel().connect("pressed", self, "cancelled").
Properties
----------
+-------------------------------+---------------+---------------------------------------------+
| :ref:`Vector2<class_Vector2>` | rect_min_size | ``Vector2( 200, 70 )`` *(parent override)* |
+-------------------------------+---------------+---------------------------------------------+
| :ref:`String<class_String>` | window_title | ``"Please Confirm..."`` *(parent override)* |
+-------------------------------+---------------+---------------------------------------------+
Methods
-------
+-----------------------------+---------------------------------------------------------------------------+
| :ref:`Button<class_Button>` | :ref:`get_cancel<class_ConfirmationDialog_method_get_cancel>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_ConfirmationDialog_method_get_cancel:
- :ref:`Button<class_Button>` **get_cancel** **(** **)**
Returns the cancel button.
**Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`