Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Preferences.ConfigurationPages.ConfigurationPageBase.html
Documentation/Source/eric4.Preferences.ConfigurationPages.ConfigurationPageBase.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.Preferences.ConfigurationPages.ConfigurationPageBase</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Preferences.ConfigurationPages.ConfigurationPageBase</h1> | |
| 24 <p> | |
| 25 Module implementing the base class for all configuration pages. | |
| 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="#ConfigurationPageBase">ConfigurationPageBase</a></td> | |
| 35 <td>Class implementing the base class for all configuration pages.</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="ConfigurationPageBase" ID="ConfigurationPageBase"></a> | |
| 44 <h2>ConfigurationPageBase</h2> | |
| 45 <p> | |
| 46 Class implementing the base class for all configuration pages. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QWidget | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#ConfigurationPageBase.initColour">initColour</a></td> | |
| 61 <td>Public method to initialize a colour selection button.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ConfigurationPageBase.polishPage">polishPage</a></td> | |
| 64 <td>Public slot to perform some polishing actions.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ConfigurationPageBase.saveState">saveState</a></td> | |
| 67 <td>Public method to save the current state of the widget.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ConfigurationPageBase.selectColour">selectColour</a></td> | |
| 70 <td>Public method used by the colour selection buttons.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ConfigurationPageBase.selectFont">selectFont</a></td> | |
| 73 <td>Public method used by the font selection buttons.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ConfigurationPageBase.setState">setState</a></td> | |
| 76 <td>Public method to set the state of the widget.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <a NAME="ConfigurationPageBase.__init__" ID="ConfigurationPageBase.__init__"></a> | |
| 80 <h4>ConfigurationPageBase (Constructor)</h4> | |
| 81 <b>ConfigurationPageBase</b>(<i></i>) | |
| 82 <p> | |
| 83 Constructor | |
| 84 </p><a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a> | |
| 85 <h4>ConfigurationPageBase.initColour</h4> | |
| 86 <b>initColour</b>(<i>colourstr, button, prefMethod</i>) | |
| 87 <p> | |
| 88 Public method to initialize a colour selection button. | |
| 89 </p><dl> | |
| 90 <dt><i>colourstr</i></dt> | |
| 91 <dd> | |
| 92 colour to be set (string) | |
| 93 </dd><dt><i>button</i></dt> | |
| 94 <dd> | |
| 95 reference to a button to show the colour on (QPushButton) | |
| 96 </dd><dt><i>prefMethod</i></dt> | |
| 97 <dd> | |
| 98 preferences method to get the colour | |
| 99 </dd> | |
| 100 </dl><dl> | |
| 101 <dt>Returns:</dt> | |
| 102 <dd> | |
| 103 reference to the created colour (QColor) | |
| 104 </dd> | |
| 105 </dl><a NAME="ConfigurationPageBase.polishPage" ID="ConfigurationPageBase.polishPage"></a> | |
| 106 <h4>ConfigurationPageBase.polishPage</h4> | |
| 107 <b>polishPage</b>(<i></i>) | |
| 108 <p> | |
| 109 Public slot to perform some polishing actions. | |
| 110 </p><a NAME="ConfigurationPageBase.saveState" ID="ConfigurationPageBase.saveState"></a> | |
| 111 <h4>ConfigurationPageBase.saveState</h4> | |
| 112 <b>saveState</b>(<i></i>) | |
| 113 <p> | |
| 114 Public method to save the current state of the widget. | |
| 115 </p><a NAME="ConfigurationPageBase.selectColour" ID="ConfigurationPageBase.selectColour"></a> | |
| 116 <h4>ConfigurationPageBase.selectColour</h4> | |
| 117 <b>selectColour</b>(<i>button, colourVar</i>) | |
| 118 <p> | |
| 119 Public method used by the colour selection buttons. | |
| 120 </p><dl> | |
| 121 <dt><i>button</i></dt> | |
| 122 <dd> | |
| 123 reference to a button to show the colour on (QPushButton) | |
| 124 </dd><dt><i>colourVar</i></dt> | |
| 125 <dd> | |
| 126 reference to the variable containing the colour (QColor) | |
| 127 </dd> | |
| 128 </dl><dl> | |
| 129 <dt>Returns:</dt> | |
| 130 <dd> | |
| 131 selected colour (QColor) | |
| 132 </dd> | |
| 133 </dl><a NAME="ConfigurationPageBase.selectFont" ID="ConfigurationPageBase.selectFont"></a> | |
| 134 <h4>ConfigurationPageBase.selectFont</h4> | |
| 135 <b>selectFont</b>(<i>fontSample, fontVar, showFontInfo = False</i>) | |
| 136 <p> | |
| 137 Public method used by the font selection buttons. | |
| 138 </p><dl> | |
| 139 <dt><i>fontSample</i></dt> | |
| 140 <dd> | |
| 141 reference to the font sample widget (QLineEdit) | |
| 142 </dd><dt><i>fontVar</i></dt> | |
| 143 <dd> | |
| 144 reference to the variable containing the font (QFont) | |
| 145 </dd><dt><i>showFontInfo</i></dt> | |
| 146 <dd> | |
| 147 flag indicating to show some font info | |
| 148 as the sample (boolean) | |
| 149 </dd> | |
| 150 </dl><dl> | |
| 151 <dt>Returns:</dt> | |
| 152 <dd> | |
| 153 selected font (QFont) | |
| 154 </dd> | |
| 155 </dl><a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a> | |
| 156 <h4>ConfigurationPageBase.setState</h4> | |
| 157 <b>setState</b>(<i>state</i>) | |
| 158 <p> | |
| 159 Public method to set the state of the widget. | |
| 160 </p><dl> | |
| 161 <dt><i>state</i></dt> | |
| 162 <dd> | |
| 163 state data generated by saveState | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <div align="right"><a href="#top">Up</a></div> | |
| 167 <hr /> | |
| 168 </body></html> |
