Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.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.HgExtensionProjectHelper</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</h1>
24
23 <p> 25 <p>
24 Module implementing the project helper base for Mercurial extension interfaces. 26 Module implementing the project helper base for Mercurial extension interfaces.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#HgExtensionProjectHelper">HgExtensionProjectHelper</a></td> 38 <td><a href="#HgExtensionProjectHelper">HgExtensionProjectHelper</a></td>
34 <td>Class implementing the project helper base for Mercurial extension interfaces.</td> 39 <td>Class implementing the project helper base for Mercurial extension interfaces.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="HgExtensionProjectHelper" ID="HgExtensionProjectHelper"></a> 49 <a NAME="HgExtensionProjectHelper" ID="HgExtensionProjectHelper"></a>
43 <h2>HgExtensionProjectHelper</h2> 50 <h2>HgExtensionProjectHelper</h2>
51
44 <p> 52 <p>
45 Class implementing the project helper base for Mercurial extension 53 Class implementing the project helper base for Mercurial extension
46 interfaces. 54 interfaces.
47 </p><p> 55 </p>
56 <p>
48 Note: The methods initActions(), initMenu(mainMenu) and menuTitle() have 57 Note: The methods initActions(), initMenu(mainMenu) and menuTitle() have
49 to be reimplemented by derived classes. 58 to be reimplemented by derived classes.
50 </p> 59 </p>
51 <h3>Derived from</h3> 60 <h3>Derived from</h3>
52 QObject 61 QObject
53 <h3>Class Attributes</h3> 62 <h3>Class Attributes</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Class Methods</h3> 67 <h3>Class Methods</h3>
68
58 <table> 69 <table>
59 <tr><td>None</td></tr> 70 <tr><td>None</td></tr>
60 </table> 71 </table>
61 <h3>Methods</h3> 72 <h3>Methods</h3>
62 <table> 73
74 <table>
75
63 <tr> 76 <tr>
64 <td><a href="#HgExtensionProjectHelper.__init__">HgExtensionProjectHelper</a></td> 77 <td><a href="#HgExtensionProjectHelper.__init__">HgExtensionProjectHelper</a></td>
65 <td>Constructor</td> 78 <td>Constructor</td>
66 </tr><tr> 79 </tr>
80 <tr>
67 <td><a href="#HgExtensionProjectHelper.getActions">getActions</a></td> 81 <td><a href="#HgExtensionProjectHelper.getActions">getActions</a></td>
68 <td>Public method to get a list of all actions.</td> 82 <td>Public method to get a list of all actions.</td>
69 </tr><tr> 83 </tr>
84 <tr>
70 <td><a href="#HgExtensionProjectHelper.initActions">initActions</a></td> 85 <td><a href="#HgExtensionProjectHelper.initActions">initActions</a></td>
71 <td>Public method to generate the action objects.</td> 86 <td>Public method to generate the action objects.</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#HgExtensionProjectHelper.initMenu">initMenu</a></td> 89 <td><a href="#HgExtensionProjectHelper.initMenu">initMenu</a></td>
74 <td>Public method to generate the extension menu.</td> 90 <td>Public method to generate the extension menu.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#HgExtensionProjectHelper.menuTitle">menuTitle</a></td> 93 <td><a href="#HgExtensionProjectHelper.menuTitle">menuTitle</a></td>
77 <td>Public method to get the menu title.</td> 94 <td>Public method to get the menu title.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#HgExtensionProjectHelper.setObjects">setObjects</a></td> 97 <td><a href="#HgExtensionProjectHelper.setObjects">setObjects</a></td>
80 <td>Public method to set references to the vcs and project objects.</td> 98 <td>Public method to set references to the vcs and project objects.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#HgExtensionProjectHelper.shutdown">shutdown</a></td> 101 <td><a href="#HgExtensionProjectHelper.shutdown">shutdown</a></td>
83 <td>Public method to perform shutdown actions.</td> 102 <td>Public method to perform shutdown actions.</td>
84 </tr> 103 </tr>
85 </table> 104 </table>
86 <h3>Static Methods</h3> 105 <h3>Static Methods</h3>
87 <table> 106
88 <tr><td>None</td></tr> 107 <table>
89 </table> 108 <tr><td>None</td></tr>
109 </table>
110
90 <a NAME="HgExtensionProjectHelper.__init__" ID="HgExtensionProjectHelper.__init__"></a> 111 <a NAME="HgExtensionProjectHelper.__init__" ID="HgExtensionProjectHelper.__init__"></a>
91 <h4>HgExtensionProjectHelper (Constructor)</h4> 112 <h4>HgExtensionProjectHelper (Constructor)</h4>
92 <b>HgExtensionProjectHelper</b>(<i></i>) 113 <b>HgExtensionProjectHelper</b>(<i></i>)
114
93 <p> 115 <p>
94 Constructor 116 Constructor
95 </p><a NAME="HgExtensionProjectHelper.getActions" ID="HgExtensionProjectHelper.getActions"></a> 117 </p>
118 <a NAME="HgExtensionProjectHelper.getActions" ID="HgExtensionProjectHelper.getActions"></a>
96 <h4>HgExtensionProjectHelper.getActions</h4> 119 <h4>HgExtensionProjectHelper.getActions</h4>
97 <b>getActions</b>(<i></i>) 120 <b>getActions</b>(<i></i>)
121
98 <p> 122 <p>
99 Public method to get a list of all actions. 123 Public method to get a list of all actions.
100 </p><dl> 124 </p>
125 <dl>
101 <dt>Returns:</dt> 126 <dt>Returns:</dt>
102 <dd> 127 <dd>
103 list of all actions (list of E5Action) 128 list of all actions (list of E5Action)
104 </dd> 129 </dd>
105 </dl><a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a> 130 </dl>
131 <a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a>
106 <h4>HgExtensionProjectHelper.initActions</h4> 132 <h4>HgExtensionProjectHelper.initActions</h4>
107 <b>initActions</b>(<i></i>) 133 <b>initActions</b>(<i></i>)
134
108 <p> 135 <p>
109 Public method to generate the action objects. 136 Public method to generate the action objects.
110 </p><p> 137 </p>
138 <p>
111 Note: Derived class must implement this method. 139 Note: Derived class must implement this method.
112 </p><dl> 140 </p>
141 <dl>
142
113 <dt>Raises <b>NotImplementedError</b>:</dt> 143 <dt>Raises <b>NotImplementedError</b>:</dt>
114 <dd> 144 <dd>
115 raised if the class has not been 145 raised if the class has not been
116 reimplemented 146 reimplemented
117 </dd> 147 </dd>
118 </dl><a NAME="HgExtensionProjectHelper.initMenu" ID="HgExtensionProjectHelper.initMenu"></a> 148 </dl>
149 <a NAME="HgExtensionProjectHelper.initMenu" ID="HgExtensionProjectHelper.initMenu"></a>
119 <h4>HgExtensionProjectHelper.initMenu</h4> 150 <h4>HgExtensionProjectHelper.initMenu</h4>
120 <b>initMenu</b>(<i>mainMenu</i>) 151 <b>initMenu</b>(<i>mainMenu</i>)
152
121 <p> 153 <p>
122 Public method to generate the extension menu. 154 Public method to generate the extension menu.
123 </p><p> 155 </p>
156 <p>
124 Note: Derived class must implement this method. 157 Note: Derived class must implement this method.
125 </p><dl> 158 </p>
159 <dl>
160
126 <dt><i>mainMenu</i></dt> 161 <dt><i>mainMenu</i></dt>
127 <dd> 162 <dd>
128 reference to the main menu (QMenu) 163 reference to the main menu (QMenu)
129 </dd> 164 </dd>
130 </dl><dl> 165 </dl>
166 <dl>
131 <dt>Returns:</dt> 167 <dt>Returns:</dt>
132 <dd> 168 <dd>
133 populated menu (QMenu) 169 populated menu (QMenu)
134 </dd> 170 </dd>
135 </dl><dl> 171 </dl>
172 <dl>
173
136 <dt>Raises <b>NotImplementedError</b>:</dt> 174 <dt>Raises <b>NotImplementedError</b>:</dt>
137 <dd> 175 <dd>
138 raised if the class has not been 176 raised if the class has not been
139 reimplemented 177 reimplemented
140 </dd> 178 </dd>
141 </dl><a NAME="HgExtensionProjectHelper.menuTitle" ID="HgExtensionProjectHelper.menuTitle"></a> 179 </dl>
180 <a NAME="HgExtensionProjectHelper.menuTitle" ID="HgExtensionProjectHelper.menuTitle"></a>
142 <h4>HgExtensionProjectHelper.menuTitle</h4> 181 <h4>HgExtensionProjectHelper.menuTitle</h4>
143 <b>menuTitle</b>(<i></i>) 182 <b>menuTitle</b>(<i></i>)
183
144 <p> 184 <p>
145 Public method to get the menu title. 185 Public method to get the menu title.
146 </p><p> 186 </p>
187 <p>
147 Note: Derived class must implement this method. 188 Note: Derived class must implement this method.
148 </p><dl> 189 </p>
190 <dl>
149 <dt>Returns:</dt> 191 <dt>Returns:</dt>
150 <dd> 192 <dd>
151 title of the menu (string) 193 title of the menu (string)
152 </dd> 194 </dd>
153 </dl><dl> 195 </dl>
196 <dl>
197
154 <dt>Raises <b>NotImplementedError</b>:</dt> 198 <dt>Raises <b>NotImplementedError</b>:</dt>
155 <dd> 199 <dd>
156 raised if the class has not been 200 raised if the class has not been
157 reimplemented 201 reimplemented
158 </dd> 202 </dd>
159 </dl><a NAME="HgExtensionProjectHelper.setObjects" ID="HgExtensionProjectHelper.setObjects"></a> 203 </dl>
204 <a NAME="HgExtensionProjectHelper.setObjects" ID="HgExtensionProjectHelper.setObjects"></a>
160 <h4>HgExtensionProjectHelper.setObjects</h4> 205 <h4>HgExtensionProjectHelper.setObjects</h4>
161 <b>setObjects</b>(<i>vcsObject, projectObject</i>) 206 <b>setObjects</b>(<i>vcsObject, projectObject</i>)
207
162 <p> 208 <p>
163 Public method to set references to the vcs and project objects. 209 Public method to set references to the vcs and project objects.
164 </p><dl> 210 </p>
211 <dl>
212
165 <dt><i>vcsObject</i></dt> 213 <dt><i>vcsObject</i></dt>
166 <dd> 214 <dd>
167 reference to the vcs object 215 reference to the vcs object
168 </dd><dt><i>projectObject</i></dt> 216 </dd>
217 <dt><i>projectObject</i></dt>
169 <dd> 218 <dd>
170 reference to the project object 219 reference to the project object
171 </dd> 220 </dd>
172 </dl><a NAME="HgExtensionProjectHelper.shutdown" ID="HgExtensionProjectHelper.shutdown"></a> 221 </dl>
222 <a NAME="HgExtensionProjectHelper.shutdown" ID="HgExtensionProjectHelper.shutdown"></a>
173 <h4>HgExtensionProjectHelper.shutdown</h4> 223 <h4>HgExtensionProjectHelper.shutdown</h4>
174 <b>shutdown</b>(<i></i>) 224 <b>shutdown</b>(<i></i>)
225
175 <p> 226 <p>
176 Public method to perform shutdown actions. 227 Public method to perform shutdown actions.
177 </p><p> 228 </p>
229 <p>
178 Note: Derived class may implement this method if needed. 230 Note: Derived class may implement this method if needed.
179 </p> 231 </p>
180 <div align="right"><a href="#top">Up</a></div> 232 <div align="right"><a href="#top">Up</a></div>
181 <hr /> 233 <hr />
182 </body></html> 234 </body></html>

Mercurial Repository: eric

eric ide

mercurial