:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the TLRichTextEditSelection.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_TLRichTextEditSelection:

TLRichTextEditSelection
=======================

**Inherits:** 

**Category:** Core

Brief Description
-----------------

Selection and caret info of the :ref:`TLRichTextEdit<class_TLRichTextEdit>`

Properties
----------

+-----+--------------------------------------------------------------------------+---+
| int | :ref:`caret_offset<class_TLRichTextEditSelection_property_caret_offset>` | 0 |
+-----+--------------------------------------------------------------------------+---+
| int | :ref:`caret_para<class_TLRichTextEditSelection_property_caret_para>`     | 0 |
+-----+--------------------------------------------------------------------------+---+
| int | :ref:`end_offset<class_TLRichTextEditSelection_property_end_offset>`     | 0 |
+-----+--------------------------------------------------------------------------+---+
| int | :ref:`end_para<class_TLRichTextEditSelection_property_end_para>`         | 0 |
+-----+--------------------------------------------------------------------------+---+
| int | :ref:`start_offset<class_TLRichTextEditSelection_property_start_offset>` | 0 |
+-----+--------------------------------------------------------------------------+---+
| int | :ref:`start_para<class_TLRichTextEditSelection_property_start_para>`     | 0 |
+-----+--------------------------------------------------------------------------+---+

Signals
-------

.. _class_TLRichTextEditSelection_signal_selection_changed:

- **selection_changed** **(** **)**

Emitted when selection range is changed or caret moved.

Property Descriptions
---------------------

.. _class_TLRichTextEditSelection_property_caret_offset:

- int **caret_offset**

.. table::
   :class: longtable
   :widths: 7 20

   +-----------+-------------------------+
   | *Default* | 0                       |
   +-----------+-------------------------+
   | *Setter*  | set_caret_offset(value) |
   +-----------+-------------------------+
   | *Getter*  | get_caret_offset()      |
   +-----------+-------------------------+

Caret position in the paragraph :ref:`caret_para<class_TLRichTextEditSelection_property_caret_para>`.

----

.. _class_TLRichTextEditSelection_property_caret_para:

- int **caret_para**

.. table::
   :class: longtable
   :widths: 7 20

   +-----------+-----------------------+
   | *Default* | 0                     |
   +-----------+-----------------------+
   | *Setter*  | set_caret_para(value) |
   +-----------+-----------------------+
   | *Getter*  | get_caret_para()      |
   +-----------+-----------------------+

Paragraph where caret currently is in.

----

.. _class_TLRichTextEditSelection_property_end_offset:

- int **end_offset**

.. table::
   :class: longtable
   :widths: 7 20

   +-----------+-----------------------+
   | *Default* | 0                     |
   +-----------+-----------------------+
   | *Setter*  | set_end_offset(value) |
   +-----------+-----------------------+
   | *Getter*  | get_end_offset()      |
   +-----------+-----------------------+

Offset of the end of selection in the paragraph :ref:`end_para<class_TLRichTextEditSelection_property_end_para>`.

----

.. _class_TLRichTextEditSelection_property_end_para:

- int **end_para**

.. table::
   :class: longtable
   :widths: 7 20

   +-----------+---------------------+
   | *Default* | 0                   |
   +-----------+---------------------+
   | *Setter*  | set_end_para(value) |
   +-----------+---------------------+
   | *Getter*  | get_end_para()      |
   +-----------+---------------------+

Last paragraph in the selection.

----

.. _class_TLRichTextEditSelection_property_start_offset:

- int **start_offset**

.. table::
   :class: longtable
   :widths: 7 20

   +-----------+-------------------------+
   | *Default* | 0                       |
   +-----------+-------------------------+
   | *Setter*  | set_start_offset(value) |
   +-----------+-------------------------+
   | *Getter*  | get_start_offset()      |
   +-----------+-------------------------+

Offset of the start of selection in the paragraph :ref:`start_para<class_TLRichTextEditSelection_property_start_para>`.

----

.. _class_TLRichTextEditSelection_property_start_para:

- int **start_para**

.. table::
   :class: longtable
   :widths: 7 20

   +-----------+-----------------------+
   | *Default* | 0                     |
   +-----------+-----------------------+
   | *Setter*  | set_start_para(value) |
   +-----------+-----------------------+
   | *Getter*  | get_start_para()      |
   +-----------+-----------------------+

First paragraph in the selection.

