--- a/Documentation/Source/eric5.VCS.ProjectBrowserHelper.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.VCS.ProjectBrowserHelper.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.VCS.ProjectBrowserHelper</h1> <p> -Module implementing the base class of the VCS project browser helper. +Module implementing the base class of the VCS project browser helper. </p> <h3>Global Attributes</h3> <table> @@ -32,7 +32,7 @@ <table> <tr> <td><a href="#VcsProjectBrowserHelper">VcsProjectBrowserHelper</a></td> -<td>Class implementing the base class of the VCS project browser helper.</td> +<td>Class implementing the base class of the VCS project browser helper.</td> </tr> </table> <h3>Functions</h3> @@ -43,7 +43,7 @@ <a NAME="VcsProjectBrowserHelper" ID="VcsProjectBrowserHelper"></a> <h2>VcsProjectBrowserHelper</h2> <p> - Class implementing the base class of the VCS project browser helper. + Class implementing the base class of the VCS project browser helper. </p> <h3>Derived from</h3> QObject @@ -55,249 +55,249 @@ <table> <tr> <td><a href="#VcsProjectBrowserHelper.__init__">VcsProjectBrowserHelper</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSAdd">_VCSAdd</a></td> -<td>Protected slot called by the context menu to add the selected file to the VCS repository.</td> +<td>Protected slot called by the context menu to add the selected file to the VCS repository.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSAddTree">_VCSAddTree</a></td> -<td>Protected slot called by the context menu.</td> +<td>Protected slot called by the context menu.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSCommit">_VCSCommit</a></td> -<td>Protected slot called by the context menu to commit the changes to the VCS repository.</td> +<td>Protected slot called by the context menu to commit the changes to the VCS repository.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSDiff">_VCSDiff</a></td> -<td>Protected slot called by the context menu to show the difference of a file/directory to the repository.</td> +<td>Protected slot called by the context menu to show the difference of a file/directory to the repository.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSInfoDisplay">_VCSInfoDisplay</a></td> -<td>Protected slot called to show some vcs information.</td> +<td>Protected slot called to show some vcs information.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSLog">_VCSLog</a></td> -<td>Protected slot called by the context menu to show the VCS log of a file/directory.</td> +<td>Protected slot called by the context menu to show the VCS log of a file/directory.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSMerge">_VCSMerge</a></td> -<td>Protected slot called by the context menu to merge changes into to a file.</td> +<td>Protected slot called by the context menu to merge changes into to a file.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSRemove">_VCSRemove</a></td> -<td>Protected slot called by the context menu to remove the selected file from the VCS repository.</td> +<td>Protected slot called by the context menu to remove the selected file from the VCS repository.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSRevert">_VCSRevert</a></td> -<td>Protected slot called by the context menu to revert changes made to a file.</td> +<td>Protected slot called by the context menu to revert changes made to a file.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSStatus">_VCSStatus</a></td> -<td>Protected slot called by the context menu to show the status of a file.</td> +<td>Protected slot called by the context menu to show the status of a file.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._VCSUpdate">_VCSUpdate</a></td> -<td>Protected slot called by the context menu to update a file from the VCS repository.</td> +<td>Protected slot called by the context menu to update a file from the VCS repository.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper._updateVCSStatus">_updateVCSStatus</a></td> -<td>Protected method to update the VCS status of an item.</td> +<td>Protected method to update the VCS status of an item.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper.addVCSMenus">addVCSMenus</a></td> -<td>Public method to add the VCS entries to the various project browser menus.</td> +<td>Public method to add the VCS entries to the various project browser menus.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper.showContextMenu">showContextMenu</a></td> -<td>Slot called before the context menu is shown.</td> +<td>Slot called before the context menu is shown.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper.showContextMenuDir">showContextMenuDir</a></td> -<td>Slot called before the context menu is shown.</td> +<td>Slot called before the context menu is shown.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper.showContextMenuDirMulti">showContextMenuDirMulti</a></td> -<td>Slot called before the context menu is shown.</td> +<td>Slot called before the context menu is shown.</td> </tr><tr> <td><a href="#VcsProjectBrowserHelper.showContextMenuMulti">showContextMenuMulti</a></td> -<td>Slot called before the context menu (multiple selections) is shown.</td> +<td>Slot called before the context menu (multiple selections) is shown.</td> </tr> </table> <a NAME="VcsProjectBrowserHelper.__init__" ID="VcsProjectBrowserHelper.__init__"></a> <h4>VcsProjectBrowserHelper (Constructor)</h4> <b>VcsProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject, isTranslationsBrowser, parent = None, name = None</i>) <p> - Constructor + Constructor </p><dl> <dt><i>vcsObject</i></dt> <dd> -reference to the vcs object +reference to the vcs object </dd><dt><i>browserObject</i></dt> <dd> -reference to the project browser object +reference to the project browser object </dd><dt><i>projectObject</i></dt> <dd> -reference to the project object +reference to the project object </dd><dt><i>isTranslationsBrowser</i></dt> <dd> -flag indicating, the helper is requested for the - translations browser (this needs some special treatment) +flag indicating, the helper is requested for the + translations browser (this needs some special treatment) </dd><dt><i>parent</i></dt> <dd> -parent widget (QWidget) +parent widget (QWidget) </dd><dt><i>name</i></dt> <dd> -name of this object (string) +name of this object (string) </dd> </dl><a NAME="VcsProjectBrowserHelper._VCSAdd" ID="VcsProjectBrowserHelper._VCSAdd"></a> <h4>VcsProjectBrowserHelper._VCSAdd</h4> <b>_VCSAdd</b>(<i></i>) <p> - Protected slot called by the context menu to add the selected file to the - VCS repository. + Protected slot called by the context menu to add the selected file to the + VCS repository. </p><a NAME="VcsProjectBrowserHelper._VCSAddTree" ID="VcsProjectBrowserHelper._VCSAddTree"></a> <h4>VcsProjectBrowserHelper._VCSAddTree</h4> <b>_VCSAddTree</b>(<i></i>) <p> - Protected slot called by the context menu. + Protected slot called by the context menu. </p><p> - It is used to add the selected - directory tree to the VCS repository. + It is used to add the selected + directory tree to the VCS repository. </p><a NAME="VcsProjectBrowserHelper._VCSCommit" ID="VcsProjectBrowserHelper._VCSCommit"></a> <h4>VcsProjectBrowserHelper._VCSCommit</h4> <b>_VCSCommit</b>(<i></i>) <p> - Protected slot called by the context menu to commit the changes to the - VCS repository. + Protected slot called by the context menu to commit the changes to the + VCS repository. </p><a NAME="VcsProjectBrowserHelper._VCSDiff" ID="VcsProjectBrowserHelper._VCSDiff"></a> <h4>VcsProjectBrowserHelper._VCSDiff</h4> <b>_VCSDiff</b>(<i></i>) <p> - Protected slot called by the context menu to show the difference of a - file/directory to the repository. + Protected slot called by the context menu to show the difference of a + file/directory to the repository. </p><a NAME="VcsProjectBrowserHelper._VCSInfoDisplay" ID="VcsProjectBrowserHelper._VCSInfoDisplay"></a> <h4>VcsProjectBrowserHelper._VCSInfoDisplay</h4> <b>_VCSInfoDisplay</b>(<i></i>) <p> - Protected slot called to show some vcs information. + Protected slot called to show some vcs information. </p><a NAME="VcsProjectBrowserHelper._VCSLog" ID="VcsProjectBrowserHelper._VCSLog"></a> <h4>VcsProjectBrowserHelper._VCSLog</h4> <b>_VCSLog</b>(<i></i>) <p> - Protected slot called by the context menu to show the VCS log of a file/directory. + Protected slot called by the context menu to show the VCS log of a file/directory. </p><a NAME="VcsProjectBrowserHelper._VCSMerge" ID="VcsProjectBrowserHelper._VCSMerge"></a> <h4>VcsProjectBrowserHelper._VCSMerge</h4> <b>_VCSMerge</b>(<i></i>) <p> - Protected slot called by the context menu to merge changes into to a file. + Protected slot called by the context menu to merge changes into to a file. </p><a NAME="VcsProjectBrowserHelper._VCSRemove" ID="VcsProjectBrowserHelper._VCSRemove"></a> <h4>VcsProjectBrowserHelper._VCSRemove</h4> <b>_VCSRemove</b>(<i></i>) <p> - Protected slot called by the context menu to remove the selected file from the - VCS repository. + Protected slot called by the context menu to remove the selected file from the + VCS repository. </p><a NAME="VcsProjectBrowserHelper._VCSRevert" ID="VcsProjectBrowserHelper._VCSRevert"></a> <h4>VcsProjectBrowserHelper._VCSRevert</h4> <b>_VCSRevert</b>(<i></i>) <p> - Protected slot called by the context menu to revert changes made to a file. + Protected slot called by the context menu to revert changes made to a file. </p><a NAME="VcsProjectBrowserHelper._VCSStatus" ID="VcsProjectBrowserHelper._VCSStatus"></a> <h4>VcsProjectBrowserHelper._VCSStatus</h4> <b>_VCSStatus</b>(<i></i>) <p> - Protected slot called by the context menu to show the status of a file. + Protected slot called by the context menu to show the status of a file. </p><a NAME="VcsProjectBrowserHelper._VCSUpdate" ID="VcsProjectBrowserHelper._VCSUpdate"></a> <h4>VcsProjectBrowserHelper._VCSUpdate</h4> <b>_VCSUpdate</b>(<i></i>) <p> - Protected slot called by the context menu to update a file from the - VCS repository. + Protected slot called by the context menu to update a file from the + VCS repository. </p><a NAME="VcsProjectBrowserHelper._updateVCSStatus" ID="VcsProjectBrowserHelper._updateVCSStatus"></a> <h4>VcsProjectBrowserHelper._updateVCSStatus</h4> <b>_updateVCSStatus</b>(<i>name</i>) <p> - Protected method to update the VCS status of an item. + Protected method to update the VCS status of an item. </p><dl> <dt><i>name</i></dt> <dd> -filename or directoryname of the item to be updated (string) +filename or directoryname of the item to be updated (string) </dd> </dl><a NAME="VcsProjectBrowserHelper.addVCSMenus" ID="VcsProjectBrowserHelper.addVCSMenus"></a> <h4>VcsProjectBrowserHelper.addVCSMenus</h4> <b>addVCSMenus</b>(<i>mainMenu, multiMenu, backMenu, dirMenu, dirMultiMenu</i>) <p> - Public method to add the VCS entries to the various project browser menus. + Public method to add the VCS entries to the various project browser menus. </p><dl> <dt><i>mainMenu</i></dt> <dd> -reference to the main menu (QPopupMenu) +reference to the main menu (QPopupMenu) </dd><dt><i>multiMenu</i></dt> <dd> -reference to the multiple selection menu (QPopupMenu) +reference to the multiple selection menu (QPopupMenu) </dd><dt><i>backMenu</i></dt> <dd> -reference to the background menu (QPopupMenu) +reference to the background menu (QPopupMenu) </dd><dt><i>dirMenu</i></dt> <dd> -reference to the directory menu (QPopupMenu) +reference to the directory menu (QPopupMenu) </dd><dt><i>dirMultiMenu</i></dt> <dd> -reference to the multiple selection directory - menu (QPopupMenu) +reference to the multiple selection directory + menu (QPopupMenu) </dd> </dl><a NAME="VcsProjectBrowserHelper.showContextMenu" ID="VcsProjectBrowserHelper.showContextMenu"></a> <h4>VcsProjectBrowserHelper.showContextMenu</h4> <b>showContextMenu</b>(<i>menu, standardItems</i>) <p> - Slot called before the context menu is shown. + Slot called before the context menu is shown. </p><p> - It enables/disables the VCS menu entries depending on the overall - VCS status and the file status. + It enables/disables the VCS menu entries depending on the overall + VCS status and the file status. </p><dl> <dt><i>menu</i></dt> <dd> -reference to the menu to be shown +reference to the menu to be shown </dd><dt><i>standardItems</i></dt> <dd> -array of standard items that need activation/deactivation - depending on the overall VCS status +array of standard items that need activation/deactivation + depending on the overall VCS status </dd> </dl><a NAME="VcsProjectBrowserHelper.showContextMenuDir" ID="VcsProjectBrowserHelper.showContextMenuDir"></a> <h4>VcsProjectBrowserHelper.showContextMenuDir</h4> <b>showContextMenuDir</b>(<i>menu, standardItems</i>) <p> - Slot called before the context menu is shown. + Slot called before the context menu is shown. </p><p> - It enables/disables the VCS menu entries depending on the overall - VCS status and the directory status. + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. </p><dl> <dt><i>menu</i></dt> <dd> -reference to the menu to be shown +reference to the menu to be shown </dd><dt><i>standardItems</i></dt> <dd> -array of standard items that need activation/deactivation - depending on the overall VCS status +array of standard items that need activation/deactivation + depending on the overall VCS status </dd> </dl><a NAME="VcsProjectBrowserHelper.showContextMenuDirMulti" ID="VcsProjectBrowserHelper.showContextMenuDirMulti"></a> <h4>VcsProjectBrowserHelper.showContextMenuDirMulti</h4> <b>showContextMenuDirMulti</b>(<i>menu, standardItems</i>) <p> - Slot called before the context menu is shown. + Slot called before the context menu is shown. </p><p> - It enables/disables the VCS menu entries depending on the overall - VCS status and the directory status. + It enables/disables the VCS menu entries depending on the overall + VCS status and the directory status. </p><dl> <dt><i>menu</i></dt> <dd> -reference to the menu to be shown +reference to the menu to be shown </dd><dt><i>standardItems</i></dt> <dd> -array of standard items that need activation/deactivation - depending on the overall VCS status +array of standard items that need activation/deactivation + depending on the overall VCS status </dd> </dl><a NAME="VcsProjectBrowserHelper.showContextMenuMulti" ID="VcsProjectBrowserHelper.showContextMenuMulti"></a> <h4>VcsProjectBrowserHelper.showContextMenuMulti</h4> <b>showContextMenuMulti</b>(<i>menu, standardItems</i>) <p> - Slot called before the context menu (multiple selections) is shown. + Slot called before the context menu (multiple selections) is shown. </p><p> - It enables/disables the VCS menu entries depending on the overall - VCS status and the files status. + It enables/disables the VCS menu entries depending on the overall + VCS status and the files status. </p><dl> <dt><i>menu</i></dt> <dd> -reference to the menu to be shown +reference to the menu to be shown </dd><dt><i>standardItems</i></dt> <dd> -array of standard items that need activation/deactivation - depending on the overall VCS status +array of standard items that need activation/deactivation + depending on the overall VCS status </dd> </dl> <div align="right"><a href="#top">Up</a></div>