class_windowdialog.rst 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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. | :ref:`bool<class_bool>` | :ref:`get_resizable<class_WindowDialog_get_resizable>` **(** **)** const |
  19. +--------------------------------------------+--------------------------------------------------------------------------------------------------------+
  20. | :ref:`String<class_string>` | :ref:`get_title<class_WindowDialog_get_title>` **(** **)** const |
  21. +--------------------------------------------+--------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_resizable<class_WindowDialog_set_resizable>` **(** :ref:`bool<class_bool>` resizable **)** |
  23. +--------------------------------------------+--------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_title<class_WindowDialog_set_title>` **(** :ref:`String<class_string>` title **)** |
  25. +--------------------------------------------+--------------------------------------------------------------------------------------------------------+
  26. Member Variables
  27. ----------------
  28. - :ref:`bool<class_bool>` **resizable**
  29. - :ref:`String<class_string>` **window_title**
  30. Description
  31. -----------
  32. 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.
  33. Member Function Description
  34. ---------------------------
  35. .. _class_WindowDialog_get_close_button:
  36. - :ref:`TextureButton<class_texturebutton>` **get_close_button** **(** **)**
  37. Return the close :ref:`TextureButton<class_texturebutton>`.
  38. .. _class_WindowDialog_get_resizable:
  39. - :ref:`bool<class_bool>` **get_resizable** **(** **)** const
  40. .. _class_WindowDialog_get_title:
  41. - :ref:`String<class_string>` **get_title** **(** **)** const
  42. Return the title of the window.
  43. .. _class_WindowDialog_set_resizable:
  44. - void **set_resizable** **(** :ref:`bool<class_bool>` resizable **)**
  45. .. _class_WindowDialog_set_title:
  46. - void **set_title** **(** :ref:`String<class_string>` title **)**
  47. Set the title of the window.