Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.bookmarks.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.bookmarks</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.bookmarks</h1>
<p>
Module implementing the bookmarks extension interface.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#Bookmarks">Bookmarks</a></td>
<td>Class implementing the bookmarks extension interface.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="Bookmarks" ID="Bookmarks"></a>
<h2>Bookmarks</h2>
<p>
    Class implementing the bookmarks extension interface.
</p>
<h3>Derived from</h3>
HgExtension
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#Bookmarks.__init__">Bookmarks</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#Bookmarks.__getInOutBookmarks">__getInOutBookmarks</a></td>
<td>Public method to get the list of incoming or outgoing bookmarks.</td>
</tr><tr>
<td><a href="#Bookmarks.hgBookmarkDefine">hgBookmarkDefine</a></td>
<td>Public method to define a bookmark.</td>
</tr><tr>
<td><a href="#Bookmarks.hgBookmarkDelete">hgBookmarkDelete</a></td>
<td>Public method to delete a bookmark.</td>
</tr><tr>
<td><a href="#Bookmarks.hgBookmarkIncoming">hgBookmarkIncoming</a></td>
<td>Public method to show a list of incoming bookmarks.</td>
</tr><tr>
<td><a href="#Bookmarks.hgBookmarkMove">hgBookmarkMove</a></td>
<td>Public method to move a bookmark.</td>
</tr><tr>
<td><a href="#Bookmarks.hgBookmarkOutgoing">hgBookmarkOutgoing</a></td>
<td>Public method to show a list of outgoing bookmarks.</td>
</tr><tr>
<td><a href="#Bookmarks.hgBookmarkPull">hgBookmarkPull</a></td>
<td>Public method to pull a bookmark from a remote repository.</td>
</tr><tr>
<td><a href="#Bookmarks.hgBookmarkPush">hgBookmarkPush</a></td>
<td>Public method to push a bookmark to a remote repository.</td>
</tr><tr>
<td><a href="#Bookmarks.hgBookmarkRename">hgBookmarkRename</a></td>
<td>Public method to rename a bookmark.</td>
</tr><tr>
<td><a href="#Bookmarks.hgGetBookmarksList">hgGetBookmarksList</a></td>
<td>Public method to get the list of bookmarks.</td>
</tr><tr>
<td><a href="#Bookmarks.hgListBookmarks">hgListBookmarks</a></td>
<td>Public method used to list the available bookmarks.</td>
</tr><tr>
<td><a href="#Bookmarks.shutdown">shutdown</a></td>
<td>Public method used to shutdown the bookmarks interface.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="Bookmarks.__init__" ID="Bookmarks.__init__"></a>
<h4>Bookmarks (Constructor)</h4>
<b>Bookmarks</b>(<i>vcs</i>)
<p>
        Constructor
</p><dl>
<dt><i>vcs</i></dt>
<dd>
reference to the Mercurial vcs object
</dd>
</dl><a NAME="Bookmarks.__getInOutBookmarks" ID="Bookmarks.__getInOutBookmarks"></a>
<h4>Bookmarks.__getInOutBookmarks</h4>
<b>__getInOutBookmarks</b>(<i>repodir, incoming</i>)
<p>
        Public method to get the list of incoming or outgoing bookmarks.
</p><dl>
<dt><i>repodir</i></dt>
<dd>
directory name of the repository (string)
</dd><dt><i>incoming</i></dt>
<dd>
flag indicating to get incoming bookmarks (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of bookmarks (list of string)
</dd>
</dl><a NAME="Bookmarks.hgBookmarkDefine" ID="Bookmarks.hgBookmarkDefine"></a>
<h4>Bookmarks.hgBookmarkDefine</h4>
<b>hgBookmarkDefine</b>(<i>name</i>)
<p>
        Public method to define a bookmark.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Bookmarks.hgBookmarkDelete" ID="Bookmarks.hgBookmarkDelete"></a>
<h4>Bookmarks.hgBookmarkDelete</h4>
<b>hgBookmarkDelete</b>(<i>name</i>)
<p>
        Public method to delete a bookmark.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Bookmarks.hgBookmarkIncoming" ID="Bookmarks.hgBookmarkIncoming"></a>
<h4>Bookmarks.hgBookmarkIncoming</h4>
<b>hgBookmarkIncoming</b>(<i>name</i>)
<p>
        Public method to show a list of incoming bookmarks.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Bookmarks.hgBookmarkMove" ID="Bookmarks.hgBookmarkMove"></a>
<h4>Bookmarks.hgBookmarkMove</h4>
<b>hgBookmarkMove</b>(<i>name</i>)
<p>
        Public method to move a bookmark.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Bookmarks.hgBookmarkOutgoing" ID="Bookmarks.hgBookmarkOutgoing"></a>
<h4>Bookmarks.hgBookmarkOutgoing</h4>
<b>hgBookmarkOutgoing</b>(<i>name</i>)
<p>
        Public method to show a list of outgoing bookmarks.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Bookmarks.hgBookmarkPull" ID="Bookmarks.hgBookmarkPull"></a>
<h4>Bookmarks.hgBookmarkPull</h4>
<b>hgBookmarkPull</b>(<i>name</i>)
<p>
        Public method to pull a bookmark from a remote repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Bookmarks.hgBookmarkPush" ID="Bookmarks.hgBookmarkPush"></a>
<h4>Bookmarks.hgBookmarkPush</h4>
<b>hgBookmarkPush</b>(<i>name</i>)
<p>
        Public method to push a bookmark to a remote repository.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Bookmarks.hgBookmarkRename" ID="Bookmarks.hgBookmarkRename"></a>
<h4>Bookmarks.hgBookmarkRename</h4>
<b>hgBookmarkRename</b>(<i>name</i>)
<p>
        Public method to rename a bookmark.
</p><dl>
<dt><i>name</i></dt>
<dd>
file/directory name (string)
</dd>
</dl><a NAME="Bookmarks.hgGetBookmarksList" ID="Bookmarks.hgGetBookmarksList"></a>
<h4>Bookmarks.hgGetBookmarksList</h4>
<b>hgGetBookmarksList</b>(<i>repodir</i>)
<p>
        Public method to get the list of bookmarks.
</p><dl>
<dt><i>repodir</i></dt>
<dd>
directory name of the repository (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of bookmarks (list of string)
</dd>
</dl><a NAME="Bookmarks.hgListBookmarks" ID="Bookmarks.hgListBookmarks"></a>
<h4>Bookmarks.hgListBookmarks</h4>
<b>hgListBookmarks</b>(<i>path</i>)
<p>
        Public method used to list the available bookmarks.
</p><dl>
<dt><i>path</i></dt>
<dd>
directory name of the project (string)
</dd>
</dl><a NAME="Bookmarks.shutdown" ID="Bookmarks.shutdown"></a>
<h4>Bookmarks.shutdown</h4>
<b>shutdown</b>(<i></i>)
<p>
        Public method used to shutdown the bookmarks interface.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>