src/eric7/Documentation/Source/eric7.Network.IRC.IrcMessageEdit.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10428
a071d4065202
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Network.IRC.IrcMessageEdit</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.Network.IRC.IrcMessageEdit</h1>
10
11 <p>
12 Module implementing a specialized line edit for entering IRC messages.
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="#IrcMessageEdit">IrcMessageEdit</a></td>
25 <td>Class implementing a specialized line edit for entering IRC messages.</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="IrcMessageEdit" ID="IrcMessageEdit"></a>
36 <h2>IrcMessageEdit</h2>
37
38 <p>
39 Class implementing a specialized line edit for entering IRC messages.
40 </p>
41 <h3>Derived from</h3>
42 QLineEdit
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>MaxHistory</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="#IrcMessageEdit.__init__">IrcMessageEdit</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#IrcMessageEdit.__addHistory">__addHistory</a></td>
63 <td>Private method to add an entry to the history.</td>
64 </tr>
65 <tr>
66 <td><a href="#IrcMessageEdit.__getHistory">__getHistory</a></td>
67 <td>Private method to move in the history.</td>
68 </tr>
69 <tr>
70 <td><a href="#IrcMessageEdit.keyPressEvent">keyPressEvent</a></td>
71 <td>Protected method implementing special key handling.</td>
72 </tr>
73 <tr>
74 <td><a href="#IrcMessageEdit.setText">setText</a></td>
75 <td>Public method to set the text.</td>
76 </tr>
77 <tr>
78 <td><a href="#IrcMessageEdit.wheelEvent">wheelEvent</a></td>
79 <td>Protected slot to support wheel events.</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="IrcMessageEdit.__init__" ID="IrcMessageEdit.__init__"></a>
89 <h4>IrcMessageEdit (Constructor)</h4>
90 <b>IrcMessageEdit</b>(<i>parent=None</i>)
91
92 <p>
93 Constructor
94 </p>
95 <dl>
96
97 <dt><i>parent</i> (QWidget)</dt>
98 <dd>
99 reference to the parent widget
100 </dd>
101 </dl>
102 <a NAME="IrcMessageEdit.__addHistory" ID="IrcMessageEdit.__addHistory"></a>
103 <h4>IrcMessageEdit.__addHistory</h4>
104 <b>__addHistory</b>(<i>txt</i>)
105
106 <p>
107 Private method to add an entry to the history.
108 </p>
109 <dl>
110
111 <dt><i>txt</i></dt>
112 <dd>
113 text to be added to the history (string)
114 </dd>
115 </dl>
116 <a NAME="IrcMessageEdit.__getHistory" ID="IrcMessageEdit.__getHistory"></a>
117 <h4>IrcMessageEdit.__getHistory</h4>
118 <b>__getHistory</b>(<i>up</i>)
119
120 <p>
121 Private method to move in the history.
122 </p>
123 <dl>
124
125 <dt><i>up</i></dt>
126 <dd>
127 flag indicating the direction (boolean)
128 </dd>
129 </dl>
130 <a NAME="IrcMessageEdit.keyPressEvent" ID="IrcMessageEdit.keyPressEvent"></a>
131 <h4>IrcMessageEdit.keyPressEvent</h4>
132 <b>keyPressEvent</b>(<i>evt</i>)
133
134 <p>
135 Protected method implementing special key handling.
136 </p>
137 <dl>
138
139 <dt><i>evt</i></dt>
140 <dd>
141 reference to the event (QKeyEvent)
142 </dd>
143 </dl>
144 <a NAME="IrcMessageEdit.setText" ID="IrcMessageEdit.setText"></a>
145 <h4>IrcMessageEdit.setText</h4>
146 <b>setText</b>(<i>text</i>)
147
148 <p>
149 Public method to set the text.
150 </p>
151 <p>
152 Note: This reimplementation ensures, that the cursor is at the end of
153 the text.
154 </p>
155 <dl>
156
157 <dt><i>text</i></dt>
158 <dd>
159 text to be set (string)
160 </dd>
161 </dl>
162 <a NAME="IrcMessageEdit.wheelEvent" ID="IrcMessageEdit.wheelEvent"></a>
163 <h4>IrcMessageEdit.wheelEvent</h4>
164 <b>wheelEvent</b>(<i>evt</i>)
165
166 <p>
167 Protected slot to support wheel events.
168 </p>
169 <dl>
170
171 <dt><i>evt</i></dt>
172 <dd>
173 reference to the wheel event (QWheelEvent)
174 </dd>
175 </dl>
176 <div align="right"><a href="#top">Up</a></div>
177 <hr />
178 </body></html>

eric ide

mercurial