f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
56 lines
2.8 KiB
XML
56 lines
2.8 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="RegExMatch" inherits="Reference" version="3.4">
|
|
<brief_description>
|
|
Contains the results of a [RegEx] search.
|
|
</brief_description>
|
|
<description>
|
|
Contains the results of a single [RegEx] match returned by [method RegEx.search] and [method RegEx.search_all]. It can be used to find the position and range of the match and its capturing groups, and it can extract its substring for you.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_end" qualifiers="const">
|
|
<return type="int" />
|
|
<argument index="0" name="name" type="Variant" default="0" />
|
|
<description>
|
|
Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.
|
|
Returns -1 if the group did not match or doesn't exist.
|
|
</description>
|
|
</method>
|
|
<method name="get_group_count" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the number of capturing groups.
|
|
</description>
|
|
</method>
|
|
<method name="get_start" qualifiers="const">
|
|
<return type="int" />
|
|
<argument index="0" name="name" type="Variant" default="0" />
|
|
<description>
|
|
Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.
|
|
Returns -1 if the group did not match or doesn't exist.
|
|
</description>
|
|
</method>
|
|
<method name="get_string" qualifiers="const">
|
|
<return type="String" />
|
|
<argument index="0" name="name" type="Variant" default="0" />
|
|
<description>
|
|
Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.
|
|
Returns an empty string if the group did not match or doesn't exist.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="names" type="Dictionary" setter="" getter="get_names" default="{}">
|
|
A dictionary of named groups and its corresponding group number. Only groups that were matched are included. If multiple groups have the same name, that name would refer to the first matching one.
|
|
</member>
|
|
<member name="strings" type="Array" setter="" getter="get_strings" default="[ ]">
|
|
An [Array] of the match and its capturing groups.
|
|
</member>
|
|
<member name="subject" type="String" setter="" getter="get_subject" default="""">
|
|
The source string used with the search pattern to find this matching result.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|