class_windowdialog.rst 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the WindowDialog.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_WindowDialog:
  5. WindowDialog
  6. ============
  7. **Inherits:** :ref:`Popup<class_popup>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Inherited By:** :ref:`AcceptDialog<class_acceptdialog>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Base class for window dialogs.
  13. Member Functions
  14. ----------------
  15. +--------------------------------------------+--------------------------------------------------------------------------+
  16. | :ref:`TextureButton<class_texturebutton>` | :ref:`get_close_button<class_WindowDialog_get_close_button>` **(** **)** |
  17. +--------------------------------------------+--------------------------------------------------------------------------+
  18. Member Variables
  19. ----------------
  20. .. _class_WindowDialog_resizable:
  21. - :ref:`bool<class_bool>` **resizable** - If ``true`` the user can resize the window. Default value: ``false``.
  22. .. _class_WindowDialog_window_title:
  23. - :ref:`String<class_string>` **window_title** - The text displayed in the window's title bar. Default value: "Save a File".
  24. Description
  25. -----------
  26. Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel :ref:`Control<class_control>` that draws a window decoration and allows motion and resizing.
  27. Member Function Description
  28. ---------------------------
  29. .. _class_WindowDialog_get_close_button:
  30. - :ref:`TextureButton<class_texturebutton>` **get_close_button** **(** **)**
  31. Return the close :ref:`TextureButton<class_texturebutton>`.