class_confirmationdialog.rst 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ConfirmationDialog.xml.
  6. .. _class_ConfirmationDialog:
  7. ConfirmationDialog
  8. ==================
  9. **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>`
  10. **Inherited By:** :ref:`EditorFileDialog<class_EditorFileDialog>`, :ref:`FileDialog<class_FileDialog>`, :ref:`ScriptCreateDialog<class_ScriptCreateDialog>`
  11. Dialog for confirmation of actions.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. 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).
  16. To get cancel action, you can use:
  17. ::
  18. get_cancel().connect("pressed", self, "cancelled").
  19. .. rst-class:: classref-reftable-group
  20. Properties
  21. ----------
  22. .. table::
  23. :widths: auto
  24. +-------------------------------+---------------+---------------------------------------------------------------------------------------------------+
  25. | :ref:`Vector2<class_Vector2>` | rect_min_size | ``Vector2( 200, 70 )`` (overrides :ref:`Control<class_Control_property_rect_min_size>`) |
  26. +-------------------------------+---------------+---------------------------------------------------------------------------------------------------+
  27. | :ref:`String<class_String>` | window_title | ``"Please Confirm..."`` (overrides :ref:`WindowDialog<class_WindowDialog_property_window_title>`) |
  28. +-------------------------------+---------------+---------------------------------------------------------------------------------------------------+
  29. .. rst-class:: classref-reftable-group
  30. Methods
  31. -------
  32. .. table::
  33. :widths: auto
  34. +-----------------------------+---------------------------------------------------------------------------+
  35. | :ref:`Button<class_Button>` | :ref:`get_cancel<class_ConfirmationDialog_method_get_cancel>` **(** **)** |
  36. +-----------------------------+---------------------------------------------------------------------------+
  37. .. rst-class:: classref-section-separator
  38. ----
  39. .. rst-class:: classref-descriptions-group
  40. Method Descriptions
  41. -------------------
  42. .. _class_ConfirmationDialog_method_get_cancel:
  43. .. rst-class:: classref-method
  44. :ref:`Button<class_Button>` **get_cancel** **(** **)**
  45. Returns the cancel button.
  46. \ **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.
  47. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  48. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  49. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  50. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`