Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.QScintilla.EditorButtonsWidget.html

eric6/Documentation/Source/eric6.QScintilla.EditorButtonsWidget.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7273
391d6b7b1eff
child 7989
a21d673a8f99
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.QScintilla.EditorButtonsWidget</h1> 23 <h1>eric6.QScintilla.EditorButtonsWidget</h1>
24
23 <p> 25 <p>
24 Module implementing a widget containing various buttons for accessing 26 Module implementing a widget containing various buttons for accessing
25 editor actions. 27 editor actions.
26 </p> 28 </p>
27 <h3>Global Attributes</h3> 29 <h3>Global Attributes</h3>
30
28 <table> 31 <table>
29 <tr><td>None</td></tr> 32 <tr><td>None</td></tr>
30 </table> 33 </table>
31 <h3>Classes</h3> 34 <h3>Classes</h3>
32 <table> 35
36 <table>
37
33 <tr> 38 <tr>
34 <td><a href="#EditorButtonsWidget">EditorButtonsWidget</a></td> 39 <td><a href="#EditorButtonsWidget">EditorButtonsWidget</a></td>
35 <td>Class implementing a widget containing various buttons for accessing editor actions.</td> 40 <td>Class implementing a widget containing various buttons for accessing editor actions.</td>
36 </tr> 41 </tr>
37 </table> 42 </table>
38 <h3>Functions</h3> 43 <h3>Functions</h3>
39 <table> 44
40 <tr><td>None</td></tr> 45 <table>
41 </table> 46 <tr><td>None</td></tr>
42 <hr /><hr /> 47 </table>
48 <hr />
49 <hr />
43 <a NAME="EditorButtonsWidget" ID="EditorButtonsWidget"></a> 50 <a NAME="EditorButtonsWidget" ID="EditorButtonsWidget"></a>
44 <h2>EditorButtonsWidget</h2> 51 <h2>EditorButtonsWidget</h2>
52
45 <p> 53 <p>
46 Class implementing a widget containing various buttons for accessing 54 Class implementing a widget containing various buttons for accessing
47 editor actions. 55 editor actions.
48 </p> 56 </p>
49 <h3>Derived from</h3> 57 <h3>Derived from</h3>
50 QWidget 58 QWidget
51 <h3>Class Attributes</h3> 59 <h3>Class Attributes</h3>
60
52 <table> 61 <table>
53 <tr><td>None</td></tr> 62 <tr><td>None</td></tr>
54 </table> 63 </table>
55 <h3>Class Methods</h3> 64 <h3>Class Methods</h3>
65
56 <table> 66 <table>
57 <tr><td>None</td></tr> 67 <tr><td>None</td></tr>
58 </table> 68 </table>
59 <h3>Methods</h3> 69 <h3>Methods</h3>
60 <table> 70
71 <table>
72
61 <tr> 73 <tr>
62 <td><a href="#EditorButtonsWidget.__init__">EditorButtonsWidget</a></td> 74 <td><a href="#EditorButtonsWidget.__init__">EditorButtonsWidget</a></td>
63 <td>Constructor</td> 75 <td>Constructor</td>
64 </tr><tr> 76 </tr>
77 <tr>
65 <td><a href="#EditorButtonsWidget.__addButton">__addButton</a></td> 78 <td><a href="#EditorButtonsWidget.__addButton">__addButton</a></td>
66 <td>Private method to add a format button.</td> 79 <td>Private method to add a format button.</td>
67 </tr><tr> 80 </tr>
81 <tr>
68 <td><a href="#EditorButtonsWidget.__addSeparator">__addSeparator</a></td> 82 <td><a href="#EditorButtonsWidget.__addSeparator">__addSeparator</a></td>
69 <td>Private method to add a separator line.</td> 83 <td>Private method to add a separator line.</td>
70 </tr><tr> 84 </tr>
85 <tr>
71 <td><a href="#EditorButtonsWidget.__createButtons">__createButtons</a></td> 86 <td><a href="#EditorButtonsWidget.__createButtons">__createButtons</a></td>
72 <td>Private slot to create the various tool buttons.</td> 87 <td>Private slot to create the various tool buttons.</td>
73 </tr><tr> 88 </tr>
89 <tr>
74 <td><a href="#EditorButtonsWidget.__editorSelectionChanged">__editorSelectionChanged</a></td> 90 <td><a href="#EditorButtonsWidget.__editorSelectionChanged">__editorSelectionChanged</a></td>
75 <td>Private slot to handle a change of the editor's selection.</td> 91 <td>Private slot to handle a change of the editor's selection.</td>
76 </tr><tr> 92 </tr>
93 <tr>
77 <td><a href="#EditorButtonsWidget.__editorSettingsRead">__editorSettingsRead</a></td> 94 <td><a href="#EditorButtonsWidget.__editorSettingsRead">__editorSettingsRead</a></td>
78 <td>Private slot to handle a change of the editor related settings.</td> 95 <td>Private slot to handle a change of the editor related settings.</td>
79 </tr><tr> 96 </tr>
97 <tr>
80 <td><a href="#EditorButtonsWidget.__enableScrollerButtons">__enableScrollerButtons</a></td> 98 <td><a href="#EditorButtonsWidget.__enableScrollerButtons">__enableScrollerButtons</a></td>
81 <td>Private method to set the enabled state of the scroll buttons.</td> 99 <td>Private method to set the enabled state of the scroll buttons.</td>
82 </tr><tr> 100 </tr>
101 <tr>
83 <td><a href="#EditorButtonsWidget.__formatClicked">__formatClicked</a></td> 102 <td><a href="#EditorButtonsWidget.__formatClicked">__formatClicked</a></td>
84 <td>Private slot to handle a format button being clicked.</td> 103 <td>Private slot to handle a format button being clicked.</td>
85 </tr><tr> 104 </tr>
105 <tr>
86 <td><a href="#EditorButtonsWidget.__headerMenuTriggered">__headerMenuTriggered</a></td> 106 <td><a href="#EditorButtonsWidget.__headerMenuTriggered">__headerMenuTriggered</a></td>
87 <td>Private method handling the selection of a header menu entry.</td> 107 <td>Private method handling the selection of a header menu entry.</td>
88 </tr><tr> 108 </tr>
109 <tr>
89 <td><a href="#EditorButtonsWidget.__slide">__slide</a></td> 110 <td><a href="#EditorButtonsWidget.__slide">__slide</a></td>
90 <td>Private method to move the sliding widget.</td> 111 <td>Private method to move the sliding widget.</td>
91 </tr><tr> 112 </tr>
113 <tr>
92 <td><a href="#EditorButtonsWidget.__slideDown">__slideDown</a></td> 114 <td><a href="#EditorButtonsWidget.__slideDown">__slideDown</a></td>
93 <td>Private slot to move the widget downwards, i.e.</td> 115 <td>Private slot to move the widget downwards, i.e.</td>
94 </tr><tr> 116 </tr>
117 <tr>
95 <td><a href="#EditorButtonsWidget.__slideUp">__slideUp</a></td> 118 <td><a href="#EditorButtonsWidget.__slideUp">__slideUp</a></td>
96 <td>Private slot to move the widget upwards, i.e.</td> 119 <td>Private slot to move the widget upwards, i.e.</td>
97 </tr><tr> 120 </tr>
121 <tr>
98 <td><a href="#EditorButtonsWidget.__updateButtonStates">__updateButtonStates</a></td> 122 <td><a href="#EditorButtonsWidget.__updateButtonStates">__updateButtonStates</a></td>
99 <td>Private slot to change the button states.</td> 123 <td>Private slot to change the button states.</td>
100 </tr><tr> 124 </tr>
125 <tr>
101 <td><a href="#EditorButtonsWidget.resizeEvent">resizeEvent</a></td> 126 <td><a href="#EditorButtonsWidget.resizeEvent">resizeEvent</a></td>
102 <td>Protected method to handle resize events.</td> 127 <td>Protected method to handle resize events.</td>
103 </tr><tr> 128 </tr>
129 <tr>
104 <td><a href="#EditorButtonsWidget.show">show</a></td> 130 <td><a href="#EditorButtonsWidget.show">show</a></td>
105 <td>Public slot to show the widget.</td> 131 <td>Public slot to show the widget.</td>
106 </tr> 132 </tr>
107 </table> 133 </table>
108 <h3>Static Methods</h3> 134 <h3>Static Methods</h3>
109 <table> 135
110 <tr><td>None</td></tr> 136 <table>
111 </table> 137 <tr><td>None</td></tr>
138 </table>
139
112 <a NAME="EditorButtonsWidget.__init__" ID="EditorButtonsWidget.__init__"></a> 140 <a NAME="EditorButtonsWidget.__init__" ID="EditorButtonsWidget.__init__"></a>
113 <h4>EditorButtonsWidget (Constructor)</h4> 141 <h4>EditorButtonsWidget (Constructor)</h4>
114 <b>EditorButtonsWidget</b>(<i>editor, parent=None</i>) 142 <b>EditorButtonsWidget</b>(<i>editor, parent=None</i>)
143
115 <p> 144 <p>
116 Constructor 145 Constructor
117 </p><dl> 146 </p>
147 <dl>
148
118 <dt><i>editor</i> (Editor)</dt> 149 <dt><i>editor</i> (Editor)</dt>
119 <dd> 150 <dd>
120 reference to the editor 151 reference to the editor
121 </dd><dt><i>parent</i> (QWidget)</dt> 152 </dd>
153 <dt><i>parent</i> (QWidget)</dt>
122 <dd> 154 <dd>
123 reference to the parent widget 155 reference to the parent widget
124 </dd> 156 </dd>
125 </dl><a NAME="EditorButtonsWidget.__addButton" ID="EditorButtonsWidget.__addButton"></a> 157 </dl>
158 <a NAME="EditorButtonsWidget.__addButton" ID="EditorButtonsWidget.__addButton"></a>
126 <h4>EditorButtonsWidget.__addButton</h4> 159 <h4>EditorButtonsWidget.__addButton</h4>
127 <b>__addButton</b>(<i>formatName, iconName, toolTip</i>) 160 <b>__addButton</b>(<i>formatName, iconName, toolTip</i>)
161
128 <p> 162 <p>
129 Private method to add a format button. 163 Private method to add a format button.
130 </p><dl> 164 </p>
165 <dl>
166
131 <dt><i>formatName</i> (str)</dt> 167 <dt><i>formatName</i> (str)</dt>
132 <dd> 168 <dd>
133 unique name of the format 169 unique name of the format
134 </dd><dt><i>iconName</i> (str)</dt> 170 </dd>
171 <dt><i>iconName</i> (str)</dt>
135 <dd> 172 <dd>
136 name of the icon for the button 173 name of the icon for the button
137 </dd><dt><i>toolTip</i> (str)</dt> 174 </dd>
175 <dt><i>toolTip</i> (str)</dt>
138 <dd> 176 <dd>
139 text for the tool tip 177 text for the tool tip
140 </dd> 178 </dd>
141 </dl><dl> 179 </dl>
180 <dl>
142 <dt>Returns:</dt> 181 <dt>Returns:</dt>
143 <dd> 182 <dd>
144 generated button 183 generated button
145 </dd> 184 </dd>
146 </dl><dl> 185 </dl>
186 <dl>
147 <dt>Return Type:</dt> 187 <dt>Return Type:</dt>
148 <dd> 188 <dd>
149 QToolButton 189 QToolButton
150 </dd> 190 </dd>
151 </dl><a NAME="EditorButtonsWidget.__addSeparator" ID="EditorButtonsWidget.__addSeparator"></a> 191 </dl>
192 <a NAME="EditorButtonsWidget.__addSeparator" ID="EditorButtonsWidget.__addSeparator"></a>
152 <h4>EditorButtonsWidget.__addSeparator</h4> 193 <h4>EditorButtonsWidget.__addSeparator</h4>
153 <b>__addSeparator</b>(<i></i>) 194 <b>__addSeparator</b>(<i></i>)
195
154 <p> 196 <p>
155 Private method to add a separator line. 197 Private method to add a separator line.
156 </p><a NAME="EditorButtonsWidget.__createButtons" ID="EditorButtonsWidget.__createButtons"></a> 198 </p>
199 <a NAME="EditorButtonsWidget.__createButtons" ID="EditorButtonsWidget.__createButtons"></a>
157 <h4>EditorButtonsWidget.__createButtons</h4> 200 <h4>EditorButtonsWidget.__createButtons</h4>
158 <b>__createButtons</b>(<i></i>) 201 <b>__createButtons</b>(<i></i>)
202
159 <p> 203 <p>
160 Private slot to create the various tool buttons. 204 Private slot to create the various tool buttons.
161 </p><a NAME="EditorButtonsWidget.__editorSelectionChanged" ID="EditorButtonsWidget.__editorSelectionChanged"></a> 205 </p>
206 <a NAME="EditorButtonsWidget.__editorSelectionChanged" ID="EditorButtonsWidget.__editorSelectionChanged"></a>
162 <h4>EditorButtonsWidget.__editorSelectionChanged</h4> 207 <h4>EditorButtonsWidget.__editorSelectionChanged</h4>
163 <b>__editorSelectionChanged</b>(<i></i>) 208 <b>__editorSelectionChanged</b>(<i></i>)
209
164 <p> 210 <p>
165 Private slot to handle a change of the editor's selection. 211 Private slot to handle a change of the editor's selection.
166 </p><a NAME="EditorButtonsWidget.__editorSettingsRead" ID="EditorButtonsWidget.__editorSettingsRead"></a> 212 </p>
213 <a NAME="EditorButtonsWidget.__editorSettingsRead" ID="EditorButtonsWidget.__editorSettingsRead"></a>
167 <h4>EditorButtonsWidget.__editorSettingsRead</h4> 214 <h4>EditorButtonsWidget.__editorSettingsRead</h4>
168 <b>__editorSettingsRead</b>(<i></i>) 215 <b>__editorSettingsRead</b>(<i></i>)
216
169 <p> 217 <p>
170 Private slot to handle a change of the editor related settings. 218 Private slot to handle a change of the editor related settings.
171 </p><a NAME="EditorButtonsWidget.__enableScrollerButtons" ID="EditorButtonsWidget.__enableScrollerButtons"></a> 219 </p>
220 <a NAME="EditorButtonsWidget.__enableScrollerButtons" ID="EditorButtonsWidget.__enableScrollerButtons"></a>
172 <h4>EditorButtonsWidget.__enableScrollerButtons</h4> 221 <h4>EditorButtonsWidget.__enableScrollerButtons</h4>
173 <b>__enableScrollerButtons</b>(<i></i>) 222 <b>__enableScrollerButtons</b>(<i></i>)
223
174 <p> 224 <p>
175 Private method to set the enabled state of the scroll buttons. 225 Private method to set the enabled state of the scroll buttons.
176 </p><a NAME="EditorButtonsWidget.__formatClicked" ID="EditorButtonsWidget.__formatClicked"></a> 226 </p>
227 <a NAME="EditorButtonsWidget.__formatClicked" ID="EditorButtonsWidget.__formatClicked"></a>
177 <h4>EditorButtonsWidget.__formatClicked</h4> 228 <h4>EditorButtonsWidget.__formatClicked</h4>
178 <b>__formatClicked</b>(<i>formatName</i>) 229 <b>__formatClicked</b>(<i>formatName</i>)
230
179 <p> 231 <p>
180 Private slot to handle a format button being clicked. 232 Private slot to handle a format button being clicked.
181 </p><dl> 233 </p>
234 <dl>
235
182 <dt><i>formatName</i> (str)</dt> 236 <dt><i>formatName</i> (str)</dt>
183 <dd> 237 <dd>
184 format type of the button 238 format type of the button
185 </dd> 239 </dd>
186 </dl><a NAME="EditorButtonsWidget.__headerMenuTriggered" ID="EditorButtonsWidget.__headerMenuTriggered"></a> 240 </dl>
241 <a NAME="EditorButtonsWidget.__headerMenuTriggered" ID="EditorButtonsWidget.__headerMenuTriggered"></a>
187 <h4>EditorButtonsWidget.__headerMenuTriggered</h4> 242 <h4>EditorButtonsWidget.__headerMenuTriggered</h4>
188 <b>__headerMenuTriggered</b>(<i>act</i>) 243 <b>__headerMenuTriggered</b>(<i>act</i>)
244
189 <p> 245 <p>
190 Private method handling the selection of a header menu entry. 246 Private method handling the selection of a header menu entry.
191 </p><dl> 247 </p>
248 <dl>
249
192 <dt><i>act</i> (QAction)</dt> 250 <dt><i>act</i> (QAction)</dt>
193 <dd> 251 <dd>
194 action of the headers menu that was triggered 252 action of the headers menu that was triggered
195 </dd> 253 </dd>
196 </dl><a NAME="EditorButtonsWidget.__slide" ID="EditorButtonsWidget.__slide"></a> 254 </dl>
255 <a NAME="EditorButtonsWidget.__slide" ID="EditorButtonsWidget.__slide"></a>
197 <h4>EditorButtonsWidget.__slide</h4> 256 <h4>EditorButtonsWidget.__slide</h4>
198 <b>__slide</b>(<i>up</i>) 257 <b>__slide</b>(<i>up</i>)
258
199 <p> 259 <p>
200 Private method to move the sliding widget. 260 Private method to move the sliding widget.
201 </p><dl> 261 </p>
262 <dl>
263
202 <dt><i>up</i></dt> 264 <dt><i>up</i></dt>
203 <dd> 265 <dd>
204 flag indicating to move upwards (boolean) 266 flag indicating to move upwards (boolean)
205 </dd> 267 </dd>
206 </dl><a NAME="EditorButtonsWidget.__slideDown" ID="EditorButtonsWidget.__slideDown"></a> 268 </dl>
269 <a NAME="EditorButtonsWidget.__slideDown" ID="EditorButtonsWidget.__slideDown"></a>
207 <h4>EditorButtonsWidget.__slideDown</h4> 270 <h4>EditorButtonsWidget.__slideDown</h4>
208 <b>__slideDown</b>(<i></i>) 271 <b>__slideDown</b>(<i></i>)
272
209 <p> 273 <p>
210 Private slot to move the widget downwards, i.e. show contents to 274 Private slot to move the widget downwards, i.e. show contents to
211 the top. 275 the top.
212 </p><a NAME="EditorButtonsWidget.__slideUp" ID="EditorButtonsWidget.__slideUp"></a> 276 </p>
277 <a NAME="EditorButtonsWidget.__slideUp" ID="EditorButtonsWidget.__slideUp"></a>
213 <h4>EditorButtonsWidget.__slideUp</h4> 278 <h4>EditorButtonsWidget.__slideUp</h4>
214 <b>__slideUp</b>(<i></i>) 279 <b>__slideUp</b>(<i></i>)
280
215 <p> 281 <p>
216 Private slot to move the widget upwards, i.e. show contents to the 282 Private slot to move the widget upwards, i.e. show contents to the
217 bottom. 283 bottom.
218 </p><a NAME="EditorButtonsWidget.__updateButtonStates" ID="EditorButtonsWidget.__updateButtonStates"></a> 284 </p>
285 <a NAME="EditorButtonsWidget.__updateButtonStates" ID="EditorButtonsWidget.__updateButtonStates"></a>
219 <h4>EditorButtonsWidget.__updateButtonStates</h4> 286 <h4>EditorButtonsWidget.__updateButtonStates</h4>
220 <b>__updateButtonStates</b>(<i></i>) 287 <b>__updateButtonStates</b>(<i></i>)
288
221 <p> 289 <p>
222 Private slot to change the button states. 290 Private slot to change the button states.
223 </p><a NAME="EditorButtonsWidget.resizeEvent" ID="EditorButtonsWidget.resizeEvent"></a> 291 </p>
292 <a NAME="EditorButtonsWidget.resizeEvent" ID="EditorButtonsWidget.resizeEvent"></a>
224 <h4>EditorButtonsWidget.resizeEvent</h4> 293 <h4>EditorButtonsWidget.resizeEvent</h4>
225 <b>resizeEvent</b>(<i>evt</i>) 294 <b>resizeEvent</b>(<i>evt</i>)
295
226 <p> 296 <p>
227 Protected method to handle resize events. 297 Protected method to handle resize events.
228 </p><dl> 298 </p>
299 <dl>
300
229 <dt><i>evt</i></dt> 301 <dt><i>evt</i></dt>
230 <dd> 302 <dd>
231 reference to the resize event (QResizeEvent) 303 reference to the resize event (QResizeEvent)
232 </dd> 304 </dd>
233 </dl><a NAME="EditorButtonsWidget.show" ID="EditorButtonsWidget.show"></a> 305 </dl>
306 <a NAME="EditorButtonsWidget.show" ID="EditorButtonsWidget.show"></a>
234 <h4>EditorButtonsWidget.show</h4> 307 <h4>EditorButtonsWidget.show</h4>
235 <b>show</b>(<i></i>) 308 <b>show</b>(<i></i>)
309
236 <p> 310 <p>
237 Public slot to show the widget. 311 Public slot to show the widget.
238 </p> 312 </p>
239 <div align="right"><a href="#top">Up</a></div> 313 <div align="right"><a href="#top">Up</a></div>
240 <hr /> 314 <hr />

Mercurial Repository: eric

eric ide

mercurial