33 <td><a href="#activate">activate</a></td> |
33 <td><a href="#activate">activate</a></td> |
34 <td>Public method to activate this plug-in.</td> |
34 <td>Public method to activate this plug-in.</td> |
35 </tr> |
35 </tr> |
36 <tr> |
36 <tr> |
37 <td><a href="#deactivate">deactivate</a></td> |
37 <td><a href="#deactivate">deactivate</a></td> |
38 <td>Module function returning data as required by the configuration dialog.</td> |
38 <td>Function to create the Translator configuration page.</td> |
|
39 </tr> |
|
40 <tr> |
|
41 <td><a href="#getConfigData">getConfigData</a></td> |
|
42 <td>Function returning data as required by the configuration dialog.</td> |
39 </tr> |
43 </tr> |
40 <tr> |
44 <tr> |
41 <td><a href="#getPreferences">getPreferences</a></td> |
45 <td><a href="#getPreferences">getPreferences</a></td> |
42 <td>Public method to retrieve the various settings values.</td> |
46 <td>Public method to retrieve the various settings values.</td> |
43 </tr> |
47 </tr> |
44 <tr> |
48 <tr> |
|
49 <td><a href="#installDependencies">installDependencies</a></td> |
|
50 <td>Function to clear the private data of the plug-in.</td> |
|
51 </tr> |
|
52 <tr> |
45 <td><a href="#prepareUninstall">prepareUninstall</a></td> |
53 <td><a href="#prepareUninstall">prepareUninstall</a></td> |
46 <td>Module function to prepare for an un-installation.</td> |
54 <td>Function to prepare for an un-installation.</td> |
47 </tr> |
55 </tr> |
48 <tr> |
56 <tr> |
49 <td><a href="#setPreferences">setPreferences</a></td> |
57 <td><a href="#setPreferences">setPreferences</a></td> |
50 <td>Module function to return the API files made available by this plug-in.</td> |
58 <td>Function to return the API files made available by this plug-in.</td> |
51 </tr> |
59 </tr> |
52 </table> |
60 </table> |
53 |
61 |
54 <hr /> |
62 <hr /> |
55 <hr /> |
63 <hr /> |
94 <hr /> |
102 <hr /> |
95 <a NAME="deactivate" ID="deactivate"></a> |
103 <a NAME="deactivate" ID="deactivate"></a> |
96 <h2>deactivate</h2> |
104 <h2>deactivate</h2> |
97 <b>deactivate</b>(<i>self</i>) |
105 <b>deactivate</b>(<i>self</i>) |
98 <p> |
106 <p> |
99 Module function returning data as required by the configuration dialog. |
107 Function to create the Translator configuration page. |
|
108 </p> |
|
109 |
|
110 <dl> |
|
111 |
|
112 <dt><i>configDlg</i> (ConfigurationWidget)</dt> |
|
113 <dd> |
|
114 reference to the configuration dialog |
|
115 </dd> |
|
116 </dl> |
|
117 <dl> |
|
118 <dt>Return:</dt> |
|
119 <dd> |
|
120 reference to the configuration page |
|
121 </dd> |
|
122 </dl> |
|
123 <dl> |
|
124 <dt>Return Type:</dt> |
|
125 <dd> |
|
126 TranslatorPage |
|
127 </dd> |
|
128 </dl> |
|
129 <div align="right"><a href="#top">Up</a></div> |
|
130 <hr /> |
|
131 <hr /> |
|
132 <a NAME="getConfigData" ID="getConfigData"></a> |
|
133 <h2>getConfigData</h2> |
|
134 <b>getConfigData</b>(<i></i>) |
|
135 <p> |
|
136 Function returning data as required by the configuration dialog. |
100 </p> |
137 </p> |
101 |
138 |
102 <dl> |
139 <dl> |
103 <dt>Return:</dt> |
140 <dt>Return:</dt> |
104 <dd> |
141 <dd> |
141 </dd> |
178 </dd> |
142 </dl> |
179 </dl> |
143 <div align="right"><a href="#top">Up</a></div> |
180 <div align="right"><a href="#top">Up</a></div> |
144 <hr /> |
181 <hr /> |
145 <hr /> |
182 <hr /> |
|
183 <a NAME="installDependencies" ID="installDependencies"></a> |
|
184 <h2>installDependencies</h2> |
|
185 <b>installDependencies</b>(<i>pipInstall</i>) |
|
186 <p> |
|
187 Function to clear the private data of the plug-in. |
|
188 </p> |
|
189 |
|
190 <div align="right"><a href="#top">Up</a></div> |
|
191 <hr /> |
|
192 <hr /> |
146 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
193 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
147 <h2>prepareUninstall</h2> |
194 <h2>prepareUninstall</h2> |
148 <b>prepareUninstall</b>(<i></i>) |
195 <b>prepareUninstall</b>(<i></i>) |
149 <p> |
196 <p> |
150 Module function to prepare for an un-installation. |
197 Function to prepare for an un-installation. |
151 </p> |
198 </p> |
152 |
199 |
153 <div align="right"><a href="#top">Up</a></div> |
200 <div align="right"><a href="#top">Up</a></div> |
154 <hr /> |
201 <hr /> |
155 <hr /> |
202 <hr /> |
156 <a NAME="setPreferences" ID="setPreferences"></a> |
203 <a NAME="setPreferences" ID="setPreferences"></a> |
157 <h2>setPreferences</h2> |
204 <h2>setPreferences</h2> |
158 <b>setPreferences</b>(<i>self, key, value</i>) |
205 <b>setPreferences</b>(<i>self, key, value</i>) |
159 <p> |
206 <p> |
160 Module function to return the API files made available by this plug-in. |
207 Function to return the API files made available by this plug-in. |
161 </p> |
208 </p> |
162 |
209 |
163 <dl> |
210 <dl> |
164 |
211 |
165 <dt><i>language</i> (str)</dt> |
212 <dt><i>language</i> (str)</dt> |