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

classref: Sync with current master branch (8e951fd)

Browse Source
This commit is contained in:
Godot Organization
2024-03-01 16:12:44 +00:00
parent 7030ad20e2
commit 045efee3ee
54 changed files with 1916 additions and 374 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
classes/class_textedit.rst
View File

@@ -429,7 +429,7 @@ Theme Properties
+-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_color<class_TextEdit_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_TextEdit_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_TextEdit_theme_color_font_outline_color>` | ``Color(0, 0, 0, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+
| :ref:`Color<class_Color>` | :ref:`font_placeholder_color<class_TextEdit_theme_color_font_placeholder_color>` | ``Color(0.875, 0.875, 0.875, 0.6)`` |
+-----------------------------------+------------------------------------------------------------------------------------------+-------------------------------------+
@@ -1014,7 +1014,7 @@ enum **GutterType**:
:ref:`GutterType<enum_TextEdit_GutterType>` **GUTTER_TYPE_STRING** = ``0``
Draw a string.
When a gutter is set to string using :ref:`set_gutter_type<class_TextEdit_method_set_gutter_type>`, it is used to contain text set via the :ref:`set_line_gutter_text<class_TextEdit_method_set_line_gutter_text>` method.
.. _class_TextEdit_constant_GUTTER_TYPE_ICON:
@@ -1022,7 +1022,7 @@ Draw a string.
:ref:`GutterType<enum_TextEdit_GutterType>` **GUTTER_TYPE_ICON** = ``1``
Draw an icon.
When a gutter is set to icon using :ref:`set_gutter_type<class_TextEdit_method_set_gutter_type>`, it is used to contain an icon set via the :ref:`set_line_gutter_icon<class_TextEdit_method_set_line_gutter_icon>` method.
.. _class_TextEdit_constant_GUTTER_TYPE_CUSTOM:
@@ -1030,7 +1030,7 @@ Draw an icon.
:ref:`GutterType<enum_TextEdit_GutterType>` **GUTTER_TYPE_CUSTOM** = ``2``
Custom draw.
When a gutter is set to custom using :ref:`set_gutter_type<class_TextEdit_method_set_gutter_type>`, it is used to contain custom visuals controlled by a callback method set via the :ref:`set_gutter_custom_draw<class_TextEdit_method_set_gutter_custom_draw>` method.
.. rst-class:: classref-section-separator
@@ -2111,7 +2111,7 @@ Returns the name of the gutter at the given index.
:ref:`GutterType<enum_TextEdit_GutterType>` **get_gutter_type**\ (\ gutter\: :ref:`int<class_int>`\ ) |const|
Returns the type of the gutter at the given index.
Returns the type of the gutter at the given index. Gutters can contain icons, text, or custom visuals. See :ref:`GutterType<enum_TextEdit_GutterType>` for options.
.. rst-class:: classref-item-separator
@@ -2243,7 +2243,7 @@ Returns the number of lines in the text.
:ref:`Texture2D<class_Texture2D>` **get_line_gutter_icon**\ (\ line\: :ref:`int<class_int>`, gutter\: :ref:`int<class_int>`\ ) |const|
Returns the icon currently in ``gutter`` at ``line``.
Returns the icon currently in ``gutter`` at ``line``. This only works when the gutter type is :ref:`GUTTER_TYPE_ICON<class_TextEdit_constant_GUTTER_TYPE_ICON>` (see :ref:`set_gutter_type<class_TextEdit_method_set_gutter_type>`).
.. rst-class:: classref-item-separator
@@ -2279,7 +2279,7 @@ Returns the metadata currently in ``gutter`` at ``line``.
:ref:`String<class_String>` **get_line_gutter_text**\ (\ line\: :ref:`int<class_int>`, gutter\: :ref:`int<class_int>`\ ) |const|
Returns the text currently in ``gutter`` at ``line``.
Returns the text currently in ``gutter`` at ``line``. This only works when the gutter type is :ref:`GUTTER_TYPE_STRING<class_TextEdit_constant_GUTTER_TYPE_STRING>` (see :ref:`set_gutter_type<class_TextEdit_method_set_gutter_type>`).
.. rst-class:: classref-item-separator
@@ -3169,7 +3169,7 @@ Sets the gutter as clickable. This will change the mouse cursor to a pointing ha
|void| **set_gutter_custom_draw**\ (\ column\: :ref:`int<class_int>`, draw_callback\: :ref:`Callable<class_Callable>`\ )
Set a custom draw method for the gutter. The callback method must take the following args: ``line: int, gutter: int, Area: Rect2``.
Set a custom draw method for the gutter. The callback method must take the following args: ``line: int, gutter: int, Area: Rect2``. This only works when the gutter type is :ref:`GUTTER_TYPE_CUSTOM<class_TextEdit_constant_GUTTER_TYPE_CUSTOM>` (see :ref:`set_gutter_type<class_TextEdit_method_set_gutter_type>`).
.. rst-class:: classref-item-separator
@@ -3217,7 +3217,7 @@ Sets the gutter to overwritable. See :ref:`merge_gutters<class_TextEdit_method_m
|void| **set_gutter_type**\ (\ gutter\: :ref:`int<class_int>`, type\: :ref:`GutterType<enum_TextEdit_GutterType>`\ )
Sets the type of gutter.
Sets the type of gutter. Gutters can contain icons, text, or custom visuals. See :ref:`GutterType<enum_TextEdit_GutterType>` for options.
.. rst-class:: classref-item-separator
@@ -3313,7 +3313,7 @@ If ``clickable`` is ``true``, makes the ``gutter`` on ``line`` clickable. See :r
|void| **set_line_gutter_icon**\ (\ line\: :ref:`int<class_int>`, gutter\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ )
Sets the icon for ``gutter`` on ``line`` to ``icon``.
Sets the icon for ``gutter`` on ``line`` to ``icon``. This only works when the gutter type is :ref:`GUTTER_TYPE_ICON<class_TextEdit_constant_GUTTER_TYPE_ICON>` (see :ref:`set_gutter_type<class_TextEdit_method_set_gutter_type>`).
.. rst-class:: classref-item-separator
@@ -3349,7 +3349,7 @@ Sets the metadata for ``gutter`` on ``line`` to ``metadata``.
|void| **set_line_gutter_text**\ (\ line\: :ref:`int<class_int>`, gutter\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ )
Sets the text for ``gutter`` on ``line`` to ``text``.
Sets the text for ``gutter`` on ``line`` to ``text``. This only works when the gutter type is :ref:`GUTTER_TYPE_STRING<class_TextEdit_constant_GUTTER_TYPE_STRING>` (see :ref:`set_gutter_type<class_TextEdit_method_set_gutter_type>`).
.. rst-class:: classref-item-separator
@@ -3546,7 +3546,7 @@ Sets the font :ref:`Color<class_Color>`.
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_outline_color** = ``Color(1, 1, 1, 1)``
:ref:`Color<class_Color>` **font_outline_color** = ``Color(0, 0, 0, 1)``
The tint of text outline of the **TextEdit**.