StyleBoxFlat

Category: Core

Customizable Stylebox with a given set of parameters. (no texture required)

Properties

	get_border_width_min ( ) const
void	( int width )
void	( int radius )
void	( int radius_top_left, radius_top_right, int radius_bottom_right, radius_bottom_left )
void	set_expand_margin_all ( size )
void	set_expand_margin_individual ( size_left, float size_top, size_right, float size_bottom )

Description

This stylebox can be used to achieve all kinds of looks without the need of a texture. Those properties are customizable:

Color
Border width (individual width for each border)
Rounded corners (individual radius for each corner)
Shadow

Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example:

The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will never be more than the height. Result:

Setter	set_anti_aliased(value)
Getter	is_anti_aliased()

Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners.

anti_aliasing_size

Setter	set_aa_size(value)
Getter	get_aa_size()

This changes the size of the faded ring. Higher values can be used to achieve a “blurry” effect.

Color bg_color

Setter	set_bg_color(value)
Getter	get_bg_color()

The background color of the stylebox.

border_blend

Setter	set_border_blend(value)
Getter	get_border_blend()

Color border_color

Setter	set_border_color(value)
Getter	get_border_color()

Sets the color of the border.

border_width_bottom

Border width for the bottom border.

int border_width_left

Setter	set_border_width(value)
Getter	get_border_width()

Border width for the left border.

border_width_right

Setter	set_border_width(value)
Getter	get_border_width()

Border width for the right border.

int border_width_top

Setter	set_border_width(value)
Getter	get_border_width()

Border width for the top border.

corner_detail

Setter	set_corner_detail(value)
Getter	get_corner_detail()

This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value you should take the corner radius (set_corner_radius_all) into account.

For corner radius smaller than 10, 4-5 should be enough.

For corner radius smaller than 30, 8-12 should be enough.

corner_radius_bottom_left

Setter	set_corner_radius(value)
Getter	get_corner_radius()

int corner_radius_bottom_right

Setter	set_corner_radius(value)
Getter	get_corner_radius()

The corner radius of the bottom right corner. When set to 0 the corner is not rounded.

corner_radius_top_left

The corner radius of the top left corner. When set to 0 the corner is not rounded.

Setter	set_corner_radius(value)
Getter	get_corner_radius()

The corner radius of the top right corner. When set to 0 the corner is not rounded.

bool draw_center

Setter	set_draw_center(value)
Getter	is_draw_center_enabled()

Toggels drawing of the inner part of the stylebox.

expand_margin_bottom

Setter	set_expand_margin(value)
Getter	get_expand_margin()

Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect.

float expand_margin_left

Setter	set_expand_margin(value)
Getter	get_expand_margin()

Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect.

expand_margin_right

Setter	set_expand_margin(value)
Getter	get_expand_margin()

Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect.

float expand_margin_top

Setter	set_expand_margin(value)
Getter	get_expand_margin()

Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect.

shadow_color

int shadow_size

Setter	set_shadow_size(value)
Getter	get_shadow_size()

The shadow size in pixels.

Method Descriptions

get_border_width_min ( ) const

void set_border_width_all ( int width )

void set_corner_radius_all ( radius )

void set_corner_radius_individual ( int radius_top_left, radius_top_right, int radius_bottom_right, radius_bottom_left )

void set_expand_margin_all ( float size )