| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107 |
- :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>`
- Base class for window dialogs.
- 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.
- Properties
- ----------
- +-----------------------------+---------------------------------------------------------------+-----------+
- | :ref:`bool<class_bool>` | :ref:`resizable<class_WindowDialog_property_resizable>` | ``false`` |
- +-----------------------------+---------------------------------------------------------------+-----------+
- | :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 | 18 |
- +---------------------------------+------------------+---------------------+
- | :ref:`Texture<class_Texture>` | close_highlight | |
- +---------------------------------+------------------+---------------------+
- | :ref:`int<class_int>` | close_v_ofs | 18 |
- +---------------------------------+------------------+---------------------+
- | :ref:`StyleBox<class_StyleBox>` | panel | |
- +---------------------------------+------------------+---------------------+
- | :ref:`int<class_int>` | scaleborder_size | 4 |
- +---------------------------------+------------------+---------------------+
- | :ref:`Color<class_Color>` | title_color | Color( 0, 0, 0, 1 ) |
- +---------------------------------+------------------+---------------------+
- | :ref:`Font<class_Font>` | title_font | |
- +---------------------------------+------------------+---------------------+
- | :ref:`int<class_int>` | title_height | 20 |
- +---------------------------------+------------------+---------------------+
- Property Descriptions
- ---------------------
- .. _class_WindowDialog_property_resizable:
- - :ref:`bool<class_bool>` **resizable**
- +-----------+----------------------+
- | *Default* | ``false`` |
- +-----------+----------------------+
- | *Setter* | set_resizable(value) |
- +-----------+----------------------+
- | *Getter* | get_resizable() |
- +-----------+----------------------+
- If ``true``, the user can resize the window.
- ----
- .. _class_WindowDialog_property_window_title:
- - :ref:`String<class_String>` **window_title**
- +-----------+------------------+
- | *Default* | ``""`` |
- +-----------+------------------+
- | *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>`.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
