godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Add property overview and setter/getter like in editor docs

Browse Source 
Output from godotengine/godot#22013.
Fixes #1729.
This commit is contained in:
Rémi Verschelde
2018-09-13 11:06:52 +02:00
parent f9caa4be29
commit ab3f908221
578 changed files with 33831 additions and 6706 deletions
Download Patch File Download Diff File Expand all files Collapse all files

270
classes/class_styleboxflat.rst
View File

@@ -8,6 +8,7 @@ StyleBoxFlat
============
**Inherits:** :ref:`StyleBox<class_StyleBox>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
@@ -15,6 +16,53 @@ Brief Description
Customizable Stylebox with a given set of parameters. (no texture required)
Properties
----------
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`anti_aliasing<class_StyleBoxFlat_anti_aliasing>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`anti_aliasing_size<class_StyleBoxFlat_anti_aliasing_size>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`bg_color<class_StyleBoxFlat_bg_color>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`border_blend<class_StyleBoxFlat_border_blend>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`border_color<class_StyleBoxFlat_border_color>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`border_width_bottom<class_StyleBoxFlat_border_width_bottom>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`border_width_left<class_StyleBoxFlat_border_width_left>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`border_width_right<class_StyleBoxFlat_border_width_right>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`border_width_top<class_StyleBoxFlat_border_width_top>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`corner_detail<class_StyleBoxFlat_corner_detail>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`corner_radius_bottom_left<class_StyleBoxFlat_corner_radius_bottom_left>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`corner_radius_bottom_right<class_StyleBoxFlat_corner_radius_bottom_right>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`corner_radius_top_left<class_StyleBoxFlat_corner_radius_top_left>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`corner_radius_top_right<class_StyleBoxFlat_corner_radius_top_right>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`draw_center<class_StyleBoxFlat_draw_center>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`expand_margin_bottom<class_StyleBoxFlat_expand_margin_bottom>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`expand_margin_left<class_StyleBoxFlat_expand_margin_left>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`expand_margin_right<class_StyleBoxFlat_expand_margin_right>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`expand_margin_top<class_StyleBoxFlat_expand_margin_top>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`shadow_color<class_StyleBoxFlat_shadow_color>` |
+---------------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`shadow_size<class_StyleBoxFlat_shadow_size>` |
+---------------------------+----------------------------------------------------------------------------------+
Methods
-------
@@ -67,43 +115,123 @@ Property Descriptions
.. _class_StyleBoxFlat_anti_aliasing:
- :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 noticeable when using rounded corners.
- :ref:`bool<class_bool>` **anti_aliasing**
+----------+-------------------------+
| *Setter* | set_anti_aliased(value) |
+----------+-------------------------+
| *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 noticeable when using rounded corners.
.. _class_StyleBoxFlat_anti_aliasing_size:
- :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:`int<class_int>` **anti_aliasing_size**
+----------+--------------------+
| *Setter* | set_aa_size(value) |
+----------+--------------------+
| *Getter* | get_aa_size() |
+----------+--------------------+
This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect.
.. _class_StyleBoxFlat_bg_color:
- :ref:`Color<class_Color>` **bg_color** - The background color of the stylebox.
- :ref:`Color<class_Color>` **bg_color**
+----------+---------------------+
| *Setter* | set_bg_color(value) |
+----------+---------------------+
| *Getter* | get_bg_color() |
+----------+---------------------+
The background color of the stylebox.
.. _class_StyleBoxFlat_border_blend:
- :ref:`bool<class_bool>` **border_blend** - When set to true, the border will fade into the background color.
- :ref:`bool<class_bool>` **border_blend**
+----------+-------------------------+
| *Setter* | set_border_blend(value) |
+----------+-------------------------+
| *Getter* | get_border_blend() |
+----------+-------------------------+
When set to true, the border will fade into the background color.
.. _class_StyleBoxFlat_border_color:
- :ref:`Color<class_Color>` **border_color** - Sets the color of the border.
- :ref:`Color<class_Color>` **border_color**
+----------+-------------------------+
| *Setter* | set_border_color(value) |
+----------+-------------------------+
| *Getter* | get_border_color() |
+----------+-------------------------+
Sets the color of the border.
.. _class_StyleBoxFlat_border_width_bottom:
- :ref:`int<class_int>` **border_width_bottom** - Border width for the bottom border.
- :ref:`int<class_int>` **border_width_bottom**
+----------+-------------------------+
| *Setter* | set_border_width(value) |
+----------+-------------------------+
| *Getter* | get_border_width() |
+----------+-------------------------+
Border width for the bottom border.
.. _class_StyleBoxFlat_border_width_left:
- :ref:`int<class_int>` **border_width_left** - Border width for the left border.
- :ref:`int<class_int>` **border_width_left**
+----------+-------------------------+
| *Setter* | set_border_width(value) |
+----------+-------------------------+
| *Getter* | get_border_width() |
+----------+-------------------------+
Border width for the left border.
.. _class_StyleBoxFlat_border_width_right:
- :ref:`int<class_int>` **border_width_right** - Border width for the right border.
- :ref:`int<class_int>` **border_width_right**
+----------+-------------------------+
| *Setter* | set_border_width(value) |
+----------+-------------------------+
| *Getter* | get_border_width() |
+----------+-------------------------+
Border width for the right border.
.. _class_StyleBoxFlat_border_width_top:
- :ref:`int<class_int>` **border_width_top** - Border width for the top border.
- :ref:`int<class_int>` **border_width_top**
+----------+-------------------------+
| *Setter* | set_border_width(value) |
+----------+-------------------------+
| *Getter* | get_border_width() |
+----------+-------------------------+
Border width for the top border.
.. _class_StyleBoxFlat_corner_detail:
- :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 (:ref:`set_corner_radius<class_StyleBoxFlat_set_corner_radius>`) into account.
- :ref:`int<class_int>` **corner_detail**
+----------+--------------------------+
| *Setter* | set_corner_detail(value) |
+----------+--------------------------+
| *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 (:ref:`set_corner_radius<class_StyleBoxFlat_set_corner_radius>`) into account.
For corner radius smaller than 10: 4-5 should be enough
@@ -111,74 +239,160 @@ For corner radius smaller than 30: 8-12 should be enough ...
.. _class_StyleBoxFlat_corner_radius_bottom_left:
- :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_left**
+----------+--------------------------+
| *Setter* | set_corner_radius(value) |
+----------+--------------------------+
| *Getter* | get_corner_radius() |
+----------+--------------------------+
The corner radius of the bottom left corner. When set to 0 the corner is not rounded.
.. _class_StyleBoxFlat_corner_radius_bottom_right:
- :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_bottom_right**
+----------+--------------------------+
| *Setter* | set_corner_radius(value) |
+----------+--------------------------+
| *Getter* | get_corner_radius() |
+----------+--------------------------+
The corner radius of the bottom right corner. When set to 0 the corner is not rounded.
.. _class_StyleBoxFlat_corner_radius_top_left:
- :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_left**
+----------+--------------------------+
| *Setter* | set_corner_radius(value) |
+----------+--------------------------+
| *Getter* | get_corner_radius() |
+----------+--------------------------+
The corner radius of the top left corner. When set to 0 the corner is not rounded.
.. _class_StyleBoxFlat_corner_radius_top_right:
- :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:`int<class_int>` **corner_radius_top_right**
+----------+--------------------------+
| *Setter* | set_corner_radius(value) |
+----------+--------------------------+
| *Getter* | get_corner_radius() |
+----------+--------------------------+
The corner radius of the top right corner. When set to 0 the corner is not rounded.
.. _class_StyleBoxFlat_draw_center:
- :ref:`bool<class_bool>` **draw_center** - Toggels drawing of the inner part of the stylebox.
- :ref:`bool<class_bool>` **draw_center**
+----------+--------------------------+
| *Setter* | set_draw_center(value) |
+----------+--------------------------+
| *Getter* | is_draw_center_enabled() |
+----------+--------------------------+
Toggels drawing of the inner part of the stylebox.
.. _class_StyleBoxFlat_expand_margin_bottom:
- :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_bottom**
+----------+--------------------------+
| *Setter* | set_expand_margin(value) |
+----------+--------------------------+
| *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.
.. _class_StyleBoxFlat_expand_margin_left:
- :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_left**
+----------+--------------------------+
| *Setter* | set_expand_margin(value) |
+----------+--------------------------+
| *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.
.. _class_StyleBoxFlat_expand_margin_right:
- :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_right**
+----------+--------------------------+
| *Setter* | set_expand_margin(value) |
+----------+--------------------------+
| *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.
.. _class_StyleBoxFlat_expand_margin_top:
- :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:`float<class_float>` **expand_margin_top**
+----------+--------------------------+
| *Setter* | set_expand_margin(value) |
+----------+--------------------------+
| *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.
.. _class_StyleBoxFlat_shadow_color:
- :ref:`Color<class_Color>` **shadow_color** - The color of the shadow. (This has no effect when shadow_size < 1)
- :ref:`Color<class_Color>` **shadow_color**
+----------+-------------------------+
| *Setter* | set_shadow_color(value) |
+----------+-------------------------+
| *Getter* | get_shadow_color() |
+----------+-------------------------+
The color of the shadow. (This has no effect when shadow_size < 1)
.. _class_StyleBoxFlat_shadow_size:
- :ref:`int<class_int>` **shadow_size** - The shadow size in pixels.
- :ref:`int<class_int>` **shadow_size**
+----------+------------------------+
| *Setter* | set_shadow_size(value) |
+----------+------------------------+
| *Getter* | get_shadow_size() |
+----------+------------------------+
The shadow size in pixels.
Method Descriptions
-------------------
.. _class_StyleBoxFlat_get_border_width_min:
.. _class_StyleBoxFlat_get_border_width_min:
- :ref:`int<class_int>` **get_border_width_min** **(** **)** const
.. _class_StyleBoxFlat_set_border_width_all:
.. _class_StyleBoxFlat_set_border_width_all:
- void **set_border_width_all** **(** :ref:`int<class_int>` width **)**
.. _class_StyleBoxFlat_set_corner_radius_all:
.. _class_StyleBoxFlat_set_corner_radius_all:
- void **set_corner_radius_all** **(** :ref:`int<class_int>` radius **)**
.. _class_StyleBoxFlat_set_corner_radius_individual:
.. _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_bottom_right, :ref:`int<class_int>` radius_bottom_left **)**
.. _class_StyleBoxFlat_set_expand_margin_all:
.. _class_StyleBoxFlat_set_expand_margin_all:
- void **set_expand_margin_all** **(** :ref:`float<class_float>` size **)**
.. _class_StyleBoxFlat_set_expand_margin_individual:
.. _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 **)**