Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.ConfigurationPageBase.html
eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.ConfigurationPageBase.html
- changeset 6942
- 2602857055c5
- parent 6123
- 39cd368143db
- child 7015
- b1a3094b33e1
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Preferences.ConfigurationPages.ConfigurationPageBase</h1> | |
| 23 <p> | |
| 24 Module implementing the base class for all configuration pages. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#ConfigurationPageBase">ConfigurationPageBase</a></td> | |
| 34 <td>Class implementing the base class for all configuration pages.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="ConfigurationPageBase" ID="ConfigurationPageBase"></a> | |
| 43 <h2>ConfigurationPageBase</h2> | |
| 44 <p> | |
| 45 Class implementing the base class for all configuration pages. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QWidget | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ConfigurationPageBase.__selectColourSlot">__selectColourSlot</a></td> | |
| 64 <td>Private slot to select a color.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ConfigurationPageBase.initColour">initColour</a></td> | |
| 67 <td>Public method to initialize a colour selection button.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ConfigurationPageBase.polishPage">polishPage</a></td> | |
| 70 <td>Public slot to perform some polishing actions.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ConfigurationPageBase.saveColours">saveColours</a></td> | |
| 73 <td>Public method to save the colour selections.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ConfigurationPageBase.saveState">saveState</a></td> | |
| 76 <td>Public method to save the current state of the widget.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ConfigurationPageBase.selectFont">selectFont</a></td> | |
| 79 <td>Public method used by the font selection buttons.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#ConfigurationPageBase.setState">setState</a></td> | |
| 82 <td>Public method to set the state of the widget.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <h3>Static Methods</h3> | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <a NAME="ConfigurationPageBase.__init__" ID="ConfigurationPageBase.__init__"></a> | |
| 90 <h4>ConfigurationPageBase (Constructor)</h4> | |
| 91 <b>ConfigurationPageBase</b>(<i></i>) | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p><a NAME="ConfigurationPageBase.__selectColourSlot" ID="ConfigurationPageBase.__selectColourSlot"></a> | |
| 95 <h4>ConfigurationPageBase.__selectColourSlot</h4> | |
| 96 <b>__selectColourSlot</b>(<i>button</i>) | |
| 97 <p> | |
| 98 Private slot to select a color. | |
| 99 </p><dl> | |
| 100 <dt><i>button</i> (QPushButton)</dt> | |
| 101 <dd> | |
| 102 reference to the button been pressed | |
| 103 </dd> | |
| 104 </dl><a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a> | |
| 105 <h4>ConfigurationPageBase.initColour</h4> | |
| 106 <b>initColour</b>(<i>colourKey, button, prefMethod, byName=False, hasAlpha=False</i>) | |
| 107 <p> | |
| 108 Public method to initialize a colour selection button. | |
| 109 </p><dl> | |
| 110 <dt><i>colourKey</i></dt> | |
| 111 <dd> | |
| 112 key of the colour resource (string) | |
| 113 </dd><dt><i>button</i></dt> | |
| 114 <dd> | |
| 115 reference to a button to show the colour on (QPushButton) | |
| 116 </dd><dt><i>prefMethod</i></dt> | |
| 117 <dd> | |
| 118 preferences method to get the colour | |
| 119 </dd><dt><i>byName=</i></dt> | |
| 120 <dd> | |
| 121 flag indicating to retrieve/save by colour name | |
| 122 (boolean) | |
| 123 </dd><dt><i>hasAlpha=</i></dt> | |
| 124 <dd> | |
| 125 flag indicating to allow alpha channel (boolean) | |
| 126 </dd> | |
| 127 </dl><a NAME="ConfigurationPageBase.polishPage" ID="ConfigurationPageBase.polishPage"></a> | |
| 128 <h4>ConfigurationPageBase.polishPage</h4> | |
| 129 <b>polishPage</b>(<i></i>) | |
| 130 <p> | |
| 131 Public slot to perform some polishing actions. | |
| 132 </p><a NAME="ConfigurationPageBase.saveColours" ID="ConfigurationPageBase.saveColours"></a> | |
| 133 <h4>ConfigurationPageBase.saveColours</h4> | |
| 134 <b>saveColours</b>(<i>prefMethod</i>) | |
| 135 <p> | |
| 136 Public method to save the colour selections. | |
| 137 </p><dl> | |
| 138 <dt><i>prefMethod</i></dt> | |
| 139 <dd> | |
| 140 preferences method to set the colour | |
| 141 </dd> | |
| 142 </dl><a NAME="ConfigurationPageBase.saveState" ID="ConfigurationPageBase.saveState"></a> | |
| 143 <h4>ConfigurationPageBase.saveState</h4> | |
| 144 <b>saveState</b>(<i></i>) | |
| 145 <p> | |
| 146 Public method to save the current state of the widget. | |
| 147 </p><a NAME="ConfigurationPageBase.selectFont" ID="ConfigurationPageBase.selectFont"></a> | |
| 148 <h4>ConfigurationPageBase.selectFont</h4> | |
| 149 <b>selectFont</b>(<i>fontSample, fontVar, showFontInfo=False, options=None</i>) | |
| 150 <p> | |
| 151 Public method used by the font selection buttons. | |
| 152 </p><dl> | |
| 153 <dt><i>fontSample</i></dt> | |
| 154 <dd> | |
| 155 reference to the font sample widget (QLineEdit) | |
| 156 </dd><dt><i>fontVar</i></dt> | |
| 157 <dd> | |
| 158 reference to the variable containing the font (QFont) | |
| 159 </dd><dt><i>showFontInfo</i></dt> | |
| 160 <dd> | |
| 161 flag indicating to show some font info | |
| 162 as the sample (boolean) | |
| 163 </dd><dt><i>options</i></dt> | |
| 164 <dd> | |
| 165 options for the font dialog | |
| 166 (QFontDialog.FontDialogOptions) | |
| 167 </dd> | |
| 168 </dl><dl> | |
| 169 <dt>Returns:</dt> | |
| 170 <dd> | |
| 171 selected font (QFont) | |
| 172 </dd> | |
| 173 </dl><a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a> | |
| 174 <h4>ConfigurationPageBase.setState</h4> | |
| 175 <b>setState</b>(<i>state</i>) | |
| 176 <p> | |
| 177 Public method to set the state of the widget. | |
| 178 </p><dl> | |
| 179 <dt><i>state</i></dt> | |
| 180 <dd> | |
| 181 state data generated by saveState | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <div align="right"><a href="#top">Up</a></div> | |
| 185 <hr /> | |
| 186 </body></html> |
