Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper</h1>
24
23 <p> 25 <p>
24 Module implementing the project browser helper base for Mercurial extension 26 Module implementing the project browser helper base for Mercurial extension
25 interfaces. 27 interfaces.
26 </p> 28 </p>
27 <h3>Global Attributes</h3> 29 <h3>Global Attributes</h3>
30
28 <table> 31 <table>
29 <tr><td>None</td></tr> 32 <tr><td>None</td></tr>
30 </table> 33 </table>
31 <h3>Classes</h3> 34 <h3>Classes</h3>
32 <table> 35
36 <table>
37
33 <tr> 38 <tr>
34 <td><a href="#HgExtensionProjectBrowserHelper">HgExtensionProjectBrowserHelper</a></td> 39 <td><a href="#HgExtensionProjectBrowserHelper">HgExtensionProjectBrowserHelper</a></td>
35 <td>Class implementing the project browser helper base for Mercurial extension interfaces.</td> 40 <td>Class implementing the project browser helper base for Mercurial extension interfaces.</td>
36 </tr> 41 </tr>
37 </table> 42 </table>
38 <h3>Functions</h3> 43 <h3>Functions</h3>
39 <table> 44
40 <tr><td>None</td></tr> 45 <table>
41 </table> 46 <tr><td>None</td></tr>
42 <hr /><hr /> 47 </table>
48 <hr />
49 <hr />
43 <a NAME="HgExtensionProjectBrowserHelper" ID="HgExtensionProjectBrowserHelper"></a> 50 <a NAME="HgExtensionProjectBrowserHelper" ID="HgExtensionProjectBrowserHelper"></a>
44 <h2>HgExtensionProjectBrowserHelper</h2> 51 <h2>HgExtensionProjectBrowserHelper</h2>
52
45 <p> 53 <p>
46 Class implementing the project browser helper base for Mercurial extension 54 Class implementing the project browser helper base for Mercurial extension
47 interfaces. 55 interfaces.
48 </p><p> 56 </p>
57 <p>
49 Note: The methods initMenus() and menuTitle() have to be reimplemented by 58 Note: The methods initMenus() and menuTitle() have to be reimplemented by
50 derived classes. 59 derived classes.
51 </p> 60 </p>
52 <h3>Derived from</h3> 61 <h3>Derived from</h3>
53 QObject 62 QObject
54 <h3>Class Attributes</h3> 63 <h3>Class Attributes</h3>
64
55 <table> 65 <table>
56 <tr><td>None</td></tr> 66 <tr><td>None</td></tr>
57 </table> 67 </table>
58 <h3>Class Methods</h3> 68 <h3>Class Methods</h3>
69
59 <table> 70 <table>
60 <tr><td>None</td></tr> 71 <tr><td>None</td></tr>
61 </table> 72 </table>
62 <h3>Methods</h3> 73 <h3>Methods</h3>
63 <table> 74
75 <table>
76
64 <tr> 77 <tr>
65 <td><a href="#HgExtensionProjectBrowserHelper.__init__">HgExtensionProjectBrowserHelper</a></td> 78 <td><a href="#HgExtensionProjectBrowserHelper.__init__">HgExtensionProjectBrowserHelper</a></td>
66 <td>Constructor</td> 79 <td>Constructor</td>
67 </tr><tr> 80 </tr>
81 <tr>
68 <td><a href="#HgExtensionProjectBrowserHelper._updateVCSStatus">_updateVCSStatus</a></td> 82 <td><a href="#HgExtensionProjectBrowserHelper._updateVCSStatus">_updateVCSStatus</a></td>
69 <td>Protected method to update the VCS status of an item.</td> 83 <td>Protected method to update the VCS status of an item.</td>
70 </tr><tr> 84 </tr>
85 <tr>
71 <td><a href="#HgExtensionProjectBrowserHelper.initMenus">initMenus</a></td> 86 <td><a href="#HgExtensionProjectBrowserHelper.initMenus">initMenus</a></td>
72 <td>Public method to generate the extension menus.</td> 87 <td>Public method to generate the extension menus.</td>
73 </tr><tr> 88 </tr>
89 <tr>
74 <td><a href="#HgExtensionProjectBrowserHelper.menuTitle">menuTitle</a></td> 90 <td><a href="#HgExtensionProjectBrowserHelper.menuTitle">menuTitle</a></td>
75 <td>Public method to get the menu title.</td> 91 <td>Public method to get the menu title.</td>
76 </tr><tr> 92 </tr>
93 <tr>
77 <td><a href="#HgExtensionProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> 94 <td><a href="#HgExtensionProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td>
78 <td>Public method to prepare the extension menu for display.</td> 95 <td>Public method to prepare the extension menu for display.</td>
79 </tr> 96 </tr>
80 </table> 97 </table>
81 <h3>Static Methods</h3> 98 <h3>Static Methods</h3>
82 <table> 99
83 <tr><td>None</td></tr> 100 <table>
84 </table> 101 <tr><td>None</td></tr>
102 </table>
103
85 <a NAME="HgExtensionProjectBrowserHelper.__init__" ID="HgExtensionProjectBrowserHelper.__init__"></a> 104 <a NAME="HgExtensionProjectBrowserHelper.__init__" ID="HgExtensionProjectBrowserHelper.__init__"></a>
86 <h4>HgExtensionProjectBrowserHelper (Constructor)</h4> 105 <h4>HgExtensionProjectBrowserHelper (Constructor)</h4>
87 <b>HgExtensionProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) 106 <b>HgExtensionProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>)
107
88 <p> 108 <p>
89 Constructor 109 Constructor
90 </p><dl> 110 </p>
111 <dl>
112
91 <dt><i>vcsObject</i></dt> 113 <dt><i>vcsObject</i></dt>
92 <dd> 114 <dd>
93 reference to the vcs object 115 reference to the vcs object
94 </dd><dt><i>browserObject</i></dt> 116 </dd>
117 <dt><i>browserObject</i></dt>
95 <dd> 118 <dd>
96 reference to the project browser object 119 reference to the project browser object
97 </dd><dt><i>projectObject</i></dt> 120 </dd>
121 <dt><i>projectObject</i></dt>
98 <dd> 122 <dd>
99 reference to the project object 123 reference to the project object
100 </dd> 124 </dd>
101 </dl><a NAME="HgExtensionProjectBrowserHelper._updateVCSStatus" ID="HgExtensionProjectBrowserHelper._updateVCSStatus"></a> 125 </dl>
126 <a NAME="HgExtensionProjectBrowserHelper._updateVCSStatus" ID="HgExtensionProjectBrowserHelper._updateVCSStatus"></a>
102 <h4>HgExtensionProjectBrowserHelper._updateVCSStatus</h4> 127 <h4>HgExtensionProjectBrowserHelper._updateVCSStatus</h4>
103 <b>_updateVCSStatus</b>(<i>name</i>) 128 <b>_updateVCSStatus</b>(<i>name</i>)
129
104 <p> 130 <p>
105 Protected method to update the VCS status of an item. 131 Protected method to update the VCS status of an item.
106 </p><dl> 132 </p>
133 <dl>
134
107 <dt><i>name</i></dt> 135 <dt><i>name</i></dt>
108 <dd> 136 <dd>
109 filename or directoryname of the item to be updated 137 filename or directoryname of the item to be updated
110 (string) 138 (string)
111 </dd> 139 </dd>
112 </dl><a NAME="HgExtensionProjectBrowserHelper.initMenus" ID="HgExtensionProjectBrowserHelper.initMenus"></a> 140 </dl>
141 <a NAME="HgExtensionProjectBrowserHelper.initMenus" ID="HgExtensionProjectBrowserHelper.initMenus"></a>
113 <h4>HgExtensionProjectBrowserHelper.initMenus</h4> 142 <h4>HgExtensionProjectBrowserHelper.initMenus</h4>
114 <b>initMenus</b>(<i></i>) 143 <b>initMenus</b>(<i></i>)
144
115 <p> 145 <p>
116 Public method to generate the extension menus. 146 Public method to generate the extension menus.
117 </p><p> 147 </p>
148 <p>
118 Note: Derived class must implement this method. 149 Note: Derived class must implement this method.
119 </p><dl> 150 </p>
151 <dl>
120 <dt>Returns:</dt> 152 <dt>Returns:</dt>
121 <dd> 153 <dd>
122 dictionary of populated menu (dict of QMenu). The dict 154 dictionary of populated menu (dict of QMenu). The dict
123 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' 155 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'
124 and 'dirMultiMenu'. 156 and 'dirMultiMenu'.
125 </dd> 157 </dd>
126 </dl><dl> 158 </dl>
159 <dl>
160
127 <dt>Raises <b>NotImplementedError</b>:</dt> 161 <dt>Raises <b>NotImplementedError</b>:</dt>
128 <dd> 162 <dd>
129 raised if the class has not been 163 raised if the class has not been
130 reimplemented 164 reimplemented
131 </dd> 165 </dd>
132 </dl><a NAME="HgExtensionProjectBrowserHelper.menuTitle" ID="HgExtensionProjectBrowserHelper.menuTitle"></a> 166 </dl>
167 <a NAME="HgExtensionProjectBrowserHelper.menuTitle" ID="HgExtensionProjectBrowserHelper.menuTitle"></a>
133 <h4>HgExtensionProjectBrowserHelper.menuTitle</h4> 168 <h4>HgExtensionProjectBrowserHelper.menuTitle</h4>
134 <b>menuTitle</b>(<i></i>) 169 <b>menuTitle</b>(<i></i>)
170
135 <p> 171 <p>
136 Public method to get the menu title. 172 Public method to get the menu title.
137 </p><p> 173 </p>
174 <p>
138 Note: Derived class must implement this method. 175 Note: Derived class must implement this method.
139 </p><dl> 176 </p>
177 <dl>
140 <dt>Returns:</dt> 178 <dt>Returns:</dt>
141 <dd> 179 <dd>
142 title of the menu (string) 180 title of the menu (string)
143 </dd> 181 </dd>
144 </dl><dl> 182 </dl>
183 <dl>
184
145 <dt>Raises <b>NotImplementedError</b>:</dt> 185 <dt>Raises <b>NotImplementedError</b>:</dt>
146 <dd> 186 <dd>
147 raised if the class has not been 187 raised if the class has not been
148 reimplemented 188 reimplemented
149 </dd> 189 </dd>
150 </dl><a NAME="HgExtensionProjectBrowserHelper.showExtensionMenu" ID="HgExtensionProjectBrowserHelper.showExtensionMenu"></a> 190 </dl>
191 <a NAME="HgExtensionProjectBrowserHelper.showExtensionMenu" ID="HgExtensionProjectBrowserHelper.showExtensionMenu"></a>
151 <h4>HgExtensionProjectBrowserHelper.showExtensionMenu</h4> 192 <h4>HgExtensionProjectBrowserHelper.showExtensionMenu</h4>
152 <b>showExtensionMenu</b>(<i>key, controlled</i>) 193 <b>showExtensionMenu</b>(<i>key, controlled</i>)
194
153 <p> 195 <p>
154 Public method to prepare the extension menu for display. 196 Public method to prepare the extension menu for display.
155 </p><p> 197 </p>
198 <p>
156 Note: Derived class must implement this method to adjust the 199 Note: Derived class must implement this method to adjust the
157 enabled states of its menus. 200 enabled states of its menus.
158 </p><dl> 201 </p>
202 <dl>
203
159 <dt><i>key</i></dt> 204 <dt><i>key</i></dt>
160 <dd> 205 <dd>
161 menu key (string, one of 'mainMenu', 'multiMenu', 206 menu key (string, one of 'mainMenu', 'multiMenu',
162 'backMenu', 'dirMenu' or 'dirMultiMenu') 207 'backMenu', 'dirMenu' or 'dirMultiMenu')
163 </dd><dt><i>controlled</i></dt> 208 </dd>
209 <dt><i>controlled</i></dt>
164 <dd> 210 <dd>
165 flag indicating to prepare the menu for a 211 flag indicating to prepare the menu for a
166 version controlled entry or a non-version controlled entry 212 version controlled entry or a non-version controlled entry
167 (boolean) 213 (boolean)
168 </dd> 214 </dd>
169 </dl><dl> 215 </dl>
216 <dl>
217
170 <dt>Raises <b>NotImplementedError</b>:</dt> 218 <dt>Raises <b>NotImplementedError</b>:</dt>
171 <dd> 219 <dd>
172 raised if the class has not been 220 raised if the class has not been
173 reimplemented 221 reimplemented
174 </dd> 222 </dd>

Mercurial Repository: eric

eric ide

mercurial