eric7/Documentation/Source/eric7.Plugins.PluginTranslator.html

branch
eric7
changeset 9148
b31f0d894b55
parent 8596
d64760b2da50
equal deleted inserted replaced
9147:bbf3af40c223 9148:b31f0d894b55
116 <p> 116 <p>
117 Constructor 117 Constructor
118 </p> 118 </p>
119 <dl> 119 <dl>
120 120
121 <dt><i>ui</i></dt> 121 <dt><i>ui</i> (UI.UserInterface)</dt>
122 <dd> 122 <dd>
123 reference to the user interface object (UI.UserInterface) 123 reference to the user interface object
124 </dd> 124 </dd>
125 </dl> 125 </dl>
126 <a NAME="TranslatorPlugin.__initialize" ID="TranslatorPlugin.__initialize"></a> 126 <a NAME="TranslatorPlugin.__initialize" ID="TranslatorPlugin.__initialize"></a>
127 <h4>TranslatorPlugin.__initialize</h4> 127 <h4>TranslatorPlugin.__initialize</h4>
128 <b>__initialize</b>(<i></i>) 128 <b>__initialize</b>(<i></i>)
138 Public method to activate this plugin. 138 Public method to activate this plugin.
139 </p> 139 </p>
140 <dl> 140 <dl>
141 <dt>Return:</dt> 141 <dt>Return:</dt>
142 <dd> 142 <dd>
143 tuple of None and activation status (boolean) 143 tuple of None and activation status
144 </dd>
145 </dl>
146 <dl>
147 <dt>Return Type:</dt>
148 <dd>
149 tuple of (None, bool)
144 </dd> 150 </dd>
145 </dl> 151 </dl>
146 <a NAME="TranslatorPlugin.deactivate" ID="TranslatorPlugin.deactivate"></a> 152 <a NAME="TranslatorPlugin.deactivate" ID="TranslatorPlugin.deactivate"></a>
147 <h4>TranslatorPlugin.deactivate</h4> 153 <h4>TranslatorPlugin.deactivate</h4>
148 <b>deactivate</b>(<i></i>) 154 <b>deactivate</b>(<i></i>)
157 <p> 163 <p>
158 Public method to retrieve the various settings. 164 Public method to retrieve the various settings.
159 </p> 165 </p>
160 <dl> 166 <dl>
161 167
162 <dt><i>key</i></dt> 168 <dt><i>key</i> (str)</dt>
163 <dd> 169 <dd>
164 the key of the value to get 170 the key of the value to get
165 </dd> 171 </dd>
166 </dl> 172 </dl>
167 <dl> 173 <dl>
168 <dt>Return:</dt> 174 <dt>Return:</dt>
169 <dd> 175 <dd>
170 the requested setting 176 the requested setting
177 </dd>
178 </dl>
179 <dl>
180 <dt>Return Type:</dt>
181 <dd>
182 any
171 </dd> 183 </dd>
172 </dl> 184 </dl>
173 <a NAME="TranslatorPlugin.getPreferencesDefault" ID="TranslatorPlugin.getPreferencesDefault"></a> 185 <a NAME="TranslatorPlugin.getPreferencesDefault" ID="TranslatorPlugin.getPreferencesDefault"></a>
174 <h4>TranslatorPlugin.getPreferencesDefault</h4> 186 <h4>TranslatorPlugin.getPreferencesDefault</h4>
175 <b>getPreferencesDefault</b>(<i>key</i>) 187 <b>getPreferencesDefault</b>(<i>key</i>)
177 <p> 189 <p>
178 Public method to retrieve the various default settings. 190 Public method to retrieve the various default settings.
179 </p> 191 </p>
180 <dl> 192 <dl>
181 193
182 <dt><i>key</i></dt> 194 <dt><i>key</i> (str)</dt>
183 <dd> 195 <dd>
184 the key of the value to get 196 the key of the value to get
185 </dd> 197 </dd>
186 </dl> 198 </dl>
187 <dl> 199 <dl>
188 <dt>Return:</dt> 200 <dt>Return:</dt>
189 <dd> 201 <dd>
190 the requested setting 202 the requested setting
203 </dd>
204 </dl>
205 <dl>
206 <dt>Return Type:</dt>
207 <dd>
208 any
191 </dd> 209 </dd>
192 </dl> 210 </dl>
193 <a NAME="TranslatorPlugin.setPreferences" ID="TranslatorPlugin.setPreferences"></a> 211 <a NAME="TranslatorPlugin.setPreferences" ID="TranslatorPlugin.setPreferences"></a>
194 <h4>TranslatorPlugin.setPreferences</h4> 212 <h4>TranslatorPlugin.setPreferences</h4>
195 <b>setPreferences</b>(<i>key, value</i>) 213 <b>setPreferences</b>(<i>key, value</i>)
197 <p> 215 <p>
198 Public method to store the various settings. 216 Public method to store the various settings.
199 </p> 217 </p>
200 <dl> 218 <dl>
201 219
202 <dt><i>key</i></dt> 220 <dt><i>key</i> (str)</dt>
203 <dd> 221 <dd>
204 the key of the setting to be set (string) 222 the key of the setting to be set
205 </dd> 223 </dd>
206 <dt><i>value</i></dt> 224 <dt><i>value</i> (any)</dt>
207 <dd> 225 <dd>
208 the value to be set 226 the value to be set
209 </dd> 227 </dd>
210 </dl> 228 </dl>
211 <div align="right"><a href="#top">Up</a></div> 229 <div align="right"><a href="#top">Up</a></div>
218 <p> 236 <p>
219 Module function to create the Translator configuration page. 237 Module function to create the Translator configuration page.
220 </p> 238 </p>
221 <dl> 239 <dl>
222 240
223 <dt><i>configDlg</i></dt> 241 <dt><i>configDlg</i> (ConfigurationWidget)</dt>
224 <dd> 242 <dd>
225 reference to the configuration dialog 243 reference to the configuration dialog
226 </dd> 244 </dd>
227 </dl> 245 </dl>
228 <dl> 246 <dl>
229 <dt>Return:</dt> 247 <dt>Return:</dt>
230 <dd> 248 <dd>
231 reference to the configuration page 249 reference to the configuration page
250 </dd>
251 </dl>
252 <dl>
253 <dt>Return Type:</dt>
254 <dd>
255 TranslatorPage
232 </dd> 256 </dd>
233 </dl> 257 </dl>
234 <div align="right"><a href="#top">Up</a></div> 258 <div align="right"><a href="#top">Up</a></div>
235 <hr /> 259 <hr />
236 <hr /> 260 <hr />
245 <dt>Return:</dt> 269 <dt>Return:</dt>
246 <dd> 270 <dd>
247 dictionary containing the relevant data 271 dictionary containing the relevant data
248 </dd> 272 </dd>
249 </dl> 273 </dl>
274 <dl>
275 <dt>Return Type:</dt>
276 <dd>
277 dict
278 </dd>
279 </dl>
250 <div align="right"><a href="#top">Up</a></div> 280 <div align="right"><a href="#top">Up</a></div>
251 <hr /> 281 <hr />
252 <hr /> 282 <hr />
253 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 283 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
254 <h2>prepareUninstall</h2> 284 <h2>prepareUninstall</h2>

eric ide

mercurial