StyleBoxFlat

Inherits: StyleBox < Resource < Reference < Object

Category: Core

Brief Description

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

Member Functions

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

Member Variables

  • bool anti_aliasing - 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.
  • int anti_aliasing_size - This changes the size of the faded ring. Higher values can be used to achieve a “blurry” effect.
  • Color bg_color - The background color of the stylebox.
  • bool border_blend - When set to true, the border will fade into the background color.
  • Color border_color - Sets the color of the border.
  • int border_width_bottom - Border width for the bottom border.
  • int border_width_left - Border width for the left border.
  • int border_width_right - Border width for the right border.
  • int border_width_top - Border width for the top border.
  • int 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) into account.

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

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

  • int corner_radius_bottom_left - The corner radius of the bottom left corner. When set to 0 the corner is not rounded.
  • int corner_radius_bottom_right - The corner radius of the bottom right corner. When set to 0 the corner is not rounded.
  • int corner_radius_top_left - The corner radius of the top left corner. When set to 0 the corner is not rounded.
  • int corner_radius_top_right - The corner radius of the top right corner. When set to 0 the corner is not rounded.
  • bool draw_center - Toggels drawing of the inner part of the stylebox.
  • float expand_margin_bottom - 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 - 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.
  • float expand_margin_right - 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 - 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.
  • Color shadow_color - The color of the shadow. (This has no effect when shadow_size < 1)
  • int shadow_size - The shadow size in pixels.

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

About corner radius:

Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example:
height = 30
corner_radius_top_left = 50
corner_radius_bottom_left = 100

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:

corner_radius_top_left: 10
corner_radius_bottom_left: 20

Member Function Description

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