Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.QScintilla.EditorButtonsWidget.html
Documentation/Source/eric6.QScintilla.EditorButtonsWidget.html
- changeset 5414
- 7b937f8b31d0
- child 5416
- 16366120b523
equal
deleted
inserted
replaced
| 5413:66b177d4d51c | 5414:7b937f8b31d0 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.QScintilla.EditorButtonsWidget</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.QScintilla.EditorButtonsWidget</h1> | |
| 23 <p> | |
| 24 Module implementing a widget containing various buttons for accessing | |
| 25 editor actions. | |
| 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="#EditorButtonsWidget">EditorButtonsWidget</a></td> | |
| 35 <td>Class implementing a widget containing various buttons for accessing editor actions.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="EditorButtonsWidget" ID="EditorButtonsWidget"></a> | |
| 44 <h2>EditorButtonsWidget</h2> | |
| 45 <p> | |
| 46 Class implementing a widget containing various buttons for accessing | |
| 47 editor actions. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QWidget | |
| 51 <h3>Class Attributes</h3> | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Class Methods</h3> | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | |
| 58 </table> | |
| 59 <h3>Methods</h3> | |
| 60 <table> | |
| 61 <tr> | |
| 62 <td><a href="#EditorButtonsWidget.__init__">EditorButtonsWidget</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#EditorButtonsWidget.__addButton">__addButton</a></td> | |
| 66 <td>Private method to add a format button.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#EditorButtonsWidget.__addSeparator">__addSeparator</a></td> | |
| 69 <td>Private method to add a separator line.</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#EditorButtonsWidget.__createButtons">__createButtons</a></td> | |
| 72 <td>Private slot to create the various tool buttons.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#EditorButtonsWidget.__editorSelectionChanged">__editorSelectionChanged</a></td> | |
| 75 <td>Private slot to handle a change of the editor's selection.</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#EditorButtonsWidget.__enableScrollerButtons">__enableScrollerButtons</a></td> | |
| 78 <td>Private method to set the enabled state of the scroll buttons.</td> | |
| 79 </tr><tr> | |
| 80 <td><a href="#EditorButtonsWidget.__formatClicked">__formatClicked</a></td> | |
| 81 <td>Private slot to handle a format button being clicked.</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#EditorButtonsWidget.__headerMenuTriggered">__headerMenuTriggered</a></td> | |
| 84 <td>Private method handling the selection of a header menu entry.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#EditorButtonsWidget.__slide">__slide</a></td> | |
| 87 <td>Private method to move the sliding widget.</td> | |
| 88 </tr><tr> | |
| 89 <td><a href="#EditorButtonsWidget.__slideDown">__slideDown</a></td> | |
| 90 <td>Private slot to move the widget downwards, i.e.</td> | |
| 91 </tr><tr> | |
| 92 <td><a href="#EditorButtonsWidget.__slideUp">__slideUp</a></td> | |
| 93 <td>Private slot to move the widget upwards, i.e.</td> | |
| 94 </tr><tr> | |
| 95 <td><a href="#EditorButtonsWidget.__updateButtonStates">__updateButtonStates</a></td> | |
| 96 <td>Private slot to change the button states.</td> | |
| 97 </tr><tr> | |
| 98 <td><a href="#EditorButtonsWidget.resizeEvent">resizeEvent</a></td> | |
| 99 <td>Protected method to handle resize events.</td> | |
| 100 </tr><tr> | |
| 101 <td><a href="#EditorButtonsWidget.show">show</a></td> | |
| 102 <td>Public slot to show the widget.</td> | |
| 103 </tr> | |
| 104 </table> | |
| 105 <h3>Static Methods</h3> | |
| 106 <table> | |
| 107 <tr><td>None</td></tr> | |
| 108 </table> | |
| 109 <a NAME="EditorButtonsWidget.__init__" ID="EditorButtonsWidget.__init__"></a> | |
| 110 <h4>EditorButtonsWidget (Constructor)</h4> | |
| 111 <b>EditorButtonsWidget</b>(<i>editor, parent=None</i>) | |
| 112 <p> | |
| 113 Constructor | |
| 114 </p><dl> | |
| 115 <dt><i>editor</i> (Editor)</dt> | |
| 116 <dd> | |
| 117 reference to the editor | |
| 118 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 119 <dd> | |
| 120 reference to the parent widget | |
| 121 </dd> | |
| 122 </dl><a NAME="EditorButtonsWidget.__addButton" ID="EditorButtonsWidget.__addButton"></a> | |
| 123 <h4>EditorButtonsWidget.__addButton</h4> | |
| 124 <b>__addButton</b>(<i>format, iconName, toolTip</i>) | |
| 125 <p> | |
| 126 Private method to add a format button. | |
| 127 </p><dl> | |
| 128 <dt><i>format</i> (str)</dt> | |
| 129 <dd> | |
| 130 unique name of the format | |
| 131 </dd><dt><i>iconName</i> (str)</dt> | |
| 132 <dd> | |
| 133 name of the icon for the button | |
| 134 </dd><dt><i>toolTip</i> (str)</dt> | |
| 135 <dd> | |
| 136 text for the tool tip | |
| 137 </dd> | |
| 138 </dl><dl> | |
| 139 <dt>Returns:</dt> | |
| 140 <dd> | |
| 141 generated button | |
| 142 </dd> | |
| 143 </dl><dl> | |
| 144 <dt>Return Type:</dt> | |
| 145 <dd> | |
| 146 QToolButton | |
| 147 </dd> | |
| 148 </dl><a NAME="EditorButtonsWidget.__addSeparator" ID="EditorButtonsWidget.__addSeparator"></a> | |
| 149 <h4>EditorButtonsWidget.__addSeparator</h4> | |
| 150 <b>__addSeparator</b>(<i></i>) | |
| 151 <p> | |
| 152 Private method to add a separator line. | |
| 153 </p><a NAME="EditorButtonsWidget.__createButtons" ID="EditorButtonsWidget.__createButtons"></a> | |
| 154 <h4>EditorButtonsWidget.__createButtons</h4> | |
| 155 <b>__createButtons</b>(<i></i>) | |
| 156 <p> | |
| 157 Private slot to create the various tool buttons. | |
| 158 </p><a NAME="EditorButtonsWidget.__editorSelectionChanged" ID="EditorButtonsWidget.__editorSelectionChanged"></a> | |
| 159 <h4>EditorButtonsWidget.__editorSelectionChanged</h4> | |
| 160 <b>__editorSelectionChanged</b>(<i></i>) | |
| 161 <p> | |
| 162 Private slot to handle a change of the editor's selection. | |
| 163 </p><a NAME="EditorButtonsWidget.__enableScrollerButtons" ID="EditorButtonsWidget.__enableScrollerButtons"></a> | |
| 164 <h4>EditorButtonsWidget.__enableScrollerButtons</h4> | |
| 165 <b>__enableScrollerButtons</b>(<i></i>) | |
| 166 <p> | |
| 167 Private method to set the enabled state of the scroll buttons. | |
| 168 </p><a NAME="EditorButtonsWidget.__formatClicked" ID="EditorButtonsWidget.__formatClicked"></a> | |
| 169 <h4>EditorButtonsWidget.__formatClicked</h4> | |
| 170 <b>__formatClicked</b>(<i>format</i>) | |
| 171 <p> | |
| 172 Private slot to handle a format button being clicked. | |
| 173 </p><dl> | |
| 174 <dt><i>format</i> (str)</dt> | |
| 175 <dd> | |
| 176 format type of the button | |
| 177 </dd> | |
| 178 </dl><a NAME="EditorButtonsWidget.__headerMenuTriggered" ID="EditorButtonsWidget.__headerMenuTriggered"></a> | |
| 179 <h4>EditorButtonsWidget.__headerMenuTriggered</h4> | |
| 180 <b>__headerMenuTriggered</b>(<i>act</i>) | |
| 181 <p> | |
| 182 Private method handling the selection of a header menu entry. | |
| 183 </p><dl> | |
| 184 <dt><i>act</i> (QAction)</dt> | |
| 185 <dd> | |
| 186 action of the headers menu that was triggered | |
| 187 </dd> | |
| 188 </dl><a NAME="EditorButtonsWidget.__slide" ID="EditorButtonsWidget.__slide"></a> | |
| 189 <h4>EditorButtonsWidget.__slide</h4> | |
| 190 <b>__slide</b>(<i>up</i>) | |
| 191 <p> | |
| 192 Private method to move the sliding widget. | |
| 193 </p><dl> | |
| 194 <dt><i>up</i></dt> | |
| 195 <dd> | |
| 196 flag indicating to move upwards (boolean) | |
| 197 </dd> | |
| 198 </dl><a NAME="EditorButtonsWidget.__slideDown" ID="EditorButtonsWidget.__slideDown"></a> | |
| 199 <h4>EditorButtonsWidget.__slideDown</h4> | |
| 200 <b>__slideDown</b>(<i></i>) | |
| 201 <p> | |
| 202 Private slot to move the widget downwards, i.e. show contents to | |
| 203 the top. | |
| 204 </p><a NAME="EditorButtonsWidget.__slideUp" ID="EditorButtonsWidget.__slideUp"></a> | |
| 205 <h4>EditorButtonsWidget.__slideUp</h4> | |
| 206 <b>__slideUp</b>(<i></i>) | |
| 207 <p> | |
| 208 Private slot to move the widget upwards, i.e. show contents to the | |
| 209 bottom. | |
| 210 </p><a NAME="EditorButtonsWidget.__updateButtonStates" ID="EditorButtonsWidget.__updateButtonStates"></a> | |
| 211 <h4>EditorButtonsWidget.__updateButtonStates</h4> | |
| 212 <b>__updateButtonStates</b>(<i></i>) | |
| 213 <p> | |
| 214 Private slot to change the button states. | |
| 215 </p><a NAME="EditorButtonsWidget.resizeEvent" ID="EditorButtonsWidget.resizeEvent"></a> | |
| 216 <h4>EditorButtonsWidget.resizeEvent</h4> | |
| 217 <b>resizeEvent</b>(<i>evt</i>) | |
| 218 <p> | |
| 219 Protected method to handle resize events. | |
| 220 </p><dl> | |
| 221 <dt><i>evt</i></dt> | |
| 222 <dd> | |
| 223 reference to the resize event (QResizeEvent) | |
| 224 </dd> | |
| 225 </dl><a NAME="EditorButtonsWidget.show" ID="EditorButtonsWidget.show"></a> | |
| 226 <h4>EditorButtonsWidget.show</h4> | |
| 227 <b>show</b>(<i></i>) | |
| 228 <p> | |
| 229 Public slot to show the widget. | |
| 230 </p> | |
| 231 <div align="right"><a href="#top">Up</a></div> | |
| 232 <hr /> | |
| 233 </body></html> |
