:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/WindowDialog.xml. .. _class_WindowDialog: WindowDialog ============ **Inherits:** :ref:`Popup` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`AcceptDialog` Base class for window dialogs. .. rst-class:: classref-introduction-group Description ----------- Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel :ref:`Control` that draws a window decoration and allows motion and resizing. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+---------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`resizable` | ``false`` | +-----------------------------+---------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`window_title` | ``""`` | +-----------------------------+---------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------+---------------------------------------------------------------------------------+ | :ref:`TextureButton` | :ref:`get_close_button` **(** **)** | +-------------------------------------------+---------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ | :ref:`Color` | :ref:`title_color` | ``Color( 0, 0, 0, 1 )`` | +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`close_h_ofs` | ``18`` | +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`close_v_ofs` | ``18`` | +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`scaleborder_size` | ``4`` | +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`title_height` | ``20`` | +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ | :ref:`Font` | :ref:`title_font` | | +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ | :ref:`Texture` | :ref:`close` | | +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ | :ref:`Texture` | :ref:`close_highlight` | | +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ | :ref:`StyleBox` | :ref:`panel` | | +---------------------------------+-----------------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_WindowDialog_property_resizable: .. rst-class:: classref-property :ref:`bool` **resizable** = ``false`` .. rst-class:: classref-property-setget - void **set_resizable** **(** :ref:`bool` value **)** - :ref:`bool` **get_resizable** **(** **)** If ``true``, the user can resize the window. .. rst-class:: classref-item-separator ---- .. _class_WindowDialog_property_window_title: .. rst-class:: classref-property :ref:`String` **window_title** = ``""`` .. rst-class:: classref-property-setget - void **set_title** **(** :ref:`String` value **)** - :ref:`String` **get_title** **(** **)** The text displayed in the window's title bar. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_WindowDialog_method_get_close_button: .. rst-class:: classref-method :ref:`TextureButton` **get_close_button** **(** **)** Returns the close :ref:`TextureButton`. \ **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their :ref:`CanvasItem.visible` property. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_WindowDialog_theme_color_title_color: .. rst-class:: classref-themeproperty :ref:`Color` **title_color** = ``Color( 0, 0, 0, 1 )`` The color of the title text. .. rst-class:: classref-item-separator ---- .. _class_WindowDialog_theme_constant_close_h_ofs: .. rst-class:: classref-themeproperty :ref:`int` **close_h_ofs** = ``18`` The horizontal offset of the close button. .. rst-class:: classref-item-separator ---- .. _class_WindowDialog_theme_constant_close_v_ofs: .. rst-class:: classref-themeproperty :ref:`int` **close_v_ofs** = ``18`` The vertical offset of the close button. .. rst-class:: classref-item-separator ---- .. _class_WindowDialog_theme_constant_scaleborder_size: .. rst-class:: classref-themeproperty :ref:`int` **scaleborder_size** = ``4`` The thickness of the border that can be dragged when scaling the window (if :ref:`resizable` is enabled). .. rst-class:: classref-item-separator ---- .. _class_WindowDialog_theme_constant_title_height: .. rst-class:: classref-themeproperty :ref:`int` **title_height** = ``20`` The vertical offset of the title text. .. rst-class:: classref-item-separator ---- .. _class_WindowDialog_theme_font_title_font: .. rst-class:: classref-themeproperty :ref:`Font` **title_font** The font used to draw the title. .. rst-class:: classref-item-separator ---- .. _class_WindowDialog_theme_icon_close: .. rst-class:: classref-themeproperty :ref:`Texture` **close** The icon for the close button. .. rst-class:: classref-item-separator ---- .. _class_WindowDialog_theme_icon_close_highlight: .. rst-class:: classref-themeproperty :ref:`Texture` **close_highlight** The icon used for the close button when it's hovered with the mouse cursor. .. rst-class:: classref-item-separator ---- .. _class_WindowDialog_theme_style_panel: .. rst-class:: classref-themeproperty :ref:`StyleBox` **panel** The style for both the content background of the **WindowDialog** and the title bar. The title bar is created with a top border and an expand margin using the ``panel`` stylebox. .. |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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`