src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ConfigurationPageBase.html

branch
eric7
changeset 10479
856476537696
parent 10428
a071d4065202
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Preferences.ConfigurationPages.ConfigurationPageBase</h1> 9 <h1>eric7.Preferences.ConfigurationPages.ConfigurationPageBase</h1>
10
11 <p> 10 <p>
12 Module implementing the base class for all configuration pages. 11 Module implementing the base class for all configuration pages.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ConfigurationPageBase">ConfigurationPageBase</a></td> 22 <td><a href="#ConfigurationPageBase">ConfigurationPageBase</a></td>
25 <td>Class implementing the base class for all configuration pages.</td> 23 <td>Class implementing the base class for all configuration pages.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="ConfigurationPageBase" ID="ConfigurationPageBase"></a> 34 <a NAME="ConfigurationPageBase" ID="ConfigurationPageBase"></a>
36 <h2>ConfigurationPageBase</h2> 35 <h2>ConfigurationPageBase</h2>
37
38 <p> 36 <p>
39 Class implementing the base class for all configuration pages. 37 Class implementing the base class for all configuration pages.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>colourChanged(str, QColor)</dt> 43 <dt>colourChanged(str, QColor)</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 QWidget 49 QWidget
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52 51 <table>
53 <table> 52 <tr><td>None</td></tr>
54 <tr><td>None</td></tr> 53 </table>
55 </table> 54
56 <h3>Class Methods</h3> 55 <h3>Class Methods</h3>
57 56 <table>
58 <table> 57 <tr><td>None</td></tr>
59 <tr><td>None</td></tr> 58 </table>
60 </table> 59
61 <h3>Methods</h3> 60 <h3>Methods</h3>
62 61 <table>
63 <table>
64
65 <tr> 62 <tr>
66 <td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td> 63 <td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td>
67 <td>Constructor</td> 64 <td>Constructor</td>
68 </tr> 65 </tr>
69 <tr> 66 <tr>
93 <tr> 90 <tr>
94 <td><a href="#ConfigurationPageBase.setState">setState</a></td> 91 <td><a href="#ConfigurationPageBase.setState">setState</a></td>
95 <td>Public method to set the state of the widget.</td> 92 <td>Public method to set the state of the widget.</td>
96 </tr> 93 </tr>
97 </table> 94 </table>
95
98 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
99 97 <table>
100 <table> 98 <tr><td>None</td></tr>
101 <tr><td>None</td></tr> 99 </table>
102 </table> 100
103 101
104 <a NAME="ConfigurationPageBase.__init__" ID="ConfigurationPageBase.__init__"></a> 102 <a NAME="ConfigurationPageBase.__init__" ID="ConfigurationPageBase.__init__"></a>
105 <h4>ConfigurationPageBase (Constructor)</h4> 103 <h4>ConfigurationPageBase (Constructor)</h4>
106 <b>ConfigurationPageBase</b>(<i></i>) 104 <b>ConfigurationPageBase</b>(<i></i>)
107
108 <p> 105 <p>
109 Constructor 106 Constructor
110 </p> 107 </p>
108
111 <a NAME="ConfigurationPageBase.__selectColourSlot" ID="ConfigurationPageBase.__selectColourSlot"></a> 109 <a NAME="ConfigurationPageBase.__selectColourSlot" ID="ConfigurationPageBase.__selectColourSlot"></a>
112 <h4>ConfigurationPageBase.__selectColourSlot</h4> 110 <h4>ConfigurationPageBase.__selectColourSlot</h4>
113 <b>__selectColourSlot</b>(<i>button</i>) 111 <b>__selectColourSlot</b>(<i>button</i>)
114
115 <p> 112 <p>
116 Private slot to select a color. 113 Private slot to select a color.
117 </p> 114 </p>
115
118 <dl> 116 <dl>
119 117
120 <dt><i>button</i> (QPushButton)</dt> 118 <dt><i>button</i> (QPushButton)</dt>
121 <dd> 119 <dd>
122 reference to the button been pressed 120 reference to the button been pressed
123 </dd> 121 </dd>
124 </dl> 122 </dl>
125 <a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a> 123 <a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a>
126 <h4>ConfigurationPageBase.initColour</h4> 124 <h4>ConfigurationPageBase.initColour</h4>
127 <b>initColour</b>(<i>colourKey, button, prefMethod, byName=False, hasAlpha=False</i>) 125 <b>initColour</b>(<i>colourKey, button, prefMethod, byName=False, hasAlpha=False</i>)
128
129 <p> 126 <p>
130 Public method to initialize a colour selection button. 127 Public method to initialize a colour selection button.
131 </p> 128 </p>
129
132 <dl> 130 <dl>
133 131
134 <dt><i>colourKey</i> (string)</dt> 132 <dt><i>colourKey</i> (string)</dt>
135 <dd> 133 <dd>
136 key of the colour resource 134 key of the colour resource
153 </dd> 151 </dd>
154 </dl> 152 </dl>
155 <a NAME="ConfigurationPageBase.polishPage" ID="ConfigurationPageBase.polishPage"></a> 153 <a NAME="ConfigurationPageBase.polishPage" ID="ConfigurationPageBase.polishPage"></a>
156 <h4>ConfigurationPageBase.polishPage</h4> 154 <h4>ConfigurationPageBase.polishPage</h4>
157 <b>polishPage</b>(<i></i>) 155 <b>polishPage</b>(<i></i>)
158
159 <p> 156 <p>
160 Public slot to perform some polishing actions. 157 Public slot to perform some polishing actions.
161 </p> 158 </p>
159
162 <a NAME="ConfigurationPageBase.saveColours" ID="ConfigurationPageBase.saveColours"></a> 160 <a NAME="ConfigurationPageBase.saveColours" ID="ConfigurationPageBase.saveColours"></a>
163 <h4>ConfigurationPageBase.saveColours</h4> 161 <h4>ConfigurationPageBase.saveColours</h4>
164 <b>saveColours</b>(<i>prefMethod</i>) 162 <b>saveColours</b>(<i>prefMethod</i>)
165
166 <p> 163 <p>
167 Public method to save the colour selections. 164 Public method to save the colour selections.
168 </p> 165 </p>
166
169 <dl> 167 <dl>
170 168
171 <dt><i>prefMethod</i> (function)</dt> 169 <dt><i>prefMethod</i> (function)</dt>
172 <dd> 170 <dd>
173 preferences method to set the colour 171 preferences method to set the colour
174 </dd> 172 </dd>
175 </dl> 173 </dl>
176 <a NAME="ConfigurationPageBase.saveState" ID="ConfigurationPageBase.saveState"></a> 174 <a NAME="ConfigurationPageBase.saveState" ID="ConfigurationPageBase.saveState"></a>
177 <h4>ConfigurationPageBase.saveState</h4> 175 <h4>ConfigurationPageBase.saveState</h4>
178 <b>saveState</b>(<i></i>) 176 <b>saveState</b>(<i></i>)
179
180 <p> 177 <p>
181 Public method to save the current state of the widget. 178 Public method to save the current state of the widget.
182 </p> 179 </p>
180
183 <a NAME="ConfigurationPageBase.selectFont" ID="ConfigurationPageBase.selectFont"></a> 181 <a NAME="ConfigurationPageBase.selectFont" ID="ConfigurationPageBase.selectFont"></a>
184 <h4>ConfigurationPageBase.selectFont</h4> 182 <h4>ConfigurationPageBase.selectFont</h4>
185 <b>selectFont</b>(<i>fontSample, fontVar, showFontInfo=False, options=None</i>) 183 <b>selectFont</b>(<i>fontSample, fontVar, showFontInfo=False, options=None</i>)
186
187 <p> 184 <p>
188 Public method used by the font selection buttons. 185 Public method used by the font selection buttons.
189 </p> 186 </p>
187
190 <dl> 188 <dl>
191 189
192 <dt><i>fontSample</i> (QLineEdit)</dt> 190 <dt><i>fontSample</i> (QLineEdit)</dt>
193 <dd> 191 <dd>
194 reference to the font sample widget 192 reference to the font sample widget
220 </dd> 218 </dd>
221 </dl> 219 </dl>
222 <a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a> 220 <a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a>
223 <h4>ConfigurationPageBase.setState</h4> 221 <h4>ConfigurationPageBase.setState</h4>
224 <b>setState</b>(<i>state</i>) 222 <b>setState</b>(<i>state</i>)
225
226 <p> 223 <p>
227 Public method to set the state of the widget. 224 Public method to set the state of the widget.
228 </p> 225 </p>
226
229 <dl> 227 <dl>
230 228
231 <dt><i>state</i> (list)</dt> 229 <dt><i>state</i> (list)</dt>
232 <dd> 230 <dd>
233 state data generated by saveState 231 state data generated by saveState

eric ide

mercurial