Sync classref with current source

This commit is contained in:
Rémi Verschelde
2019-10-29 12:48:46 +01:00
parent bbc6682099
commit a72184300f
449 changed files with 14004 additions and 232 deletions

View File

@@ -120,6 +120,8 @@ Signals
Emitted when the text changes.
----
.. _class_LineEdit_signal_text_entered:
- **text_entered** **(** :ref:`String<class_String>` new_text **)**
@@ -149,6 +151,8 @@ enum **Align**:
- **ALIGN_FILL** = **3** --- Stretches whitespaces to fit the ``LineEdit``'s width.
----
.. _enum_LineEdit_MenuItems:
.. _class_LineEdit_constant_MENU_CUT:
@@ -227,6 +231,8 @@ Property Descriptions
Text alignment as defined in the ``ALIGN_*`` enum.
----
.. _class_LineEdit_property_caret_blink:
- :ref:`bool<class_bool>` **caret_blink**
@@ -241,6 +247,8 @@ Text alignment as defined in the ``ALIGN_*`` enum.
If ``true``, the caret (visual cursor) blinks.
----
.. _class_LineEdit_property_caret_blink_speed:
- :ref:`float<class_float>` **caret_blink_speed**
@@ -255,6 +263,8 @@ If ``true``, the caret (visual cursor) blinks.
Duration (in seconds) of a caret's blinking cycle.
----
.. _class_LineEdit_property_caret_position:
- :ref:`int<class_int>` **caret_position**
@@ -269,6 +279,8 @@ Duration (in seconds) of a caret's blinking cycle.
The cursor's position inside the ``LineEdit``. When set, the text may scroll to accommodate it.
----
.. _class_LineEdit_property_clear_button_enabled:
- :ref:`bool<class_bool>` **clear_button_enabled**
@@ -283,6 +295,8 @@ The cursor's position inside the ``LineEdit``. When set, the text may scroll to
If ``true``, the ``LineEdit`` will show a clear button if ``text`` is not empty.
----
.. _class_LineEdit_property_context_menu_enabled:
- :ref:`bool<class_bool>` **context_menu_enabled**
@@ -297,6 +311,8 @@ If ``true``, the ``LineEdit`` will show a clear button if ``text`` is not empty.
If ``true``, the context menu will appear when right-clicked.
----
.. _class_LineEdit_property_editable:
- :ref:`bool<class_bool>` **editable**
@@ -311,6 +327,8 @@ If ``true``, the context menu will appear when right-clicked.
If ``false``, existing text cannot be modified and new text cannot be added.
----
.. _class_LineEdit_property_expand_to_text_length:
- :ref:`bool<class_bool>` **expand_to_text_length**
@@ -325,6 +343,8 @@ If ``false``, existing text cannot be modified and new text cannot be added.
If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:`text<class_LineEdit_property_text>`. It will **not** compress if the :ref:`text<class_LineEdit_property_text>` is shortened.
----
.. _class_LineEdit_property_max_length:
- :ref:`int<class_int>` **max_length**
@@ -339,6 +359,8 @@ If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:`
Maximum amount of characters that can be entered inside the ``LineEdit``. If ``0``, there is no limit.
----
.. _class_LineEdit_property_placeholder_alpha:
- :ref:`float<class_float>` **placeholder_alpha**
@@ -353,6 +375,8 @@ Maximum amount of characters that can be entered inside the ``LineEdit``. If ``0
Opacity of the :ref:`placeholder_text<class_LineEdit_property_placeholder_text>`. From ``0`` to ``1``.
----
.. _class_LineEdit_property_placeholder_text:
- :ref:`String<class_String>` **placeholder_text**
@@ -367,6 +391,8 @@ Opacity of the :ref:`placeholder_text<class_LineEdit_property_placeholder_text>`
Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s default value (see :ref:`text<class_LineEdit_property_text>`).
----
.. _class_LineEdit_property_right_icon:
- :ref:`Texture<class_Texture>` **right_icon**
@@ -379,6 +405,8 @@ Text shown when the ``LineEdit`` is empty. It is **not** the ``LineEdit``'s defa
Sets the icon that will appear in the right end of the ``LineEdit`` if there's no :ref:`text<class_LineEdit_property_text>`, or always, if :ref:`clear_button_enabled<class_LineEdit_property_clear_button_enabled>` is set to ``false``.
----
.. _class_LineEdit_property_secret:
- :ref:`bool<class_bool>` **secret**
@@ -393,6 +421,8 @@ Sets the icon that will appear in the right end of the ``LineEdit`` if there's n
If ``true``, every character is replaced with the secret character (see :ref:`secret_character<class_LineEdit_property_secret_character>`).
----
.. _class_LineEdit_property_secret_character:
- :ref:`String<class_String>` **secret_character**
@@ -407,6 +437,8 @@ If ``true``, every character is replaced with the secret character (see :ref:`se
The character to use to mask secret input (defaults to "\*"). Only a single character can be used as the secret character.
----
.. _class_LineEdit_property_selecting_enabled:
- :ref:`bool<class_bool>` **selecting_enabled**
@@ -419,6 +451,8 @@ The character to use to mask secret input (defaults to "\*"). Only a single char
| *Getter* | is_selecting_enabled() |
+-----------+------------------------------+
----
.. _class_LineEdit_property_shortcut_keys_enabled:
- :ref:`bool<class_bool>` **shortcut_keys_enabled**
@@ -431,6 +465,8 @@ The character to use to mask secret input (defaults to "\*"). Only a single char
| *Getter* | is_shortcut_keys_enabled() |
+-----------+----------------------------------+
----
.. _class_LineEdit_property_text:
- :ref:`String<class_String>` **text**
@@ -454,30 +490,40 @@ Method Descriptions
Adds ``text`` after the cursor. If the resulting value is longer than :ref:`max_length<class_LineEdit_property_max_length>`, nothing happens.
----
.. _class_LineEdit_method_clear:
- void **clear** **(** **)**
Erases the ``LineEdit`` text.
----
.. _class_LineEdit_method_deselect:
- void **deselect** **(** **)**
Clears the current selection.
----
.. _class_LineEdit_method_get_menu:
- :ref:`PopupMenu<class_PopupMenu>` **get_menu** **(** **)** const
Returns the :ref:`PopupMenu<class_PopupMenu>` of this ``LineEdit``. By default, this menu is displayed when right-clicking on the ``LineEdit``.
----
.. _class_LineEdit_method_menu_option:
- void **menu_option** **(** :ref:`int<class_int>` option **)**
Executes a given action as defined in the``MENU_*`` enum.
----
.. _class_LineEdit_method_select:
- void **select** **(** :ref:`int<class_int>` from=0, :ref:`int<class_int>` to=-1 **)**
@@ -491,6 +537,8 @@ Selects characters inside ``LineEdit`` between ``from`` and ``to``. By default,
select(4) # Will select "ome"
select(2, 5) # Will select "lco"
----
.. _class_LineEdit_method_select_all:
- void **select_all** **(** **)**