Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.ProjectHelper.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.ProjectHelper</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.ProjectHelper</h1>
<p>
Module implementing the bookmarks extension project helper.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#BookmarksProjectHelper">BookmarksProjectHelper</a></td>
<td>Class implementing the bookmarks extension project helper.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="BookmarksProjectHelper" ID="BookmarksProjectHelper"></a>
<h2>BookmarksProjectHelper</h2>
<p>
    Class implementing the bookmarks extension project helper.
</p>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#BookmarksProjectHelper.__init__">BookmarksProjectHelper</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.__hgBookmarkDefine">__hgBookmarkDefine</a></td>
<td>Private slot used to define a bookmark.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.__hgBookmarkDelete">__hgBookmarkDelete</a></td>
<td>Private slot used to delete a bookmark.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.__hgBookmarkIncoming">__hgBookmarkIncoming</a></td>
<td>Private slot used to show a list of incoming bookmarks.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.__hgBookmarkMove">__hgBookmarkMove</a></td>
<td>Private slot used to move a bookmark.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.__hgBookmarkOutgoing">__hgBookmarkOutgoing</a></td>
<td>Private slot used to show a list of outgoing bookmarks.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.__hgBookmarkPull">__hgBookmarkPull</a></td>
<td>Private slot used to pull a bookmark from a remote repository.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.__hgBookmarkPush">__hgBookmarkPush</a></td>
<td>Private slot used to push a bookmark to a remote repository.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.__hgBookmarkRename">__hgBookmarkRename</a></td>
<td>Private slot used to rename a bookmark.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.__hgBookmarksList">__hgBookmarksList</a></td>
<td>Private slot used to list the bookmarks.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.getActions">getActions</a></td>
<td>Public method to get a list of all actions.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.initActions">initActions</a></td>
<td>Public method to generate the action objects.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.initMenu">initMenu</a></td>
<td>Public method to generate the extension menu.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.menuTitle">menuTitle</a></td>
<td>Public method to get the menu title.</td>
</tr><tr>
<td><a href="#BookmarksProjectHelper.setObjects">setObjects</a></td>
<td>Public method to set references to the vcs and project objects.</td>
</tr>
</table>
<a NAME="BookmarksProjectHelper.__init__" ID="BookmarksProjectHelper.__init__"></a>
<h4>BookmarksProjectHelper (Constructor)</h4>
<b>BookmarksProjectHelper</b>(<i></i>)
<p>
        Constructor
</p><a NAME="BookmarksProjectHelper.__hgBookmarkDefine" ID="BookmarksProjectHelper.__hgBookmarkDefine"></a>
<h4>BookmarksProjectHelper.__hgBookmarkDefine</h4>
<b>__hgBookmarkDefine</b>(<i></i>)
<p>
        Private slot used to define a bookmark.
</p><a NAME="BookmarksProjectHelper.__hgBookmarkDelete" ID="BookmarksProjectHelper.__hgBookmarkDelete"></a>
<h4>BookmarksProjectHelper.__hgBookmarkDelete</h4>
<b>__hgBookmarkDelete</b>(<i></i>)
<p>
        Private slot used to delete a bookmark.
</p><a NAME="BookmarksProjectHelper.__hgBookmarkIncoming" ID="BookmarksProjectHelper.__hgBookmarkIncoming"></a>
<h4>BookmarksProjectHelper.__hgBookmarkIncoming</h4>
<b>__hgBookmarkIncoming</b>(<i></i>)
<p>
        Private slot used to show a list of incoming bookmarks.
</p><a NAME="BookmarksProjectHelper.__hgBookmarkMove" ID="BookmarksProjectHelper.__hgBookmarkMove"></a>
<h4>BookmarksProjectHelper.__hgBookmarkMove</h4>
<b>__hgBookmarkMove</b>(<i></i>)
<p>
        Private slot used to move a bookmark.
</p><a NAME="BookmarksProjectHelper.__hgBookmarkOutgoing" ID="BookmarksProjectHelper.__hgBookmarkOutgoing"></a>
<h4>BookmarksProjectHelper.__hgBookmarkOutgoing</h4>
<b>__hgBookmarkOutgoing</b>(<i></i>)
<p>
        Private slot used to show a list of outgoing bookmarks.
</p><a NAME="BookmarksProjectHelper.__hgBookmarkPull" ID="BookmarksProjectHelper.__hgBookmarkPull"></a>
<h4>BookmarksProjectHelper.__hgBookmarkPull</h4>
<b>__hgBookmarkPull</b>(<i></i>)
<p>
        Private slot used to pull a bookmark from a remote repository.
</p><a NAME="BookmarksProjectHelper.__hgBookmarkPush" ID="BookmarksProjectHelper.__hgBookmarkPush"></a>
<h4>BookmarksProjectHelper.__hgBookmarkPush</h4>
<b>__hgBookmarkPush</b>(<i></i>)
<p>
        Private slot used to push a bookmark to a remote repository.
</p><a NAME="BookmarksProjectHelper.__hgBookmarkRename" ID="BookmarksProjectHelper.__hgBookmarkRename"></a>
<h4>BookmarksProjectHelper.__hgBookmarkRename</h4>
<b>__hgBookmarkRename</b>(<i></i>)
<p>
        Private slot used to rename a bookmark.
</p><a NAME="BookmarksProjectHelper.__hgBookmarksList" ID="BookmarksProjectHelper.__hgBookmarksList"></a>
<h4>BookmarksProjectHelper.__hgBookmarksList</h4>
<b>__hgBookmarksList</b>(<i></i>)
<p>
        Private slot used to list the bookmarks.
</p><a NAME="BookmarksProjectHelper.getActions" ID="BookmarksProjectHelper.getActions"></a>
<h4>BookmarksProjectHelper.getActions</h4>
<b>getActions</b>(<i></i>)
<p>
        Public method to get a list of all actions.
</p><dl>
<dt>Returns:</dt>
<dd>
list of all actions (list of E5Action)
</dd>
</dl><a NAME="BookmarksProjectHelper.initActions" ID="BookmarksProjectHelper.initActions"></a>
<h4>BookmarksProjectHelper.initActions</h4>
<b>initActions</b>(<i></i>)
<p>
        Public method to generate the action objects.
</p><a NAME="BookmarksProjectHelper.initMenu" ID="BookmarksProjectHelper.initMenu"></a>
<h4>BookmarksProjectHelper.initMenu</h4>
<b>initMenu</b>(<i>mainMenu</i>)
<p>
        Public method to generate the extension menu.
</p><dl>
<dt><i>mainMenu</i></dt>
<dd>
reference to the main menu (QMenu)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
populated menu (QMenu)
</dd>
</dl><a NAME="BookmarksProjectHelper.menuTitle" ID="BookmarksProjectHelper.menuTitle"></a>
<h4>BookmarksProjectHelper.menuTitle</h4>
<b>menuTitle</b>(<i></i>)
<p>
        Public method to get the menu title.
</p><a NAME="BookmarksProjectHelper.setObjects" ID="BookmarksProjectHelper.setObjects"></a>
<h4>BookmarksProjectHelper.setObjects</h4>
<b>setObjects</b>(<i>vcsObject, projectObject</i>)
<p>
        Public method to set references to the vcs and project objects.
</p><dl>
<dt><i>vcsObject</i></dt>
<dd>
reference to the vcs object
</dd><dt><i>projectObject</i></dt>
<dd>
reference to the project object
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>