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