72 lines
2.6 KiB
XML
72 lines
2.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="RegExMatch" inherits="Reference" category="Core" version="3.0.alpha.custom_build">
|
|
<brief_description>
|
|
Contains the results of a regex search.
|
|
</brief_description>
|
|
<description>
|
|
Contains the results of a regex search. [method RegEx.search] returns an instance of [code]RegExMatch[/code] if it finds the search pattern in the [source] string.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="get_end" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<argument index="0" name="name" type="Variant" default="0">
|
|
</argument>
|
|
<description>
|
|
Returns the end position of the match in the [source] string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
|
|
</description>
|
|
</method>
|
|
<method name="get_group_count" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
Returns the number of numeric capturing groups.
|
|
</description>
|
|
</method>
|
|
<method name="get_names" qualifiers="const">
|
|
<return type="Dictionary">
|
|
</return>
|
|
<description>
|
|
Returns an array of names of named capturing groups.
|
|
</description>
|
|
</method>
|
|
<method name="get_start" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<argument index="0" name="name" type="Variant" default="0">
|
|
</argument>
|
|
<description>
|
|
Returns the starting position of the match in the [source] string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
|
|
</description>
|
|
</method>
|
|
<method name="get_string" qualifiers="const">
|
|
<return type="String">
|
|
</return>
|
|
<argument index="0" name="name" type="Variant" default="0">
|
|
</argument>
|
|
<description>
|
|
Returns the result of the match in the [source] string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern).
|
|
</description>
|
|
</method>
|
|
<method name="get_strings" qualifiers="const">
|
|
<return type="Array">
|
|
</return>
|
|
<description>
|
|
Returns an [Array] of the matches in the [source] string.
|
|
</description>
|
|
</method>
|
|
<method name="get_subject" qualifiers="const">
|
|
<return type="String">
|
|
</return>
|
|
<description>
|
|
Returns the [source] string used with the search pattern to find this matching result.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|