Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 11068
15f0385e0471
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.HgExtensionProjectBrowserHelper</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper</h1>
10
11 <p> 10 <p>
12 Module implementing the project browser helper base for Mercurial extension 11 Module implementing the project browser helper base for Mercurial extension
13 interfaces. 12 interfaces.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16 16 <table>
17 <table> 17 <tr><td>None</td></tr>
18 <tr><td>None</td></tr> 18 </table>
19 </table> 19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21 21 <table>
22 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#HgExtensionProjectBrowserHelper">HgExtensionProjectBrowserHelper</a></td> 23 <td><a href="#HgExtensionProjectBrowserHelper">HgExtensionProjectBrowserHelper</a></td>
26 <td>Class implementing the project browser helper base for Mercurial extension interfaces.</td> 24 <td>Class implementing the project browser helper base for Mercurial extension interfaces.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30 29 <table>
31 <table> 30 <tr><td>None</td></tr>
32 <tr><td>None</td></tr> 31 </table>
33 </table> 32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="HgExtensionProjectBrowserHelper" ID="HgExtensionProjectBrowserHelper"></a> 35 <a NAME="HgExtensionProjectBrowserHelper" ID="HgExtensionProjectBrowserHelper"></a>
37 <h2>HgExtensionProjectBrowserHelper</h2> 36 <h2>HgExtensionProjectBrowserHelper</h2>
38
39 <p> 37 <p>
40 Class implementing the project browser helper base for Mercurial extension 38 Class implementing the project browser helper base for Mercurial extension
41 interfaces. 39 interfaces.
42 </p> 40 </p>
43 <p> 41 <p>
44 Note: The methods initMenus() and menuTitle() have to be reimplemented by 42 Note: The methods initMenus() and menuTitle() have to be reimplemented by
45 derived classes. 43 derived classes.
46 </p> 44 </p>
45
47 <h3>Derived from</h3> 46 <h3>Derived from</h3>
48 QObject 47 QObject
49 <h3>Class Attributes</h3> 48 <h3>Class Attributes</h3>
50 49 <table>
51 <table> 50 <tr><td>None</td></tr>
52 <tr><td>None</td></tr> 51 </table>
53 </table> 52
54 <h3>Class Methods</h3> 53 <h3>Class Methods</h3>
55 54 <table>
56 <table> 55 <tr><td>None</td></tr>
57 <tr><td>None</td></tr> 56 </table>
58 </table> 57
59 <h3>Methods</h3> 58 <h3>Methods</h3>
60 59 <table>
61 <table>
62
63 <tr> 60 <tr>
64 <td><a href="#HgExtensionProjectBrowserHelper.__init__">HgExtensionProjectBrowserHelper</a></td> 61 <td><a href="#HgExtensionProjectBrowserHelper.__init__">HgExtensionProjectBrowserHelper</a></td>
65 <td>Constructor</td> 62 <td>Constructor</td>
66 </tr> 63 </tr>
67 <tr> 64 <tr>
79 <tr> 76 <tr>
80 <td><a href="#HgExtensionProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> 77 <td><a href="#HgExtensionProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td>
81 <td>Public method to prepare the extension menu for display.</td> 78 <td>Public method to prepare the extension menu for display.</td>
82 </tr> 79 </tr>
83 </table> 80 </table>
81
84 <h3>Static Methods</h3> 82 <h3>Static Methods</h3>
85 83 <table>
86 <table> 84 <tr><td>None</td></tr>
87 <tr><td>None</td></tr> 85 </table>
88 </table> 86
89 87
90 <a NAME="HgExtensionProjectBrowserHelper.__init__" ID="HgExtensionProjectBrowserHelper.__init__"></a> 88 <a NAME="HgExtensionProjectBrowserHelper.__init__" ID="HgExtensionProjectBrowserHelper.__init__"></a>
91 <h4>HgExtensionProjectBrowserHelper (Constructor)</h4> 89 <h4>HgExtensionProjectBrowserHelper (Constructor)</h4>
92 <b>HgExtensionProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) 90 <b>HgExtensionProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>)
93
94 <p> 91 <p>
95 Constructor 92 Constructor
96 </p> 93 </p>
94
97 <dl> 95 <dl>
98 96
99 <dt><i>vcsObject</i> (Hg)</dt> 97 <dt><i>vcsObject</i> (Hg)</dt>
100 <dd> 98 <dd>
101 reference to the vcs object 99 reference to the vcs object
110 </dd> 108 </dd>
111 </dl> 109 </dl>
112 <a NAME="HgExtensionProjectBrowserHelper._updateVCSStatus" ID="HgExtensionProjectBrowserHelper._updateVCSStatus"></a> 110 <a NAME="HgExtensionProjectBrowserHelper._updateVCSStatus" ID="HgExtensionProjectBrowserHelper._updateVCSStatus"></a>
113 <h4>HgExtensionProjectBrowserHelper._updateVCSStatus</h4> 111 <h4>HgExtensionProjectBrowserHelper._updateVCSStatus</h4>
114 <b>_updateVCSStatus</b>(<i>name</i>) 112 <b>_updateVCSStatus</b>(<i>name</i>)
115
116 <p> 113 <p>
117 Protected method to update the VCS status of an item. 114 Protected method to update the VCS status of an item.
118 </p> 115 </p>
116
119 <dl> 117 <dl>
120 118
121 <dt><i>name</i> (str)</dt> 119 <dt><i>name</i> (str)</dt>
122 <dd> 120 <dd>
123 filename or directory name of the item to be updated 121 filename or directory name of the item to be updated
124 </dd> 122 </dd>
125 </dl> 123 </dl>
126 <a NAME="HgExtensionProjectBrowserHelper.initMenus" ID="HgExtensionProjectBrowserHelper.initMenus"></a> 124 <a NAME="HgExtensionProjectBrowserHelper.initMenus" ID="HgExtensionProjectBrowserHelper.initMenus"></a>
127 <h4>HgExtensionProjectBrowserHelper.initMenus</h4> 125 <h4>HgExtensionProjectBrowserHelper.initMenus</h4>
128 <b>initMenus</b>(<i></i>) 126 <b>initMenus</b>(<i></i>)
129
130 <p> 127 <p>
131 Public method to generate the extension menus. 128 Public method to generate the extension menus.
132 </p> 129 </p>
133 <p> 130 <p>
134 Note: Derived class must implement this method. 131 Note: Derived class must implement this method.
135 </p> 132 </p>
133
136 <dl> 134 <dl>
137 <dt>Return:</dt> 135 <dt>Return:</dt>
138 <dd> 136 <dd>
139 dictionary of populated menu. The dict must have the keys 137 dictionary of populated menu. The dict must have the keys
140 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. 138 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'.
155 </dd> 153 </dd>
156 </dl> 154 </dl>
157 <a NAME="HgExtensionProjectBrowserHelper.menuTitle" ID="HgExtensionProjectBrowserHelper.menuTitle"></a> 155 <a NAME="HgExtensionProjectBrowserHelper.menuTitle" ID="HgExtensionProjectBrowserHelper.menuTitle"></a>
158 <h4>HgExtensionProjectBrowserHelper.menuTitle</h4> 156 <h4>HgExtensionProjectBrowserHelper.menuTitle</h4>
159 <b>menuTitle</b>(<i></i>) 157 <b>menuTitle</b>(<i></i>)
160
161 <p> 158 <p>
162 Public method to get the menu title. 159 Public method to get the menu title.
163 </p> 160 </p>
164 <p> 161 <p>
165 Note: Derived class must implement this method. 162 Note: Derived class must implement this method.
166 </p> 163 </p>
164
167 <dl> 165 <dl>
168 <dt>Return:</dt> 166 <dt>Return:</dt>
169 <dd> 167 <dd>
170 title of the menu 168 title of the menu
171 </dd> 169 </dd>
185 </dd> 183 </dd>
186 </dl> 184 </dl>
187 <a NAME="HgExtensionProjectBrowserHelper.showExtensionMenu" ID="HgExtensionProjectBrowserHelper.showExtensionMenu"></a> 185 <a NAME="HgExtensionProjectBrowserHelper.showExtensionMenu" ID="HgExtensionProjectBrowserHelper.showExtensionMenu"></a>
188 <h4>HgExtensionProjectBrowserHelper.showExtensionMenu</h4> 186 <h4>HgExtensionProjectBrowserHelper.showExtensionMenu</h4>
189 <b>showExtensionMenu</b>(<i>key, controlled</i>) 187 <b>showExtensionMenu</b>(<i>key, controlled</i>)
190
191 <p> 188 <p>
192 Public method to prepare the extension menu for display. 189 Public method to prepare the extension menu for display.
193 </p> 190 </p>
194 <p> 191 <p>
195 Note: Derived class must implement this method to adjust the 192 Note: Derived class must implement this method to adjust the
196 enabled states of its menus. 193 enabled states of its menus.
197 </p> 194 </p>
195
198 <dl> 196 <dl>
199 197
200 <dt><i>key</i> (str)</dt> 198 <dt><i>key</i> (str)</dt>
201 <dd> 199 <dd>
202 menu key (one of 'mainMenu', 'multiMenu', 200 menu key (one of 'mainMenu', 'multiMenu',

Mercurial Repository: eric

eric ide

mercurial