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

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

eric ide

mercurial