~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.VCS.vcsCVS.CvsDialog.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>eric4.VCS.vcsCVS.CvsDialog</title>
 
6
<style>
 
7
body {
 
8
    background:white;
 
9
    margin: 0em 1em 10em 1em;
 
10
    color: black;
 
11
}
 
12
 
 
13
h1 { color: white; background: #4FA4FF; }
 
14
h2 { color: white; background: #4FA4FF; }
 
15
h3 { color: white; background: #00557F; }
 
16
h4 { color: white; background: #00557F; }
 
17
    
 
18
a { color: #AA5500; }
 
19
 
 
20
</style>
 
21
</head>
 
22
<body><a NAME="top" ID="top"></a>
 
23
<h1>eric4.VCS.vcsCVS.CvsDialog</h1>
 
24
<p>
 
25
Module implementing a dialog starting a process and showing its output.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#CvsDialog">CvsDialog</a></td>
 
31
<td>Module implementing a dialog starting a process and showing its output.</td>
 
32
</tr>
 
33
</table>
 
34
<h3>Functions</h3>
 
35
<table>
 
36
<tr><td>None</td></tr>
 
37
</table>
 
38
<hr /><hr />
 
39
<a NAME="CvsDialog" ID="CvsDialog"></a>
 
40
<h2>CvsDialog</h2>
 
41
<p>
 
42
    Module implementing a dialog starting a process and showing its output.
 
43
</p><p>
 
44
    It starts a QProcess and display a dialog that
 
45
    shows the output of the process. The dialog is modal,
 
46
    which causes a synchronized execution of the process.
 
47
</p>
 
48
<h3>Derived from</h3>
 
49
QDialog, Ui_CvsDialog
 
50
<h3>Methods</h3>
 
51
<table>
 
52
<tr>
 
53
<td><a href="#CvsDialog.__init__">CvsDialog</a></td>
 
54
<td>Constructor</td>
 
55
</tr><tr>
 
56
<td><a href="#CvsDialog.__finish">__finish</a></td>
 
57
<td>Private slot called when the process finished or the user pressed the button.</td>
 
58
</tr><tr>
 
59
<td><a href="#CvsDialog.__procFinished">__procFinished</a></td>
 
60
<td>Private slot connected to the finished signal.</td>
 
61
</tr><tr>
 
62
<td><a href="#CvsDialog.__readStderr">__readStderr</a></td>
 
63
<td>Private slot to handle the readyReadStderr signal.</td>
 
64
</tr><tr>
 
65
<td><a href="#CvsDialog.__readStdout">__readStdout</a></td>
 
66
<td>Private slot to handle the readyReadStdout signal.</td>
 
67
</tr><tr>
 
68
<td><a href="#CvsDialog.keyPressEvent">keyPressEvent</a></td>
 
69
<td>Protected slot to handle a key press event.</td>
 
70
</tr><tr>
 
71
<td><a href="#CvsDialog.normalExit">normalExit</a></td>
 
72
<td>Public method to check for a normal process termination.</td>
 
73
</tr><tr>
 
74
<td><a href="#CvsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
 
75
<td>Private slot called by a button of the button box clicked.</td>
 
76
</tr><tr>
 
77
<td><a href="#CvsDialog.on_input_returnPressed">on_input_returnPressed</a></td>
 
78
<td>Private slot to handle the press of the return key in the input field.</td>
 
79
</tr><tr>
 
80
<td><a href="#CvsDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
 
81
<td>Private slot to handle the password checkbox toggled.</td>
 
82
</tr><tr>
 
83
<td><a href="#CvsDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
 
84
<td>Private slot to send the input to the subversion process.</td>
 
85
</tr><tr>
 
86
<td><a href="#CvsDialog.startProcess">startProcess</a></td>
 
87
<td>Public slot used to start the process.</td>
 
88
</tr>
 
89
</table>
 
90
<p><a NAME="CvsDialog.__init__" ID="CvsDialog.__init__"></a>
 
91
<h4>CvsDialog (Constructor)</h4>
 
92
<b>CvsDialog</b>(<i>text, parent = None</i>)
 
93
<p>
 
94
        Constructor
 
95
</p><dl>
 
96
<dt><i>text</i></dt>
 
97
<dd>
 
98
text to be shown by the label (string or QString)
 
99
</dd><dt><i>parent</i></dt>
 
100
<dd>
 
101
parent widget (QWidget)
 
102
</dd>
 
103
</dl><a NAME="CvsDialog.__finish" ID="CvsDialog.__finish"></a>
 
104
<h4>CvsDialog.__finish</h4>
 
105
<b>__finish</b>(<i></i>)
 
106
<p>
 
107
        Private slot called when the process finished or the user pressed the button.
 
108
</p><a NAME="CvsDialog.__procFinished" ID="CvsDialog.__procFinished"></a>
 
109
<h4>CvsDialog.__procFinished</h4>
 
110
<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
 
111
<p>
 
112
        Private slot connected to the finished signal.
 
113
</p><dl>
 
114
<dt><i>exitCode</i></dt>
 
115
<dd>
 
116
exit code of the process (integer)
 
117
</dd><dt><i>exitStatus</i></dt>
 
118
<dd>
 
119
exit status of the process (QProcess.ExitStatus)
 
120
</dd>
 
121
</dl><a NAME="CvsDialog.__readStderr" ID="CvsDialog.__readStderr"></a>
 
122
<h4>CvsDialog.__readStderr</h4>
 
123
<b>__readStderr</b>(<i></i>)
 
124
<p>
 
125
        Private slot to handle the readyReadStderr signal.
 
126
</p><p>
 
127
        It reads the error output of the process and inserts it into the
 
128
        error pane.
 
129
</p><a NAME="CvsDialog.__readStdout" ID="CvsDialog.__readStdout"></a>
 
130
<h4>CvsDialog.__readStdout</h4>
 
131
<b>__readStdout</b>(<i></i>)
 
132
<p>
 
133
        Private slot to handle the readyReadStdout signal. 
 
134
</p><p>
 
135
        It reads the output of the process, formats it and inserts it into
 
136
        the contents pane.
 
137
</p><a NAME="CvsDialog.keyPressEvent" ID="CvsDialog.keyPressEvent"></a>
 
138
<h4>CvsDialog.keyPressEvent</h4>
 
139
<b>keyPressEvent</b>(<i>evt</i>)
 
140
<p>
 
141
        Protected slot to handle a key press event.
 
142
</p><dl>
 
143
<dt><i>evt</i></dt>
 
144
<dd>
 
145
the key press event (QKeyEvent)
 
146
</dd>
 
147
</dl><a NAME="CvsDialog.normalExit" ID="CvsDialog.normalExit"></a>
 
148
<h4>CvsDialog.normalExit</h4>
 
149
<b>normalExit</b>(<i></i>)
 
150
<p>
 
151
        Public method to check for a normal process termination.
 
152
</p><dl>
 
153
<dt>Returns:</dt>
 
154
<dd>
 
155
flag indicating normal process termination (boolean)
 
156
</dd>
 
157
</dl><a NAME="CvsDialog.on_buttonBox_clicked" ID="CvsDialog.on_buttonBox_clicked"></a>
 
158
<h4>CvsDialog.on_buttonBox_clicked</h4>
 
159
<b>on_buttonBox_clicked</b>(<i>button</i>)
 
160
<p>
 
161
        Private slot called by a button of the button box clicked.
 
162
</p><dl>
 
163
<dt><i>button</i></dt>
 
164
<dd>
 
165
button that was clicked (QAbstractButton)
 
166
</dd>
 
167
</dl><a NAME="CvsDialog.on_input_returnPressed" ID="CvsDialog.on_input_returnPressed"></a>
 
168
<h4>CvsDialog.on_input_returnPressed</h4>
 
169
<b>on_input_returnPressed</b>(<i></i>)
 
170
<p>
 
171
        Private slot to handle the press of the return key in the input field.
 
172
</p><a NAME="CvsDialog.on_passwordCheckBox_toggled" ID="CvsDialog.on_passwordCheckBox_toggled"></a>
 
173
<h4>CvsDialog.on_passwordCheckBox_toggled</h4>
 
174
<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
 
175
<p>
 
176
        Private slot to handle the password checkbox toggled.
 
177
</p><dl>
 
178
<dt><i>isOn</i></dt>
 
179
<dd>
 
180
flag indicating the status of the check box (boolean)
 
181
</dd>
 
182
</dl><a NAME="CvsDialog.on_sendButton_clicked" ID="CvsDialog.on_sendButton_clicked"></a>
 
183
<h4>CvsDialog.on_sendButton_clicked</h4>
 
184
<b>on_sendButton_clicked</b>(<i></i>)
 
185
<p>
 
186
        Private slot to send the input to the subversion process.
 
187
</p><a NAME="CvsDialog.startProcess" ID="CvsDialog.startProcess"></a>
 
188
<h4>CvsDialog.startProcess</h4>
 
189
<b>startProcess</b>(<i>args, workingDir = None</i>)
 
190
<p>
 
191
        Public slot used to start the process.
 
192
</p><dl>
 
193
<dt><i>args</i></dt>
 
194
<dd>
 
195
list of arguments for the process (QStringList)
 
196
</dd><dt><i>workingDir</i></dt>
 
197
<dd>
 
198
working directory for the process (string or QString)
 
199
</dd>
 
200
</dl><dl>
 
201
<dt>Returns:</dt>
 
202
<dd>
 
203
flag indicating a successful start of the process
 
204
</dd>
 
205
</dl></p>
 
206
<div align="right"><a href="#top">Up</a></div>
 
207
<hr />
 
208
</body></html>
 
 
b'\\ No newline at end of file'