virtualx-engine-docs/_sources/classes/class_confirmationdialog.rst.txt
2024-10-23 09:41:33 -07:00

80 lines
3.4 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ConfirmationDialog.xml.
.. _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.
.. rst-class:: classref-introduction-group
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").
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------------+---------------+---------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | rect_min_size | ``Vector2( 200, 70 )`` (overrides :ref:`Control<class_Control_property_rect_min_size>`) |
+-------------------------------+---------------+---------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | window_title | ``"Please Confirm..."`` (overrides :ref:`WindowDialog<class_WindowDialog_property_window_title>`) |
+-------------------------------+---------------+---------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+-----------------------------+---------------------------------------------------------------------------+
| :ref:`Button<class_Button>` | :ref:`get_cancel<class_ConfirmationDialog_method_get_cancel>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_ConfirmationDialog_method_get_cancel:
.. rst-class:: classref-method
: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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`