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

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Preferences.ConfigurationPages.ConfigurationPageBase</h1> 23 <h1>eric5.Preferences.ConfigurationPages.ConfigurationPageBase</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;&#115;. 25 Module implementing the base class for all configuration pages.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#ConfigurationPageBase">ConfigurationPageBase</a></td> 34 <td><a href="#ConfigurationPageBase">ConfigurationPageBase</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;&#115;.</td> 35 <td>Class implementing the base class for all configuration pages.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="ConfigurationPageBase" ID="ConfigurationPageBase"></a> 43 <a NAME="ConfigurationPageBase" ID="ConfigurationPageBase"></a>
44 <h2>ConfigurationPageBase</h2> 44 <h2>ConfigurationPageBase</h2>
45 <p> 45 <p>
46 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;&#115;. 46 Class implementing the base class for all configuration pages.
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 QWidget 49 QWidget
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
53 </table> 53 </table>
54 <h3>Methods</h3> 54 <h3>Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td> 57 <td><a href="#ConfigurationPageBase.__init__">ConfigurationPageBase</a></td>
58 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#ConfigurationPageBase.initColour">initColour</a></td> 60 <td><a href="#ConfigurationPageBase.initColour">initColour</a></td>
61 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#97; &#99;&#111;&#108;&#111;&#117;&#114; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;.</td> 61 <td>Public method to initialize a colour selection button.</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#ConfigurationPageBase.polishPage">polishPage</a></td> 63 <td><a href="#ConfigurationPageBase.polishPage">polishPage</a></td>
64 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#115;&#111;&#109;&#101; &#112;&#111;&#108;&#105;&#115;&#104;&#105;&#110;&#103; &#97;&#99;&#116;&#105;&#111;&#110;&#115;.</td> 64 <td>Public slot to perform some polishing actions.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#ConfigurationPageBase.saveState">saveState</a></td> 66 <td><a href="#ConfigurationPageBase.saveState">saveState</a></td>
67 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#97;v&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116;.</td> 67 <td>Public method to save the current state of the widget.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#ConfigurationPageBase.selectColour">selectColour</a></td> 69 <td><a href="#ConfigurationPageBase.selectColour">selectColour</a></td>
70 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;&#115;.</td> 70 <td>Public method used by the colour selection buttons.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#ConfigurationPageBase.selectFont">selectFont</a></td> 72 <td><a href="#ConfigurationPageBase.selectFont">selectFont</a></td>
73 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#98;y &#116;&#104;&#101; &#102;&#111;&#110;&#116; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;&#115;.</td> 73 <td>Public method used by the font selection buttons.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#ConfigurationPageBase.setState">setState</a></td> 75 <td><a href="#ConfigurationPageBase.setState">setState</a></td>
76 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116;.</td> 76 <td>Public method to set the state of the widget.</td>
77 </tr> 77 </tr>
78 </table> 78 </table>
79 <a NAME="ConfigurationPageBase.__init__" ID="ConfigurationPageBase.__init__"></a> 79 <a NAME="ConfigurationPageBase.__init__" ID="ConfigurationPageBase.__init__"></a>
80 <h4>ConfigurationPageBase (Constructor)</h4> 80 <h4>ConfigurationPageBase (Constructor)</h4>
81 <b>ConfigurationPageBase</b>(<i></i>) 81 <b>ConfigurationPageBase</b>(<i></i>)
82 <p> 82 <p>
83 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 83 Constructor
84 </p><a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a> 84 </p><a NAME="ConfigurationPageBase.initColour" ID="ConfigurationPageBase.initColour"></a>
85 <h4>ConfigurationPageBase.initColour</h4> 85 <h4>ConfigurationPageBase.initColour</h4>
86 <b>initColour</b>(<i>colourstr, button, prefMethod</i>) 86 <b>initColour</b>(<i>colourstr, button, prefMethod</i>)
87 <p> 87 <p>
88 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#97; &#99;&#111;&#108;&#111;&#117;&#114; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;. 88 Public method to initialize a colour selection button.
89 </p><dl> 89 </p><dl>
90 <dt><i>colourstr</i></dt> 90 <dt><i>colourstr</i></dt>
91 <dd> 91 <dd>
92 &#99;&#111;&#108;&#111;&#117;&#114; &#116;&#111; &#98;&#101; &#115;&#101;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;) 92 colour to be set (string)
93 </dd><dt><i>button</i></dt> 93 </dd><dt><i>button</i></dt>
94 <dd> 94 <dd>
95 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; &#111;&#110; (&#81;&#80;&#117;&#115;&#104;&#66;&#117;&#116;&#116;&#111;&#110;) 95 reference to a button to show the colour on (QPushButton)
96 </dd><dt><i>prefMethod</i></dt> 96 </dd><dt><i>prefMethod</i></dt>
97 <dd> 97 <dd>
98 &#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; 98 preferences method to get the colour
99 </dd> 99 </dd>
100 </dl><dl> 100 </dl><dl>
101 <dt>Returns:</dt> 101 <dt>Returns:</dt>
102 <dd> 102 <dd>
103 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#99;&#114;&#101;&#97;&#116;&#101;&#100; &#99;&#111;&#108;&#111;&#117;&#114; (&#81;&#67;&#111;&#108;&#111;&#114;) 103 reference to the created colour (QColor)
104 </dd> 104 </dd>
105 </dl><a NAME="ConfigurationPageBase.polishPage" ID="ConfigurationPageBase.polishPage"></a> 105 </dl><a NAME="ConfigurationPageBase.polishPage" ID="ConfigurationPageBase.polishPage"></a>
106 <h4>ConfigurationPageBase.polishPage</h4> 106 <h4>ConfigurationPageBase.polishPage</h4>
107 <b>polishPage</b>(<i></i>) 107 <b>polishPage</b>(<i></i>)
108 <p> 108 <p>
109 &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#115;&#111;&#109;&#101; &#112;&#111;&#108;&#105;&#115;&#104;&#105;&#110;&#103; &#97;&#99;&#116;&#105;&#111;&#110;&#115;. 109 Public slot to perform some polishing actions.
110 </p><a NAME="ConfigurationPageBase.saveState" ID="ConfigurationPageBase.saveState"></a> 110 </p><a NAME="ConfigurationPageBase.saveState" ID="ConfigurationPageBase.saveState"></a>
111 <h4>ConfigurationPageBase.saveState</h4> 111 <h4>ConfigurationPageBase.saveState</h4>
112 <b>saveState</b>(<i></i>) 112 <b>saveState</b>(<i></i>)
113 <p> 113 <p>
114 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#97;v&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116;. 114 Public method to save the current state of the widget.
115 </p><a NAME="ConfigurationPageBase.selectColour" ID="ConfigurationPageBase.selectColour"></a> 115 </p><a NAME="ConfigurationPageBase.selectColour" ID="ConfigurationPageBase.selectColour"></a>
116 <h4>ConfigurationPageBase.selectColour</h4> 116 <h4>ConfigurationPageBase.selectColour</h4>
117 <b>selectColour</b>(<i>button, colourVar</i>) 117 <b>selectColour</b>(<i>button, colourVar</i>)
118 <p> 118 <p>
119 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;&#115;. 119 Public method used by the colour selection buttons.
120 </p><dl> 120 </p><dl>
121 <dt><i>button</i></dt> 121 <dt><i>button</i></dt>
122 <dd> 122 <dd>
123 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; &#111;&#110; (&#81;&#80;&#117;&#115;&#104;&#66;&#117;&#116;&#116;&#111;&#110;) 123 reference to a button to show the colour on (QPushButton)
124 </dd><dt><i>colourVar</i></dt> 124 </dd><dt><i>colourVar</i></dt>
125 <dd> 125 <dd>
126 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; v&#97;&#114;&#105;&#97;&#98;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#99;&#111;&#108;&#111;&#117;&#114; (&#81;&#67;&#111;&#108;&#111;&#114;) 126 reference to the variable containing the colour (QColor)
127 </dd> 127 </dd>
128 </dl><dl> 128 </dl><dl>
129 <dt>Returns:</dt> 129 <dt>Returns:</dt>
130 <dd> 130 <dd>
131 &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#99;&#111;&#108;&#111;&#117;&#114; (&#81;&#67;&#111;&#108;&#111;&#114;) 131 selected colour (QColor)
132 </dd> 132 </dd>
133 </dl><a NAME="ConfigurationPageBase.selectFont" ID="ConfigurationPageBase.selectFont"></a> 133 </dl><a NAME="ConfigurationPageBase.selectFont" ID="ConfigurationPageBase.selectFont"></a>
134 <h4>ConfigurationPageBase.selectFont</h4> 134 <h4>ConfigurationPageBase.selectFont</h4>
135 <b>selectFont</b>(<i>fontSample, fontVar, showFontInfo = False</i>) 135 <b>selectFont</b>(<i>fontSample, fontVar, showFontInfo = False</i>)
136 <p> 136 <p>
137 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#98;y &#116;&#104;&#101; &#102;&#111;&#110;&#116; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#98;&#117;&#116;&#116;&#111;&#110;&#115;. 137 Public method used by the font selection buttons.
138 </p><dl> 138 </p><dl>
139 <dt><i>fontSample</i></dt> 139 <dt><i>fontSample</i></dt>
140 <dd> 140 <dd>
141 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#102;&#111;&#110;&#116; &#115;&#97;&#109;&#112;&#108;&#101; w&#105;&#100;&#103;&#101;&#116; (&#81;&#76;&#105;&#110;&#101;&#69;&#100;&#105;&#116;) 141 reference to the font sample widget (QLineEdit)
142 </dd><dt><i>fontVar</i></dt> 142 </dd><dt><i>fontVar</i></dt>
143 <dd> 143 <dd>
144 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; v&#97;&#114;&#105;&#97;&#98;&#108;&#101; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#102;&#111;&#110;&#116; (&#81;&#70;&#111;&#110;&#116;) 144 reference to the variable containing the font (QFont)
145 </dd><dt><i>showFontInfo</i></dt> 145 </dd><dt><i>showFontInfo</i></dt>
146 <dd> 146 <dd>
147 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#111; &#115;&#104;&#111;w &#115;&#111;&#109;&#101; &#102;&#111;&#110;&#116; &#105;&#110;&#102;&#111; 147 flag indicating to show some font info
148 &#97;&#115; &#116;&#104;&#101; &#115;&#97;&#109;&#112;&#108;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 148 as the sample (boolean)
149 </dd> 149 </dd>
150 </dl><dl> 150 </dl><dl>
151 <dt>Returns:</dt> 151 <dt>Returns:</dt>
152 <dd> 152 <dd>
153 &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#102;&#111;&#110;&#116; (&#81;&#70;&#111;&#110;&#116;) 153 selected font (QFont)
154 </dd> 154 </dd>
155 </dl><a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a> 155 </dl><a NAME="ConfigurationPageBase.setState" ID="ConfigurationPageBase.setState"></a>
156 <h4>ConfigurationPageBase.setState</h4> 156 <h4>ConfigurationPageBase.setState</h4>
157 <b>setState</b>(<i>state</i>) 157 <b>setState</b>(<i>state</i>)
158 <p> 158 <p>
159 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116;. 159 Public method to set the state of the widget.
160 </p><dl> 160 </p><dl>
161 <dt><i>state</i></dt> 161 <dt><i>state</i></dt>
162 <dd> 162 <dd>
163 &#115;&#116;&#97;&#116;&#101; &#100;&#97;&#116;&#97; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#98;y &#115;&#97;v&#101;&#83;&#116;&#97;&#116;&#101; 163 state data generated by saveState
164 </dd> 164 </dd>
165 </dl> 165 </dl>
166 <div align="right"><a href="#top">Up</a></div> 166 <div align="right"><a href="#top">Up</a></div>
167 <hr /> 167 <hr />
168 </body></html> 168 </body></html>

eric ide

mercurial