|
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>eric5.Preferences.ConfigurationPages.ConfigurationPageBase</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Preferences.ConfigurationPages.ConfigurationPageBase</h1> |
|
12 <p> |
|
13 Module implementing the base class for all configuration pages. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#ConfigurationPageBase">ConfigurationPageBase</a></td> |
|
23 <td>Class implementing the base class for all configuration pages.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="ConfigurationPageBase" ID="ConfigurationPageBase"></a> |
|
32 <h2>ConfigurationPageBase</h2> |
|
33 <p> |
|
34 Class implementing the base class for all configuration pages. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QWidget |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#ConfigurationPageBase.initColour">initColour</a></td> |
|
49 <td>Public method to initialize a colour selection button.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#ConfigurationPageBase.polishPage">polishPage</a></td> |
|
52 <td>Public slot to perform some polishing actions.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#ConfigurationPageBase.saveState">saveState</a></td> |
|
55 <td>Public method to save the current state of the widget.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#ConfigurationPageBase.selectColour">selectColour</a></td> |
|
58 <td>Public method used by the colour selection buttons.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#ConfigurationPageBase.selectFont">selectFont</a></td> |
|
61 <td>Public method used by the font selection buttons.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#ConfigurationPageBase.setState">setState</a></td> |
|
64 <td>Public method to set the state of the widget.</td> |
|
65 </tr> |
|
66 </table> |
|
67 <a NAME="ConfigurationPageBase.__init__" ID="ConfigurationPageBase.__init__"></a> |
|
68 <h4>ConfigurationPageBase (Constructor)</h4> |
|
69 <b>ConfigurationPageBase</b>(<i></i>) |
|
70 <p> |
|
71 Constructor |
|
72 </p><a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a> |
|
73 <h4>ConfigurationPageBase.initColour</h4> |
|
74 <b>initColour</b>(<i>colourstr, button, prefMethod</i>) |
|
75 <p> |
|
76 Public method to initialize a colour selection button. |
|
77 </p><dl> |
|
78 <dt><i>colourstr</i></dt> |
|
79 <dd> |
|
80 colour to be set (string) |
|
81 </dd><dt><i>button</i></dt> |
|
82 <dd> |
|
83 reference to a button to show the colour on (QPushButton) |
|
84 </dd><dt><i>prefMethod</i></dt> |
|
85 <dd> |
|
86 preferences method to get the colour |
|
87 </dd> |
|
88 </dl><dl> |
|
89 <dt>Returns:</dt> |
|
90 <dd> |
|
91 reference to the created colour (QColor) |
|
92 </dd> |
|
93 </dl><a NAME="ConfigurationPageBase.polishPage" ID="ConfigurationPageBase.polishPage"></a> |
|
94 <h4>ConfigurationPageBase.polishPage</h4> |
|
95 <b>polishPage</b>(<i></i>) |
|
96 <p> |
|
97 Public slot to perform some polishing actions. |
|
98 </p><a NAME="ConfigurationPageBase.saveState" ID="ConfigurationPageBase.saveState"></a> |
|
99 <h4>ConfigurationPageBase.saveState</h4> |
|
100 <b>saveState</b>(<i></i>) |
|
101 <p> |
|
102 Public method to save the current state of the widget. |
|
103 </p><a NAME="ConfigurationPageBase.selectColour" ID="ConfigurationPageBase.selectColour"></a> |
|
104 <h4>ConfigurationPageBase.selectColour</h4> |
|
105 <b>selectColour</b>(<i>button, colourVar</i>) |
|
106 <p> |
|
107 Public method used by the colour selection buttons. |
|
108 </p><dl> |
|
109 <dt><i>button</i></dt> |
|
110 <dd> |
|
111 reference to a button to show the colour on (QPushButton) |
|
112 </dd><dt><i>colourVar</i></dt> |
|
113 <dd> |
|
114 reference to the variable containing the colour (QColor) |
|
115 </dd> |
|
116 </dl><dl> |
|
117 <dt>Returns:</dt> |
|
118 <dd> |
|
119 selected colour (QColor) |
|
120 </dd> |
|
121 </dl><a NAME="ConfigurationPageBase.selectFont" ID="ConfigurationPageBase.selectFont"></a> |
|
122 <h4>ConfigurationPageBase.selectFont</h4> |
|
123 <b>selectFont</b>(<i>fontSample, fontVar, showFontInfo = False</i>) |
|
124 <p> |
|
125 Public method used by the font selection buttons. |
|
126 </p><dl> |
|
127 <dt><i>fontSample</i></dt> |
|
128 <dd> |
|
129 reference to the font sample widget (QLineEdit) |
|
130 </dd><dt><i>fontVar</i></dt> |
|
131 <dd> |
|
132 reference to the variable containing the font (QFont) |
|
133 </dd><dt><i>showFontInfo</i></dt> |
|
134 <dd> |
|
135 flag indicating to show some font info |
|
136 as the sample (boolean) |
|
137 </dd> |
|
138 </dl><dl> |
|
139 <dt>Returns:</dt> |
|
140 <dd> |
|
141 selected font (QFont) |
|
142 </dd> |
|
143 </dl><a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a> |
|
144 <h4>ConfigurationPageBase.setState</h4> |
|
145 <b>setState</b>(<i>state</i>) |
|
146 <p> |
|
147 Public method to set the state of the widget. |
|
148 </p><dl> |
|
149 <dt><i>state</i></dt> |
|
150 <dd> |
|
151 state data generated by saveState |
|
152 </dd> |
|
153 </dl> |
|
154 <div align="right"><a href="#top">Up</a></div> |
|
155 <hr /> |
|
156 </body></html> |