Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.PluginVcsSubversion.html
src/eric7/Documentation/Source/eric7.Plugins.PluginVcsSubversion.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 Constructor | 137 Constructor |
| 138 </p> | 138 </p> |
| 139 <dl> | 139 <dl> |
| 140 | 140 |
| 141 <dt><i>ui</i></dt> | 141 <dt><i>ui</i> (UserInterface)</dt> |
| 142 <dd> | 142 <dd> |
| 143 reference to the user interface object (UI.UserInterface) | 143 reference to the user interface object |
| 144 </dd> | 144 </dd> |
| 145 </dl> | 145 </dl> |
| 146 <a NAME="VcsSubversionPlugin.activate" ID="VcsSubversionPlugin.activate"></a> | 146 <a NAME="VcsSubversionPlugin.activate" ID="VcsSubversionPlugin.activate"></a> |
| 147 <h4>VcsSubversionPlugin.activate</h4> | 147 <h4>VcsSubversionPlugin.activate</h4> |
| 148 <b>activate</b>(<i></i>) | 148 <b>activate</b>(<i></i>) |
| 152 </p> | 152 </p> |
| 153 <dl> | 153 <dl> |
| 154 <dt>Return:</dt> | 154 <dt>Return:</dt> |
| 155 <dd> | 155 <dd> |
| 156 tuple of reference to instantiated viewmanager and | 156 tuple of reference to instantiated viewmanager and |
| 157 activation status (boolean) | 157 activation status |
| 158 </dd> | |
| 159 </dl> | |
| 160 <dl> | |
| 161 <dt>Return Type:</dt> | |
| 162 <dd> | |
| 163 tuple of (Subversion, bool) | |
| 158 </dd> | 164 </dd> |
| 159 </dl> | 165 </dl> |
| 160 <a NAME="VcsSubversionPlugin.deactivate" ID="VcsSubversionPlugin.deactivate"></a> | 166 <a NAME="VcsSubversionPlugin.deactivate" ID="VcsSubversionPlugin.deactivate"></a> |
| 161 <h4>VcsSubversionPlugin.deactivate</h4> | 167 <h4>VcsSubversionPlugin.deactivate</h4> |
| 162 <b>deactivate</b>(<i></i>) | 168 <b>deactivate</b>(<i></i>) |
| 172 Public method to get the filename of the config file. | 178 Public method to get the filename of the config file. |
| 173 </p> | 179 </p> |
| 174 <dl> | 180 <dl> |
| 175 <dt>Return:</dt> | 181 <dt>Return:</dt> |
| 176 <dd> | 182 <dd> |
| 177 filename of the config file (string) | 183 filename of the config file |
| 184 </dd> | |
| 185 </dl> | |
| 186 <dl> | |
| 187 <dt>Return Type:</dt> | |
| 188 <dd> | |
| 189 str | |
| 178 </dd> | 190 </dd> |
| 179 </dl> | 191 </dl> |
| 180 <a NAME="VcsSubversionPlugin.getPreferences" ID="VcsSubversionPlugin.getPreferences"></a> | 192 <a NAME="VcsSubversionPlugin.getPreferences" ID="VcsSubversionPlugin.getPreferences"></a> |
| 181 <h4>VcsSubversionPlugin.getPreferences</h4> | 193 <h4>VcsSubversionPlugin.getPreferences</h4> |
| 182 <b>getPreferences</b>(<i>key</i>) | 194 <b>getPreferences</b>(<i>key</i>) |
| 184 <p> | 196 <p> |
| 185 Public method to retrieve the various settings. | 197 Public method to retrieve the various settings. |
| 186 </p> | 198 </p> |
| 187 <dl> | 199 <dl> |
| 188 | 200 |
| 189 <dt><i>key</i></dt> | 201 <dt><i>key</i> (str)</dt> |
| 190 <dd> | 202 <dd> |
| 191 the key of the value to get | 203 the key of the value to get |
| 192 </dd> | 204 </dd> |
| 193 </dl> | 205 </dl> |
| 194 <dl> | 206 <dl> |
| 195 <dt>Return:</dt> | 207 <dt>Return:</dt> |
| 196 <dd> | 208 <dd> |
| 197 the requested setting | 209 the requested setting |
| 210 </dd> | |
| 211 </dl> | |
| 212 <dl> | |
| 213 <dt>Return Type:</dt> | |
| 214 <dd> | |
| 215 Any | |
| 198 </dd> | 216 </dd> |
| 199 </dl> | 217 </dl> |
| 200 <a NAME="VcsSubversionPlugin.getProjectHelper" ID="VcsSubversionPlugin.getProjectHelper"></a> | 218 <a NAME="VcsSubversionPlugin.getProjectHelper" ID="VcsSubversionPlugin.getProjectHelper"></a> |
| 201 <h4>VcsSubversionPlugin.getProjectHelper</h4> | 219 <h4>VcsSubversionPlugin.getProjectHelper</h4> |
| 202 <b>getProjectHelper</b>(<i></i>) | 220 <b>getProjectHelper</b>(<i></i>) |
| 208 <dt>Return:</dt> | 226 <dt>Return:</dt> |
| 209 <dd> | 227 <dd> |
| 210 reference to the project helper object | 228 reference to the project helper object |
| 211 </dd> | 229 </dd> |
| 212 </dl> | 230 </dl> |
| 231 <dl> | |
| 232 <dt>Return Type:</dt> | |
| 233 <dd> | |
| 234 SvnProjectHelper | |
| 235 </dd> | |
| 236 </dl> | |
| 213 <a NAME="VcsSubversionPlugin.getServersPath" ID="VcsSubversionPlugin.getServersPath"></a> | 237 <a NAME="VcsSubversionPlugin.getServersPath" ID="VcsSubversionPlugin.getServersPath"></a> |
| 214 <h4>VcsSubversionPlugin.getServersPath</h4> | 238 <h4>VcsSubversionPlugin.getServersPath</h4> |
| 215 <b>getServersPath</b>(<i></i>) | 239 <b>getServersPath</b>(<i></i>) |
| 216 | 240 |
| 217 <p> | 241 <p> |
| 218 Public method to get the filename of the servers file. | 242 Public method to get the filename of the servers file. |
| 219 </p> | 243 </p> |
| 220 <dl> | 244 <dl> |
| 221 <dt>Return:</dt> | 245 <dt>Return:</dt> |
| 222 <dd> | 246 <dd> |
| 223 filename of the servers file (string) | 247 filename of the servers file |
| 248 </dd> | |
| 249 </dl> | |
| 250 <dl> | |
| 251 <dt>Return Type:</dt> | |
| 252 <dd> | |
| 253 str | |
| 224 </dd> | 254 </dd> |
| 225 </dl> | 255 </dl> |
| 226 <a NAME="VcsSubversionPlugin.initToolbar" ID="VcsSubversionPlugin.initToolbar"></a> | 256 <a NAME="VcsSubversionPlugin.initToolbar" ID="VcsSubversionPlugin.initToolbar"></a> |
| 227 <h4>VcsSubversionPlugin.initToolbar</h4> | 257 <h4>VcsSubversionPlugin.initToolbar</h4> |
| 228 <b>initToolbar</b>(<i>ui, toolbarManager</i>) | 258 <b>initToolbar</b>(<i>ui, toolbarManager</i>) |
| 230 <p> | 260 <p> |
| 231 Public slot to initialize the VCS toolbar. | 261 Public slot to initialize the VCS toolbar. |
| 232 </p> | 262 </p> |
| 233 <dl> | 263 <dl> |
| 234 | 264 |
| 235 <dt><i>ui</i></dt> | 265 <dt><i>ui</i> (UserInterface)</dt> |
| 236 <dd> | 266 <dd> |
| 237 reference to the main window (UserInterface) | 267 reference to the main window |
| 238 </dd> | 268 </dd> |
| 239 <dt><i>toolbarManager</i></dt> | 269 <dt><i>toolbarManager</i> (EricToolBarManager)</dt> |
| 240 <dd> | 270 <dd> |
| 241 reference to a toolbar manager object | 271 reference to a toolbar manager object |
| 242 (EricToolBarManager) | |
| 243 </dd> | 272 </dd> |
| 244 </dl> | 273 </dl> |
| 245 <a NAME="VcsSubversionPlugin.prepareUninstall" ID="VcsSubversionPlugin.prepareUninstall"></a> | 274 <a NAME="VcsSubversionPlugin.prepareUninstall" ID="VcsSubversionPlugin.prepareUninstall"></a> |
| 246 <h4>VcsSubversionPlugin.prepareUninstall</h4> | 275 <h4>VcsSubversionPlugin.prepareUninstall</h4> |
| 247 <b>prepareUninstall</b>(<i></i>) | 276 <b>prepareUninstall</b>(<i></i>) |
| 263 <p> | 292 <p> |
| 264 Public method to store the various settings. | 293 Public method to store the various settings. |
| 265 </p> | 294 </p> |
| 266 <dl> | 295 <dl> |
| 267 | 296 |
| 268 <dt><i>key</i></dt> | 297 <dt><i>key</i> (str)</dt> |
| 269 <dd> | 298 <dd> |
| 270 the key of the setting to be set | 299 the key of the setting to be set |
| 271 </dd> | 300 </dd> |
| 272 <dt><i>value</i></dt> | 301 <dt><i>value</i> (Any)</dt> |
| 273 <dd> | 302 <dd> |
| 274 the value to be set | 303 the value to be set |
| 275 </dd> | 304 </dd> |
| 276 </dl> | 305 </dl> |
| 277 <div align="right"><a href="#top">Up</a></div> | 306 <div align="right"><a href="#top">Up</a></div> |
| 284 <p> | 313 <p> |
| 285 Module function to create the configuration page. | 314 Module function to create the configuration page. |
| 286 </p> | 315 </p> |
| 287 <dl> | 316 <dl> |
| 288 | 317 |
| 289 <dt><i>configDlg</i></dt> | 318 <dt><i>configDlg</i> (QDialog)</dt> |
| 290 <dd> | 319 <dd> |
| 291 reference to the configuration dialog (QDialog) | 320 reference to the configuration dialog |
| 292 </dd> | 321 </dd> |
| 293 </dl> | 322 </dl> |
| 294 <dl> | 323 <dl> |
| 295 <dt>Return:</dt> | 324 <dt>Return:</dt> |
| 296 <dd> | 325 <dd> |
| 297 reference to the configuration page | 326 reference to the configuration page |
| 327 </dd> | |
| 328 </dl> | |
| 329 <dl> | |
| 330 <dt>Return Type:</dt> | |
| 331 <dd> | |
| 332 SubversionPage | |
| 298 </dd> | 333 </dd> |
| 299 </dl> | 334 </dl> |
| 300 <div align="right"><a href="#top">Up</a></div> | 335 <div align="right"><a href="#top">Up</a></div> |
| 301 <hr /> | 336 <hr /> |
| 302 <hr /> | 337 <hr /> |
| 308 Public function to get the display string. | 343 Public function to get the display string. |
| 309 </p> | 344 </p> |
| 310 <dl> | 345 <dl> |
| 311 <dt>Return:</dt> | 346 <dt>Return:</dt> |
| 312 <dd> | 347 <dd> |
| 313 display string (string) | 348 display string |
| 349 </dd> | |
| 350 </dl> | |
| 351 <dl> | |
| 352 <dt>Return Type:</dt> | |
| 353 <dd> | |
| 354 str | |
| 314 </dd> | 355 </dd> |
| 315 </dl> | 356 </dl> |
| 316 <div align="right"><a href="#top">Up</a></div> | 357 <div align="right"><a href="#top">Up</a></div> |
| 317 <hr /> | 358 <hr /> |
| 318 <hr /> | 359 <hr /> |
| 328 <dd> | 369 <dd> |
| 329 dictionary containing the data to query the presence of | 370 dictionary containing the data to query the presence of |
| 330 the executable | 371 the executable |
| 331 </dd> | 372 </dd> |
| 332 </dl> | 373 </dl> |
| 374 <dl> | |
| 375 <dt>Return Type:</dt> | |
| 376 <dd> | |
| 377 dict | |
| 378 </dd> | |
| 379 </dl> | |
| 333 <div align="right"><a href="#top">Up</a></div> | 380 <div align="right"><a href="#top">Up</a></div> |
| 334 <hr /> | 381 <hr /> |
| 335 <hr /> | 382 <hr /> |
| 336 <a NAME="getConfigData" ID="getConfigData"></a> | 383 <a NAME="getConfigData" ID="getConfigData"></a> |
| 337 <h2>getConfigData</h2> | 384 <h2>getConfigData</h2> |
| 342 </p> | 389 </p> |
| 343 <dl> | 390 <dl> |
| 344 <dt>Return:</dt> | 391 <dt>Return:</dt> |
| 345 <dd> | 392 <dd> |
| 346 dictionary with key "zzz_subversionPage" containing the relevant | 393 dictionary with key "zzz_subversionPage" containing the relevant |
| 394 </dd> | |
| 395 </dl> | |
| 396 <dl> | |
| 397 <dt>Return Type:</dt> | |
| 398 <dd> | |
| 399 dict | |
| 347 data | 400 data |
| 348 </dd> | 401 </dd> |
| 349 </dl> | 402 </dl> |
| 350 <div align="right"><a href="#top">Up</a></div> | 403 <div align="right"><a href="#top">Up</a></div> |
| 351 <hr /> | 404 <hr /> |
| 359 </p> | 412 </p> |
| 360 <dl> | 413 <dl> |
| 361 <dt>Return:</dt> | 414 <dt>Return:</dt> |
| 362 <dd> | 415 <dd> |
| 363 dictionary with indicator as key and a tuple with the vcs name | 416 dictionary with indicator as key and a tuple with the vcs name |
| 364 (string) and vcs display string (string) | 417 and vcs display string |
| 418 </dd> | |
| 419 </dl> | |
| 420 <dl> | |
| 421 <dt>Return Type:</dt> | |
| 422 <dd> | |
| 423 dict | |
| 365 </dd> | 424 </dd> |
| 366 </dl> | 425 </dl> |
| 367 <div align="right"><a href="#top">Up</a></div> | 426 <div align="right"><a href="#top">Up</a></div> |
| 368 <hr /> | 427 <hr /> |
| 369 <hr /> | 428 <hr /> |
