File: WindowDialog.xml

package info (click to toggle)
godot 3.6%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 270,588 kB
  • sloc: cpp: 971,579; ansic: 617,953; xml: 80,302; asm: 17,498; cs: 14,559; python: 11,744; java: 9,681; javascript: 4,654; pascal: 1,176; sh: 896; objc: 529; makefile: 176
file content (59 lines) | stat: -rw-r--r-- 2,721 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WindowDialog" inherits="Popup" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<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].
				[b]Warning:[/b] 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 [member CanvasItem.visible] property.
			</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="title_color" data_type="color" type="Color" default="Color( 0, 0, 0, 1 )">
			The color of the title text.
		</theme_item>
		<theme_item name="close_h_ofs" data_type="constant" type="int" default="18">
			The horizontal offset of the close button.
		</theme_item>
		<theme_item name="close_v_ofs" data_type="constant" type="int" default="18">
			The vertical offset of the close button.
		</theme_item>
		<theme_item name="scaleborder_size" data_type="constant" 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_height" data_type="constant" type="int" default="20">
			The vertical offset of the title text.
		</theme_item>
		<theme_item name="title_font" data_type="font" type="Font">
			The font used to draw the title.
		</theme_item>
		<theme_item name="close" data_type="icon" type="Texture">
			The icon for the close button.
		</theme_item>
		<theme_item name="close_highlight" data_type="icon" type="Texture">
			The icon used for the close button when it's hovered with the mouse cursor.
		</theme_item>
		<theme_item name="panel" data_type="style" 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_items>
</class>