Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.ConfigurationPageBase.html

eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.ConfigurationPageBase.html

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

Mercurial Repository: eric

eric ide

mercurial