|
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.PluginWizardE5MessageBox</title> |
|
6 <style> |
|
7 body { |
|
8 background: #EDECE6; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #85774A; } |
|
14 h2 { color: white; background: #85774A; } |
|
15 h3 { color: white; background: #9D936E; } |
|
16 h4 { color: white; background: #9D936E; } |
|
17 |
|
18 a { color: #BA6D36; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.Plugins.PluginWizardE5MessageBox</h1> |
|
24 <p> |
|
25 Module implementing the E5MessageBox wizard plugin. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <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> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#E5MessageBoxWizard">E5MessageBoxWizard</a></td> |
|
35 <td>Class implementing the E5MessageBox wizard plugin.</td> |
|
36 </tr> |
|
37 </table> |
|
38 <h3>Functions</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /><hr /> |
|
43 <a NAME="E5MessageBoxWizard" ID="E5MessageBoxWizard"></a> |
|
44 <h2>E5MessageBoxWizard</h2> |
|
45 <p> |
|
46 Class implementing the E5MessageBox wizard plugin. |
|
47 </p> |
|
48 <h3>Derived from</h3> |
|
49 QObject |
|
50 <h3>Class Attributes</h3> |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Methods</h3> |
|
55 <table> |
|
56 <tr> |
|
57 <td><a href="#E5MessageBoxWizard.__init__">E5MessageBoxWizard</a></td> |
|
58 <td>Constructor</td> |
|
59 </tr><tr> |
|
60 <td><a href="#E5MessageBoxWizard.__callForm">__callForm</a></td> |
|
61 <td>Private method to display a dialog and get the code.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#E5MessageBoxWizard.__handle">__handle</a></td> |
|
64 <td>Private method to handle the wizards action</td> |
|
65 </tr><tr> |
|
66 <td><a href="#E5MessageBoxWizard.__initAction">__initAction</a></td> |
|
67 <td>Private method to initialize the action.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#E5MessageBoxWizard.__initMenu">__initMenu</a></td> |
|
70 <td>Private method to add the actions to the right menu.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#E5MessageBoxWizard.activate">activate</a></td> |
|
73 <td>Public method to activate this plugin.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#E5MessageBoxWizard.deactivate">deactivate</a></td> |
|
76 <td>Public method to deactivate this plugin.</td> |
|
77 </tr> |
|
78 </table> |
|
79 <a NAME="E5MessageBoxWizard.__init__" ID="E5MessageBoxWizard.__init__"></a> |
|
80 <h4>E5MessageBoxWizard (Constructor)</h4> |
|
81 <b>E5MessageBoxWizard</b>(<i>ui</i>) |
|
82 <p> |
|
83 Constructor |
|
84 </p><dl> |
|
85 <dt><i>ui</i></dt> |
|
86 <dd> |
|
87 reference to the user interface object (UI.UserInterface) |
|
88 </dd> |
|
89 </dl><a NAME="E5MessageBoxWizard.__callForm" ID="E5MessageBoxWizard.__callForm"></a> |
|
90 <h4>E5MessageBoxWizard.__callForm</h4> |
|
91 <b>__callForm</b>(<i>editor</i>) |
|
92 <p> |
|
93 Private method to display a dialog and get the code. |
|
94 </p><dl> |
|
95 <dt><i>editor</i></dt> |
|
96 <dd> |
|
97 reference to the current editor |
|
98 </dd> |
|
99 </dl><dl> |
|
100 <dt>Returns:</dt> |
|
101 <dd> |
|
102 the generated code (string) |
|
103 </dd> |
|
104 </dl><a NAME="E5MessageBoxWizard.__handle" ID="E5MessageBoxWizard.__handle"></a> |
|
105 <h4>E5MessageBoxWizard.__handle</h4> |
|
106 <b>__handle</b>(<i></i>) |
|
107 <p> |
|
108 Private method to handle the wizards action |
|
109 </p><a NAME="E5MessageBoxWizard.__initAction" ID="E5MessageBoxWizard.__initAction"></a> |
|
110 <h4>E5MessageBoxWizard.__initAction</h4> |
|
111 <b>__initAction</b>(<i></i>) |
|
112 <p> |
|
113 Private method to initialize the action. |
|
114 </p><a NAME="E5MessageBoxWizard.__initMenu" ID="E5MessageBoxWizard.__initMenu"></a> |
|
115 <h4>E5MessageBoxWizard.__initMenu</h4> |
|
116 <b>__initMenu</b>(<i></i>) |
|
117 <p> |
|
118 Private method to add the actions to the right menu. |
|
119 </p><a NAME="E5MessageBoxWizard.activate" ID="E5MessageBoxWizard.activate"></a> |
|
120 <h4>E5MessageBoxWizard.activate</h4> |
|
121 <b>activate</b>(<i></i>) |
|
122 <p> |
|
123 Public method to activate this plugin. |
|
124 </p><dl> |
|
125 <dt>Returns:</dt> |
|
126 <dd> |
|
127 tuple of None and activation status (boolean) |
|
128 </dd> |
|
129 </dl><a NAME="E5MessageBoxWizard.deactivate" ID="E5MessageBoxWizard.deactivate"></a> |
|
130 <h4>E5MessageBoxWizard.deactivate</h4> |
|
131 <b>deactivate</b>(<i></i>) |
|
132 <p> |
|
133 Public method to deactivate this plugin. |
|
134 </p> |
|
135 <div align="right"><a href="#top">Up</a></div> |
|
136 <hr /> |
|
137 </body></html> |