class_confirmationdialog.rst 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ConfirmationDialog.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ConfirmationDialog:
  6. ConfirmationDialog
  7. ==================
  8. **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>`
  9. **Inherited By:** :ref:`EditorFileDialog<class_EditorFileDialog>`, :ref:`FileDialog<class_FileDialog>`, :ref:`ScriptCreateDialog<class_ScriptCreateDialog>`
  10. Dialog for confirmation of actions.
  11. Description
  12. -----------
  13. 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).
  14. To get cancel action, you can use:
  15. ::
  16. get_cancel().connect("pressed", self, "cancelled").
  17. Properties
  18. ----------
  19. +-------------------------------+---------------+---------------------------------------------+
  20. | :ref:`Vector2<class_Vector2>` | rect_min_size | ``Vector2( 200, 70 )`` *(parent override)* |
  21. +-------------------------------+---------------+---------------------------------------------+
  22. | :ref:`String<class_String>` | window_title | ``"Please Confirm..."`` *(parent override)* |
  23. +-------------------------------+---------------+---------------------------------------------+
  24. Methods
  25. -------
  26. +-----------------------------+---------------------------------------------------------------------------+
  27. | :ref:`Button<class_Button>` | :ref:`get_cancel<class_ConfirmationDialog_method_get_cancel>` **(** **)** |
  28. +-----------------------------+---------------------------------------------------------------------------+
  29. Method Descriptions
  30. -------------------
  31. .. _class_ConfirmationDialog_method_get_cancel:
  32. - :ref:`Button<class_Button>` **get_cancel** **(** **)**
  33. Returns the cancel button.
  34. **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.
  35. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  36. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  37. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`