src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10437
2f70ca07f0af
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer</h1>
10
11 <p>
12 Module implementing the PyQt6 server part of the QRegularExpression wizzard.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22 <tr><td>None</td></tr>
23 </table>
24 <h3>Functions</h3>
25
26 <table>
27
28 <tr>
29 <td><a href="#main">main</a></td>
30 <td>Function containing the main routine.</td>
31 </tr>
32 <tr>
33 <td><a href="#rxExecute">rxExecute</a></td>
34 <td>Function to execute the given regular expression for a given text.</td>
35 </tr>
36 <tr>
37 <td><a href="#rxValidate">rxValidate</a></td>
38 <td>Function to validate the given regular expression.</td>
39 </tr>
40 </table>
41 <hr />
42 <hr />
43 <a NAME="main" ID="main"></a>
44 <h2>main</h2>
45 <b>main</b>(<i></i>)
46
47 <p>
48 Function containing the main routine.
49 </p>
50 <div align="right"><a href="#top">Up</a></div>
51 <hr />
52 <hr />
53 <a NAME="rxExecute" ID="rxExecute"></a>
54 <h2>rxExecute</h2>
55 <b>rxExecute</b>(<i>regexp, options, text, startpos</i>)
56
57 <p>
58 Function to execute the given regular expression for a given text.
59 </p>
60 <dl>
61
62 <dt><i>regexp</i></dt>
63 <dd>
64 regular expression to validate (string)
65 </dd>
66 <dt><i>options</i></dt>
67 <dd>
68 list of options (list of string)
69 </dd>
70 <dt><i>text</i></dt>
71 <dd>
72 text to execute on (string)
73 </dd>
74 <dt><i>startpos</i></dt>
75 <dd>
76 start position for the execution (integer)
77 </dd>
78 </dl>
79 <dl>
80 <dt>Return:</dt>
81 <dd>
82 tuple of a flag indicating a successful match (boolean) and
83 a list of captures containing the complete match as matched string
84 (string), match start (integer), match end (integer) and match length
85 (integer) for each entry
86 </dd>
87 </dl>
88 <div align="right"><a href="#top">Up</a></div>
89 <hr />
90 <hr />
91 <a NAME="rxValidate" ID="rxValidate"></a>
92 <h2>rxValidate</h2>
93 <b>rxValidate</b>(<i>regexp, options</i>)
94
95 <p>
96 Function to validate the given regular expression.
97 </p>
98 <dl>
99
100 <dt><i>regexp</i></dt>
101 <dd>
102 regular expression to validate (string)
103 </dd>
104 <dt><i>options</i></dt>
105 <dd>
106 list of options (list of string)
107 </dd>
108 </dl>
109 <dl>
110 <dt>Return:</dt>
111 <dd>
112 tuple of flag indicating validity (boolean), error
113 string (string) and error offset (integer)
114 </dd>
115 </dl>
116 <div align="right"><a href="#top">Up</a></div>
117 <hr />
118 </body></html>

eric ide

mercurial