summaryrefslogtreecommitdiff
path: root/doc/classes/RegExMatch.xml
blob: 9e021ed6c8dcc97007a2db2f876cde23a6636ae1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RegExMatch" inherits="Reference" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
	</brief_description>
	<description>
	</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 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 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 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>
			</description>
		</method>
		<method name="get_subject" qualifiers="const">
			<return type="String">
			</return>
			<description>
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>