sascha
/
godot
mirror of https://github.com/godotengine/godot.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #98423 from Calinou/doc-textedit-is-caret-visible 

Clarify `TextEdit.is_caret_visible()` behavior in the class reference
pull/98343/head
Thaddeus Crews 2024-11-12 09:28:14 +07:00
parent 686b1c4d98 2cd007fa4a
commit ab5a539549
No known key found for this signature in database
GPG Key ID: 62181B86FE9E5D84
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/TextEdit.xml
Unescape Escape View File

@ -763,7 +763,8 @@
<return type="bool" /> <return type="bool" />
<param index="0" name="caret_index" type="int" default="0" /> <param index="0" name="caret_index" type="int" default="0" />
<description> <description>
Returns [code]true[/code] if the caret is visible on the screen. Returns [code]true[/code] if the caret is visible, [code]false[/code] otherwise. A caret will be considered hidden if it is outside the scrollable area when scrolling is enabled.
[b]Note:[/b] [method is_caret_visible] does not account for a caret being off-screen if it is still within the scrollable area. It will return [code]true[/code] even if the caret is off-screen as long as it meets [TextEdit]'s own conditions for being visible. This includes uses of [member scroll_fit_content_width] and [member scroll_fit_content_height] that cause the [TextEdit] to expand beyond the viewport's bounds.
</description> </description>
</method> </method>
<method name="is_dragging_cursor" qualifiers="const"> <method name="is_dragging_cursor" qualifiers="const">