2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-07-31 20:13:10 +02:00
<class name= "StyleBoxFlat" inherits= "StyleBox" category= "Core" version= "3.0.7" >
2017-09-12 22:42:36 +02:00
<brief_description >
Customizable Stylebox with a given set of parameters. (no texture required)
</brief_description>
<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:
[codeblock]
height = 30
corner_radius_top_left = 50
2017-10-14 12:45:26 +02:00
corner_radius_bottom_left = 100
2017-09-12 22:42:36 +02:00
[/codeblock]
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 [b]never[/b] be more than the height. Result:
[codeblock]
corner_radius_top_left: 10
2017-10-14 12:45:26 +02:00
corner_radius_bottom_left: 20
2017-09-12 22:42:36 +02:00
[/codeblock]
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "get_border_width_min" qualifiers= "const" >
<return type= "int" >
</return>
<description >
</description>
</method>
<method name= "set_border_width_all" >
<return type= "void" >
</return>
<argument index= "0" name= "width" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "set_corner_radius_all" >
<return type= "void" >
</return>
<argument index= "0" name= "radius" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "set_corner_radius_individual" >
<return type= "void" >
</return>
<argument index= "0" name= "radius_top_left" type= "int" >
</argument>
<argument index= "1" name= "radius_top_right" type= "int" >
</argument>
2017-10-21 12:02:08 +02:00
<argument index= "2" name= "radius_bottom_right" type= "int" >
2017-09-12 22:42:36 +02:00
</argument>
<argument index= "3" name= "radius_bottom_left" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "set_expand_margin_all" >
<return type= "void" >
</return>
<argument index= "0" name= "size" type= "float" >
</argument>
<description >
</description>
</method>
<method name= "set_expand_margin_individual" >
<return type= "void" >
</return>
<argument index= "0" name= "size_left" type= "float" >
</argument>
<argument index= "1" name= "size_top" type= "float" >
</argument>
<argument index= "2" name= "size_right" type= "float" >
</argument>
<argument index= "3" name= "size_bottom" type= "float" >
</argument>
<description >
</description>
</method>
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "anti_aliasing" type= "bool" setter= "set_anti_aliased" getter= "is_anti_aliased" >
2017-10-14 12:45:26 +02:00
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.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "anti_aliasing_size" type= "int" setter= "set_aa_size" getter= "get_aa_size" >
2017-09-12 22:42:36 +02:00
This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect.
</member>
2017-09-13 08:49:40 +02:00
<member name= "bg_color" type= "Color" setter= "set_bg_color" getter= "get_bg_color" >
2017-09-12 22:42:36 +02:00
The background color of the stylebox.
</member>
2017-09-13 08:49:40 +02:00
<member name= "border_blend" type= "bool" setter= "set_border_blend" getter= "get_border_blend" >
2017-09-12 22:42:36 +02:00
When set to true, the border will fade into the background color.
</member>
2017-09-13 08:49:40 +02:00
<member name= "border_color" type= "Color" setter= "set_border_color" getter= "get_border_color" >
2017-09-12 22:42:36 +02:00
Sets the color of the border.
</member>
2017-09-13 08:49:40 +02:00
<member name= "border_width_bottom" type= "int" setter= "set_border_width" getter= "get_border_width" >
2017-09-12 22:42:36 +02:00
Border width for the bottom border.
</member>
2017-09-13 08:49:40 +02:00
<member name= "border_width_left" type= "int" setter= "set_border_width" getter= "get_border_width" >
2017-09-12 22:42:36 +02:00
Border width for the left border.
</member>
2017-09-13 08:49:40 +02:00
<member name= "border_width_right" type= "int" setter= "set_border_width" getter= "get_border_width" >
2017-09-12 22:42:36 +02:00
Border width for the right border.
</member>
2017-09-13 08:49:40 +02:00
<member name= "border_width_top" type= "int" setter= "set_border_width" getter= "get_border_width" >
2017-09-12 22:42:36 +02:00
Border width for the top border.
</member>
2017-09-13 08:49:40 +02:00
<member name= "corner_detail" type= "int" setter= "set_corner_detail" getter= "get_corner_detail" >
2017-09-12 22:42:36 +02:00
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 ...
</member>
2017-09-13 08:49:40 +02:00
<member name= "corner_radius_bottom_left" type= "int" setter= "set_corner_radius" getter= "get_corner_radius" >
2017-09-12 22:42:36 +02:00
The corner radius of the bottom left corner. When set to 0 the corner is not rounded.
</member>
2017-09-13 08:49:40 +02:00
<member name= "corner_radius_bottom_right" type= "int" setter= "set_corner_radius" getter= "get_corner_radius" >
2017-09-12 22:42:36 +02:00
The corner radius of the bottom right corner. When set to 0 the corner is not rounded.
</member>
2017-09-13 08:49:40 +02:00
<member name= "corner_radius_top_left" type= "int" setter= "set_corner_radius" getter= "get_corner_radius" >
2017-09-12 22:42:36 +02:00
The corner radius of the top left corner. When set to 0 the corner is not rounded.
</member>
2017-09-13 08:49:40 +02:00
<member name= "corner_radius_top_right" type= "int" setter= "set_corner_radius" getter= "get_corner_radius" >
2017-09-12 22:42:36 +02:00
The corner radius of the top right corner. When set to 0 the corner is not rounded.
</member>
2017-09-13 08:49:40 +02:00
<member name= "draw_center" type= "bool" setter= "set_draw_center" getter= "is_draw_center_enabled" >
2017-09-12 22:42:36 +02:00
Toggels drawing of the inner part of the stylebox.
</member>
2017-09-13 08:49:40 +02:00
<member name= "expand_margin_bottom" type= "float" setter= "set_expand_margin" getter= "get_expand_margin" >
2017-09-12 22:42:36 +02:00
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.
</member>
2017-09-13 08:49:40 +02:00
<member name= "expand_margin_left" type= "float" setter= "set_expand_margin" getter= "get_expand_margin" >
2017-09-12 22:42:36 +02:00
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.
</member>
2017-09-13 08:49:40 +02:00
<member name= "expand_margin_right" type= "float" setter= "set_expand_margin" getter= "get_expand_margin" >
2017-09-12 22:42:36 +02:00
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.
</member>
2017-09-13 08:49:40 +02:00
<member name= "expand_margin_top" type= "float" setter= "set_expand_margin" getter= "get_expand_margin" >
2017-09-12 22:42:36 +02:00
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.
</member>
2017-09-13 08:49:40 +02:00
<member name= "shadow_color" type= "Color" setter= "set_shadow_color" getter= "get_shadow_color" >
2017-09-12 22:42:36 +02:00
The color of the shadow. (This has no effect when shadow_size < 1)
</member>
2017-09-13 08:49:40 +02:00
<member name= "shadow_size" type= "int" setter= "set_shadow_size" getter= "get_shadow_size" >
2017-09-12 22:42:36 +02:00
The shadow size in pixels.
</member>
</members>
<constants >
</constants>
</class>