|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric5.Plugins.PluginWizardQRegularExpression</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><a NAME="top" ID="top"></a> |
|
22 <h1>eric5.Plugins.PluginWizardQRegularExpression</h1> |
|
23 <p> |
|
24 Module implementing the QRegularExpression wizard plugin. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#QRegularExpressionWizard">QRegularExpressionWizard</a></td> |
|
34 <td>Class implementing the QRegularExpression wizard plugin.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="QRegularExpressionWizard" ID="QRegularExpressionWizard"></a> |
|
43 <h2>QRegularExpressionWizard</h2> |
|
44 <p> |
|
45 Class implementing the QRegularExpression wizard plugin. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QObject |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#QRegularExpressionWizard.__init__">QRegularExpressionWizard</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#QRegularExpressionWizard.__callForm">__callForm</a></td> |
|
64 <td>Private method to display a dialog and get the code.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#QRegularExpressionWizard.__handle">__handle</a></td> |
|
67 <td>Private method to handle the wizards action</td> |
|
68 </tr><tr> |
|
69 <td><a href="#QRegularExpressionWizard.__initAction">__initAction</a></td> |
|
70 <td>Private method to initialize the action.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#QRegularExpressionWizard.__initMenu">__initMenu</a></td> |
|
73 <td>Private method to add the actions to the right menu.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#QRegularExpressionWizard.activate">activate</a></td> |
|
76 <td>Public method to activate this plugin.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#QRegularExpressionWizard.deactivate">deactivate</a></td> |
|
79 <td>Public method to deactivate this plugin.</td> |
|
80 </tr> |
|
81 </table> |
|
82 <h3>Static Methods</h3> |
|
83 <table> |
|
84 <tr><td>None</td></tr> |
|
85 </table> |
|
86 <a NAME="QRegularExpressionWizard.__init__" ID="QRegularExpressionWizard.__init__"></a> |
|
87 <h4>QRegularExpressionWizard (Constructor)</h4> |
|
88 <b>QRegularExpressionWizard</b>(<i>ui</i>) |
|
89 <p> |
|
90 Constructor |
|
91 </p><dl> |
|
92 <dt><i>ui</i></dt> |
|
93 <dd> |
|
94 reference to the user interface object (UI.UserInterface) |
|
95 </dd> |
|
96 </dl><a NAME="QRegularExpressionWizard.__callForm" ID="QRegularExpressionWizard.__callForm"></a> |
|
97 <h4>QRegularExpressionWizard.__callForm</h4> |
|
98 <b>__callForm</b>(<i>editor</i>) |
|
99 <p> |
|
100 Private method to display a dialog and get the code. |
|
101 </p><dl> |
|
102 <dt><i>editor</i></dt> |
|
103 <dd> |
|
104 reference to the current editor |
|
105 </dd> |
|
106 </dl><dl> |
|
107 <dt>Returns:</dt> |
|
108 <dd> |
|
109 the generated code (string) |
|
110 </dd> |
|
111 </dl><a NAME="QRegularExpressionWizard.__handle" ID="QRegularExpressionWizard.__handle"></a> |
|
112 <h4>QRegularExpressionWizard.__handle</h4> |
|
113 <b>__handle</b>(<i></i>) |
|
114 <p> |
|
115 Private method to handle the wizards action |
|
116 </p><a NAME="QRegularExpressionWizard.__initAction" ID="QRegularExpressionWizard.__initAction"></a> |
|
117 <h4>QRegularExpressionWizard.__initAction</h4> |
|
118 <b>__initAction</b>(<i></i>) |
|
119 <p> |
|
120 Private method to initialize the action. |
|
121 </p><a NAME="QRegularExpressionWizard.__initMenu" ID="QRegularExpressionWizard.__initMenu"></a> |
|
122 <h4>QRegularExpressionWizard.__initMenu</h4> |
|
123 <b>__initMenu</b>(<i></i>) |
|
124 <p> |
|
125 Private method to add the actions to the right menu. |
|
126 </p><a NAME="QRegularExpressionWizard.activate" ID="QRegularExpressionWizard.activate"></a> |
|
127 <h4>QRegularExpressionWizard.activate</h4> |
|
128 <b>activate</b>(<i></i>) |
|
129 <p> |
|
130 Public method to activate this plugin. |
|
131 </p><dl> |
|
132 <dt>Returns:</dt> |
|
133 <dd> |
|
134 tuple of None and activation status (boolean) |
|
135 </dd> |
|
136 </dl><a NAME="QRegularExpressionWizard.deactivate" ID="QRegularExpressionWizard.deactivate"></a> |
|
137 <h4>QRegularExpressionWizard.deactivate</h4> |
|
138 <b>deactivate</b>(<i></i>) |
|
139 <p> |
|
140 Public method to deactivate this plugin. |
|
141 </p> |
|
142 <div align="right"><a href="#top">Up</a></div> |
|
143 <hr /> |
|
144 </body></html> |