summaryrefslogtreecommitdiff
path: root/doc/classes/TextEdit.xml
diff options
context:
space:
mode:
authorPaulb23 <p_batty@hotmail.co.uk>2021-07-09 17:27:09 +0100
committerPaulb23 <p_batty@hotmail.co.uk>2021-08-12 09:29:58 +0100
commit0a32a6907b4c6801e0b9d22057863c01fd25a3cd (patch)
tree0c6e91bcf5886acc2a87c0ba88d3702cdc7f3b7e /doc/classes/TextEdit.xml
parent7dbb0f32333a2bb2c856e17cc1cc69a91fbf1fa3 (diff)
Cleanup and expose viewport / scrolling methods
Diffstat (limited to 'doc/classes/TextEdit.xml')
-rw-r--r--doc/classes/TextEdit.xml102
1 files changed, 96 insertions, 6 deletions
diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml
index 00c4c170db..c89748f323 100644
--- a/doc/classes/TextEdit.xml
+++ b/doc/classes/TextEdit.xml
@@ -50,6 +50,13 @@
<description>
</description>
</method>
+ <method name="adjust_viewport_to_caret">
+ <return type="void">
+ </return>
+ <description>
+ Adjust the viewport so the caret is visible.
+ </description>
+ </method>
<method name="backspace">
<return type="void" />
<description>
@@ -135,6 +142,13 @@
<description>
</description>
</method>
+ <method name="get_first_visible_line" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ Returns the first visible line.
+ </description>
+ </method>
<method name="get_gutter_count" qualifiers="const">
<return type="int" />
<description>
@@ -165,6 +179,20 @@
Returns the indent level of a specific line.
</description>
</method>
+ <method name="get_last_full_visible_line" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ Return the last visible line. Use [method get_last_full_visible_line_wrap_index] for the wrap index.
+ </description>
+ </method>
+ <method name="get_last_full_visible_line_wrap_index" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ Returns the last visible wrap index of the last visible line.
+ </description>
+ </method>
<method name="get_line" qualifiers="const">
<return type="String" />
<argument index="0" name="line" type="int" />
@@ -248,6 +276,13 @@
Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit].
</description>
</method>
+ <method name="get_minimap_visible_lines" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ Gets the total amount of lines that can be draw on the minimap.
+ </description>
+ </method>
<method name="get_opentype_feature" qualifiers="const">
<return type="int" />
<argument index="0" name="tag" type="String" />
@@ -255,6 +290,24 @@
Returns OpenType feature [code]tag[/code].
</description>
</method>
+ <method name="get_scroll_pos_for_line" qualifiers="const">
+ <return type="float">
+ </return>
+ <argument index="0" name="line" type="int">
+ </argument>
+ <argument index="1" name="wrap_index" type="int" default="0">
+ </argument>
+ <description>
+ Gets the scroll position for [code]wrap_index[/code] of [code]line[/code].
+ </description>
+ </method>
+ <method name="get_selected_text" qualifiers="const">
+ <return type="String">
+ </return>
+ <description>
+ Returns the text inside the selection.
+ </description>
+ </method>
<method name="get_selection_column" qualifiers="const">
<return type="int" />
<description>
@@ -282,12 +335,6 @@
<description>
</description>
</method>
- <method name="get_selection_text" qualifiers="const">
- <return type="String" />
- <description>
- Returns the text inside the selection.
- </description>
- </method>
<method name="get_selection_to_column" qualifiers="const">
<return type="int" />
<description>
@@ -311,6 +358,13 @@
<description>
</description>
</method>
+ <method name="get_total_visible_line_count" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ Gets the total amount of lines that could be draw.
+ </description>
+ </method>
<method name="get_visible_line_count" qualifiers="const">
<return type="int" />
<description>
@@ -571,6 +625,39 @@
Sets the text for a specific line.
</description>
</method>
+ <method name="set_line_as_center_visible">
+ <return type="void">
+ </return>
+ <argument index="0" name="line" type="int">
+ </argument>
+ <argument index="1" name="wrap_index" type="int" default="0">
+ </argument>
+ <description>
+ Positions the [code]wrap_index[/code] of [code]line[/code] at the center of the viewport.
+ </description>
+ </method>
+ <method name="set_line_as_first_visible">
+ <return type="void">
+ </return>
+ <argument index="0" name="line" type="int">
+ </argument>
+ <argument index="1" name="wrap_index" type="int" default="0">
+ </argument>
+ <description>
+ Positions the [code]wrap_index[/code] of [code]line[/code] at the top of the viewport.
+ </description>
+ </method>
+ <method name="set_line_as_last_visible">
+ <return type="void">
+ </return>
+ <argument index="0" name="line" type="int">
+ </argument>
+ <argument index="1" name="wrap_index" type="int" default="0">
+ </argument>
+ <description>
+ Positions the [code]wrap_index[/code] of [code]line[/code] at the bottom of the viewport.
+ </description>
+ </method>
<method name="set_line_background_color">
<return type="void" />
<argument index="0" name="line" type="int" />
@@ -714,6 +801,9 @@
<member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll" default="0">
If there is a horizontal scrollbar, this determines the current horizontal scroll value in pixels.
</member>
+ <member name="scroll_past_end_of_file" type="bool" setter="set_scroll_past_end_of_file_enabled" getter="is_scroll_past_end_of_file_enabled" default="false">
+ Allow scrolling past the last line into "virtual" space.
+ </member>
<member name="scroll_vertical" type="float" setter="set_v_scroll" getter="get_v_scroll" default="0.0">
If there is a vertical scrollbar, this determines the current vertical scroll value in line numbers, starting at 0 for the top line.
</member>