diff options
Diffstat (limited to 'doc/classes/StyleBoxFlat.xml')
| -rw-r--r-- | doc/classes/StyleBoxFlat.xml | 338 |
1 files changed, 338 insertions, 0 deletions
diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml new file mode 100644 index 0000000000..b09b9f0679 --- /dev/null +++ b/doc/classes/StyleBoxFlat.xml @@ -0,0 +1,338 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StyleBoxFlat" inherits="StyleBox" category="Core" version="3.0.alpha.custom_build"> + <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 + corner_raidus_bottom_left = 100 + [/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 + corner_raidus_bottom_left: 20 + [/codeblock] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_aa_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_bg_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_border_blend" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_border_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_border_width" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + </description> + </method> + <method name="get_border_width_min" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_corner_detail" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_corner_radius" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="corner" type="int" enum="Corner"> + </argument> + <description> + </description> + </method> + <method name="get_expand_margin" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + </description> + </method> + <method name="get_shadow_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_shadow_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_anti_aliased" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_draw_center_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_aa_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_anti_aliased"> + <return type="void"> + </return> + <argument index="0" name="anti_aliased" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bg_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_border_blend"> + <return type="void"> + </return> + <argument index="0" name="blend" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_border_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_border_width"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="width" type="int"> + </argument> + <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_detail"> + <return type="void"> + </return> + <argument index="0" name="detail" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_corner_radius"> + <return type="void"> + </return> + <argument index="0" name="corner" type="int" enum="Corner"> + </argument> + <argument index="1" name="radius" 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> + <argument index="2" name="radius_botton_right" type="int"> + </argument> + <argument index="3" name="radius_bottom_left" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_draw_center"> + <return type="void"> + </return> + <argument index="0" name="draw_center" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_expand_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="size" type="float"> + </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> + <method name="set_shadow_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="anti_aliasing" type="bool" setter="set_anti_aliased" 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 noticable when using rounded corners. + </member> + <member name="anti_aliasing_size" type="int" setter="set_aa_size" getter="get_aa_size"> + This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. + </member> + <member name="bg_color" type="Color" setter="set_bg_color" getter="get_bg_color"> + The background color of the stylebox. + </member> + <member name="border_blend" type="bool" setter="set_border_blend" getter="get_border_blend"> + When set to true, the border will fade into the background color. + </member> + <member name="border_color" type="Color" setter="set_border_color" getter="get_border_color"> + Sets the color of the border. + </member> + <member name="border_width_bottom" type="int" setter="set_border_width" getter="get_border_width"> + Border width for the bottom border. + </member> + <member name="border_width_left" type="int" setter="set_border_width" getter="get_border_width"> + Border width for the left border. + </member> + <member name="border_width_right" type="int" setter="set_border_width" getter="get_border_width"> + Border width for the right border. + </member> + <member name="border_width_top" type="int" setter="set_border_width" getter="get_border_width"> + Border width for the top border. + </member> + <member name="corner_detail" type="int" setter="set_corner_detail" 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 ([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> + <member name="corner_radius_bottom_left" type="int" setter="set_corner_radius" getter="get_corner_radius"> + The corner radius of the bottom left corner. When set to 0 the corner is not rounded. + </member> + <member name="corner_radius_bottom_right" type="int" setter="set_corner_radius" getter="get_corner_radius"> + The corner radius of the bottom right corner. When set to 0 the corner is not rounded. + </member> + <member name="corner_radius_top_left" type="int" setter="set_corner_radius" getter="get_corner_radius"> + The corner radius of the top left corner. When set to 0 the corner is not rounded. + </member> + <member name="corner_radius_top_right" type="int" setter="set_corner_radius" getter="get_corner_radius"> + The corner radius of the top right corner. When set to 0 the corner is not rounded. + </member> + <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled"> + Toggels drawing of the inner part of the stylebox. + </member> + <member name="expand_margin_bottom" type="float" setter="set_expand_margin" 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. + </member> + <member name="expand_margin_left" type="float" setter="set_expand_margin" 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. + </member> + <member name="expand_margin_right" type="float" setter="set_expand_margin" 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. + </member> + <member name="expand_margin_top" type="float" setter="set_expand_margin" 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. + </member> + <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color"> + The color of the shadow. (This has no effect when shadow_size < 1) + </member> + <member name="shadow_size" type="int" setter="set_shadow_size" getter="get_shadow_size"> + The shadow size in pixels. + </member> + </members> + <constants> + </constants> +</class> |