godot/doc/classes/WindowDialog.xml

60 lines
2.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="WindowDialog" inherits="Popup" version="4.0">
<brief_description>
Base class for window dialogs.
</brief_description>
<description>
Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control] that draws a window decoration and allows motion and resizing.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_close_button">
<return type="TextureButton">
</return>
<description>
Returns the close [TextureButton].
</description>
</method>
</methods>
<members>
<member name="resizable" type="bool" setter="set_resizable" getter="get_resizable" default="false">
If [code]true[/code], the user can resize the window.
</member>
<member name="window_title" type="String" setter="set_title" getter="get_title" default="&quot;&quot;">
The text displayed in the window's title bar.
</member>
</members>
<constants>
</constants>
<theme_items>
<theme_item name="close" type="Texture2D">
The icon for the close button.
</theme_item>
<theme_item name="close_h_ofs" type="int" default="18">
The horizontal offset of the close button.
</theme_item>
<theme_item name="close_highlight" type="Texture2D">
The icon used for the close button when it's hovered with the mouse cursor.
</theme_item>
<theme_item name="close_v_ofs" type="int" default="18">
The vertical offset of the close button.
</theme_item>
<theme_item name="panel" type="StyleBox">
The style for both the content background of the [WindowDialog] and the title bar.
</theme_item>
<theme_item name="scaleborder_size" type="int" default="4">
The thickness of the border that can be dragged when scaling the window (if [member resizable] is enabled).
</theme_item>
<theme_item name="title_color" type="Color" default="Color( 0, 0, 0, 1 )">
The color of the title text.
</theme_item>
<theme_item name="title_font" type="Font">
The font used to draw the title.
</theme_item>
<theme_item name="title_height" type="int" default="20">
The vertical offset of the title text.
</theme_item>
</theme_items>
</class>