Files
godot-docs/classes/class_windowdialog.rst
2020-01-21 09:28:25 +01:00

105 lines
3.6 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the WindowDialog.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_WindowDialog:
WindowDialog
============
**Inherits:** :ref:`Popup<class_Popup>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`AcceptDialog<class_AcceptDialog>`
**Category:** Core
Brief Description
-----------------
Base class for window dialogs.
Properties
----------
+-----------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`resizable<class_WindowDialog_property_resizable>` |
+-----------------------------+---------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`window_title<class_WindowDialog_property_window_title>` |
+-----------------------------+---------------------------------------------------------------+
Methods
-------
+-------------------------------------------+---------------------------------------------------------------------------------+
| :ref:`TextureButton<class_TextureButton>` | :ref:`get_close_button<class_WindowDialog_method_get_close_button>` **(** **)** |
+-------------------------------------------+---------------------------------------------------------------------------------+
Theme Properties
----------------
+---------------------------------+------------------+
| :ref:`Texture<class_Texture>` | close |
+---------------------------------+------------------+
| :ref:`int<class_int>` | close_h_ofs |
+---------------------------------+------------------+
| :ref:`Texture<class_Texture>` | close_highlight |
+---------------------------------+------------------+
| :ref:`int<class_int>` | close_v_ofs |
+---------------------------------+------------------+
| :ref:`StyleBox<class_StyleBox>` | panel |
+---------------------------------+------------------+
| :ref:`int<class_int>` | scaleborder_size |
+---------------------------------+------------------+
| :ref:`Color<class_Color>` | title_color |
+---------------------------------+------------------+
| :ref:`Font<class_Font>` | title_font |
+---------------------------------+------------------+
| :ref:`int<class_int>` | title_height |
+---------------------------------+------------------+
Description
-----------
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.
Property Descriptions
---------------------
.. _class_WindowDialog_property_resizable:
- :ref:`bool<class_bool>` **resizable**
+----------+----------------------+
| *Setter* | set_resizable(value) |
+----------+----------------------+
| *Getter* | get_resizable() |
+----------+----------------------+
If ``true``, the user can resize the window. Default value: ``false``.
----
.. _class_WindowDialog_property_window_title:
- :ref:`String<class_String>` **window_title**
+----------+------------------+
| *Setter* | set_title(value) |
+----------+------------------+
| *Getter* | get_title() |
+----------+------------------+
The text displayed in the window's title bar.
Method Descriptions
-------------------
.. _class_WindowDialog_method_get_close_button:
- :ref:`TextureButton<class_TextureButton>` **get_close_button** **(** **)**
Returns the close :ref:`TextureButton<class_TextureButton>`.