Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesHeaderDialog.html

changeset 1037
b547147ccb4b
child 1228
7afaf2fca55b
equal deleted inserted replaced
1036:1922b6ce2a57 1037:b547147ccb4b
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesHeaderDialog</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesHeaderDialog</h1>
24 <p>
25 Module implementing a dialog to show the commit message of the current patch.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#HgQueuesHeaderDialog">HgQueuesHeaderDialog</a></td>
35 <td>Class implementing a dialog to show the commit message of the current patch.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="HgQueuesHeaderDialog" ID="HgQueuesHeaderDialog"></a>
44 <h2>HgQueuesHeaderDialog</h2>
45 <p>
46 Class implementing a dialog to show the commit message of the current patch.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_HgQueuesHeaderDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#HgQueuesHeaderDialog.__init__">HgQueuesHeaderDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#HgQueuesHeaderDialog.__finish">__finish</a></td>
61 <td>Private slot called when the process finished or the user pressed the button.</td>
62 </tr><tr>
63 <td><a href="#HgQueuesHeaderDialog.__procFinished">__procFinished</a></td>
64 <td>Private slot connected to the finished signal.</td>
65 </tr><tr>
66 <td><a href="#HgQueuesHeaderDialog.__readStderr">__readStderr</a></td>
67 <td>Private slot to handle the readyReadStderr signal.</td>
68 </tr><tr>
69 <td><a href="#HgQueuesHeaderDialog.__readStdout">__readStdout</a></td>
70 <td>Private slot to handle the readyReadStdout signal.</td>
71 </tr><tr>
72 <td><a href="#HgQueuesHeaderDialog.closeEvent">closeEvent</a></td>
73 <td>Private slot implementing a close event handler.</td>
74 </tr><tr>
75 <td><a href="#HgQueuesHeaderDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
76 <td>Private slot called by a button of the button box clicked.</td>
77 </tr><tr>
78 <td><a href="#HgQueuesHeaderDialog.start">start</a></td>
79 <td>Public slot to start the list command.</td>
80 </tr>
81 </table>
82 <a NAME="HgQueuesHeaderDialog.__init__" ID="HgQueuesHeaderDialog.__init__"></a>
83 <h4>HgQueuesHeaderDialog (Constructor)</h4>
84 <b>HgQueuesHeaderDialog</b>(<i>vcs, parent=None</i>)
85 <p>
86 Constructor
87 </p><dl>
88 <dt><i>vcs</i></dt>
89 <dd>
90 reference to the vcs object
91 </dd><dt><i>parent</i></dt>
92 <dd>
93 reference to the parent widget (QWidget)
94 </dd>
95 </dl><a NAME="HgQueuesHeaderDialog.__finish" ID="HgQueuesHeaderDialog.__finish"></a>
96 <h4>HgQueuesHeaderDialog.__finish</h4>
97 <b>__finish</b>(<i></i>)
98 <p>
99 Private slot called when the process finished or the user pressed the button.
100 </p><a NAME="HgQueuesHeaderDialog.__procFinished" ID="HgQueuesHeaderDialog.__procFinished"></a>
101 <h4>HgQueuesHeaderDialog.__procFinished</h4>
102 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
103 <p>
104 Private slot connected to the finished signal.
105 </p><dl>
106 <dt><i>exitCode</i></dt>
107 <dd>
108 exit code of the process (integer)
109 </dd><dt><i>exitStatus</i></dt>
110 <dd>
111 exit status of the process (QProcess.ExitStatus)
112 </dd>
113 </dl><a NAME="HgQueuesHeaderDialog.__readStderr" ID="HgQueuesHeaderDialog.__readStderr"></a>
114 <h4>HgQueuesHeaderDialog.__readStderr</h4>
115 <b>__readStderr</b>(<i></i>)
116 <p>
117 Private slot to handle the readyReadStderr signal.
118 </p><p>
119 It reads the error output of the process and inserts it into the
120 error pane.
121 </p><a NAME="HgQueuesHeaderDialog.__readStdout" ID="HgQueuesHeaderDialog.__readStdout"></a>
122 <h4>HgQueuesHeaderDialog.__readStdout</h4>
123 <b>__readStdout</b>(<i></i>)
124 <p>
125 Private slot to handle the readyReadStdout signal.
126 </p><p>
127 It reads the output of the process, formats it and inserts it into
128 the contents pane.
129 </p><a NAME="HgQueuesHeaderDialog.closeEvent" ID="HgQueuesHeaderDialog.closeEvent"></a>
130 <h4>HgQueuesHeaderDialog.closeEvent</h4>
131 <b>closeEvent</b>(<i>e</i>)
132 <p>
133 Private slot implementing a close event handler.
134 </p><dl>
135 <dt><i>e</i></dt>
136 <dd>
137 close event (QCloseEvent)
138 </dd>
139 </dl><a NAME="HgQueuesHeaderDialog.on_buttonBox_clicked" ID="HgQueuesHeaderDialog.on_buttonBox_clicked"></a>
140 <h4>HgQueuesHeaderDialog.on_buttonBox_clicked</h4>
141 <b>on_buttonBox_clicked</b>(<i>button</i>)
142 <p>
143 Private slot called by a button of the button box clicked.
144 </p><dl>
145 <dt><i>button</i></dt>
146 <dd>
147 button that was clicked (QAbstractButton)
148 </dd>
149 </dl><a NAME="HgQueuesHeaderDialog.start" ID="HgQueuesHeaderDialog.start"></a>
150 <h4>HgQueuesHeaderDialog.start</h4>
151 <b>start</b>(<i>path</i>)
152 <p>
153 Public slot to start the list command.
154 </p><dl>
155 <dt><i>path</i></dt>
156 <dd>
157 name of directory to be listed (string)
158 </dd>
159 </dl>
160 <div align="right"><a href="#top">Up</a></div>
161 <hr />
162 </body></html>

eric ide

mercurial