Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html

changeset 1020
adf7e95f05e7
parent 1005
6986db425aa2
child 1064
10bdbb173c0f
equal deleted inserted replaced
1019:d8a9697f78d1 1020:adf7e95f05e7
61 <table> 61 <table>
62 <tr> 62 <tr>
63 <td><a href="#Hg.__init__">Hg</a></td> 63 <td><a href="#Hg.__init__">Hg</a></td>
64 <td>Constructor</td> 64 <td>Constructor</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#Hg.__getExtensionsInfo">__getExtensionsInfo</a></td>
67 <td>Private method to get the active extensions from Mercurial.</td>
68 </tr><tr>
66 <td><a href="#Hg.__hgURL">__hgURL</a></td> 69 <td><a href="#Hg.__hgURL">__hgURL</a></td>
67 <td>Private method to format a url for Mercurial.</td> 70 <td>Private method to format a url for Mercurial.</td>
68 </tr><tr> 71 </tr><tr>
72 <td><a href="#Hg.__iniFileChanged">__iniFileChanged</a></td>
73 <td>Private slot to handle a change of the Mercurial config file.</td>
74 </tr><tr>
75 <td><a href="#Hg.__monitorRepoIniFile">__monitorRepoIniFile</a></td>
76 <td>Private slot to add a repository config file to the list of monitored files.</td>
77 </tr><tr>
69 <td><a href="#Hg.__vcsCommit_Step2">__vcsCommit_Step2</a></td> 78 <td><a href="#Hg.__vcsCommit_Step2">__vcsCommit_Step2</a></td>
70 <td>Private slot performing the second step of the commit action.</td> 79 <td>Private slot performing the second step of the commit action.</td>
71 </tr><tr> 80 </tr><tr>
72 <td><a href="#Hg._createStatusMonitorThread">_createStatusMonitorThread</a></td> 81 <td><a href="#Hg._createStatusMonitorThread">_createStatusMonitorThread</a></td>
73 <td>Protected method to create an instance of the VCS status monitor thread.</td> 82 <td>Protected method to create an instance of the VCS status monitor thread.</td>
74 </tr><tr> 83 </tr><tr>
75 <td><a href="#Hg.clearStatusCache">clearStatusCache</a></td> 84 <td><a href="#Hg.clearStatusCache">clearStatusCache</a></td>
76 <td>Public method to clear the status cache.</td> 85 <td>Public method to clear the status cache.</td>
77 </tr><tr> 86 </tr><tr>
87 <td><a href="#Hg.getExtensionObject">getExtensionObject</a></td>
88 <td>Public method to get a reference to an extension object.</td>
89 </tr><tr>
78 <td><a href="#Hg.getPlugin">getPlugin</a></td> 90 <td><a href="#Hg.getPlugin">getPlugin</a></td>
79 <td>Public method to get a reference to the plugin object.</td> 91 <td>Public method to get a reference to the plugin object.</td>
80 </tr><tr> 92 </tr><tr>
81 <td><a href="#Hg.hgAnnotate">hgAnnotate</a></td> 93 <td><a href="#Hg.hgAnnotate">hgAnnotate</a></td>
82 <td>Public method to show the output of the hg annotate command.</td> 94 <td>Public method to show the output of the hg annotate command.</td>
106 <td>Public method used to view the difference of a file/directory to the Mercurial repository.</td> 118 <td>Public method used to view the difference of a file/directory to the Mercurial repository.</td>
107 </tr><tr> 119 </tr><tr>
108 <td><a href="#Hg.hgForget">hgForget</a></td> 120 <td><a href="#Hg.hgForget">hgForget</a></td>
109 <td>Public method used to remove a file from the Mercurial repository.</td> 121 <td>Public method used to remove a file from the Mercurial repository.</td>
110 </tr><tr> 122 </tr><tr>
123 <td><a href="#Hg.hgGetBranchesList">hgGetBranchesList</a></td>
124 <td>Public method to get the list of branches.</td>
125 </tr><tr>
126 <td><a href="#Hg.hgGetTagsList">hgGetTagsList</a></td>
127 <td>Public method to get the list of tags.</td>
128 </tr><tr>
111 <td><a href="#Hg.hgIdentify">hgIdentify</a></td> 129 <td><a href="#Hg.hgIdentify">hgIdentify</a></td>
112 <td>Public method to identify the current working directory.</td> 130 <td>Public method to identify the current working directory.</td>
113 </tr><tr> 131 </tr><tr>
114 <td><a href="#Hg.hgIdentifyBundle">hgIdentifyBundle</a></td> 132 <td><a href="#Hg.hgIdentifyBundle">hgIdentifyBundle</a></td>
115 <td>Public method used to identify a changegroup file.</td> 133 <td>Public method used to identify a changegroup file.</td>
169 <td>Public method to apply changegroup files.</td> 187 <td>Public method to apply changegroup files.</td>
170 </tr><tr> 188 </tr><tr>
171 <td><a href="#Hg.hgVerify">hgVerify</a></td> 189 <td><a href="#Hg.hgVerify">hgVerify</a></td>
172 <td>Public method to verify the integrity of the repository.</td> 190 <td>Public method to verify the integrity of the repository.</td>
173 </tr><tr> 191 </tr><tr>
192 <td><a href="#Hg.isExtensionActive">isExtensionActive</a></td>
193 <td>Public method to check, if an extension is active.</td>
194 </tr><tr>
174 <td><a href="#Hg.vcsAdd">vcsAdd</a></td> 195 <td><a href="#Hg.vcsAdd">vcsAdd</a></td>
175 <td>Public method used to add a file/directory to the Mercurial repository.</td> 196 <td>Public method used to add a file/directory to the Mercurial repository.</td>
176 </tr><tr> 197 </tr><tr>
177 <td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td> 198 <td><a href="#Hg.vcsAddBinary">vcsAddBinary</a></td>
178 <td>Public method used to add a file/directory in binary mode to the Mercurial repository.</td> 199 <td>Public method used to add a file/directory in binary mode to the Mercurial repository.</td>
206 </tr><tr> 227 </tr><tr>
207 <td><a href="#Hg.vcsExport">vcsExport</a></td> 228 <td><a href="#Hg.vcsExport">vcsExport</a></td>
208 <td>Public method used to export a directory from the Subversion repository.</td> 229 <td>Public method used to export a directory from the Subversion repository.</td>
209 </tr><tr> 230 </tr><tr>
210 <td><a href="#Hg.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td> 231 <td><a href="#Hg.vcsGetProjectBrowserHelper">vcsGetProjectBrowserHelper</a></td>
211 <td>Public method to instanciate a helper object for the different project browsers.</td> 232 <td>Public method to instantiate a helper object for the different project browsers.</td>
212 </tr><tr> 233 </tr><tr>
213 <td><a href="#Hg.vcsGetProjectHelper">vcsGetProjectHelper</a></td> 234 <td><a href="#Hg.vcsGetProjectHelper">vcsGetProjectHelper</a></td>
214 <td>Public method to instanciate a helper object for the project.</td> 235 <td>Public method to instantiate a helper object for the project.</td>
215 </tr><tr> 236 </tr><tr>
216 <td><a href="#Hg.vcsImport">vcsImport</a></td> 237 <td><a href="#Hg.vcsImport">vcsImport</a></td>
217 <td>Public method used to import the project into the Subversion repository.</td> 238 <td>Public method used to import the project into the Subversion repository.</td>
218 </tr><tr> 239 </tr><tr>
219 <td><a href="#Hg.vcsInit">vcsInit</a></td> 240 <td><a href="#Hg.vcsInit">vcsInit</a></td>
279 parent widget (QWidget) 300 parent widget (QWidget)
280 </dd><dt><i>name</i></dt> 301 </dd><dt><i>name</i></dt>
281 <dd> 302 <dd>
282 name of this object (string) 303 name of this object (string)
283 </dd> 304 </dd>
284 </dl><a NAME="Hg.__hgURL" ID="Hg.__hgURL"></a> 305 </dl><a NAME="Hg.__getExtensionsInfo" ID="Hg.__getExtensionsInfo"></a>
306 <h4>Hg.__getExtensionsInfo</h4>
307 <b>__getExtensionsInfo</b>(<i></i>)
308 <p>
309 Private method to get the active extensions from Mercurial.
310 </p><a NAME="Hg.__hgURL" ID="Hg.__hgURL"></a>
285 <h4>Hg.__hgURL</h4> 311 <h4>Hg.__hgURL</h4>
286 <b>__hgURL</b>(<i>url</i>) 312 <b>__hgURL</b>(<i>url</i>)
287 <p> 313 <p>
288 Private method to format a url for Mercurial. 314 Private method to format a url for Mercurial.
289 </p><dl> 315 </p><dl>
293 </dd> 319 </dd>
294 </dl><dl> 320 </dl><dl>
295 <dt>Returns:</dt> 321 <dt>Returns:</dt>
296 <dd> 322 <dd>
297 properly formated url for subversion (string) 323 properly formated url for subversion (string)
324 </dd>
325 </dl><a NAME="Hg.__iniFileChanged" ID="Hg.__iniFileChanged"></a>
326 <h4>Hg.__iniFileChanged</h4>
327 <b>__iniFileChanged</b>(<i>path</i>)
328 <p>
329 Private slot to handle a change of the Mercurial config file.
330 </p><dl>
331 <dt><i>path</i></dt>
332 <dd>
333 name of the changed file (string)
334 </dd>
335 </dl><a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a>
336 <h4>Hg.__monitorRepoIniFile</h4>
337 <b>__monitorRepoIniFile</b>(<i>name</i>)
338 <p>
339 Private slot to add a repository config file to the list of monitored files.
340 </p><dl>
341 <dt><i>name</i></dt>
342 <dd>
343 directory name pointing into the repository (string)
298 </dd> 344 </dd>
299 </dl><a NAME="Hg.__vcsCommit_Step2" ID="Hg.__vcsCommit_Step2"></a> 345 </dl><a NAME="Hg.__vcsCommit_Step2" ID="Hg.__vcsCommit_Step2"></a>
300 <h4>Hg.__vcsCommit_Step2</h4> 346 <h4>Hg.__vcsCommit_Step2</h4>
301 <b>__vcsCommit_Step2</b>(<i></i>) 347 <b>__vcsCommit_Step2</b>(<i></i>)
302 <p> 348 <p>
322 </dl><a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a> 368 </dl><a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a>
323 <h4>Hg.clearStatusCache</h4> 369 <h4>Hg.clearStatusCache</h4>
324 <b>clearStatusCache</b>(<i></i>) 370 <b>clearStatusCache</b>(<i></i>)
325 <p> 371 <p>
326 Public method to clear the status cache. 372 Public method to clear the status cache.
327 </p><a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a> 373 </p><a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a>
374 <h4>Hg.getExtensionObject</h4>
375 <b>getExtensionObject</b>(<i>extensionName</i>)
376 <p>
377 Public method to get a reference to an extension object.
378 </p><dl>
379 <dt><i>extensionName</i></dt>
380 <dd>
381 name of the extension (string)
382 </dd>
383 </dl><dl>
384 <dt>Returns:</dt>
385 <dd>
386 reference to the extension object (boolean)
387 </dd>
388 </dl><a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a>
328 <h4>Hg.getPlugin</h4> 389 <h4>Hg.getPlugin</h4>
329 <b>getPlugin</b>(<i></i>) 390 <b>getPlugin</b>(<i></i>)
330 <p> 391 <p>
331 Public method to get a reference to the plugin object. 392 Public method to get a reference to the plugin object.
332 </p><dl> 393 </p><dl>
461 </p><dl> 522 </p><dl>
462 <dt><i>name</i></dt> 523 <dt><i>name</i></dt>
463 <dd> 524 <dd>
464 file/directory name to be removed (string or list of strings)) 525 file/directory name to be removed (string or list of strings))
465 </dd> 526 </dd>
527 </dl><a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a>
528 <h4>Hg.hgGetBranchesList</h4>
529 <b>hgGetBranchesList</b>(<i>repodir</i>)
530 <p>
531 Public method to get the list of branches.
532 </p><dl>
533 <dt><i>repodir</i></dt>
534 <dd>
535 directory name of the repository (string)
536 </dd>
537 </dl><dl>
538 <dt>Returns:</dt>
539 <dd>
540 list of branches (list of string)
541 </dd>
542 </dl><a NAME="Hg.hgGetTagsList" ID="Hg.hgGetTagsList"></a>
543 <h4>Hg.hgGetTagsList</h4>
544 <b>hgGetTagsList</b>(<i>repodir</i>)
545 <p>
546 Public method to get the list of tags.
547 </p><dl>
548 <dt><i>repodir</i></dt>
549 <dd>
550 directory name of the repository (string)
551 </dd>
552 </dl><dl>
553 <dt>Returns:</dt>
554 <dd>
555 list of tags (list of string)
556 </dd>
466 </dl><a NAME="Hg.hgIdentify" ID="Hg.hgIdentify"></a> 557 </dl><a NAME="Hg.hgIdentify" ID="Hg.hgIdentify"></a>
467 <h4>Hg.hgIdentify</h4> 558 <h4>Hg.hgIdentify</h4>
468 <b>hgIdentify</b>(<i>name</i>) 559 <b>hgIdentify</b>(<i>name</i>)
469 <p> 560 <p>
470 Public method to identify the current working directory. 561 Public method to identify the current working directory.
699 Public method to verify the integrity of the repository. 790 Public method to verify the integrity of the repository.
700 </p><dl> 791 </p><dl>
701 <dt><i>name</i></dt> 792 <dt><i>name</i></dt>
702 <dd> 793 <dd>
703 file/directory name (string) 794 file/directory name (string)
795 </dd>
796 </dl><a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a>
797 <h4>Hg.isExtensionActive</h4>
798 <b>isExtensionActive</b>(<i>extensionName</i>)
799 <p>
800 Public method to check, if an extension is active.
801 </p><dl>
802 <dt><i>extensionName</i></dt>
803 <dd>
804 name of the extension to check for (string)
805 </dd>
806 </dl><dl>
807 <dt>Returns:</dt>
808 <dd>
809 flag indicating an active extension (boolean)
704 </dd> 810 </dd>
705 </dl><a NAME="Hg.vcsAdd" ID="Hg.vcsAdd"></a> 811 </dl><a NAME="Hg.vcsAdd" ID="Hg.vcsAdd"></a>
706 <h4>Hg.vcsAdd</h4> 812 <h4>Hg.vcsAdd</h4>
707 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>) 813 <b>vcsAdd</b>(<i>name, isDir=False, noDialog=False</i>)
708 <p> 814 <p>
887 </dd> 993 </dd>
888 </dl><a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a> 994 </dl><a NAME="Hg.vcsGetProjectBrowserHelper" ID="Hg.vcsGetProjectBrowserHelper"></a>
889 <h4>Hg.vcsGetProjectBrowserHelper</h4> 995 <h4>Hg.vcsGetProjectBrowserHelper</h4>
890 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>) 996 <b>vcsGetProjectBrowserHelper</b>(<i>browser, project, isTranslationsBrowser=False</i>)
891 <p> 997 <p>
892 Public method to instanciate a helper object for the different project browsers. 998 Public method to instantiate a helper object for the different project browsers.
893 </p><dl> 999 </p><dl>
894 <dt><i>browser</i></dt> 1000 <dt><i>browser</i></dt>
895 <dd> 1001 <dd>
896 reference to the project browser object 1002 reference to the project browser object
897 </dd><dt><i>project</i></dt> 1003 </dd><dt><i>project</i></dt>
909 </dd> 1015 </dd>
910 </dl><a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a> 1016 </dl><a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a>
911 <h4>Hg.vcsGetProjectHelper</h4> 1017 <h4>Hg.vcsGetProjectHelper</h4>
912 <b>vcsGetProjectHelper</b>(<i>project</i>) 1018 <b>vcsGetProjectHelper</b>(<i>project</i>)
913 <p> 1019 <p>
914 Public method to instanciate a helper object for the project. 1020 Public method to instantiate a helper object for the project.
915 </p><dl> 1021 </p><dl>
916 <dt><i>project</i></dt> 1022 <dt><i>project</i></dt>
917 <dd> 1023 <dd>
918 reference to the project object 1024 reference to the project object
919 </dd> 1025 </dd>

eric ide

mercurial