godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2017-11-27 08:32:15 +01:00
parent 33f109ea70
commit 5bf33731b6
303 changed files with 2187 additions and 18408 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
classes/class_stylebox.rst
View File

@@ -21,23 +21,19 @@ Base class for drawing stylized boxes for the UI.
Member Functions
----------------
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw<class_StyleBox_draw>` **(** :ref:`RID<class_rid>` canvas_item, :ref:`Rect2<class_rect2>` rect **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_center_size<class_StyleBox_get_center_size>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_default_margin<class_StyleBox_get_default_margin>` **(** :ref:`int<class_int>` margin **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_margin<class_StyleBox_get_margin>` **(** :ref:`int<class_int>` margin **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_StyleBox_get_minimum_size>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_StyleBox_get_offset>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_margin<class_StyleBox_set_default_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`test_mask<class_StyleBox_test_mask>` **(** :ref:`Vector2<class_vector2>` point, :ref:`Rect2<class_rect2>` rect **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw<class_StyleBox_draw>` **(** :ref:`RID<class_rid>` canvas_item, :ref:`Rect2<class_rect2>` rect **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_center_size<class_StyleBox_get_center_size>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_margin<class_StyleBox_get_margin>` **(** :ref:`int<class_int>` margin **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_StyleBox_get_minimum_size>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_StyleBox_get_offset>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`test_mask<class_StyleBox_test_mask>` **(** :ref:`Vector2<class_vector2>` point, :ref:`Rect2<class_rect2>` rect **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -75,12 +71,6 @@ Member Function Description
- :ref:`Vector2<class_vector2>` **get_center_size** **(** **)** const
.. _class_StyleBox_get_default_margin:
- :ref:`float<class_float>` **get_default_margin** **(** :ref:`int<class_int>` margin **)** const
Return the default offset of the margin "margin" (see MARGIN\_\* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded.
.. _class_StyleBox_get_margin:
- :ref:`float<class_float>` **get_margin** **(** :ref:`int<class_int>` margin **)** const
@@ -99,12 +89,6 @@ Return the minimum size that this stylebox can be shrunk to.
Return the "offset" of a stylebox, this is a helper function, like writing ``Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))``.
.. _class_StyleBox_set_default_margin:
- void **set_default_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset **)**
Set the default offset "offset" of the margin "margin" (see MARGIN\_\* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded.
.. _class_StyleBox_test_mask:
- :ref:`bool<class_bool>` **test_mask** **(** :ref:`Vector2<class_vector2>` point, :ref:`Rect2<class_rect2>` rect **)** const