mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
Sync classref with current source
Changes order of brief/long descriptions and removes category as per godotengine/godot#35132.
This commit is contained in:
@@ -13,13 +13,13 @@ StyleBox
|
||||
|
||||
**Inherited By:** :ref:`StyleBoxEmpty<class_StyleBoxEmpty>`, :ref:`StyleBoxFlat<class_StyleBoxFlat>`, :ref:`StyleBoxLine<class_StyleBoxLine>`, :ref:`StyleBoxTexture<class_StyleBoxTexture>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Base class for drawing stylized boxes for the UI.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
StyleBox is :ref:`Resource<class_Resource>` that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
@@ -56,11 +56,6 @@ Methods
|
||||
| :ref:`bool<class_bool>` | :ref:`test_mask<class_StyleBox_method_test_mask>` **(** :ref:`Vector2<class_Vector2>` point, :ref:`Rect2<class_Rect2>` rect **)** const |
|
||||
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
StyleBox is :ref:`Resource<class_Resource>` that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below.
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
@@ -145,31 +140,41 @@ Method Descriptions
|
||||
|
||||
- void **draw** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Rect2<class_Rect2>` rect **)** const
|
||||
|
||||
Draws this stylebox using a :ref:`CanvasItem<class_CanvasItem>` with given :ref:`RID<class_RID>`.
|
||||
|
||||
You can get a :ref:`RID<class_RID>` value using :ref:`Object.get_instance_id<class_Object_method_get_instance_id>` on a :ref:`CanvasItem<class_CanvasItem>`-derived node.
|
||||
|
||||
----
|
||||
|
||||
.. _class_StyleBox_method_get_center_size:
|
||||
|
||||
- :ref:`Vector2<class_Vector2>` **get_center_size** **(** **)** const
|
||||
|
||||
Returns the size of this ``StyleBox`` without the margins.
|
||||
|
||||
----
|
||||
|
||||
.. _class_StyleBox_method_get_current_item_drawn:
|
||||
|
||||
- :ref:`CanvasItem<class_CanvasItem>` **get_current_item_drawn** **(** **)** const
|
||||
|
||||
Returns the :ref:`CanvasItem<class_CanvasItem>` that handles its :ref:`CanvasItem.NOTIFICATION_DRAW<class_CanvasItem_constant_NOTIFICATION_DRAW>` or :ref:`CanvasItem._draw<class_CanvasItem_method__draw>` callback at this moment.
|
||||
|
||||
----
|
||||
|
||||
.. _class_StyleBox_method_get_default_margin:
|
||||
|
||||
- :ref:`float<class_float>` **get_default_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const
|
||||
|
||||
Returns the default value of the specified :ref:`Margin<enum_@GlobalScope_Margin>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_StyleBox_method_get_margin:
|
||||
|
||||
- :ref:`float<class_float>` **get_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** const
|
||||
|
||||
Returns the content margin offset for the specified margin.
|
||||
Returns the content margin offset for the specified :ref:`Margin<enum_@GlobalScope_Margin>`.
|
||||
|
||||
Positive values reduce size inwards, unlike :ref:`Control<class_Control>`'s margin values.
|
||||
|
||||
@@ -195,6 +200,8 @@ Returns the "offset" of a stylebox. This helper function returns a value equival
|
||||
|
||||
- void **set_default_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`float<class_float>` offset **)**
|
||||
|
||||
Sets the default value of the specified :ref:`Margin<enum_@GlobalScope_Margin>` to given ``offset`` in pixels.
|
||||
|
||||
----
|
||||
|
||||
.. _class_StyleBox_method_test_mask:
|
||||
|
||||
Reference in New Issue
Block a user