Documentation/Source/eric4.E4Gui.E4ToolBox.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
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.E4Gui.E4ToolBox</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.E4Gui.E4ToolBox</h1>
24 <p>
25 Module implementing a horizontal and a vertical toolbox class.
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="#E4HorizontalToolBox">E4HorizontalToolBox</a></td>
35 <td>Class implementing a vertical QToolBox like widget.</td>
36 </tr><tr>
37 <td><a href="#E4VerticalToolBox">E4VerticalToolBox</a></td>
38 <td>Class implementing a ToolBox class substituting QToolBox to support wheel events.</td>
39 </tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="E4HorizontalToolBox" ID="E4HorizontalToolBox"></a>
47 <h2>E4HorizontalToolBox</h2>
48 <p>
49 Class implementing a vertical QToolBox like widget.
50 </p>
51 <h3>Derived from</h3>
52 E4TabWidget
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#E4HorizontalToolBox.__init__">E4HorizontalToolBox</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#E4HorizontalToolBox.addItem">addItem</a></td>
64 <td>Public method to add a widget to the toolbox.</td>
65 </tr><tr>
66 <td><a href="#E4HorizontalToolBox.insertItem">insertItem</a></td>
67 <td>Public method to add a widget to the toolbox.</td>
68 </tr><tr>
69 <td><a href="#E4HorizontalToolBox.setItemEnabled">setItemEnabled</a></td>
70 <td>Public method to set the enabled state of an item.</td>
71 </tr><tr>
72 <td><a href="#E4HorizontalToolBox.setItemToolTip">setItemToolTip</a></td>
73 <td>Public method to set the tooltip of an item.</td>
74 </tr>
75 </table>
76 <a NAME="E4HorizontalToolBox.__init__" ID="E4HorizontalToolBox.__init__"></a>
77 <h4>E4HorizontalToolBox (Constructor)</h4>
78 <b>E4HorizontalToolBox</b>(<i>parent = None</i>)
79 <p>
80 Constructor
81 </p><dl>
82 <dt><i>parent</i></dt>
83 <dd>
84 reference to the parent widget (QWidget)
85 </dd>
86 </dl><a NAME="E4HorizontalToolBox.addItem" ID="E4HorizontalToolBox.addItem"></a>
87 <h4>E4HorizontalToolBox.addItem</h4>
88 <b>addItem</b>(<i>widget, icon, text</i>)
89 <p>
90 Public method to add a widget to the toolbox.
91 </p><dl>
92 <dt><i>widget</i></dt>
93 <dd>
94 reference to the widget to be added (QWidget)
95 </dd><dt><i>icon</i></dt>
96 <dd>
97 the icon to be shown (QIcon)
98 </dd><dt><i>text</i></dt>
99 <dd>
100 the text to be shown (string)
101 </dd>
102 </dl><dl>
103 <dt>Returns:</dt>
104 <dd>
105 index of the added widget (integer)
106 </dd>
107 </dl><a NAME="E4HorizontalToolBox.insertItem" ID="E4HorizontalToolBox.insertItem"></a>
108 <h4>E4HorizontalToolBox.insertItem</h4>
109 <b>insertItem</b>(<i>index, widget, icon, text</i>)
110 <p>
111 Public method to add a widget to the toolbox.
112 </p><dl>
113 <dt><i>index</i></dt>
114 <dd>
115 position at which the widget should be inserted (integer)
116 </dd><dt><i>widget</i></dt>
117 <dd>
118 reference to the widget to be added (QWidget)
119 </dd><dt><i>icon</i></dt>
120 <dd>
121 the icon to be shown (QIcon)
122 </dd><dt><i>text</i></dt>
123 <dd>
124 the text to be shown (string)
125 </dd>
126 </dl><dl>
127 <dt>Returns:</dt>
128 <dd>
129 index of the added widget (integer)
130 </dd>
131 </dl><a NAME="E4HorizontalToolBox.setItemEnabled" ID="E4HorizontalToolBox.setItemEnabled"></a>
132 <h4>E4HorizontalToolBox.setItemEnabled</h4>
133 <b>setItemEnabled</b>(<i>index, enabled</i>)
134 <p>
135 Public method to set the enabled state of an item.
136 </p><dl>
137 <dt><i>index</i></dt>
138 <dd>
139 index of the item (integer)
140 </dd><dt><i>enabled</i></dt>
141 <dd>
142 flag indicating the enabled state (boolean)
143 </dd>
144 </dl><a NAME="E4HorizontalToolBox.setItemToolTip" ID="E4HorizontalToolBox.setItemToolTip"></a>
145 <h4>E4HorizontalToolBox.setItemToolTip</h4>
146 <b>setItemToolTip</b>(<i>index, toolTip</i>)
147 <p>
148 Public method to set the tooltip of an item.
149 </p><dl>
150 <dt><i>index</i></dt>
151 <dd>
152 index of the item (integer)
153 </dd><dt><i>toolTip</i></dt>
154 <dd>
155 tooltip text to be set (string)
156 </dd>
157 </dl>
158 <div align="right"><a href="#top">Up</a></div>
159 <hr /><hr />
160 <a NAME="E4VerticalToolBox" ID="E4VerticalToolBox"></a>
161 <h2>E4VerticalToolBox</h2>
162 <p>
163 Class implementing a ToolBox class substituting QToolBox to support wheel events.
164 </p>
165 <h3>Derived from</h3>
166 QToolBox
167 <h3>Class Attributes</h3>
168 <table>
169 <tr><td>None</td></tr>
170 </table>
171 <h3>Methods</h3>
172 <table>
173 <tr>
174 <td><a href="#E4VerticalToolBox.__init__">E4VerticalToolBox</a></td>
175 <td>Constructor</td>
176 </tr><tr>
177 <td><a href="#E4VerticalToolBox.wheelEvent">wheelEvent</a></td>
178 <td>Protected slot to support wheel events.</td>
179 </tr>
180 </table>
181 <a NAME="E4VerticalToolBox.__init__" ID="E4VerticalToolBox.__init__"></a>
182 <h4>E4VerticalToolBox (Constructor)</h4>
183 <b>E4VerticalToolBox</b>(<i>parent = None</i>)
184 <p>
185 Constructor
186 </p><dl>
187 <dt><i>parent</i></dt>
188 <dd>
189 reference to the parent widget (QWidget)
190 </dd>
191 </dl><a NAME="E4VerticalToolBox.wheelEvent" ID="E4VerticalToolBox.wheelEvent"></a>
192 <h4>E4VerticalToolBox.wheelEvent</h4>
193 <b>wheelEvent</b>(<i>event</i>)
194 <p>
195 Protected slot to support wheel events.
196 </p><dl>
197 <dt><i>reference</i></dt>
198 <dd>
199 to the wheel event (QWheelEvent)
200 </dd>
201 </dl>
202 <div align="right"><a href="#top">Up</a></div>
203 <hr />
204 </body></html>

eric ide

mercurial