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