src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.ProjectHelper.html

branch
eric7
changeset 11084
adbb5d1944ea
equal deleted inserted replaced
11083:0ecbf7ebfc49 11084:adbb5d1944ea
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.ProjectHelper</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.UncommitExtension.ProjectHelper</h1>
10 <p>
11 Module implementing the uncommit extension project helper.
12 </p>
13
14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>None</td></tr>
17 </table>
18
19 <h3>Classes</h3>
20 <table>
21 <tr>
22 <td><a href="#UncommitProjectHelper">UncommitProjectHelper</a></td>
23 <td>Class implementing the uncommit extension project helper.</td>
24 </tr>
25 </table>
26
27 <h3>Functions</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31
32 <hr />
33 <hr />
34 <a NAME="UncommitProjectHelper" ID="UncommitProjectHelper"></a>
35 <h2>UncommitProjectHelper</h2>
36 <p>
37 Class implementing the uncommit extension project helper.
38 </p>
39
40 <h3>Derived from</h3>
41 HgExtensionProjectHelper
42 <h3>Class Attributes</h3>
43 <table>
44 <tr><td>None</td></tr>
45 </table>
46
47 <h3>Class Methods</h3>
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51
52 <h3>Methods</h3>
53 <table>
54 <tr>
55 <td><a href="#UncommitProjectHelper.__init__">UncommitProjectHelper</a></td>
56 <td>Constructor</td>
57 </tr>
58 <tr>
59 <td><a href="#UncommitProjectHelper.__hgUncommit">__hgUncommit</a></td>
60 <td>Private slot to undo a local commit.</td>
61 </tr>
62 <tr>
63 <td><a href="#UncommitProjectHelper.__reopenProject">__reopenProject</a></td>
64 <td>Private method to reopen the project if needed and wanted.</td>
65 </tr>
66 <tr>
67 <td><a href="#UncommitProjectHelper.initActions">initActions</a></td>
68 <td>Public method to generate the action objects.</td>
69 </tr>
70 <tr>
71 <td><a href="#UncommitProjectHelper.initMenu">initMenu</a></td>
72 <td>Public method to generate the extension menu.</td>
73 </tr>
74 <tr>
75 <td><a href="#UncommitProjectHelper.menuTitle">menuTitle</a></td>
76 <td>Public method to get the menu title.</td>
77 </tr>
78 </table>
79
80 <h3>Static Methods</h3>
81 <table>
82 <tr><td>None</td></tr>
83 </table>
84
85
86 <a NAME="UncommitProjectHelper.__init__" ID="UncommitProjectHelper.__init__"></a>
87 <h4>UncommitProjectHelper (Constructor)</h4>
88 <b>UncommitProjectHelper</b>(<i></i>)
89 <p>
90 Constructor
91 </p>
92
93 <a NAME="UncommitProjectHelper.__hgUncommit" ID="UncommitProjectHelper.__hgUncommit"></a>
94 <h4>UncommitProjectHelper.__hgUncommit</h4>
95 <b>__hgUncommit</b>(<i></i>)
96 <p>
97 Private slot to undo a local commit.
98 </p>
99
100 <a NAME="UncommitProjectHelper.__reopenProject" ID="UncommitProjectHelper.__reopenProject"></a>
101 <h4>UncommitProjectHelper.__reopenProject</h4>
102 <b>__reopenProject</b>(<i>shouldReopen, title</i>)
103 <p>
104 Private method to reopen the project if needed and wanted.
105 </p>
106
107 <dl>
108
109 <dt><i>shouldReopen</i> (bool)</dt>
110 <dd>
111 flag indicating that the project should
112 be reopened
113 </dd>
114 <dt><i>title</i> (str)</dt>
115 <dd>
116 title of the message box
117 </dd>
118 </dl>
119 <a NAME="UncommitProjectHelper.initActions" ID="UncommitProjectHelper.initActions"></a>
120 <h4>UncommitProjectHelper.initActions</h4>
121 <b>initActions</b>(<i></i>)
122 <p>
123 Public method to generate the action objects.
124 </p>
125
126 <a NAME="UncommitProjectHelper.initMenu" ID="UncommitProjectHelper.initMenu"></a>
127 <h4>UncommitProjectHelper.initMenu</h4>
128 <b>initMenu</b>(<i>mainMenu</i>)
129 <p>
130 Public method to generate the extension menu.
131 </p>
132
133 <dl>
134
135 <dt><i>mainMenu</i> (QMenu)</dt>
136 <dd>
137 reference to the main menu
138 </dd>
139 </dl>
140 <dl>
141 <dt>Return:</dt>
142 <dd>
143 populated menu
144 </dd>
145 </dl>
146 <dl>
147 <dt>Return Type:</dt>
148 <dd>
149 QMenu
150 </dd>
151 </dl>
152 <a NAME="UncommitProjectHelper.menuTitle" ID="UncommitProjectHelper.menuTitle"></a>
153 <h4>UncommitProjectHelper.menuTitle</h4>
154 <b>menuTitle</b>(<i></i>)
155 <p>
156 Public method to get the menu title.
157 </p>
158
159 <dl>
160 <dt>Return:</dt>
161 <dd>
162 title of the menu
163 </dd>
164 </dl>
165 <dl>
166 <dt>Return Type:</dt>
167 <dd>
168 str
169 </dd>
170 </dl>
171 <div align="right"><a href="#top">Up</a></div>
172 <hr />
173 </body></html>

eric ide

mercurial