src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarkDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9029
14efd8fa5d8f
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarkDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarkDialog</h1>
10
11 <p>
12 Module implementing the bookmark dialog.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#HgBookmarkDialog">HgBookmarkDialog</a></td>
25 <td>Class mplementing the bookmark dialog.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="HgBookmarkDialog" ID="HgBookmarkDialog"></a>
36 <h2>HgBookmarkDialog</h2>
37
38 <p>
39 Class mplementing the bookmark dialog.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_HgBookmarkDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>DEFINE_MODE</td></tr><tr><td>MOVE_MODE</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#HgBookmarkDialog.__init__">HgBookmarkDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#HgBookmarkDialog.__updateBookmarksCombo">__updateBookmarksCombo</a></td>
63 <td>Private slot to update the bookmarks combo.</td>
64 </tr>
65 <tr>
66 <td><a href="#HgBookmarkDialog.__updateOK">__updateOK</a></td>
67 <td>Private slot to update the OK button.</td>
68 </tr>
69 <tr>
70 <td><a href="#HgBookmarkDialog.getData">getData</a></td>
71 <td>Public method to retrieve the entered data.</td>
72 </tr>
73 </table>
74 <h3>Static Methods</h3>
75
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79
80 <a NAME="HgBookmarkDialog.__init__" ID="HgBookmarkDialog.__init__"></a>
81 <h4>HgBookmarkDialog (Constructor)</h4>
82 <b>HgBookmarkDialog</b>(<i>mode, tagsList, branchesList, bookmarksList, parent=None</i>)
83
84 <p>
85 Constructor
86 </p>
87 <dl>
88
89 <dt><i>mode</i> (int)</dt>
90 <dd>
91 of the dialog
92 </dd>
93 <dt><i>tagsList</i> (list of str)</dt>
94 <dd>
95 list of tags
96 </dd>
97 <dt><i>branchesList</i> (list of str)</dt>
98 <dd>
99 list of branches
100 </dd>
101 <dt><i>bookmarksList</i> (list of str)</dt>
102 <dd>
103 list of bookmarks
104 </dd>
105 <dt><i>parent</i> (QWidget)</dt>
106 <dd>
107 parent widget
108 </dd>
109 </dl>
110 <a NAME="HgBookmarkDialog.__updateBookmarksCombo" ID="HgBookmarkDialog.__updateBookmarksCombo"></a>
111 <h4>HgBookmarkDialog.__updateBookmarksCombo</h4>
112 <b>__updateBookmarksCombo</b>(<i></i>)
113
114 <p>
115 Private slot to update the bookmarks combo.
116 </p>
117 <a NAME="HgBookmarkDialog.__updateOK" ID="HgBookmarkDialog.__updateOK"></a>
118 <h4>HgBookmarkDialog.__updateOK</h4>
119 <b>__updateOK</b>(<i></i>)
120
121 <p>
122 Private slot to update the OK button.
123 </p>
124 <a NAME="HgBookmarkDialog.getData" ID="HgBookmarkDialog.getData"></a>
125 <h4>HgBookmarkDialog.getData</h4>
126 <b>getData</b>(<i></i>)
127
128 <p>
129 Public method to retrieve the entered data.
130 </p>
131 <dl>
132 <dt>Return:</dt>
133 <dd>
134 tuple naming the revision and the bookmark name
135 </dd>
136 </dl>
137 <dl>
138 <dt>Return Type:</dt>
139 <dd>
140 tuple of (str, str)
141 </dd>
142 </dl>
143 <div align="right"><a href="#top">Up</a></div>
144 <hr />
145 </body></html>

eric ide

mercurial