2
0

class_windowdialog.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the WindowDialog.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_WindowDialog:
  6. WindowDialog
  7. ============
  8. **Inherits:** :ref:`Popup<class_Popup>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`AcceptDialog<class_AcceptDialog>`
  10. **Category:** Core
  11. Brief Description
  12. -----------------
  13. Base class for window dialogs.
  14. Properties
  15. ----------
  16. +-----------------------------+---------------------------------------------------------------+
  17. | :ref:`bool<class_bool>` | :ref:`resizable<class_WindowDialog_property_resizable>` |
  18. +-----------------------------+---------------------------------------------------------------+
  19. | :ref:`String<class_String>` | :ref:`window_title<class_WindowDialog_property_window_title>` |
  20. +-----------------------------+---------------------------------------------------------------+
  21. Methods
  22. -------
  23. +-------------------------------------------+---------------------------------------------------------------------------------+
  24. | :ref:`TextureButton<class_TextureButton>` | :ref:`get_close_button<class_WindowDialog_method_get_close_button>` **(** **)** |
  25. +-------------------------------------------+---------------------------------------------------------------------------------+
  26. Theme Properties
  27. ----------------
  28. +---------------------------------+------------------+
  29. | :ref:`Texture<class_Texture>` | close |
  30. +---------------------------------+------------------+
  31. | :ref:`int<class_int>` | close_h_ofs |
  32. +---------------------------------+------------------+
  33. | :ref:`Texture<class_Texture>` | close_highlight |
  34. +---------------------------------+------------------+
  35. | :ref:`int<class_int>` | close_v_ofs |
  36. +---------------------------------+------------------+
  37. | :ref:`StyleBox<class_StyleBox>` | panel |
  38. +---------------------------------+------------------+
  39. | :ref:`int<class_int>` | scaleborder_size |
  40. +---------------------------------+------------------+
  41. | :ref:`Color<class_Color>` | title_color |
  42. +---------------------------------+------------------+
  43. | :ref:`Font<class_Font>` | title_font |
  44. +---------------------------------+------------------+
  45. | :ref:`int<class_int>` | title_height |
  46. +---------------------------------+------------------+
  47. Description
  48. -----------
  49. 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.
  50. Property Descriptions
  51. ---------------------
  52. .. _class_WindowDialog_property_resizable:
  53. - :ref:`bool<class_bool>` **resizable**
  54. +----------+----------------------+
  55. | *Setter* | set_resizable(value) |
  56. +----------+----------------------+
  57. | *Getter* | get_resizable() |
  58. +----------+----------------------+
  59. If ``true``, the user can resize the window. Default value: ``false``.
  60. ----
  61. .. _class_WindowDialog_property_window_title:
  62. - :ref:`String<class_String>` **window_title**
  63. +----------+------------------+
  64. | *Setter* | set_title(value) |
  65. +----------+------------------+
  66. | *Getter* | get_title() |
  67. +----------+------------------+
  68. The text displayed in the window's title bar.
  69. Method Descriptions
  70. -------------------
  71. .. _class_WindowDialog_method_get_close_button:
  72. - :ref:`TextureButton<class_TextureButton>` **get_close_button** **(** **)**
  73. Returns the close :ref:`TextureButton<class_TextureButton>`.