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

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10437:2f70ca07f0af 10438:4cd7e5a8b3cf
92 <p> 92 <p>
93 Constructor 93 Constructor
94 </p> 94 </p>
95 <dl> 95 <dl>
96 96
97 <dt><i>vcsObject</i></dt> 97 <dt><i>vcsObject</i> (Hg)</dt>
98 <dd> 98 <dd>
99 reference to the vcs object 99 reference to the vcs object
100 </dd> 100 </dd>
101 <dt><i>browserObject</i></dt> 101 <dt><i>browserObject</i> (ProjectBaseBrowser)</dt>
102 <dd> 102 <dd>
103 reference to the project browser object 103 reference to the project browser object
104 </dd> 104 </dd>
105 <dt><i>projectObject</i></dt> 105 <dt><i>projectObject</i> (Project)</dt>
106 <dd> 106 <dd>
107 reference to the project object 107 reference to the project object
108 </dd> 108 </dd>
109 </dl> 109 </dl>
110 <a NAME="ShelveProjectBrowserHelper.__hgShelve" ID="ShelveProjectBrowserHelper.__hgShelve"></a> 110 <a NAME="ShelveProjectBrowserHelper.__hgShelve" ID="ShelveProjectBrowserHelper.__hgShelve"></a>
121 <p> 121 <p>
122 Private method to reopen the project if needed and wanted. 122 Private method to reopen the project if needed and wanted.
123 </p> 123 </p>
124 <dl> 124 <dl>
125 125
126 <dt><i>shouldReopen</i></dt> 126 <dt><i>shouldReopen</i> (bool)</dt>
127 <dd> 127 <dd>
128 flag indicating that the project should 128 flag indicating that the project should
129 be reopened (boolean) 129 be reopened
130 </dd> 130 </dd>
131 <dt><i>title</i></dt> 131 <dt><i>title</i> (str)</dt>
132 <dd> 132 <dd>
133 title of the message box (string) 133 title of the message box
134 </dd> 134 </dd>
135 </dl> 135 </dl>
136 <a NAME="ShelveProjectBrowserHelper.initMenus" ID="ShelveProjectBrowserHelper.initMenus"></a> 136 <a NAME="ShelveProjectBrowserHelper.initMenus" ID="ShelveProjectBrowserHelper.initMenus"></a>
137 <h4>ShelveProjectBrowserHelper.initMenus</h4> 137 <h4>ShelveProjectBrowserHelper.initMenus</h4>
138 <b>initMenus</b>(<i></i>) 138 <b>initMenus</b>(<i></i>)
141 Public method to generate the extension menus. 141 Public method to generate the extension menus.
142 </p> 142 </p>
143 <dl> 143 <dl>
144 <dt>Return:</dt> 144 <dt>Return:</dt>
145 <dd> 145 <dd>
146 dictionary of populated menu (dict of QMenu). The dict 146 dictionary of populated menu. The dict must have the keys 'mainMenu',
147 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' 147 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'.
148 and 'dirMultiMenu'. 148 </dd>
149 </dl>
150 <dl>
151 <dt>Return Type:</dt>
152 <dd>
153 dict of QMenu
149 </dd> 154 </dd>
150 </dl> 155 </dl>
151 <a NAME="ShelveProjectBrowserHelper.menuTitle" ID="ShelveProjectBrowserHelper.menuTitle"></a> 156 <a NAME="ShelveProjectBrowserHelper.menuTitle" ID="ShelveProjectBrowserHelper.menuTitle"></a>
152 <h4>ShelveProjectBrowserHelper.menuTitle</h4> 157 <h4>ShelveProjectBrowserHelper.menuTitle</h4>
153 <b>menuTitle</b>(<i></i>) 158 <b>menuTitle</b>(<i></i>)
156 Public method to get the menu title. 161 Public method to get the menu title.
157 </p> 162 </p>
158 <dl> 163 <dl>
159 <dt>Return:</dt> 164 <dt>Return:</dt>
160 <dd> 165 <dd>
161 title of the menu (string) 166 title of the menu
167 </dd>
168 </dl>
169 <dl>
170 <dt>Return Type:</dt>
171 <dd>
172 str
162 </dd> 173 </dd>
163 </dl> 174 </dl>
164 <a NAME="ShelveProjectBrowserHelper.showExtensionMenu" ID="ShelveProjectBrowserHelper.showExtensionMenu"></a> 175 <a NAME="ShelveProjectBrowserHelper.showExtensionMenu" ID="ShelveProjectBrowserHelper.showExtensionMenu"></a>
165 <h4>ShelveProjectBrowserHelper.showExtensionMenu</h4> 176 <h4>ShelveProjectBrowserHelper.showExtensionMenu</h4>
166 <b>showExtensionMenu</b>(<i>key, controlled</i>) 177 <b>showExtensionMenu</b>(<i>key, controlled</i>)
168 <p> 179 <p>
169 Public method to prepare the extension menu for display. 180 Public method to prepare the extension menu for display.
170 </p> 181 </p>
171 <dl> 182 <dl>
172 183
173 <dt><i>key</i></dt> 184 <dt><i>key</i> (str)</dt>
174 <dd> 185 <dd>
175 menu key (string, one of 'mainMenu', 'multiMenu', 186 menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'
176 'backMenu', 'dirMenu' or 'dirMultiMenu') 187 or 'dirMultiMenu')
177 </dd> 188 </dd>
178 <dt><i>controlled</i></dt> 189 <dt><i>controlled</i> (bool)</dt>
179 <dd> 190 <dd>
180 flag indicating to prepare the menu for a 191 flag indicating to prepare the menu for a
181 version controlled entry or a non-version controlled entry 192 version controlled entry or a non-version controlled entry
182 (boolean)
183 </dd> 193 </dd>
184 </dl> 194 </dl>
185 <div align="right"><a href="#top">Up</a></div> 195 <div align="right"><a href="#top">Up</a></div>
186 <hr /> 196 <hr />
187 </body></html> 197 </body></html>

eric ide

mercurial