src/eric7/Documentation/Source/eric7.UI.UserInterface.html

branch
eric7
changeset 10816
236d97cba7c5
parent 10812
f62e1bf47492
child 10828
fc1310995b98
equal deleted inserted replaced
10813:77d4d1878228 10816:236d97cba7c5
17 </table> 17 </table>
18 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 <table> 20 <table>
21 <tr> 21 <tr>
22 <td><a href="#Redirector">Redirector</a></td>
23 <td>Helper class used to redirect stdout and stderr to the log window.</td>
24 </tr>
25 <tr>
26 <td><a href="#UserInterface">UserInterface</a></td> 22 <td><a href="#UserInterface">UserInterface</a></td>
27 <td>Class implementing the main user interface.</td> 23 <td>Class implementing the main user interface.</td>
28 </tr> 24 </tr>
29 <tr> 25 <tr>
30 <td><a href="#UserInterfaceSide">UserInterfaceSide</a></td> 26 <td><a href="#UserInterfaceSide">UserInterfaceSide</a></td>
35 <h3>Functions</h3> 31 <h3>Functions</h3>
36 <table> 32 <table>
37 <tr><td>None</td></tr> 33 <tr><td>None</td></tr>
38 </table> 34 </table>
39 35
40 <hr />
41 <hr />
42 <a NAME="Redirector" ID="Redirector"></a>
43 <h2>Redirector</h2>
44 <p>
45 Helper class used to redirect stdout and stderr to the log window.
46 </p>
47
48 <h3>Signals</h3>
49 <dl>
50
51 <dt>appendStderr(str)</dt>
52 <dd>
53 emitted to write data to stderr logger
54 </dd>
55 <dt>appendStdout(str)</dt>
56 <dd>
57 emitted to write data to stdout logger
58 </dd>
59 </dl>
60 <h3>Derived from</h3>
61 QObject
62 <h3>Class Attributes</h3>
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66
67 <h3>Class Methods</h3>
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71
72 <h3>Methods</h3>
73 <table>
74 <tr>
75 <td><a href="#Redirector.__init__">Redirector</a></td>
76 <td>Constructor</td>
77 </tr>
78 <tr>
79 <td><a href="#Redirector.__bufferedWrite">__bufferedWrite</a></td>
80 <td>Private method returning number of characters to write.</td>
81 </tr>
82 <tr>
83 <td><a href="#Redirector.__nWrite">__nWrite</a></td>
84 <td>Private method used to write data.</td>
85 </tr>
86 <tr>
87 <td><a href="#Redirector.encoding">encoding</a></td>
88 <td>Public method to report the used encoding.</td>
89 </tr>
90 <tr>
91 <td><a href="#Redirector.flush">flush</a></td>
92 <td>Public method used to flush the buffered data.</td>
93 </tr>
94 <tr>
95 <td><a href="#Redirector.isatty">isatty</a></td>
96 <td>Public method to indicate a tty.</td>
97 </tr>
98 <tr>
99 <td><a href="#Redirector.write">write</a></td>
100 <td>Public method used to write data.</td>
101 </tr>
102 </table>
103
104 <h3>Static Methods</h3>
105 <table>
106 <tr><td>None</td></tr>
107 </table>
108
109
110 <a NAME="Redirector.__init__" ID="Redirector.__init__"></a>
111 <h4>Redirector (Constructor)</h4>
112 <b>Redirector</b>(<i>stderr, parent=None</i>)
113 <p>
114 Constructor
115 </p>
116
117 <dl>
118
119 <dt><i>stderr</i> (bool)</dt>
120 <dd>
121 flag indicating stderr is being redirected
122 </dd>
123 <dt><i>parent</i> (QObject)</dt>
124 <dd>
125 reference to the parent object
126 </dd>
127 </dl>
128 <a NAME="Redirector.__bufferedWrite" ID="Redirector.__bufferedWrite"></a>
129 <h4>Redirector.__bufferedWrite</h4>
130 <b>__bufferedWrite</b>(<i></i>)
131 <p>
132 Private method returning number of characters to write.
133 </p>
134
135 <dl>
136 <dt>Return:</dt>
137 <dd>
138 number of characters buffered or length of buffered line
139 </dd>
140 </dl>
141 <dl>
142 <dt>Return Type:</dt>
143 <dd>
144 int
145 </dd>
146 </dl>
147 <a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a>
148 <h4>Redirector.__nWrite</h4>
149 <b>__nWrite</b>(<i>n</i>)
150 <p>
151 Private method used to write data.
152 </p>
153
154 <dl>
155
156 <dt><i>n</i> (int)</dt>
157 <dd>
158 max number of bytes to write
159 </dd>
160 </dl>
161 <a NAME="Redirector.encoding" ID="Redirector.encoding"></a>
162 <h4>Redirector.encoding</h4>
163 <b>encoding</b>(<i></i>)
164 <p>
165 Public method to report the used encoding.
166 </p>
167
168 <dl>
169 <dt>Return:</dt>
170 <dd>
171 used encoding
172 </dd>
173 </dl>
174 <dl>
175 <dt>Return Type:</dt>
176 <dd>
177 str
178 </dd>
179 </dl>
180 <a NAME="Redirector.flush" ID="Redirector.flush"></a>
181 <h4>Redirector.flush</h4>
182 <b>flush</b>(<i></i>)
183 <p>
184 Public method used to flush the buffered data.
185 </p>
186
187 <a NAME="Redirector.isatty" ID="Redirector.isatty"></a>
188 <h4>Redirector.isatty</h4>
189 <b>isatty</b>(<i></i>)
190 <p>
191 Public method to indicate a tty.
192 </p>
193 <p>
194 Note: This always reports 'False'.
195 </p>
196
197 <dl>
198 <dt>Return:</dt>
199 <dd>
200 flag indicating a tty
201 </dd>
202 </dl>
203 <dl>
204 <dt>Return Type:</dt>
205 <dd>
206 bool
207 </dd>
208 </dl>
209 <a NAME="Redirector.write" ID="Redirector.write"></a>
210 <h4>Redirector.write</h4>
211 <b>write</b>(<i>s</i>)
212 <p>
213 Public method used to write data.
214 </p>
215
216 <dl>
217
218 <dt><i>s</i> (Any)</dt>
219 <dd>
220 data to be written (it must support the str-method)
221 </dd>
222 </dl>
223 <div align="right"><a href="#top">Up</a></div>
224 <hr /> 36 <hr />
225 <hr /> 37 <hr />
226 <a NAME="UserInterface" ID="UserInterface"></a> 38 <a NAME="UserInterface" ID="UserInterface"></a>
227 <h2>UserInterface</h2> 39 <h2>UserInterface</h2>
228 <p> 40 <p>
267 <h3>Derived from</h3> 79 <h3>Derived from</h3>
268 EricMainWindow 80 EricMainWindow
269 <h3>Class Attributes</h3> 81 <h3>Class Attributes</h3>
270 <table> 82 <table>
271 <tr><td>ErrorLogFileName</td></tr> 83 <tr><td>ErrorLogFileName</td></tr>
84 <tr><td>ReleaseMode</td></tr>
272 <tr><td>maxFilePathLen</td></tr> 85 <tr><td>maxFilePathLen</td></tr>
273 <tr><td>maxMenuFilePathLen</td></tr> 86 <tr><td>maxMenuFilePathLen</td></tr>
274 </table> 87 </table>
275 88
276 <h3>Class Methods</h3> 89 <h3>Class Methods</h3>

eric ide

mercurial