Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html
src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html
- branch
- eric7
- changeset 10437
- 2f70ca07f0af
- parent 10259
- b51dfacef37f
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10436:f6881d10e995 | 10437:2f70ca07f0af |
|---|---|
| 136 <p> | 136 <p> |
| 137 Class method to retrieve the various settings. | 137 Class method to retrieve the various settings. |
| 138 </p> | 138 </p> |
| 139 <dl> | 139 <dl> |
| 140 | 140 |
| 141 <dt><i>key</i></dt> | 141 <dt><i>key</i> (str)</dt> |
| 142 <dd> | 142 <dd> |
| 143 the key of the value to get | 143 the key of the value to get |
| 144 </dd> | 144 </dd> |
| 145 </dl> | 145 </dl> |
| 146 <dl> | 146 <dl> |
| 147 <dt>Return:</dt> | 147 <dt>Return:</dt> |
| 148 <dd> | 148 <dd> |
| 149 the requested setting | 149 the requested setting |
| 150 </dd> | |
| 151 </dl> | |
| 152 <dl> | |
| 153 <dt>Return Type:</dt> | |
| 154 <dd> | |
| 155 Any | |
| 150 </dd> | 156 </dd> |
| 151 </dl> | 157 </dl> |
| 152 <a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a> | 158 <a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a> |
| 153 <h4>VcsGitPlugin.setPreferences (class method)</h4> | 159 <h4>VcsGitPlugin.setPreferences (class method)</h4> |
| 154 <b>setPreferences</b>(<i>key, value</i>) | 160 <b>setPreferences</b>(<i>key, value</i>) |
| 156 <p> | 162 <p> |
| 157 Class method to store the various settings. | 163 Class method to store the various settings. |
| 158 </p> | 164 </p> |
| 159 <dl> | 165 <dl> |
| 160 | 166 |
| 161 <dt><i>key</i></dt> | 167 <dt><i>key</i> (str)</dt> |
| 162 <dd> | 168 <dd> |
| 163 the key of the setting to be set | 169 the key of the setting to be set |
| 164 </dd> | 170 </dd> |
| 165 <dt><i>value</i></dt> | 171 <dt><i>value</i> (Any)</dt> |
| 166 <dd> | 172 <dd> |
| 167 the value to be set | 173 the value to be set |
| 168 </dd> | 174 </dd> |
| 169 </dl> | 175 </dl> |
| 170 <a NAME="VcsGitPlugin.__init__" ID="VcsGitPlugin.__init__"></a> | 176 <a NAME="VcsGitPlugin.__init__" ID="VcsGitPlugin.__init__"></a> |
| 174 <p> | 180 <p> |
| 175 Constructor | 181 Constructor |
| 176 </p> | 182 </p> |
| 177 <dl> | 183 <dl> |
| 178 | 184 |
| 179 <dt><i>ui</i></dt> | 185 <dt><i>ui</i> (UserInterface)</dt> |
| 180 <dd> | 186 <dd> |
| 181 reference to the user interface object (UI.UserInterface) | 187 reference to the user interface object |
| 182 </dd> | 188 </dd> |
| 183 </dl> | 189 </dl> |
| 184 <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a> | 190 <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a> |
| 185 <h4>VcsGitPlugin.activate</h4> | 191 <h4>VcsGitPlugin.activate</h4> |
| 186 <b>activate</b>(<i></i>) | 192 <b>activate</b>(<i></i>) |
| 189 Public method to activate this plugin. | 195 Public method to activate this plugin. |
| 190 </p> | 196 </p> |
| 191 <dl> | 197 <dl> |
| 192 <dt>Return:</dt> | 198 <dt>Return:</dt> |
| 193 <dd> | 199 <dd> |
| 194 tuple of reference to instantiated viewmanager and | 200 tuple of reference to instantiated version control and |
| 195 activation status (boolean) | 201 activation status |
| 202 </dd> | |
| 203 </dl> | |
| 204 <dl> | |
| 205 <dt>Return Type:</dt> | |
| 206 <dd> | |
| 207 tuple of (Git, bool) | |
| 196 </dd> | 208 </dd> |
| 197 </dl> | 209 </dl> |
| 198 <a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a> | 210 <a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a> |
| 199 <h4>VcsGitPlugin.deactivate</h4> | 211 <h4>VcsGitPlugin.deactivate</h4> |
| 200 <b>deactivate</b>(<i></i>) | 212 <b>deactivate</b>(<i></i>) |
| 210 Public method to get the filename of the config file. | 222 Public method to get the filename of the config file. |
| 211 </p> | 223 </p> |
| 212 <dl> | 224 <dl> |
| 213 <dt>Return:</dt> | 225 <dt>Return:</dt> |
| 214 <dd> | 226 <dd> |
| 215 filename of the config file (string) | 227 filename of the config file |
| 228 </dd> | |
| 229 </dl> | |
| 230 <dl> | |
| 231 <dt>Return Type:</dt> | |
| 232 <dd> | |
| 233 str | |
| 216 </dd> | 234 </dd> |
| 217 </dl> | 235 </dl> |
| 218 <a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a> | 236 <a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a> |
| 219 <h4>VcsGitPlugin.getProjectHelper</h4> | 237 <h4>VcsGitPlugin.getProjectHelper</h4> |
| 220 <b>getProjectHelper</b>(<i></i>) | 238 <b>getProjectHelper</b>(<i></i>) |
| 226 <dt>Return:</dt> | 244 <dt>Return:</dt> |
| 227 <dd> | 245 <dd> |
| 228 reference to the project helper object | 246 reference to the project helper object |
| 229 </dd> | 247 </dd> |
| 230 </dl> | 248 </dl> |
| 249 <dl> | |
| 250 <dt>Return Type:</dt> | |
| 251 <dd> | |
| 252 GitProjectHelper | |
| 253 </dd> | |
| 254 </dl> | |
| 231 <a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a> | 255 <a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a> |
| 232 <h4>VcsGitPlugin.initToolbar</h4> | 256 <h4>VcsGitPlugin.initToolbar</h4> |
| 233 <b>initToolbar</b>(<i>ui, toolbarManager</i>) | 257 <b>initToolbar</b>(<i>ui, toolbarManager</i>) |
| 234 | 258 |
| 235 <p> | 259 <p> |
| 236 Public slot to initialize the VCS toolbar. | 260 Public slot to initialize the VCS toolbar. |
| 237 </p> | 261 </p> |
| 238 <dl> | 262 <dl> |
| 239 | 263 |
| 240 <dt><i>ui</i></dt> | 264 <dt><i>ui</i> (UserInterface)</dt> |
| 241 <dd> | 265 <dd> |
| 242 reference to the main window (UserInterface) | 266 reference to the main window |
| 243 </dd> | 267 </dd> |
| 244 <dt><i>toolbarManager</i></dt> | 268 <dt><i>toolbarManager</i> (EricToolBarManager)</dt> |
| 245 <dd> | 269 <dd> |
| 246 reference to a toolbar manager object | 270 reference to a toolbar manager object |
| 247 (EricToolBarManager) | |
| 248 </dd> | 271 </dd> |
| 249 </dl> | 272 </dl> |
| 250 <a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a> | 273 <a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a> |
| 251 <h4>VcsGitPlugin.prepareUninstall</h4> | 274 <h4>VcsGitPlugin.prepareUninstall</h4> |
| 252 <b>prepareUninstall</b>(<i></i>) | 275 <b>prepareUninstall</b>(<i></i>) |
| 281 <p> | 304 <p> |
| 282 Module function to create the configuration page. | 305 Module function to create the configuration page. |
| 283 </p> | 306 </p> |
| 284 <dl> | 307 <dl> |
| 285 | 308 |
| 286 <dt><i>configDlg</i></dt> | 309 <dt><i>configDlg</i> (QDialog)</dt> |
| 287 <dd> | 310 <dd> |
| 288 reference to the configuration dialog (QDialog) | 311 reference to the configuration dialog |
| 289 </dd> | 312 </dd> |
| 290 </dl> | 313 </dl> |
| 291 <dl> | 314 <dl> |
| 292 <dt>Return:</dt> | 315 <dt>Return:</dt> |
| 293 <dd> | 316 <dd> |
| 294 reference to the configuration page | 317 reference to the configuration page |
| 318 </dd> | |
| 319 </dl> | |
| 320 <dl> | |
| 321 <dt>Return Type:</dt> | |
| 322 <dd> | |
| 323 GitPage | |
| 295 </dd> | 324 </dd> |
| 296 </dl> | 325 </dl> |
| 297 <div align="right"><a href="#top">Up</a></div> | 326 <div align="right"><a href="#top">Up</a></div> |
| 298 <hr /> | 327 <hr /> |
| 299 <hr /> | 328 <hr /> |
| 305 Public function to get the display string. | 334 Public function to get the display string. |
| 306 </p> | 335 </p> |
| 307 <dl> | 336 <dl> |
| 308 <dt>Return:</dt> | 337 <dt>Return:</dt> |
| 309 <dd> | 338 <dd> |
| 310 display string (string) | 339 display string |
| 340 </dd> | |
| 341 </dl> | |
| 342 <dl> | |
| 343 <dt>Return Type:</dt> | |
| 344 <dd> | |
| 345 str | |
| 311 </dd> | 346 </dd> |
| 312 </dl> | 347 </dl> |
| 313 <div align="right"><a href="#top">Up</a></div> | 348 <div align="right"><a href="#top">Up</a></div> |
| 314 <hr /> | 349 <hr /> |
| 315 <hr /> | 350 <hr /> |
| 325 <dd> | 360 <dd> |
| 326 dictionary containing the data to query the presence of | 361 dictionary containing the data to query the presence of |
| 327 the executable | 362 the executable |
| 328 </dd> | 363 </dd> |
| 329 </dl> | 364 </dl> |
| 365 <dl> | |
| 366 <dt>Return Type:</dt> | |
| 367 <dd> | |
| 368 dict | |
| 369 </dd> | |
| 370 </dl> | |
| 330 <div align="right"><a href="#top">Up</a></div> | 371 <div align="right"><a href="#top">Up</a></div> |
| 331 <hr /> | 372 <hr /> |
| 332 <hr /> | 373 <hr /> |
| 333 <a NAME="getConfigData" ID="getConfigData"></a> | 374 <a NAME="getConfigData" ID="getConfigData"></a> |
| 334 <h2>getConfigData</h2> | 375 <h2>getConfigData</h2> |
| 338 Module function returning data as required by the configuration dialog. | 379 Module function returning data as required by the configuration dialog. |
| 339 </p> | 380 </p> |
| 340 <dl> | 381 <dl> |
| 341 <dt>Return:</dt> | 382 <dt>Return:</dt> |
| 342 <dd> | 383 <dd> |
| 343 dictionary with key "zzz_gitPage" containing the relevant | 384 dictionary with key "zzz_gitPage" containing the relevant data |
| 344 data | 385 </dd> |
| 386 </dl> | |
| 387 <dl> | |
| 388 <dt>Return Type:</dt> | |
| 389 <dd> | |
| 390 dict | |
| 345 </dd> | 391 </dd> |
| 346 </dl> | 392 </dl> |
| 347 <div align="right"><a href="#top">Up</a></div> | 393 <div align="right"><a href="#top">Up</a></div> |
| 348 <hr /> | 394 <hr /> |
| 349 <hr /> | 395 <hr /> |
| 356 </p> | 402 </p> |
| 357 <dl> | 403 <dl> |
| 358 <dt>Return:</dt> | 404 <dt>Return:</dt> |
| 359 <dd> | 405 <dd> |
| 360 dictionary with indicator as key and a tuple with the vcs name | 406 dictionary with indicator as key and a tuple with the vcs name |
| 361 (string) and vcs display string (string) | 407 and vcs display string |
| 408 </dd> | |
| 409 </dl> | |
| 410 <dl> | |
| 411 <dt>Return Type:</dt> | |
| 412 <dd> | |
| 413 dict | |
| 362 </dd> | 414 </dd> |
| 363 </dl> | 415 </dl> |
| 364 <div align="right"><a href="#top">Up</a></div> | 416 <div align="right"><a href="#top">Up</a></div> |
| 365 <hr /> | 417 <hr /> |
| 366 <hr /> | 418 <hr /> |
