|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgExportDialog</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgExportDialog</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a dialog to enter data for the Mercurial export command. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#HgExportDialog">HgExportDialog</a></td> |
|
39 <td>Class implementing a dialog to enter data for the Mercurial export command.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="HgExportDialog" ID="HgExportDialog"></a> |
|
50 <h2>HgExportDialog</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing a dialog to enter data for the Mercurial export command. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 QDialog, Ui_HgExportDialog |
|
57 <h3>Class Attributes</h3> |
|
58 |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 |
|
64 <table> |
|
65 <tr><td>None</td></tr> |
|
66 </table> |
|
67 <h3>Methods</h3> |
|
68 |
|
69 <table> |
|
70 |
|
71 <tr> |
|
72 <td><a href="#HgExportDialog.__init__">HgExportDialog</a></td> |
|
73 <td>Constructor</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#HgExportDialog.__updateOK">__updateOK</a></td> |
|
77 <td>Private slot to update the OK button.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#HgExportDialog.getParameters">getParameters</a></td> |
|
81 <td>Public method to retrieve the export data.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#HgExportDialog.on_changesetsEdit_textChanged">on_changesetsEdit_textChanged</a></td> |
|
85 <td>Private slot to react on changes of the changesets edit.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#HgExportDialog.on_directoryPicker_textChanged">on_directoryPicker_textChanged</a></td> |
|
89 <td>Private slot to react on changes of the export directory edit.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#HgExportDialog.on_patternEdit_textChanged">on_patternEdit_textChanged</a></td> |
|
93 <td>Private slot to react on changes of the export file name pattern edit.</td> |
|
94 </tr> |
|
95 </table> |
|
96 <h3>Static Methods</h3> |
|
97 |
|
98 <table> |
|
99 <tr><td>None</td></tr> |
|
100 </table> |
|
101 |
|
102 <a NAME="HgExportDialog.__init__" ID="HgExportDialog.__init__"></a> |
|
103 <h4>HgExportDialog (Constructor)</h4> |
|
104 <b>HgExportDialog</b>(<i>bookmarksList, bookmarkAvailable, parent=None</i>) |
|
105 |
|
106 <p> |
|
107 Constructor |
|
108 </p> |
|
109 <dl> |
|
110 |
|
111 <dt><i>bookmarksList</i> (list of str)</dt> |
|
112 <dd> |
|
113 list of defined bookmarks |
|
114 </dd> |
|
115 <dt><i>bookmarkAvailable</i> (bool)</dt> |
|
116 <dd> |
|
117 flag indicating the availability of the |
|
118 "--bookmark" option |
|
119 </dd> |
|
120 <dt><i>parent</i> (QWidget)</dt> |
|
121 <dd> |
|
122 reference to the parent widget |
|
123 </dd> |
|
124 </dl> |
|
125 <a NAME="HgExportDialog.__updateOK" ID="HgExportDialog.__updateOK"></a> |
|
126 <h4>HgExportDialog.__updateOK</h4> |
|
127 <b>__updateOK</b>(<i></i>) |
|
128 |
|
129 <p> |
|
130 Private slot to update the OK button. |
|
131 </p> |
|
132 <a NAME="HgExportDialog.getParameters" ID="HgExportDialog.getParameters"></a> |
|
133 <h4>HgExportDialog.getParameters</h4> |
|
134 <b>getParameters</b>(<i></i>) |
|
135 |
|
136 <p> |
|
137 Public method to retrieve the export data. |
|
138 </p> |
|
139 <dl> |
|
140 <dt>Return:</dt> |
|
141 <dd> |
|
142 tuple naming the output file name, the list of revisions to |
|
143 export, the name of a bookmarked branch and flags indicating to |
|
144 compare against the second parent, to treat all files as text, |
|
145 to omit dates in the diff headers and to use the git extended |
|
146 diff format |
|
147 </dd> |
|
148 </dl> |
|
149 <dl> |
|
150 <dt>Return Type:</dt> |
|
151 <dd> |
|
152 tuple of (str, list of str, str, bool, bool, bool, bool) |
|
153 </dd> |
|
154 </dl> |
|
155 <a NAME="HgExportDialog.on_changesetsEdit_textChanged" ID="HgExportDialog.on_changesetsEdit_textChanged"></a> |
|
156 <h4>HgExportDialog.on_changesetsEdit_textChanged</h4> |
|
157 <b>on_changesetsEdit_textChanged</b>(<i></i>) |
|
158 |
|
159 <p> |
|
160 Private slot to react on changes of the changesets edit. |
|
161 </p> |
|
162 <a NAME="HgExportDialog.on_directoryPicker_textChanged" ID="HgExportDialog.on_directoryPicker_textChanged"></a> |
|
163 <h4>HgExportDialog.on_directoryPicker_textChanged</h4> |
|
164 <b>on_directoryPicker_textChanged</b>(<i>txt</i>) |
|
165 |
|
166 <p> |
|
167 Private slot to react on changes of the export directory edit. |
|
168 </p> |
|
169 <dl> |
|
170 |
|
171 <dt><i>txt</i></dt> |
|
172 <dd> |
|
173 contents of the line edit (string) |
|
174 </dd> |
|
175 </dl> |
|
176 <a NAME="HgExportDialog.on_patternEdit_textChanged" ID="HgExportDialog.on_patternEdit_textChanged"></a> |
|
177 <h4>HgExportDialog.on_patternEdit_textChanged</h4> |
|
178 <b>on_patternEdit_textChanged</b>(<i>txt</i>) |
|
179 |
|
180 <p> |
|
181 Private slot to react on changes of the export file name pattern edit. |
|
182 </p> |
|
183 <dl> |
|
184 |
|
185 <dt><i>txt</i></dt> |
|
186 <dd> |
|
187 contents of the line edit (string) |
|
188 </dd> |
|
189 </dl> |
|
190 <div align="right"><a href="#top">Up</a></div> |
|
191 <hr /> |
|
192 </body></html> |