.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StyleBoxFlat.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_StyleBoxFlat: StyleBoxFlat ============ **Inherits:** :ref:`StyleBox` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Customizable Stylebox with a given set of parameters. (no texture required) Member Functions ---------------- +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_aa_size` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_bg_color` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_border_blend` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_border_color` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_border_width` **(** :ref:`int` margin **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_border_width_min` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_corner_detail` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_corner_radius` **(** :ref:`int` corner **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_expand_margin` **(** :ref:`int` margin **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_shadow_size` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_anti_aliased` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_draw_center_enabled` **(** **)** const | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_aa_size` **(** :ref:`int` size **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_anti_aliased` **(** :ref:`bool` anti_aliased **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_border_blend` **(** :ref:`bool` blend **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_border_color` **(** :ref:`Color` color **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_border_width` **(** :ref:`int` margin, :ref:`int` width **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_corner_detail` **(** :ref:`int` detail **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_corner_radius` **(** :ref:`int` corner, :ref:`int` radius **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_corner_radius_individual` **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_botton_right, :ref:`int` radius_bottom_left **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_expand_margin` **(** :ref:`int` margin, :ref:`float` size **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shadow_color` **(** :ref:`Color` color **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shadow_size` **(** :ref:`int` size **)** | +----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`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 noticable when using rounded corners. - :ref:`int` **anti_aliasing_size** - This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. - :ref:`Color` **bg_color** - The background color of the stylebox. - :ref:`bool` **border_blend** - When set to true, the border will fade into the background color. - :ref:`Color` **border_color** - Sets the color of the border. - :ref:`int` **border_width_bottom** - Border width for the bottom border. - :ref:`int` **border_width_left** - Border width for the left border. - :ref:`int` **border_width_right** - Border width for the right border. - :ref:`int` **border_width_top** - Border width for the top border. - :ref:`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 ([method 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 ... - :ref:`int` **corner_radius_bottom_left** - The corner radius of the bottom left corner. When set to 0 the corner is not rounded. - :ref:`int` **corner_radius_bottom_right** - The corner radius of the bottom right corner. When set to 0 the corner is not rounded. - :ref:`int` **corner_radius_top_left** - The corner radius of the top left corner. When set to 0 the corner is not rounded. - :ref:`int` **corner_radius_top_right** - The corner radius of the top right corner. When set to 0 the corner is not rounded. - :ref:`bool` **draw_center** - Toggels drawing of the inner part of the stylebox. - :ref:`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. - :ref:`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. - :ref:`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. - :ref:`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. - :ref:`Color` **shadow_color** - The color of the shadow. (This has no effect when shadow_size < 1) - :ref:`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_raidus_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_raidus_bottom_left: 20 Member Function Description --------------------------- .. _class_StyleBoxFlat_get_aa_size: - :ref:`int` **get_aa_size** **(** **)** const .. _class_StyleBoxFlat_get_bg_color: - :ref:`Color` **get_bg_color** **(** **)** const .. _class_StyleBoxFlat_get_border_blend: - :ref:`bool` **get_border_blend** **(** **)** const .. _class_StyleBoxFlat_get_border_color: - :ref:`Color` **get_border_color** **(** **)** const .. _class_StyleBoxFlat_get_border_width: - :ref:`int` **get_border_width** **(** :ref:`int` margin **)** const .. _class_StyleBoxFlat_get_border_width_min: - :ref:`int` **get_border_width_min** **(** **)** const .. _class_StyleBoxFlat_get_corner_detail: - :ref:`int` **get_corner_detail** **(** **)** const .. _class_StyleBoxFlat_get_corner_radius: - :ref:`int` **get_corner_radius** **(** :ref:`int` corner **)** const .. _class_StyleBoxFlat_get_expand_margin: - :ref:`float` **get_expand_margin** **(** :ref:`int` margin **)** const .. _class_StyleBoxFlat_get_shadow_color: - :ref:`Color` **get_shadow_color** **(** **)** const .. _class_StyleBoxFlat_get_shadow_size: - :ref:`int` **get_shadow_size** **(** **)** const .. _class_StyleBoxFlat_is_anti_aliased: - :ref:`bool` **is_anti_aliased** **(** **)** const .. _class_StyleBoxFlat_is_draw_center_enabled: - :ref:`bool` **is_draw_center_enabled** **(** **)** const .. _class_StyleBoxFlat_set_aa_size: - void **set_aa_size** **(** :ref:`int` size **)** .. _class_StyleBoxFlat_set_anti_aliased: - void **set_anti_aliased** **(** :ref:`bool` anti_aliased **)** .. _class_StyleBoxFlat_set_bg_color: - void **set_bg_color** **(** :ref:`Color` color **)** .. _class_StyleBoxFlat_set_border_blend: - void **set_border_blend** **(** :ref:`bool` blend **)** .. _class_StyleBoxFlat_set_border_color: - void **set_border_color** **(** :ref:`Color` color **)** .. _class_StyleBoxFlat_set_border_width: - void **set_border_width** **(** :ref:`int` margin, :ref:`int` width **)** .. _class_StyleBoxFlat_set_border_width_all: - void **set_border_width_all** **(** :ref:`int` width **)** .. _class_StyleBoxFlat_set_corner_detail: - void **set_corner_detail** **(** :ref:`int` detail **)** .. _class_StyleBoxFlat_set_corner_radius: - void **set_corner_radius** **(** :ref:`int` corner, :ref:`int` radius **)** .. _class_StyleBoxFlat_set_corner_radius_all: - void **set_corner_radius_all** **(** :ref:`int` radius **)** .. _class_StyleBoxFlat_set_corner_radius_individual: - void **set_corner_radius_individual** **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_botton_right, :ref:`int` radius_bottom_left **)** .. _class_StyleBoxFlat_set_draw_center: - void **set_draw_center** **(** :ref:`bool` draw_center **)** .. _class_StyleBoxFlat_set_expand_margin: - void **set_expand_margin** **(** :ref:`int` margin, :ref:`float` size **)** .. _class_StyleBoxFlat_set_expand_margin_all: - void **set_expand_margin_all** **(** :ref:`float` size **)** .. _class_StyleBoxFlat_set_expand_margin_individual: - void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** .. _class_StyleBoxFlat_set_shadow_color: - void **set_shadow_color** **(** :ref:`Color` color **)** .. _class_StyleBoxFlat_set_shadow_size: - void **set_shadow_size** **(** :ref:`int` size **)**