You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2025-11-10 13:00:37 +00:00
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
59 lines
2.2 KiB
XML
59 lines
2.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="WindowDialog" inherits="Popup" version="3.4">
|
|
<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" />
|
|
<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="""">
|
|
The text displayed in the window's title bar.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
<theme_items>
|
|
<theme_item name="close" type="Texture">
|
|
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="Texture">
|
|
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. The title bar is created with a top border and an expand margin using the [code]panel[/code] stylebox.
|
|
</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>
|