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

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

eric ide

mercurial