Git commit 2b83b782229a5a9605879a5b4bcb682a50d21827 by Christoph Cullmann, on behalf of Pablo Rauzy. Committed on 08/08/2022 at 11:23. Pushed by cullmann into branch 'master'.
add documentation for view.searchText This adds the documentation for `view.searchText` from JS in KTextEditor added there in frameworks/ktexteditor!394. M +17 -0 doc/katepart/development.docbook https://invent.kde.org/utilities/kate/commit/2b83b782229a5a9605879a5b4bcb682a50d21827 diff --git a/doc/katepart/development.docbook b/doc/katepart/development.docbook index 9cfd2774f..600502a0f 100644 --- a/doc/katepart/development.docbook +++ b/doc/katepart/development.docbook @@ -3541,6 +3541,23 @@ In case of an error, the string <replaceable>object.status</replaceable> contain </listitem> </varlistentry> +<varlistentry> +<term><synopsis> +Range view.searchText(<parameter>Range <replaceable>range</replaceable></parameter>, + <parameter>String <replaceable>pattern</replaceable></parameter>, + <parameter>bool <replaceable>backwards</replaceable> = false</parameter>); +</synopsis></term> +<listitem><para> +Search for the first occurrence of <replaceable>pattern</replaceable> in <replaceable>range</replaceable> and returns the matched range. +Search is performed backwards if the optional boolean parameter <replaceable>backwards</replaceable> is set to <literal>true</literal>. +</para> +<para> +The returned range is invalid (see Range.isValid()) if <replaceable>pattern</replaceable> is not found in <replaceable>range</replaceable>. +</para> +<para>Since: &kde-frameworks; 5.97</para> +</listitem> +</varlistentry> + </variablelist> </para> </sect3>
