|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.PluginWizardSetup</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.Plugins.PluginWizardSetup</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing the setup.py wizard plug-in. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
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>needsRestart</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 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#SetupWizard">SetupWizard</a></td> |
|
25 <td>Class implementing the setup.py wizard plug-in.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="SetupWizard" ID="SetupWizard"></a> |
|
36 <h2>SetupWizard</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing the setup.py wizard plug-in. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QObject |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 |
|
55 <table> |
|
56 |
|
57 <tr> |
|
58 <td><a href="#SetupWizard.__init__">SetupWizard</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#SetupWizard.__handle">__handle</a></td> |
|
63 <td>Private method to handle the wizards action.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#SetupWizard.__initActions">__initActions</a></td> |
|
67 <td>Private method to initialize the actions.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#SetupWizard.__initMenu">__initMenu</a></td> |
|
71 <td>Private method to add the actions to the right menu.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#SetupWizard.activate">activate</a></td> |
|
75 <td>Public method to activate this plug-in.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#SetupWizard.deactivate">deactivate</a></td> |
|
79 <td>Public method to deactivate this plug-in.</td> |
|
80 </tr> |
|
81 </table> |
|
82 <h3>Static Methods</h3> |
|
83 |
|
84 <table> |
|
85 <tr><td>None</td></tr> |
|
86 </table> |
|
87 |
|
88 <a NAME="SetupWizard.__init__" ID="SetupWizard.__init__"></a> |
|
89 <h4>SetupWizard (Constructor)</h4> |
|
90 <b>SetupWizard</b>(<i>ui</i>) |
|
91 |
|
92 <p> |
|
93 Constructor |
|
94 </p> |
|
95 <dl> |
|
96 |
|
97 <dt><i>ui</i> (UI.UserInterface)</dt> |
|
98 <dd> |
|
99 reference to the user interface object |
|
100 </dd> |
|
101 </dl> |
|
102 <a NAME="SetupWizard.__handle" ID="SetupWizard.__handle"></a> |
|
103 <h4>SetupWizard.__handle</h4> |
|
104 <b>__handle</b>(<i>category</i>) |
|
105 |
|
106 <p> |
|
107 Private method to handle the wizards action. |
|
108 </p> |
|
109 <dl> |
|
110 |
|
111 <dt><i>category</i> (str)</dt> |
|
112 <dd> |
|
113 category of setup file to create |
|
114 </dd> |
|
115 </dl> |
|
116 <a NAME="SetupWizard.__initActions" ID="SetupWizard.__initActions"></a> |
|
117 <h4>SetupWizard.__initActions</h4> |
|
118 <b>__initActions</b>(<i></i>) |
|
119 |
|
120 <p> |
|
121 Private method to initialize the actions. |
|
122 </p> |
|
123 <a NAME="SetupWizard.__initMenu" ID="SetupWizard.__initMenu"></a> |
|
124 <h4>SetupWizard.__initMenu</h4> |
|
125 <b>__initMenu</b>(<i></i>) |
|
126 |
|
127 <p> |
|
128 Private method to add the actions to the right menu. |
|
129 </p> |
|
130 <a NAME="SetupWizard.activate" ID="SetupWizard.activate"></a> |
|
131 <h4>SetupWizard.activate</h4> |
|
132 <b>activate</b>(<i></i>) |
|
133 |
|
134 <p> |
|
135 Public method to activate this plug-in. |
|
136 </p> |
|
137 <dl> |
|
138 <dt>Return:</dt> |
|
139 <dd> |
|
140 tuple of None and activation status |
|
141 </dd> |
|
142 </dl> |
|
143 <dl> |
|
144 <dt>Return Type:</dt> |
|
145 <dd> |
|
146 tuple of (None, boolean) |
|
147 </dd> |
|
148 </dl> |
|
149 <a NAME="SetupWizard.deactivate" ID="SetupWizard.deactivate"></a> |
|
150 <h4>SetupWizard.deactivate</h4> |
|
151 <b>deactivate</b>(<i></i>) |
|
152 |
|
153 <p> |
|
154 Public method to deactivate this plug-in. |
|
155 </p> |
|
156 <div align="right"><a href="#top">Up</a></div> |
|
157 <hr /> |
|
158 </body></html> |