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

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

162
classes/class_label.rst
View File

@@ -8,6 +8,7 @@ Label
=====
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
@@ -15,6 +16,31 @@ Brief Description
Displays plain text in a line or wrapped inside a rectangle. For formatted text, use :ref:`RichTextLabel<class_RichTextLabel>`.
Properties
----------
+----------------------------------+-----------------------------------------------------------+
| :ref:`Align<enum_Label_Align>` | :ref:`align<class_Label_align>` |
+----------------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`autowrap<class_Label_autowrap>` |
+----------------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Label_clip_text>` |
+----------------------------------+-----------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`lines_skipped<class_Label_lines_skipped>` |
+----------------------------------+-----------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`max_lines_visible<class_Label_max_lines_visible>` |
+----------------------------------+-----------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`percent_visible<class_Label_percent_visible>` |
+----------------------------------+-----------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`text<class_Label_text>` |
+----------------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`uppercase<class_Label_uppercase>` |
+----------------------------------+-----------------------------------------------------------+
| :ref:`VAlign<enum_Label_VAlign>` | :ref:`valign<class_Label_valign>` |
+----------------------------------+-----------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`visible_characters<class_Label_visible_characters>` |
+----------------------------------+-----------------------------------------------------------+
Methods
-------
@@ -28,12 +54,35 @@ Methods
| :ref:`int<class_int>` | :ref:`get_visible_line_count<class_Label_get_visible_line_count>` **(** **)** const |
+------------------------+-------------------------------------------------------------------------------------------+
Theme Properties
----------------
+---------------------------------+-----------------------------------------------------------------+
| :ref:`Font<class_Font>` | :ref:`font<class_Label_font>` |
+---------------------------------+-----------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color<class_Label_font_color>` |
+---------------------------------+-----------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color_shadow<class_Label_font_color_shadow>` |
+---------------------------------+-----------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_outline_modulate<class_Label_font_outline_modulate>` |
+---------------------------------+-----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`line_spacing<class_Label_line_spacing>` |
+---------------------------------+-----------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_Label_normal>` |
+---------------------------------+-----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`shadow_as_outline<class_Label_shadow_as_outline>` |
+---------------------------------+-----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`shadow_offset_x<class_Label_shadow_offset_x>` |
+---------------------------------+-----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`shadow_offset_y<class_Label_shadow_offset_y>` |
+---------------------------------+-----------------------------------------------------------------+
Enumerations
------------
.. _enum_Label_Align:
enum **Align**
enum **Align**:
- **ALIGN_LEFT** = **0** --- Align rows to the left (default).
- **ALIGN_CENTER** = **1** --- Align rows centered.
@@ -42,14 +91,13 @@ enum **Align**
.. _enum_Label_VAlign:
enum **VAlign**
enum **VAlign**:
- **VALIGN_TOP** = **0** --- Align the whole text to the top.
- **VALIGN_CENTER** = **1** --- Align the whole text to the center.
- **VALIGN_BOTTOM** = **2** --- Align the whole text to the bottom.
- **VALIGN_FILL** = **3** --- Align the whole text by spreading the rows.
Description
-----------
@@ -62,70 +110,148 @@ Property Descriptions
.. _class_Label_align:
- :ref:`Align<enum_Label_Align>` **align** - Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN_*`` constants.
- :ref:`Align<enum_Label_Align>` **align**
+----------+------------------+
| *Setter* | set_align(value) |
+----------+------------------+
| *Getter* | get_align() |
+----------+------------------+
Controls the text's horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ``ALIGN_*`` constants.
.. _class_Label_autowrap:
- :ref:`bool<class_bool>` **autowrap** - If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: false.
- :ref:`bool<class_bool>` **autowrap**
+----------+---------------------+
| *Setter* | set_autowrap(value) |
+----------+---------------------+
| *Getter* | has_autowrap() |
+----------+---------------------+
If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: false.
.. _class_Label_clip_text:
- :ref:`bool<class_bool>` **clip_text** - If ``true``, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely.
- :ref:`bool<class_bool>` **clip_text**
+----------+----------------------+
| *Setter* | set_clip_text(value) |
+----------+----------------------+
| *Getter* | is_clipping_text() |
+----------+----------------------+
If ``true``, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely.
.. _class_Label_lines_skipped:
- :ref:`int<class_int>` **lines_skipped** - The node ignores the first ``lines_skipped`` lines before it starts to display text.
- :ref:`int<class_int>` **lines_skipped**
+----------+--------------------------+
| *Setter* | set_lines_skipped(value) |
+----------+--------------------------+
| *Getter* | get_lines_skipped() |
+----------+--------------------------+
The node ignores the first ``lines_skipped`` lines before it starts to display text.
.. _class_Label_max_lines_visible:
- :ref:`int<class_int>` **max_lines_visible** - Limits the lines of text the node shows on screen.
- :ref:`int<class_int>` **max_lines_visible**
+----------+------------------------------+
| *Setter* | set_max_lines_visible(value) |
+----------+------------------------------+
| *Getter* | get_max_lines_visible() |
+----------+------------------------------+
Limits the lines of text the node shows on screen.
.. _class_Label_percent_visible:
- :ref:`float<class_float>` **percent_visible** - Limits the count of visible characters. If you set ``percent_visible`` to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box.
- :ref:`float<class_float>` **percent_visible**
+----------+----------------------------+
| *Setter* | set_percent_visible(value) |
+----------+----------------------------+
| *Getter* | get_percent_visible() |
+----------+----------------------------+
Limits the count of visible characters. If you set ``percent_visible`` to 50, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box.
.. _class_Label_text:
- :ref:`String<class_String>` **text** - The text to display on screen.
- :ref:`String<class_String>` **text**
+----------+-----------------+
| *Setter* | set_text(value) |
+----------+-----------------+
| *Getter* | get_text() |
+----------+-----------------+
The text to display on screen.
.. _class_Label_uppercase:
- :ref:`bool<class_bool>` **uppercase** - If ``true``, all the text displays as UPPERCASE.
- :ref:`bool<class_bool>` **uppercase**
+----------+----------------------+
| *Setter* | set_uppercase(value) |
+----------+----------------------+
| *Getter* | is_uppercase() |
+----------+----------------------+
If ``true``, all the text displays as UPPERCASE.
.. _class_Label_valign:
- :ref:`VAlign<enum_Label_VAlign>` **valign** - Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants.
- :ref:`VAlign<enum_Label_VAlign>` **valign**
+----------+-------------------+
| *Setter* | set_valign(value) |
+----------+-------------------+
| *Getter* | get_valign() |
+----------+-------------------+
Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the ``VALIGN_*`` constants.
.. _class_Label_visible_characters:
- :ref:`int<class_int>` **visible_characters** - Restricts the number of characters to display. Set to -1 to disable.
- :ref:`int<class_int>` **visible_characters**
+----------+-------------------------------+
| *Setter* | set_visible_characters(value) |
+----------+-------------------------------+
| *Getter* | get_visible_characters() |
+----------+-------------------------------+
Restricts the number of characters to display. Set to -1 to disable.
Method Descriptions
-------------------
.. _class_Label_get_line_count:
.. _class_Label_get_line_count:
- :ref:`int<class_int>` **get_line_count** **(** **)** const
Returns the amount of lines of text the Label has.
.. _class_Label_get_line_height:
.. _class_Label_get_line_height:
- :ref:`int<class_int>` **get_line_height** **(** **)** const
Returns the font size in pixels.
.. _class_Label_get_total_character_count:
.. _class_Label_get_total_character_count:
- :ref:`int<class_int>` **get_total_character_count** **(** **)** const
Returns the total length of the text.
.. _class_Label_get_visible_line_count:
.. _class_Label_get_visible_line_count:
- :ref:`int<class_int>` **get_visible_line_count** **(** **)** const
Returns the number of lines shown. Useful if the ``Label`` 's height cannot currently display all lines.