|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.Plugins.PluginWizardPyRegExp</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Plugins.PluginWizardPyRegExp</h1> |
|
12 <p> |
|
13 Module implementing the Python re wizard plugin. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <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> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#PyRegExpWizard">PyRegExpWizard</a></td> |
|
23 <td>Class implementing the Python re wizard plugin.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="PyRegExpWizard" ID="PyRegExpWizard"></a> |
|
32 <h2>PyRegExpWizard</h2> |
|
33 <p> |
|
34 Class implementing the Python re wizard plugin. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QObject |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#PyRegExpWizard.__init__">PyRegExpWizard</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#PyRegExpWizard.__callForm">__callForm</a></td> |
|
49 <td>Private method to display a dialog and get the code.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#PyRegExpWizard.__handle">__handle</a></td> |
|
52 <td>Private method to handle the wizards action</td> |
|
53 </tr><tr> |
|
54 <td><a href="#PyRegExpWizard.__initAction">__initAction</a></td> |
|
55 <td>Private method to initialize the action.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#PyRegExpWizard.__initMenu">__initMenu</a></td> |
|
58 <td>Private method to add the actions to the right menu.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#PyRegExpWizard.activate">activate</a></td> |
|
61 <td>Public method to activate this plugin.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#PyRegExpWizard.deactivate">deactivate</a></td> |
|
64 <td>Public method to deactivate this plugin.</td> |
|
65 </tr> |
|
66 </table> |
|
67 <a NAME="PyRegExpWizard.__init__" ID="PyRegExpWizard.__init__"></a> |
|
68 <h4>PyRegExpWizard (Constructor)</h4> |
|
69 <b>PyRegExpWizard</b>(<i>ui</i>) |
|
70 <p> |
|
71 Constructor |
|
72 </p><dl> |
|
73 <dt><i>ui</i></dt> |
|
74 <dd> |
|
75 reference to the user interface object (UI.UserInterface) |
|
76 </dd> |
|
77 </dl><a NAME="PyRegExpWizard.__callForm" ID="PyRegExpWizard.__callForm"></a> |
|
78 <h4>PyRegExpWizard.__callForm</h4> |
|
79 <b>__callForm</b>(<i>editor</i>) |
|
80 <p> |
|
81 Private method to display a dialog and get the code. |
|
82 </p><dl> |
|
83 <dt><i>editor</i></dt> |
|
84 <dd> |
|
85 reference to the current editor |
|
86 </dd> |
|
87 </dl><dl> |
|
88 <dt>Returns:</dt> |
|
89 <dd> |
|
90 the generated code (string) |
|
91 </dd> |
|
92 </dl><a NAME="PyRegExpWizard.__handle" ID="PyRegExpWizard.__handle"></a> |
|
93 <h4>PyRegExpWizard.__handle</h4> |
|
94 <b>__handle</b>(<i></i>) |
|
95 <p> |
|
96 Private method to handle the wizards action |
|
97 </p><a NAME="PyRegExpWizard.__initAction" ID="PyRegExpWizard.__initAction"></a> |
|
98 <h4>PyRegExpWizard.__initAction</h4> |
|
99 <b>__initAction</b>(<i></i>) |
|
100 <p> |
|
101 Private method to initialize the action. |
|
102 </p><a NAME="PyRegExpWizard.__initMenu" ID="PyRegExpWizard.__initMenu"></a> |
|
103 <h4>PyRegExpWizard.__initMenu</h4> |
|
104 <b>__initMenu</b>(<i></i>) |
|
105 <p> |
|
106 Private method to add the actions to the right menu. |
|
107 </p><a NAME="PyRegExpWizard.activate" ID="PyRegExpWizard.activate"></a> |
|
108 <h4>PyRegExpWizard.activate</h4> |
|
109 <b>activate</b>(<i></i>) |
|
110 <p> |
|
111 Public method to activate this plugin. |
|
112 </p><dl> |
|
113 <dt>Returns:</dt> |
|
114 <dd> |
|
115 tuple of None and activation status (boolean) |
|
116 </dd> |
|
117 </dl><a NAME="PyRegExpWizard.deactivate" ID="PyRegExpWizard.deactivate"></a> |
|
118 <h4>PyRegExpWizard.deactivate</h4> |
|
119 <b>deactivate</b>(<i></i>) |
|
120 <p> |
|
121 Public method to deactivate this plugin. |
|
122 </p> |
|
123 <div align="right"><a href="#top">Up</a></div> |
|
124 <hr /> |
|
125 </body></html> |