class_windowdialog.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  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. Properties
  14. ----------
  15. +-----------------------------+---------------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`resizable<class_WindowDialog_property_resizable>` |
  17. +-----------------------------+---------------------------------------------------------------+
  18. | :ref:`String<class_String>` | :ref:`window_title<class_WindowDialog_property_window_title>` |
  19. +-----------------------------+---------------------------------------------------------------+
  20. Methods
  21. -------
  22. +-------------------------------------------+---------------------------------------------------------------------------------+
  23. | :ref:`TextureButton<class_TextureButton>` | :ref:`get_close_button<class_WindowDialog_method_get_close_button>` **(** **)** |
  24. +-------------------------------------------+---------------------------------------------------------------------------------+
  25. Theme Properties
  26. ----------------
  27. +---------------------------------+------------------+
  28. | :ref:`Texture<class_Texture>` | close |
  29. +---------------------------------+------------------+
  30. | :ref:`int<class_int>` | close_h_ofs |
  31. +---------------------------------+------------------+
  32. | :ref:`Texture<class_Texture>` | close_highlight |
  33. +---------------------------------+------------------+
  34. | :ref:`int<class_int>` | close_v_ofs |
  35. +---------------------------------+------------------+
  36. | :ref:`StyleBox<class_StyleBox>` | panel |
  37. +---------------------------------+------------------+
  38. | :ref:`int<class_int>` | scaleborder_size |
  39. +---------------------------------+------------------+
  40. | :ref:`Color<class_Color>` | title_color |
  41. +---------------------------------+------------------+
  42. | :ref:`Font<class_Font>` | title_font |
  43. +---------------------------------+------------------+
  44. | :ref:`int<class_int>` | title_height |
  45. +---------------------------------+------------------+
  46. Description
  47. -----------
  48. 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.
  49. Property Descriptions
  50. ---------------------
  51. .. _class_WindowDialog_property_resizable:
  52. - :ref:`bool<class_bool>` **resizable**
  53. +----------+----------------------+
  54. | *Setter* | set_resizable(value) |
  55. +----------+----------------------+
  56. | *Getter* | get_resizable() |
  57. +----------+----------------------+
  58. If ``true``, the user can resize the window. Default value: ``false``.
  59. .. _class_WindowDialog_property_window_title:
  60. - :ref:`String<class_String>` **window_title**
  61. +----------+------------------+
  62. | *Setter* | set_title(value) |
  63. +----------+------------------+
  64. | *Getter* | get_title() |
  65. +----------+------------------+
  66. The text displayed in the window's title bar.
  67. Method Descriptions
  68. -------------------
  69. .. _class_WindowDialog_method_get_close_button:
  70. - :ref:`TextureButton<class_TextureButton>` **get_close_button** **(** **)**
  71. Returns the close :ref:`TextureButton<class_TextureButton>`.