Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.bookmarks.html

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

changeset 1020
adf7e95f05e7
child 1066
a3dd41fd9ea8
equal deleted inserted replaced
1019:d8a9697f78d1 1020:adf7e95f05e7
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.bookmarks</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.bookmarks</h1>
24 <p>
25 Module implementing the bookmarks extension interface.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#Bookmarks">Bookmarks</a></td>
35 <td>Class implementing the bookmarks extension interface.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="Bookmarks" ID="Bookmarks"></a>
44 <h2>Bookmarks</h2>
45 <p>
46 Class implementing the bookmarks extension interface.
47 </p>
48 <h3>Derived from</h3>
49 QObject
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#Bookmarks.__init__">Bookmarks</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#Bookmarks.__getInOutBookmarks">__getInOutBookmarks</a></td>
61 <td>Public method to get the list of incoming or outgoing bookmarks.</td>
62 </tr><tr>
63 <td><a href="#Bookmarks.hgBookmarkDefine">hgBookmarkDefine</a></td>
64 <td>Public method to define a bookmark.</td>
65 </tr><tr>
66 <td><a href="#Bookmarks.hgBookmarkDelete">hgBookmarkDelete</a></td>
67 <td>Public method to delete a bookmark.</td>
68 </tr><tr>
69 <td><a href="#Bookmarks.hgBookmarkIncoming">hgBookmarkIncoming</a></td>
70 <td>Public method to show a list of incoming bookmarks.</td>
71 </tr><tr>
72 <td><a href="#Bookmarks.hgBookmarkMove">hgBookmarkMove</a></td>
73 <td>Public method to move a bookmark.</td>
74 </tr><tr>
75 <td><a href="#Bookmarks.hgBookmarkOutgoing">hgBookmarkOutgoing</a></td>
76 <td>Public method to show a list of outgoing bookmarks.</td>
77 </tr><tr>
78 <td><a href="#Bookmarks.hgBookmarkPull">hgBookmarkPull</a></td>
79 <td>Public method to pull a bookmark from a remote repository.</td>
80 </tr><tr>
81 <td><a href="#Bookmarks.hgBookmarkPush">hgBookmarkPush</a></td>
82 <td>Public method to push a bookmark to a remote repository.</td>
83 </tr><tr>
84 <td><a href="#Bookmarks.hgBookmarkRename">hgBookmarkRename</a></td>
85 <td>Public method to rename a bookmark.</td>
86 </tr><tr>
87 <td><a href="#Bookmarks.hgGetBookmarksList">hgGetBookmarksList</a></td>
88 <td>Public method to get the list of bookmarks.</td>
89 </tr><tr>
90 <td><a href="#Bookmarks.hgListBookmarks">hgListBookmarks</a></td>
91 <td>Public method used to list the available bookmarks.</td>
92 </tr><tr>
93 <td><a href="#Bookmarks.shutdown">shutdown</a></td>
94 <td>Public method used to shutdown the bookmarks interface.</td>
95 </tr>
96 </table>
97 <a NAME="Bookmarks.__init__" ID="Bookmarks.__init__"></a>
98 <h4>Bookmarks (Constructor)</h4>
99 <b>Bookmarks</b>(<i>vcs</i>)
100 <p>
101 Constructor
102 </p><a NAME="Bookmarks.__getInOutBookmarks" ID="Bookmarks.__getInOutBookmarks"></a>
103 <h4>Bookmarks.__getInOutBookmarks</h4>
104 <b>__getInOutBookmarks</b>(<i>repodir, incoming</i>)
105 <p>
106 Public method to get the list of incoming or outgoing bookmarks.
107 </p><dl>
108 <dt><i>repodir</i></dt>
109 <dd>
110 directory name of the repository (string)
111 </dd><dt><i>incoming</i></dt>
112 <dd>
113 flag indicating to get incoming bookmarks (boolean)
114 </dd>
115 </dl><dl>
116 <dt>Returns:</dt>
117 <dd>
118 list of bookmarks (list of string)
119 </dd>
120 </dl><a NAME="Bookmarks.hgBookmarkDefine" ID="Bookmarks.hgBookmarkDefine"></a>
121 <h4>Bookmarks.hgBookmarkDefine</h4>
122 <b>hgBookmarkDefine</b>(<i>name</i>)
123 <p>
124 Public method to define a bookmark.
125 </p><dl>
126 <dt><i>name</i></dt>
127 <dd>
128 file/directory name (string)
129 </dd>
130 </dl><a NAME="Bookmarks.hgBookmarkDelete" ID="Bookmarks.hgBookmarkDelete"></a>
131 <h4>Bookmarks.hgBookmarkDelete</h4>
132 <b>hgBookmarkDelete</b>(<i>name</i>)
133 <p>
134 Public method to delete a bookmark.
135 </p><dl>
136 <dt><i>name</i></dt>
137 <dd>
138 file/directory name (string)
139 </dd>
140 </dl><a NAME="Bookmarks.hgBookmarkIncoming" ID="Bookmarks.hgBookmarkIncoming"></a>
141 <h4>Bookmarks.hgBookmarkIncoming</h4>
142 <b>hgBookmarkIncoming</b>(<i>name</i>)
143 <p>
144 Public method to show a list of incoming bookmarks.
145 </p><dl>
146 <dt><i>name</i></dt>
147 <dd>
148 file/directory name (string)
149 </dd>
150 </dl><a NAME="Bookmarks.hgBookmarkMove" ID="Bookmarks.hgBookmarkMove"></a>
151 <h4>Bookmarks.hgBookmarkMove</h4>
152 <b>hgBookmarkMove</b>(<i>name</i>)
153 <p>
154 Public method to move a bookmark.
155 </p><dl>
156 <dt><i>name</i></dt>
157 <dd>
158 file/directory name (string)
159 </dd>
160 </dl><a NAME="Bookmarks.hgBookmarkOutgoing" ID="Bookmarks.hgBookmarkOutgoing"></a>
161 <h4>Bookmarks.hgBookmarkOutgoing</h4>
162 <b>hgBookmarkOutgoing</b>(<i>name</i>)
163 <p>
164 Public method to show a list of outgoing bookmarks.
165 </p><dl>
166 <dt><i>name</i></dt>
167 <dd>
168 file/directory name (string)
169 </dd>
170 </dl><a NAME="Bookmarks.hgBookmarkPull" ID="Bookmarks.hgBookmarkPull"></a>
171 <h4>Bookmarks.hgBookmarkPull</h4>
172 <b>hgBookmarkPull</b>(<i>name</i>)
173 <p>
174 Public method to pull a bookmark from a remote repository.
175 </p><dl>
176 <dt><i>name</i></dt>
177 <dd>
178 file/directory name (string)
179 </dd>
180 </dl><a NAME="Bookmarks.hgBookmarkPush" ID="Bookmarks.hgBookmarkPush"></a>
181 <h4>Bookmarks.hgBookmarkPush</h4>
182 <b>hgBookmarkPush</b>(<i>name</i>)
183 <p>
184 Public method to push a bookmark to a remote repository.
185 </p><dl>
186 <dt><i>name</i></dt>
187 <dd>
188 file/directory name (string)
189 </dd>
190 </dl><a NAME="Bookmarks.hgBookmarkRename" ID="Bookmarks.hgBookmarkRename"></a>
191 <h4>Bookmarks.hgBookmarkRename</h4>
192 <b>hgBookmarkRename</b>(<i>name</i>)
193 <p>
194 Public method to rename a bookmark.
195 </p><dl>
196 <dt><i>name</i></dt>
197 <dd>
198 file/directory name (string)
199 </dd>
200 </dl><a NAME="Bookmarks.hgGetBookmarksList" ID="Bookmarks.hgGetBookmarksList"></a>
201 <h4>Bookmarks.hgGetBookmarksList</h4>
202 <b>hgGetBookmarksList</b>(<i>repodir</i>)
203 <p>
204 Public method to get the list of bookmarks.
205 </p><dl>
206 <dt><i>repodir</i></dt>
207 <dd>
208 directory name of the repository (string)
209 </dd>
210 </dl><dl>
211 <dt>Returns:</dt>
212 <dd>
213 list of bookmarks (list of string)
214 </dd>
215 </dl><a NAME="Bookmarks.hgListBookmarks" ID="Bookmarks.hgListBookmarks"></a>
216 <h4>Bookmarks.hgListBookmarks</h4>
217 <b>hgListBookmarks</b>(<i>path</i>)
218 <p>
219 Public method used to list the available bookmarks.
220 </p><dl>
221 <dt><i>path</i></dt>
222 <dd>
223 directory name of the project (string)
224 </dd>
225 </dl><a NAME="Bookmarks.shutdown" ID="Bookmarks.shutdown"></a>
226 <h4>Bookmarks.shutdown</h4>
227 <b>shutdown</b>(<i></i>)
228 <p>
229 Public method used to shutdown the bookmarks interface.
230 </p>
231 <div align="right"><a href="#top">Up</a></div>
232 <hr />
233 </body></html>

Mercurial Repository: eric

eric ide

mercurial