65 <tr> |
65 <tr> |
66 <td><a href="#SetupWizard.__handle">__handle</a></td> |
66 <td><a href="#SetupWizard.__handle">__handle</a></td> |
67 <td>Private method to handle the wizards action.</td> |
67 <td>Private method to handle the wizards action.</td> |
68 </tr> |
68 </tr> |
69 <tr> |
69 <tr> |
70 <td><a href="#SetupWizard.__initAction">__initAction</a></td> |
70 <td><a href="#SetupWizard.__initActions">__initActions</a></td> |
71 <td>Private method to initialize the action.</td> |
71 <td>Private method to initialize the actions.</td> |
72 </tr> |
72 </tr> |
73 <tr> |
73 <tr> |
74 <td><a href="#SetupWizard.__initMenu">__initMenu</a></td> |
74 <td><a href="#SetupWizard.__initMenu">__initMenu</a></td> |
75 <td>Private method to add the actions to the right menu.</td> |
75 <td>Private method to add the actions to the right menu.</td> |
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#SetupWizard.__initialize">__initialize</a></td> |
|
79 <td>Private slot to (re)initialize the plug-in.</td> |
|
80 </tr> |
76 </tr> |
81 <tr> |
77 <tr> |
82 <td><a href="#SetupWizard.activate">activate</a></td> |
78 <td><a href="#SetupWizard.activate">activate</a></td> |
83 <td>Public method to activate this plug-in.</td> |
79 <td>Public method to activate this plug-in.</td> |
84 </tr> |
80 </tr> |
100 <p> |
96 <p> |
101 Constructor |
97 Constructor |
102 </p> |
98 </p> |
103 <dl> |
99 <dl> |
104 |
100 |
105 <dt><i>ui</i></dt> |
101 <dt><i>ui</i> (UI.UserInterface)</dt> |
106 <dd> |
102 <dd> |
107 reference to the user interface object (UI.UserInterface) |
103 reference to the user interface object |
108 </dd> |
104 </dd> |
109 </dl> |
105 </dl> |
110 <a NAME="SetupWizard.__callForm" ID="SetupWizard.__callForm"></a> |
106 <a NAME="SetupWizard.__callForm" ID="SetupWizard.__callForm"></a> |
111 <h4>SetupWizard.__callForm</h4> |
107 <h4>SetupWizard.__callForm</h4> |
112 <b>__callForm</b>(<i>editor</i>) |
108 <b>__callForm</b>(<i>editor, category</i>) |
113 |
109 |
114 <p> |
110 <p> |
115 Private method to display a dialog and get the code. |
111 Private method to display a dialog and get the code. |
116 </p> |
112 </p> |
117 <dl> |
113 <dl> |
118 |
114 |
119 <dt><i>editor</i></dt> |
115 <dt><i>editor</i> (Editor)</dt> |
120 <dd> |
116 <dd> |
121 reference to the current editor |
117 reference to the current editor |
|
118 </dd> |
|
119 <dt><i>category</i> (str)</dt> |
|
120 <dd> |
|
121 category of setup file to create |
122 </dd> |
122 </dd> |
123 </dl> |
123 </dl> |
124 <dl> |
124 <dl> |
125 <dt>Return:</dt> |
125 <dt>Return:</dt> |
126 <dd> |
126 <dd> |
127 the generated code (string) |
127 tuple containing the generated code and a flag indicating an error |
|
128 </dd> |
|
129 </dl> |
|
130 <dl> |
|
131 <dt>Return Type:</dt> |
|
132 <dd> |
|
133 tuple of (str, bool) |
128 </dd> |
134 </dd> |
129 </dl> |
135 </dl> |
130 <a NAME="SetupWizard.__handle" ID="SetupWizard.__handle"></a> |
136 <a NAME="SetupWizard.__handle" ID="SetupWizard.__handle"></a> |
131 <h4>SetupWizard.__handle</h4> |
137 <h4>SetupWizard.__handle</h4> |
132 <b>__handle</b>(<i></i>) |
138 <b>__handle</b>(<i>category</i>) |
133 |
139 |
134 <p> |
140 <p> |
135 Private method to handle the wizards action. |
141 Private method to handle the wizards action. |
136 </p> |
142 </p> |
137 <a NAME="SetupWizard.__initAction" ID="SetupWizard.__initAction"></a> |
143 <dl> |
138 <h4>SetupWizard.__initAction</h4> |
144 |
139 <b>__initAction</b>(<i></i>) |
145 <dt><i>category</i> (str)</dt> |
|
146 <dd> |
|
147 category of setup file to create |
|
148 </dd> |
|
149 </dl> |
|
150 <a NAME="SetupWizard.__initActions" ID="SetupWizard.__initActions"></a> |
|
151 <h4>SetupWizard.__initActions</h4> |
|
152 <b>__initActions</b>(<i></i>) |
140 |
153 |
141 <p> |
154 <p> |
142 Private method to initialize the action. |
155 Private method to initialize the actions. |
143 </p> |
156 </p> |
144 <a NAME="SetupWizard.__initMenu" ID="SetupWizard.__initMenu"></a> |
157 <a NAME="SetupWizard.__initMenu" ID="SetupWizard.__initMenu"></a> |
145 <h4>SetupWizard.__initMenu</h4> |
158 <h4>SetupWizard.__initMenu</h4> |
146 <b>__initMenu</b>(<i></i>) |
159 <b>__initMenu</b>(<i></i>) |
147 |
160 |
148 <p> |
161 <p> |
149 Private method to add the actions to the right menu. |
162 Private method to add the actions to the right menu. |
150 </p> |
|
151 <a NAME="SetupWizard.__initialize" ID="SetupWizard.__initialize"></a> |
|
152 <h4>SetupWizard.__initialize</h4> |
|
153 <b>__initialize</b>(<i></i>) |
|
154 |
|
155 <p> |
|
156 Private slot to (re)initialize the plug-in. |
|
157 </p> |
163 </p> |
158 <a NAME="SetupWizard.activate" ID="SetupWizard.activate"></a> |
164 <a NAME="SetupWizard.activate" ID="SetupWizard.activate"></a> |
159 <h4>SetupWizard.activate</h4> |
165 <h4>SetupWizard.activate</h4> |
160 <b>activate</b>(<i></i>) |
166 <b>activate</b>(<i></i>) |
161 |
167 |
163 Public method to activate this plug-in. |
169 Public method to activate this plug-in. |
164 </p> |
170 </p> |
165 <dl> |
171 <dl> |
166 <dt>Return:</dt> |
172 <dt>Return:</dt> |
167 <dd> |
173 <dd> |
168 tuple of None and activation status (boolean) |
174 tuple of None and activation status |
|
175 </dd> |
|
176 </dl> |
|
177 <dl> |
|
178 <dt>Return Type:</dt> |
|
179 <dd> |
|
180 tuple of (None, boolean) |
169 </dd> |
181 </dd> |
170 </dl> |
182 </dl> |
171 <a NAME="SetupWizard.deactivate" ID="SetupWizard.deactivate"></a> |
183 <a NAME="SetupWizard.deactivate" ID="SetupWizard.deactivate"></a> |
172 <h4>SetupWizard.deactivate</h4> |
184 <h4>SetupWizard.deactivate</h4> |
173 <b>deactivate</b>(<i></i>) |
185 <b>deactivate</b>(<i></i>) |