Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ConfigurationPageBase.html
src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ConfigurationPageBase.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.Preferences.ConfigurationPages.ConfigurationPageBase</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.Preferences.ConfigurationPages.ConfigurationPageBase</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the base class for all configuration pages. | |
| 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="#ConfigurationPageBase">ConfigurationPageBase</a></td> | |
| 25 <td>Class implementing the base class for all configuration pages.</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="ConfigurationPageBase" ID="ConfigurationPageBase"></a> | |
| 36 <h2>ConfigurationPageBase</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the base class for all configuration pages. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>colourChanged(str, QColor)</dt> | |
| 45 <dd> | |
| 46 To inform about a new colour selection | |
| 47 </dd> | |
| 48 </dl> | |
| 49 <h3>Derived from</h3> | |
| 50 QWidget | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#ConfigurationPageBase.__selectColourSlot">__selectColourSlot</a></td> | |
| 71 <td>Private slot to select a color.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#ConfigurationPageBase.initColour">initColour</a></td> | |
| 75 <td>Public method to initialize a colour selection button.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#ConfigurationPageBase.polishPage">polishPage</a></td> | |
| 79 <td>Public slot to perform some polishing actions.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#ConfigurationPageBase.saveColours">saveColours</a></td> | |
| 83 <td>Public method to save the colour selections.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#ConfigurationPageBase.saveState">saveState</a></td> | |
| 87 <td>Public method to save the current state of the widget.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#ConfigurationPageBase.selectFont">selectFont</a></td> | |
| 91 <td>Public method used by the font selection buttons.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#ConfigurationPageBase.setState">setState</a></td> | |
| 95 <td>Public method to set the state of the widget.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 | |
| 104 <a NAME="ConfigurationPageBase.__init__" ID="ConfigurationPageBase.__init__"></a> | |
| 105 <h4>ConfigurationPageBase (Constructor)</h4> | |
| 106 <b>ConfigurationPageBase</b>(<i></i>) | |
| 107 | |
| 108 <p> | |
| 109 Constructor | |
| 110 </p> | |
| 111 <a NAME="ConfigurationPageBase.__selectColourSlot" ID="ConfigurationPageBase.__selectColourSlot"></a> | |
| 112 <h4>ConfigurationPageBase.__selectColourSlot</h4> | |
| 113 <b>__selectColourSlot</b>(<i>button</i>) | |
| 114 | |
| 115 <p> | |
| 116 Private slot to select a color. | |
| 117 </p> | |
| 118 <dl> | |
| 119 | |
| 120 <dt><i>button</i> (QPushButton)</dt> | |
| 121 <dd> | |
| 122 reference to the button been pressed | |
| 123 </dd> | |
| 124 </dl> | |
| 125 <a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a> | |
| 126 <h4>ConfigurationPageBase.initColour</h4> | |
| 127 <b>initColour</b>(<i>colourKey, button, prefMethod, byName=False, hasAlpha=False</i>) | |
| 128 | |
| 129 <p> | |
| 130 Public method to initialize a colour selection button. | |
| 131 </p> | |
| 132 <dl> | |
| 133 | |
| 134 <dt><i>colourKey</i></dt> | |
| 135 <dd> | |
| 136 key of the colour resource (string) | |
| 137 </dd> | |
| 138 <dt><i>button</i></dt> | |
| 139 <dd> | |
| 140 reference to a button to show the colour on (QPushButton) | |
| 141 </dd> | |
| 142 <dt><i>prefMethod</i></dt> | |
| 143 <dd> | |
| 144 preferences method to get the colour | |
| 145 </dd> | |
| 146 <dt><i>byName</i></dt> | |
| 147 <dd> | |
| 148 flag indicating to retrieve/save by colour name | |
| 149 (boolean) | |
| 150 </dd> | |
| 151 <dt><i>hasAlpha</i></dt> | |
| 152 <dd> | |
| 153 flag indicating to allow alpha channel (boolean) | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <a NAME="ConfigurationPageBase.polishPage" ID="ConfigurationPageBase.polishPage"></a> | |
| 157 <h4>ConfigurationPageBase.polishPage</h4> | |
| 158 <b>polishPage</b>(<i></i>) | |
| 159 | |
| 160 <p> | |
| 161 Public slot to perform some polishing actions. | |
| 162 </p> | |
| 163 <a NAME="ConfigurationPageBase.saveColours" ID="ConfigurationPageBase.saveColours"></a> | |
| 164 <h4>ConfigurationPageBase.saveColours</h4> | |
| 165 <b>saveColours</b>(<i>prefMethod</i>) | |
| 166 | |
| 167 <p> | |
| 168 Public method to save the colour selections. | |
| 169 </p> | |
| 170 <dl> | |
| 171 | |
| 172 <dt><i>prefMethod</i></dt> | |
| 173 <dd> | |
| 174 preferences method to set the colour | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <a NAME="ConfigurationPageBase.saveState" ID="ConfigurationPageBase.saveState"></a> | |
| 178 <h4>ConfigurationPageBase.saveState</h4> | |
| 179 <b>saveState</b>(<i></i>) | |
| 180 | |
| 181 <p> | |
| 182 Public method to save the current state of the widget. | |
| 183 </p> | |
| 184 <a NAME="ConfigurationPageBase.selectFont" ID="ConfigurationPageBase.selectFont"></a> | |
| 185 <h4>ConfigurationPageBase.selectFont</h4> | |
| 186 <b>selectFont</b>(<i>fontSample, fontVar, showFontInfo=False, options=None</i>) | |
| 187 | |
| 188 <p> | |
| 189 Public method used by the font selection buttons. | |
| 190 </p> | |
| 191 <dl> | |
| 192 | |
| 193 <dt><i>fontSample</i></dt> | |
| 194 <dd> | |
| 195 reference to the font sample widget (QLineEdit) | |
| 196 </dd> | |
| 197 <dt><i>fontVar</i></dt> | |
| 198 <dd> | |
| 199 reference to the variable containing the font (QFont) | |
| 200 </dd> | |
| 201 <dt><i>showFontInfo</i></dt> | |
| 202 <dd> | |
| 203 flag indicating to show some font info | |
| 204 as the sample (boolean) | |
| 205 </dd> | |
| 206 <dt><i>options</i></dt> | |
| 207 <dd> | |
| 208 options for the font dialog | |
| 209 (QFontDialog.FontDialogOption) | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <dl> | |
| 213 <dt>Return:</dt> | |
| 214 <dd> | |
| 215 selected font (QFont) | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a> | |
| 219 <h4>ConfigurationPageBase.setState</h4> | |
| 220 <b>setState</b>(<i>state</i>) | |
| 221 | |
| 222 <p> | |
| 223 Public method to set the state of the widget. | |
| 224 </p> | |
| 225 <dl> | |
| 226 | |
| 227 <dt><i>state</i></dt> | |
| 228 <dd> | |
| 229 state data generated by saveState | |
| 230 </dd> | |
| 231 </dl> | |
| 232 <div align="right"><a href="#top">Up</a></div> | |
| 233 <hr /> | |
| 234 </body></html> |
