mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
265 lines
26 KiB
ReStructuredText
265 lines
26 KiB
ReStructuredText
.. 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/<name>/doc_classes.
|
|
|
|
.. _class_StyleBoxFlat:
|
|
|
|
StyleBoxFlat
|
|
============
|
|
|
|
**Inherits:** :ref:`StyleBox<class_stylebox>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Customizable Stylebox with a given set of parameters. (no texture required)
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_aa_size<class_StyleBoxFlat_get_aa_size>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Color<class_color>` | :ref:`get_bg_color<class_StyleBoxFlat_get_bg_color>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`get_border_blend<class_StyleBoxFlat_get_border_blend>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Color<class_color>` | :ref:`get_border_color<class_StyleBoxFlat_get_border_color>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_border_width<class_StyleBoxFlat_get_border_width>` **(** :ref:`int<class_int>` margin **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_border_width_min<class_StyleBoxFlat_get_border_width_min>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_corner_detail<class_StyleBoxFlat_get_corner_detail>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_corner_radius<class_StyleBoxFlat_get_corner_radius>` **(** :ref:`int<class_int>` corner **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_expand_margin<class_StyleBoxFlat_get_expand_margin>` **(** :ref:`int<class_int>` margin **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Color<class_color>` | :ref:`get_shadow_color<class_StyleBoxFlat_get_shadow_color>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_shadow_size<class_StyleBoxFlat_get_shadow_size>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_anti_aliased<class_StyleBoxFlat_is_anti_aliased>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_draw_center_enabled<class_StyleBoxFlat_is_draw_center_enabled>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_aa_size<class_StyleBoxFlat_set_aa_size>` **(** :ref:`int<class_int>` size **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_anti_aliased<class_StyleBoxFlat_set_anti_aliased>` **(** :ref:`bool<class_bool>` anti_aliased **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_bg_color<class_StyleBoxFlat_set_bg_color>` **(** :ref:`Color<class_color>` color **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_border_blend<class_StyleBoxFlat_set_border_blend>` **(** :ref:`bool<class_bool>` blend **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_border_color<class_StyleBoxFlat_set_border_color>` **(** :ref:`Color<class_color>` color **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_border_width<class_StyleBoxFlat_set_border_width>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` width **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_border_width_all<class_StyleBoxFlat_set_border_width_all>` **(** :ref:`int<class_int>` width **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_corner_detail<class_StyleBoxFlat_set_corner_detail>` **(** :ref:`int<class_int>` detail **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_corner_radius<class_StyleBoxFlat_set_corner_radius>` **(** :ref:`int<class_int>` corner, :ref:`int<class_int>` radius **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_corner_radius_all<class_StyleBoxFlat_set_corner_radius_all>` **(** :ref:`int<class_int>` radius **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_corner_radius_individual<class_StyleBoxFlat_set_corner_radius_individual>` **(** :ref:`int<class_int>` radius_top_left, :ref:`int<class_int>` radius_top_right, :ref:`int<class_int>` radius_botton_right, :ref:`int<class_int>` radius_bottom_left **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_draw_center<class_StyleBoxFlat_set_draw_center>` **(** :ref:`bool<class_bool>` draw_center **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_expand_margin<class_StyleBoxFlat_set_expand_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_expand_margin_all<class_StyleBoxFlat_set_expand_margin_all>` **(** :ref:`float<class_float>` size **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_expand_margin_individual<class_StyleBoxFlat_set_expand_margin_individual>` **(** :ref:`float<class_float>` size_left, :ref:`float<class_float>` size_top, :ref:`float<class_float>` size_right, :ref:`float<class_float>` size_bottom **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_shadow_color<class_StyleBoxFlat_set_shadow_color>` **(** :ref:`Color<class_color>` color **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_shadow_size<class_StyleBoxFlat_set_shadow_size>` **(** :ref:`int<class_int>` size **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
- :ref:`bool<class_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<class_int>` **anti_aliasing_size** - This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect.
|
|
- :ref:`Color<class_color>` **bg_color** - The background color of the stylebox.
|
|
- :ref:`bool<class_bool>` **border_blend** - When set to true, the border will fade into the background color.
|
|
- :ref:`Color<class_color>` **border_color** - Sets the color of the border.
|
|
- :ref:`int<class_int>` **border_width_bottom** - Border width for the bottom border.
|
|
- :ref:`int<class_int>` **border_width_left** - Border width for the left border.
|
|
- :ref:`int<class_int>` **border_width_right** - Border width for the right border.
|
|
- :ref:`int<class_int>` **border_width_top** - Border width for the top border.
|
|
- :ref:`int<class_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<class_int>` **corner_radius_bottom_left** - The corner radius of the bottom left corner. When set to 0 the corner is not rounded.
|
|
- :ref:`int<class_int>` **corner_radius_bottom_right** - The corner radius of the bottom right corner. When set to 0 the corner is not rounded.
|
|
- :ref:`int<class_int>` **corner_radius_top_left** - The corner radius of the top left corner. When set to 0 the corner is not rounded.
|
|
- :ref:`int<class_int>` **corner_radius_top_right** - The corner radius of the top right corner. When set to 0 the corner is not rounded.
|
|
- :ref:`bool<class_bool>` **draw_center** - Toggels drawing of the inner part of the stylebox.
|
|
- :ref:`float<class_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<class_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<class_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<class_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<class_color>` **shadow_color** - The color of the shadow. (This has no effect when shadow_size < 1)
|
|
- :ref:`int<class_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<class_int>` **get_aa_size** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_bg_color:
|
|
|
|
- :ref:`Color<class_color>` **get_bg_color** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_border_blend:
|
|
|
|
- :ref:`bool<class_bool>` **get_border_blend** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_border_color:
|
|
|
|
- :ref:`Color<class_color>` **get_border_color** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_border_width:
|
|
|
|
- :ref:`int<class_int>` **get_border_width** **(** :ref:`int<class_int>` margin **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_border_width_min:
|
|
|
|
- :ref:`int<class_int>` **get_border_width_min** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_corner_detail:
|
|
|
|
- :ref:`int<class_int>` **get_corner_detail** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_corner_radius:
|
|
|
|
- :ref:`int<class_int>` **get_corner_radius** **(** :ref:`int<class_int>` corner **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_expand_margin:
|
|
|
|
- :ref:`float<class_float>` **get_expand_margin** **(** :ref:`int<class_int>` margin **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_shadow_color:
|
|
|
|
- :ref:`Color<class_color>` **get_shadow_color** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_get_shadow_size:
|
|
|
|
- :ref:`int<class_int>` **get_shadow_size** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_is_anti_aliased:
|
|
|
|
- :ref:`bool<class_bool>` **is_anti_aliased** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_is_draw_center_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **is_draw_center_enabled** **(** **)** const
|
|
|
|
.. _class_StyleBoxFlat_set_aa_size:
|
|
|
|
- void **set_aa_size** **(** :ref:`int<class_int>` size **)**
|
|
|
|
.. _class_StyleBoxFlat_set_anti_aliased:
|
|
|
|
- void **set_anti_aliased** **(** :ref:`bool<class_bool>` anti_aliased **)**
|
|
|
|
.. _class_StyleBoxFlat_set_bg_color:
|
|
|
|
- void **set_bg_color** **(** :ref:`Color<class_color>` color **)**
|
|
|
|
.. _class_StyleBoxFlat_set_border_blend:
|
|
|
|
- void **set_border_blend** **(** :ref:`bool<class_bool>` blend **)**
|
|
|
|
.. _class_StyleBoxFlat_set_border_color:
|
|
|
|
- void **set_border_color** **(** :ref:`Color<class_color>` color **)**
|
|
|
|
.. _class_StyleBoxFlat_set_border_width:
|
|
|
|
- void **set_border_width** **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` width **)**
|
|
|
|
.. _class_StyleBoxFlat_set_border_width_all:
|
|
|
|
- void **set_border_width_all** **(** :ref:`int<class_int>` width **)**
|
|
|
|
.. _class_StyleBoxFlat_set_corner_detail:
|
|
|
|
- void **set_corner_detail** **(** :ref:`int<class_int>` detail **)**
|
|
|
|
.. _class_StyleBoxFlat_set_corner_radius:
|
|
|
|
- void **set_corner_radius** **(** :ref:`int<class_int>` corner, :ref:`int<class_int>` radius **)**
|
|
|
|
.. _class_StyleBoxFlat_set_corner_radius_all:
|
|
|
|
- void **set_corner_radius_all** **(** :ref:`int<class_int>` radius **)**
|
|
|
|
.. _class_StyleBoxFlat_set_corner_radius_individual:
|
|
|
|
- void **set_corner_radius_individual** **(** :ref:`int<class_int>` radius_top_left, :ref:`int<class_int>` radius_top_right, :ref:`int<class_int>` radius_botton_right, :ref:`int<class_int>` radius_bottom_left **)**
|
|
|
|
.. _class_StyleBoxFlat_set_draw_center:
|
|
|
|
- void **set_draw_center** **(** :ref:`bool<class_bool>` draw_center **)**
|
|
|
|
.. _class_StyleBoxFlat_set_expand_margin:
|
|
|
|
- void **set_expand_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` size **)**
|
|
|
|
.. _class_StyleBoxFlat_set_expand_margin_all:
|
|
|
|
- void **set_expand_margin_all** **(** :ref:`float<class_float>` size **)**
|
|
|
|
.. _class_StyleBoxFlat_set_expand_margin_individual:
|
|
|
|
- void **set_expand_margin_individual** **(** :ref:`float<class_float>` size_left, :ref:`float<class_float>` size_top, :ref:`float<class_float>` size_right, :ref:`float<class_float>` size_bottom **)**
|
|
|
|
.. _class_StyleBoxFlat_set_shadow_color:
|
|
|
|
- void **set_shadow_color** **(** :ref:`Color<class_color>` color **)**
|
|
|
|
.. _class_StyleBoxFlat_set_shadow_size:
|
|
|
|
- void **set_shadow_size** **(** :ref:`int<class_int>` size **)**
|
|
|
|
|