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
Files
5bf33731b6b4a892269fe69a78bb06920a5ab0d9
godot-docs/classes/class_styleboxflat.rst
Rémi Verschelde 5bf33731b6 Sync classref with current source
2017-11-27 08:32:15 +01:00

186 lines
10 KiB
ReStructuredText
Raw Blame History

.. 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_border_width_min<class_StyleBoxFlat_get_border_width_min>` **(** **)** const |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_border_width_all<class_StyleBoxFlat_set_border_width_all>` **(** :ref:`int<class_int>` width **)** |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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_bottom_right, :ref:`int<class_int>` radius_bottom_left **)** |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _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.
.. _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.
.. _class_StyleBoxFlat_bg_color:
- :ref:`Color<class_color>` **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.
.. _class_StyleBoxFlat_border_color:
- :ref:`Color<class_color>` **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.
.. _class_StyleBoxFlat_border_width_left:
- :ref:`int<class_int>` **border_width_left** - Border width for the left border.
.. _class_StyleBoxFlat_border_width_right:
- :ref:`int<class_int>` **border_width_right** - Border width for the right border.
.. _class_StyleBoxFlat_border_width_top:
- :ref:`int<class_int>` **border_width_top** - 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.
For corner radius smaller than 10: 4-5 should be enough
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.
.. _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.
.. _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.
.. _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.
.. _class_StyleBoxFlat_draw_center:
- :ref:`bool<class_bool>` **draw_center** - 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.
.. _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.
.. _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.
.. _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.
.. _class_StyleBoxFlat_shadow_color:
- :ref:`Color<class_color>` **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.
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_radius_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_radius_bottom_left: 20
Member Function Description
---------------------------
.. _class_StyleBoxFlat_get_border_width_min:
- :ref:`int<class_int>` **get_border_width_min** **(** **)** const
.. _class_StyleBoxFlat_set_border_width_all:
- void **set_border_width_all** **(** :ref:`int<class_int>` width **)**
.. _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_bottom_right, :ref:`int<class_int>` radius_bottom_left **)**
.. _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 **)**
Reference in New Issue View Git Blame Copy Permalink