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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7900
72b88fb20261
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.HgDiffDialog</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to show the output of the hg diff command process. 26 Module implementing a dialog to show the output of the hg diff command process.
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="#HgDiffDialog">HgDiffDialog</a></td> 38 <td><a href="#HgDiffDialog">HgDiffDialog</a></td>
34 <td>Class implementing a dialog to show the output of the hg diff command process.</td> 39 <td>Class implementing a dialog to show the output of the hg diff command process.</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="HgDiffDialog" ID="HgDiffDialog"></a> 49 <a NAME="HgDiffDialog" ID="HgDiffDialog"></a>
43 <h2>HgDiffDialog</h2> 50 <h2>HgDiffDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to show the output of the hg diff command 53 Class implementing a dialog to show the output of the hg diff command
46 process. 54 process.
47 </p> 55 </p>
48 <h3>Derived from</h3> 56 <h3>Derived from</h3>
49 QWidget, Ui_HgDiffDialog 57 QWidget, Ui_HgDiffDialog
50 <h3>Class Attributes</h3> 58 <h3>Class Attributes</h3>
59
51 <table> 60 <table>
52 <tr><td>None</td></tr> 61 <tr><td>None</td></tr>
53 </table> 62 </table>
54 <h3>Class Methods</h3> 63 <h3>Class Methods</h3>
64
55 <table> 65 <table>
56 <tr><td>None</td></tr> 66 <tr><td>None</td></tr>
57 </table> 67 </table>
58 <h3>Methods</h3> 68 <h3>Methods</h3>
59 <table> 69
70 <table>
71
60 <tr> 72 <tr>
61 <td><a href="#HgDiffDialog.__init__">HgDiffDialog</a></td> 73 <td><a href="#HgDiffDialog.__init__">HgDiffDialog</a></td>
62 <td>Constructor</td> 74 <td>Constructor</td>
63 </tr><tr> 75 </tr>
76 <tr>
64 <td><a href="#HgDiffDialog.__generatorFinished">__generatorFinished</a></td> 77 <td><a href="#HgDiffDialog.__generatorFinished">__generatorFinished</a></td>
65 <td>Private slot connected to the finished signal.</td> 78 <td>Private slot connected to the finished signal.</td>
66 </tr><tr> 79 </tr>
80 <tr>
67 <td><a href="#HgDiffDialog.closeEvent">closeEvent</a></td> 81 <td><a href="#HgDiffDialog.closeEvent">closeEvent</a></td>
68 <td>Protected slot implementing a close event handler.</td> 82 <td>Protected slot implementing a close event handler.</td>
69 </tr><tr> 83 </tr>
84 <tr>
70 <td><a href="#HgDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 85 <td><a href="#HgDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
71 <td>Private slot called by a button of the button box clicked.</td> 86 <td>Private slot called by a button of the button box clicked.</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#HgDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td> 89 <td><a href="#HgDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td>
74 <td>Private slot to handle the selection of a file.</td> 90 <td>Private slot to handle the selection of a file.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#HgDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> 93 <td><a href="#HgDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
77 <td>Private slot to refresh the display.</td> 94 <td>Private slot to refresh the display.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#HgDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> 97 <td><a href="#HgDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
80 <td>Private slot to handle the Save button press.</td> 98 <td>Private slot to handle the Save button press.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#HgDiffDialog.start">start</a></td> 101 <td><a href="#HgDiffDialog.start">start</a></td>
83 <td>Public slot to start the hg diff command.</td> 102 <td>Public slot to start the hg diff command.</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="HgDiffDialog.__init__" ID="HgDiffDialog.__init__"></a> 111 <a NAME="HgDiffDialog.__init__" ID="HgDiffDialog.__init__"></a>
91 <h4>HgDiffDialog (Constructor)</h4> 112 <h4>HgDiffDialog (Constructor)</h4>
92 <b>HgDiffDialog</b>(<i>vcs, parent=None</i>) 113 <b>HgDiffDialog</b>(<i>vcs, parent=None</i>)
114
93 <p> 115 <p>
94 Constructor 116 Constructor
95 </p><dl> 117 </p>
118 <dl>
119
96 <dt><i>vcs</i></dt> 120 <dt><i>vcs</i></dt>
97 <dd> 121 <dd>
98 reference to the vcs object 122 reference to the vcs object
99 </dd><dt><i>parent</i></dt> 123 </dd>
124 <dt><i>parent</i></dt>
100 <dd> 125 <dd>
101 parent widget (QWidget) 126 parent widget (QWidget)
102 </dd> 127 </dd>
103 </dl><a NAME="HgDiffDialog.__generatorFinished" ID="HgDiffDialog.__generatorFinished"></a> 128 </dl>
129 <a NAME="HgDiffDialog.__generatorFinished" ID="HgDiffDialog.__generatorFinished"></a>
104 <h4>HgDiffDialog.__generatorFinished</h4> 130 <h4>HgDiffDialog.__generatorFinished</h4>
105 <b>__generatorFinished</b>(<i></i>) 131 <b>__generatorFinished</b>(<i></i>)
132
106 <p> 133 <p>
107 Private slot connected to the finished signal. 134 Private slot connected to the finished signal.
108 </p><a NAME="HgDiffDialog.closeEvent" ID="HgDiffDialog.closeEvent"></a> 135 </p>
136 <a NAME="HgDiffDialog.closeEvent" ID="HgDiffDialog.closeEvent"></a>
109 <h4>HgDiffDialog.closeEvent</h4> 137 <h4>HgDiffDialog.closeEvent</h4>
110 <b>closeEvent</b>(<i>e</i>) 138 <b>closeEvent</b>(<i>e</i>)
139
111 <p> 140 <p>
112 Protected slot implementing a close event handler. 141 Protected slot implementing a close event handler.
113 </p><dl> 142 </p>
143 <dl>
144
114 <dt><i>e</i></dt> 145 <dt><i>e</i></dt>
115 <dd> 146 <dd>
116 close event (QCloseEvent) 147 close event (QCloseEvent)
117 </dd> 148 </dd>
118 </dl><a NAME="HgDiffDialog.on_buttonBox_clicked" ID="HgDiffDialog.on_buttonBox_clicked"></a> 149 </dl>
150 <a NAME="HgDiffDialog.on_buttonBox_clicked" ID="HgDiffDialog.on_buttonBox_clicked"></a>
119 <h4>HgDiffDialog.on_buttonBox_clicked</h4> 151 <h4>HgDiffDialog.on_buttonBox_clicked</h4>
120 <b>on_buttonBox_clicked</b>(<i>button</i>) 152 <b>on_buttonBox_clicked</b>(<i>button</i>)
153
121 <p> 154 <p>
122 Private slot called by a button of the button box clicked. 155 Private slot called by a button of the button box clicked.
123 </p><dl> 156 </p>
157 <dl>
158
124 <dt><i>button</i></dt> 159 <dt><i>button</i></dt>
125 <dd> 160 <dd>
126 button that was clicked (QAbstractButton) 161 button that was clicked (QAbstractButton)
127 </dd> 162 </dd>
128 </dl><a NAME="HgDiffDialog.on_filesCombo_activated" ID="HgDiffDialog.on_filesCombo_activated"></a> 163 </dl>
164 <a NAME="HgDiffDialog.on_filesCombo_activated" ID="HgDiffDialog.on_filesCombo_activated"></a>
129 <h4>HgDiffDialog.on_filesCombo_activated</h4> 165 <h4>HgDiffDialog.on_filesCombo_activated</h4>
130 <b>on_filesCombo_activated</b>(<i>index</i>) 166 <b>on_filesCombo_activated</b>(<i>index</i>)
167
131 <p> 168 <p>
132 Private slot to handle the selection of a file. 169 Private slot to handle the selection of a file.
133 </p><dl> 170 </p>
171 <dl>
172
134 <dt><i>index</i></dt> 173 <dt><i>index</i></dt>
135 <dd> 174 <dd>
136 activated row (integer) 175 activated row (integer)
137 </dd> 176 </dd>
138 </dl><a NAME="HgDiffDialog.on_refreshButton_clicked" ID="HgDiffDialog.on_refreshButton_clicked"></a> 177 </dl>
178 <a NAME="HgDiffDialog.on_refreshButton_clicked" ID="HgDiffDialog.on_refreshButton_clicked"></a>
139 <h4>HgDiffDialog.on_refreshButton_clicked</h4> 179 <h4>HgDiffDialog.on_refreshButton_clicked</h4>
140 <b>on_refreshButton_clicked</b>(<i></i>) 180 <b>on_refreshButton_clicked</b>(<i></i>)
181
141 <p> 182 <p>
142 Private slot to refresh the display. 183 Private slot to refresh the display.
143 </p><a NAME="HgDiffDialog.on_saveButton_clicked" ID="HgDiffDialog.on_saveButton_clicked"></a> 184 </p>
185 <a NAME="HgDiffDialog.on_saveButton_clicked" ID="HgDiffDialog.on_saveButton_clicked"></a>
144 <h4>HgDiffDialog.on_saveButton_clicked</h4> 186 <h4>HgDiffDialog.on_saveButton_clicked</h4>
145 <b>on_saveButton_clicked</b>(<i></i>) 187 <b>on_saveButton_clicked</b>(<i></i>)
188
146 <p> 189 <p>
147 Private slot to handle the Save button press. 190 Private slot to handle the Save button press.
148 </p><p> 191 </p>
192 <p>
149 It saves the diff shown in the dialog to a file in the local 193 It saves the diff shown in the dialog to a file in the local
150 filesystem. 194 filesystem.
151 </p><a NAME="HgDiffDialog.start" ID="HgDiffDialog.start"></a> 195 </p>
196 <a NAME="HgDiffDialog.start" ID="HgDiffDialog.start"></a>
152 <h4>HgDiffDialog.start</h4> 197 <h4>HgDiffDialog.start</h4>
153 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False, refreshable=False</i>) 198 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False, refreshable=False</i>)
199
154 <p> 200 <p>
155 Public slot to start the hg diff command. 201 Public slot to start the hg diff command.
156 </p><dl> 202 </p>
203 <dl>
204
157 <dt><i>fn</i></dt> 205 <dt><i>fn</i></dt>
158 <dd> 206 <dd>
159 filename to be diffed (string) 207 filename to be diffed (string)
160 </dd><dt><i>versions=</i></dt> 208 </dd>
209 <dt><i>versions=</i></dt>
161 <dd> 210 <dd>
162 list of versions to be diffed (list of up to 211 list of versions to be diffed (list of up to
163 2 strings or None) 212 2 strings or None)
164 </dd><dt><i>bundle=</i></dt> 213 </dd>
214 <dt><i>bundle=</i></dt>
165 <dd> 215 <dd>
166 name of a bundle file (string) 216 name of a bundle file (string)
167 </dd><dt><i>qdiff=</i></dt> 217 </dd>
218 <dt><i>qdiff=</i></dt>
168 <dd> 219 <dd>
169 flag indicating qdiff command shall be used (boolean) 220 flag indicating qdiff command shall be used (boolean)
170 </dd><dt><i>refreshable=</i></dt> 221 </dd>
222 <dt><i>refreshable=</i></dt>
171 <dd> 223 <dd>
172 flag indicating a refreshable diff (boolean) 224 flag indicating a refreshable diff (boolean)
173 </dd> 225 </dd>
174 </dl> 226 </dl>
175 <div align="right"><a href="#top">Up</a></div> 227 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial