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