TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html

branch
eric7
changeset 98
693e42176007
parent 95
7449695cf655
child 106
6deb942739dc
equal deleted inserted replaced
97:44ec4168b442 98:693e42176007
122 <p> 122 <p>
123 Constructor 123 Constructor
124 </p> 124 </p>
125 <dl> 125 <dl>
126 126
127 <dt><i>ui</i></dt> 127 <dt><i>ui</i> (UserInterface)</dt>
128 <dd> 128 <dd>
129 reference to the user interface object (UI.UserInterface) 129 reference to the user interface object
130 </dd> 130 </dd>
131 </dl> 131 </dl>
132 <a NAME="TimeTrackerPlugin.__initialize" ID="TimeTrackerPlugin.__initialize"></a> 132 <a NAME="TimeTrackerPlugin.__initialize" ID="TimeTrackerPlugin.__initialize"></a>
133 <h4>TimeTrackerPlugin.__initialize</h4> 133 <h4>TimeTrackerPlugin.__initialize</h4>
134 <b>__initialize</b>(<i></i>) 134 <b>__initialize</b>(<i></i>)
151 Public method to activate this plugin. 151 Public method to activate this plugin.
152 </p> 152 </p>
153 <dl> 153 <dl>
154 <dt>Return:</dt> 154 <dt>Return:</dt>
155 <dd> 155 <dd>
156 tuple of None and activation status (boolean) 156 tuple of None and activation status
157 </dd>
158 </dl>
159 <dl>
160 <dt>Return Type:</dt>
161 <dd>
162 bool
157 </dd> 163 </dd>
158 </dl> 164 </dl>
159 <a NAME="TimeTrackerPlugin.deactivate" ID="TimeTrackerPlugin.deactivate"></a> 165 <a NAME="TimeTrackerPlugin.deactivate" ID="TimeTrackerPlugin.deactivate"></a>
160 <h4>TimeTrackerPlugin.deactivate</h4> 166 <h4>TimeTrackerPlugin.deactivate</h4>
161 <b>deactivate</b>(<i></i>) 167 <b>deactivate</b>(<i></i>)
170 <p> 176 <p>
171 Public method to retrieve the various settings. 177 Public method to retrieve the various settings.
172 </p> 178 </p>
173 <dl> 179 <dl>
174 180
175 <dt><i>key</i></dt> 181 <dt><i>key</i> (str)</dt>
176 <dd> 182 <dd>
177 the key of the value to get 183 key of the value to get
178 </dd> 184 </dd>
179 </dl> 185 </dl>
180 <dl> 186 <dl>
181 <dt>Return:</dt> 187 <dt>Return:</dt>
182 <dd> 188 <dd>
183 the requested setting 189 value of the requested setting
190 </dd>
191 </dl>
192 <dl>
193 <dt>Return Type:</dt>
194 <dd>
195 Any
184 </dd> 196 </dd>
185 </dl> 197 </dl>
186 <a NAME="TimeTrackerPlugin.setPreferences" ID="TimeTrackerPlugin.setPreferences"></a> 198 <a NAME="TimeTrackerPlugin.setPreferences" ID="TimeTrackerPlugin.setPreferences"></a>
187 <h4>TimeTrackerPlugin.setPreferences</h4> 199 <h4>TimeTrackerPlugin.setPreferences</h4>
188 <b>setPreferences</b>(<i>key, value</i>) 200 <b>setPreferences</b>(<i>key, value</i>)
190 <p> 202 <p>
191 Public method to store the various settings. 203 Public method to store the various settings.
192 </p> 204 </p>
193 <dl> 205 <dl>
194 206
195 <dt><i>key</i></dt> 207 <dt><i>key</i> (str)</dt>
196 <dd> 208 <dd>
197 the key of the setting to be set (string) 209 key of the setting to be set
198 </dd> 210 </dd>
199 <dt><i>value</i></dt> 211 <dt><i>value</i> (Any)</dt>
200 <dd> 212 <dd>
201 the value to be set 213 value to be set
202 </dd> 214 </dd>
203 </dl> 215 </dl>
204 <div align="right"><a href="#top">Up</a></div> 216 <div align="right"><a href="#top">Up</a></div>
205 <hr /> 217 <hr />
206 <hr /> 218 <hr />
211 <p> 223 <p>
212 Module function to create the Time Tracker configuration page. 224 Module function to create the Time Tracker configuration page.
213 </p> 225 </p>
214 <dl> 226 <dl>
215 227
216 <dt><i>configDlg</i></dt> 228 <dt><i>configDlg</i> (ConfigurationWidget)</dt>
217 <dd> 229 <dd>
218 reference to the configuration dialog 230 reference to the configuration dialog
219 </dd> 231 </dd>
220 </dl> 232 </dl>
221 <dl> 233 <dl>
222 <dt>Return:</dt> 234 <dt>Return:</dt>
223 <dd> 235 <dd>
224 reference to the configuration page 236 reference to the configuration page
237 </dd>
238 </dl>
239 <dl>
240 <dt>Return Type:</dt>
241 <dd>
242 TimeTrackerPage
225 </dd> 243 </dd>
226 </dl> 244 </dl>
227 <div align="right"><a href="#top">Up</a></div> 245 <div align="right"><a href="#top">Up</a></div>
228 <hr /> 246 <hr />
229 <hr /> 247 <hr />
238 <dt>Return:</dt> 256 <dt>Return:</dt>
239 <dd> 257 <dd>
240 dictionary containing the relevant data 258 dictionary containing the relevant data
241 </dd> 259 </dd>
242 </dl> 260 </dl>
261 <dl>
262 <dt>Return Type:</dt>
263 <dd>
264 dict
265 </dd>
266 </dl>
243 <div align="right"><a href="#top">Up</a></div> 267 <div align="right"><a href="#top">Up</a></div>
244 <hr /> 268 <hr />
245 <hr /> 269 <hr />
246 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 270 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
247 <h2>prepareUninstall</h2> 271 <h2>prepareUninstall</h2>

eric ide

mercurial