From 0bf521f33b998e5acbbb1cacc6a57434e77037db Mon Sep 17 00:00:00 2001 From: toger5 Date: Sun, 3 Sep 2017 00:37:53 +0200 Subject: [PATCH] documented StyleBoxFlat --- doc/base/classes.xml | 44 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 42 insertions(+), 2 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 96d515de5e6..be2284acbfb 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -49206,10 +49206,27 @@ - Stylebox of a single color. + Customizable Stylebox with a given set of parameters. (no texture required) - Stylebox of a single color. Displays the stylebox of a single color, alternatively a border with light/dark colors can be assigned. + 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] + @@ -49453,46 +49470,69 @@ + 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. + This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. + The background color of the stylebox. + When set to true, the border will fade into the background color. + Sets the color of the border. + Border width for the bottom border. + Border width for the left border. + Border width for the right border. + Border width for the top border. + 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 ... + The corner radius of the bottom left corner. When set to 0 the corner is not rounded. + The corner radius of the bottom right corner. When set to 0 the corner is not rounded. + The corner radius of the top left corner. When set to 0 the corner is not rounded. + The corner radius of the top right corner. When set to 0 the corner is not rounded. + Toggels drawing of the inner part of the stylebox. + 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. + 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. + 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. + 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. + The color of the shadow. (This has no effect when shadow_size < 1) + The shadow size in pixels.