Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper.html

src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper</h1>
10
11 <p> 10 <p>
12 Module implementing the shelve extension project browser helper. 11 Module implementing the shelve extension project browser helper.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ShelveProjectBrowserHelper">ShelveProjectBrowserHelper</a></td> 22 <td><a href="#ShelveProjectBrowserHelper">ShelveProjectBrowserHelper</a></td>
25 <td>Class implementing the shelve extension project browser helper.</td> 23 <td>Class implementing the shelve extension project browser helper.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="ShelveProjectBrowserHelper" ID="ShelveProjectBrowserHelper"></a> 34 <a NAME="ShelveProjectBrowserHelper" ID="ShelveProjectBrowserHelper"></a>
36 <h2>ShelveProjectBrowserHelper</h2> 35 <h2>ShelveProjectBrowserHelper</h2>
37
38 <p> 36 <p>
39 Class implementing the shelve extension project browser helper. 37 Class implementing the shelve extension project browser helper.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 HgExtensionProjectBrowserHelper 41 HgExtensionProjectBrowserHelper
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>None</td></tr> 44 <tr><td>None</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#ShelveProjectBrowserHelper.__init__">ShelveProjectBrowserHelper</a></td> 55 <td><a href="#ShelveProjectBrowserHelper.__init__">ShelveProjectBrowserHelper</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
77 <tr> 74 <tr>
78 <td><a href="#ShelveProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> 75 <td><a href="#ShelveProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td>
79 <td>Public method to prepare the extension menu for display.</td> 76 <td>Public method to prepare the extension menu for display.</td>
80 </tr> 77 </tr>
81 </table> 78 </table>
79
82 <h3>Static Methods</h3> 80 <h3>Static Methods</h3>
83
84 <table> 81 <table>
85 <tr><td>None</td></tr> 82 <tr><td>None</td></tr>
86 </table> 83 </table>
87 84
85
88 <a NAME="ShelveProjectBrowserHelper.__init__" ID="ShelveProjectBrowserHelper.__init__"></a> 86 <a NAME="ShelveProjectBrowserHelper.__init__" ID="ShelveProjectBrowserHelper.__init__"></a>
89 <h4>ShelveProjectBrowserHelper (Constructor)</h4> 87 <h4>ShelveProjectBrowserHelper (Constructor)</h4>
90 <b>ShelveProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) 88 <b>ShelveProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>)
91
92 <p> 89 <p>
93 Constructor 90 Constructor
94 </p> 91 </p>
92
95 <dl> 93 <dl>
96 94
97 <dt><i>vcsObject</i> (Hg)</dt> 95 <dt><i>vcsObject</i> (Hg)</dt>
98 <dd> 96 <dd>
99 reference to the vcs object 97 reference to the vcs object
108 </dd> 106 </dd>
109 </dl> 107 </dl>
110 <a NAME="ShelveProjectBrowserHelper.__hgShelve" ID="ShelveProjectBrowserHelper.__hgShelve"></a> 108 <a NAME="ShelveProjectBrowserHelper.__hgShelve" ID="ShelveProjectBrowserHelper.__hgShelve"></a>
111 <h4>ShelveProjectBrowserHelper.__hgShelve</h4> 109 <h4>ShelveProjectBrowserHelper.__hgShelve</h4>
112 <b>__hgShelve</b>(<i></i>) 110 <b>__hgShelve</b>(<i></i>)
113
114 <p> 111 <p>
115 Private slot used to shelve all current changes. 112 Private slot used to shelve all current changes.
116 </p> 113 </p>
114
117 <a NAME="ShelveProjectBrowserHelper.__reopenProject" ID="ShelveProjectBrowserHelper.__reopenProject"></a> 115 <a NAME="ShelveProjectBrowserHelper.__reopenProject" ID="ShelveProjectBrowserHelper.__reopenProject"></a>
118 <h4>ShelveProjectBrowserHelper.__reopenProject</h4> 116 <h4>ShelveProjectBrowserHelper.__reopenProject</h4>
119 <b>__reopenProject</b>(<i>shouldReopen, title</i>) 117 <b>__reopenProject</b>(<i>shouldReopen, title</i>)
120
121 <p> 118 <p>
122 Private method to reopen the project if needed and wanted. 119 Private method to reopen the project if needed and wanted.
123 </p> 120 </p>
121
124 <dl> 122 <dl>
125 123
126 <dt><i>shouldReopen</i> (bool)</dt> 124 <dt><i>shouldReopen</i> (bool)</dt>
127 <dd> 125 <dd>
128 flag indicating that the project should 126 flag indicating that the project should
134 </dd> 132 </dd>
135 </dl> 133 </dl>
136 <a NAME="ShelveProjectBrowserHelper.initMenus" ID="ShelveProjectBrowserHelper.initMenus"></a> 134 <a NAME="ShelveProjectBrowserHelper.initMenus" ID="ShelveProjectBrowserHelper.initMenus"></a>
137 <h4>ShelveProjectBrowserHelper.initMenus</h4> 135 <h4>ShelveProjectBrowserHelper.initMenus</h4>
138 <b>initMenus</b>(<i></i>) 136 <b>initMenus</b>(<i></i>)
139
140 <p> 137 <p>
141 Public method to generate the extension menus. 138 Public method to generate the extension menus.
142 </p> 139 </p>
140
143 <dl> 141 <dl>
144 <dt>Return:</dt> 142 <dt>Return:</dt>
145 <dd> 143 <dd>
146 dictionary of populated menu. The dict must have the keys 'mainMenu', 144 dictionary of populated menu. The dict must have the keys 'mainMenu',
147 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. 145 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'.
154 </dd> 152 </dd>
155 </dl> 153 </dl>
156 <a NAME="ShelveProjectBrowserHelper.menuTitle" ID="ShelveProjectBrowserHelper.menuTitle"></a> 154 <a NAME="ShelveProjectBrowserHelper.menuTitle" ID="ShelveProjectBrowserHelper.menuTitle"></a>
157 <h4>ShelveProjectBrowserHelper.menuTitle</h4> 155 <h4>ShelveProjectBrowserHelper.menuTitle</h4>
158 <b>menuTitle</b>(<i></i>) 156 <b>menuTitle</b>(<i></i>)
159
160 <p> 157 <p>
161 Public method to get the menu title. 158 Public method to get the menu title.
162 </p> 159 </p>
160
163 <dl> 161 <dl>
164 <dt>Return:</dt> 162 <dt>Return:</dt>
165 <dd> 163 <dd>
166 title of the menu 164 title of the menu
167 </dd> 165 </dd>
173 </dd> 171 </dd>
174 </dl> 172 </dl>
175 <a NAME="ShelveProjectBrowserHelper.showExtensionMenu" ID="ShelveProjectBrowserHelper.showExtensionMenu"></a> 173 <a NAME="ShelveProjectBrowserHelper.showExtensionMenu" ID="ShelveProjectBrowserHelper.showExtensionMenu"></a>
176 <h4>ShelveProjectBrowserHelper.showExtensionMenu</h4> 174 <h4>ShelveProjectBrowserHelper.showExtensionMenu</h4>
177 <b>showExtensionMenu</b>(<i>key, controlled</i>) 175 <b>showExtensionMenu</b>(<i>key, controlled</i>)
178
179 <p> 176 <p>
180 Public method to prepare the extension menu for display. 177 Public method to prepare the extension menu for display.
181 </p> 178 </p>
179
182 <dl> 180 <dl>
183 181
184 <dt><i>key</i> (str)</dt> 182 <dt><i>key</i> (str)</dt>
185 <dd> 183 <dd>
186 menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' 184 menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'

Mercurial Repository: eric

eric ide

mercurial