|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.PluginWizardPyRegExp</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.PluginWizardPyRegExp</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing the Python re wizard plugin. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <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> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#PyRegExpWizard">PyRegExpWizard</a></td> |
|
39 <td>Class implementing the Python re wizard plugin.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="PyRegExpWizard" ID="PyRegExpWizard"></a> |
|
50 <h2>PyRegExpWizard</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing the Python re wizard plugin. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 QObject |
|
57 <h3>Class Attributes</h3> |
|
58 |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 |
|
64 <table> |
|
65 <tr><td>None</td></tr> |
|
66 </table> |
|
67 <h3>Methods</h3> |
|
68 |
|
69 <table> |
|
70 |
|
71 <tr> |
|
72 <td><a href="#PyRegExpWizard.__init__">PyRegExpWizard</a></td> |
|
73 <td>Constructor</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#PyRegExpWizard.__callForm">__callForm</a></td> |
|
77 <td>Private method to display a dialog and get the code.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#PyRegExpWizard.__handle">__handle</a></td> |
|
81 <td>Private method to handle the wizards action.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#PyRegExpWizard.__initAction">__initAction</a></td> |
|
85 <td>Private method to initialize the action.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#PyRegExpWizard.__initMenu">__initMenu</a></td> |
|
89 <td>Private method to add the actions to the right menu.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#PyRegExpWizard.activate">activate</a></td> |
|
93 <td>Public method to activate this plugin.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#PyRegExpWizard.deactivate">deactivate</a></td> |
|
97 <td>Public method to deactivate this plugin.</td> |
|
98 </tr> |
|
99 </table> |
|
100 <h3>Static Methods</h3> |
|
101 |
|
102 <table> |
|
103 <tr><td>None</td></tr> |
|
104 </table> |
|
105 |
|
106 <a NAME="PyRegExpWizard.__init__" ID="PyRegExpWizard.__init__"></a> |
|
107 <h4>PyRegExpWizard (Constructor)</h4> |
|
108 <b>PyRegExpWizard</b>(<i>ui</i>) |
|
109 |
|
110 <p> |
|
111 Constructor |
|
112 </p> |
|
113 <dl> |
|
114 |
|
115 <dt><i>ui</i></dt> |
|
116 <dd> |
|
117 reference to the user interface object (UI.UserInterface) |
|
118 </dd> |
|
119 </dl> |
|
120 <a NAME="PyRegExpWizard.__callForm" ID="PyRegExpWizard.__callForm"></a> |
|
121 <h4>PyRegExpWizard.__callForm</h4> |
|
122 <b>__callForm</b>(<i>editor</i>) |
|
123 |
|
124 <p> |
|
125 Private method to display a dialog and get the code. |
|
126 </p> |
|
127 <dl> |
|
128 |
|
129 <dt><i>editor</i></dt> |
|
130 <dd> |
|
131 reference to the current editor |
|
132 </dd> |
|
133 </dl> |
|
134 <dl> |
|
135 <dt>Return:</dt> |
|
136 <dd> |
|
137 the generated code (string) |
|
138 </dd> |
|
139 </dl> |
|
140 <a NAME="PyRegExpWizard.__handle" ID="PyRegExpWizard.__handle"></a> |
|
141 <h4>PyRegExpWizard.__handle</h4> |
|
142 <b>__handle</b>(<i></i>) |
|
143 |
|
144 <p> |
|
145 Private method to handle the wizards action. |
|
146 </p> |
|
147 <a NAME="PyRegExpWizard.__initAction" ID="PyRegExpWizard.__initAction"></a> |
|
148 <h4>PyRegExpWizard.__initAction</h4> |
|
149 <b>__initAction</b>(<i></i>) |
|
150 |
|
151 <p> |
|
152 Private method to initialize the action. |
|
153 </p> |
|
154 <a NAME="PyRegExpWizard.__initMenu" ID="PyRegExpWizard.__initMenu"></a> |
|
155 <h4>PyRegExpWizard.__initMenu</h4> |
|
156 <b>__initMenu</b>(<i></i>) |
|
157 |
|
158 <p> |
|
159 Private method to add the actions to the right menu. |
|
160 </p> |
|
161 <a NAME="PyRegExpWizard.activate" ID="PyRegExpWizard.activate"></a> |
|
162 <h4>PyRegExpWizard.activate</h4> |
|
163 <b>activate</b>(<i></i>) |
|
164 |
|
165 <p> |
|
166 Public method to activate this plugin. |
|
167 </p> |
|
168 <dl> |
|
169 <dt>Return:</dt> |
|
170 <dd> |
|
171 tuple of None and activation status (boolean) |
|
172 </dd> |
|
173 </dl> |
|
174 <a NAME="PyRegExpWizard.deactivate" ID="PyRegExpWizard.deactivate"></a> |
|
175 <h4>PyRegExpWizard.deactivate</h4> |
|
176 <b>deactivate</b>(<i></i>) |
|
177 |
|
178 <p> |
|
179 Public method to deactivate this plugin. |
|
180 </p> |
|
181 <div align="right"><a href="#top">Up</a></div> |
|
182 <hr /> |
|
183 </body></html> |