WindowDialog

WindowDialog

Inherits: Popup < Control < CanvasItem < Node < Object

Inherited By: AcceptDialog

Base class for window dialogs.

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.

Properties

bool	resizable	`false`
String	window_title	`“”`

Methods

TextureButton

get_close_button ( )

Theme Properties

Color	title_color	`Color( 0, 0, 0, 1 )`
int	close_h_ofs	`18`
int	close_v_ofs	`18`
int	scaleborder_size	`4`
int	title_height	`20`
Font	title_font
Texture	close
Texture	close_highlight
StyleBox	panel

Property Descriptions

bool resizable

Default	`false`
Setter	set_resizable(value)
Getter	get_resizable()

If true, the user can resize the window.

String window_title

Default	`“”`
Setter	set_title(value)
Getter	get_title()

The text displayed in the window’s title bar.

Method Descriptions

TextureButton get_close_button ( )

Returns the close 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 CanvasItem.visible property.

Theme Property Descriptions

Color title_color

Default

Color( 0, 0, 0, 1 )

The color of the title text.

int close_h_ofs

Default

18

The horizontal offset of the close button.

int close_v_ofs

Default

18

The vertical offset of the close button.

int scaleborder_size

Default

4

The thickness of the border that can be dragged when scaling the window (if resizable is enabled).

int title_height

Default

20

The vertical offset of the title text.

Font title_font

The font used to draw the title.

Texture close

The icon for the close button.

Texture close_highlight

The icon used for the close button when it’s hovered with the mouse cursor.

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.