eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.DiffColoursPage.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.DiffColoursPage</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Preferences.ConfigurationPages.DiffColoursPage</h1>
24
25 <p>
26 Module implementing the Diff colours configuration page.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#DiffColoursPage">DiffColoursPage</a></td>
39 <td>Class implementing the Diff colours configuration page.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45
46 <tr>
47 <td><a href="#create">create</a></td>
48 <td>Module function to create the configuration page.</td>
49 </tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="DiffColoursPage" ID="DiffColoursPage"></a>
54 <h2>DiffColoursPage</h2>
55
56 <p>
57 Class implementing the Diff colours configuration page.
58 </p>
59 <h3>Derived from</h3>
60 ConfigurationPageBase, Ui_DiffColoursPage
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#DiffColoursPage.__init__">DiffColoursPage</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#DiffColoursPage.__initColour">__initColour</a></td>
81 <td>Private method to initialize a colour selection button.</td>
82 </tr>
83 <tr>
84 <td><a href="#DiffColoursPage.__selectBackgroundColour">__selectBackgroundColour</a></td>
85 <td>Private slot to select a background colour.</td>
86 </tr>
87 <tr>
88 <td><a href="#DiffColoursPage.__selectTextColour">__selectTextColour</a></td>
89 <td>Private slot to select the text colour.</td>
90 </tr>
91 <tr>
92 <td><a href="#DiffColoursPage.__updateSampleBackgroundColour">__updateSampleBackgroundColour</a></td>
93 <td>Private slot to update the background colour of a sample.</td>
94 </tr>
95 <tr>
96 <td><a href="#DiffColoursPage.__updateSampleTextColour">__updateSampleTextColour</a></td>
97 <td>Private slot to update the text colour of all samples.</td>
98 </tr>
99 <tr>
100 <td><a href="#DiffColoursPage.save">save</a></td>
101 <td>Public slot to save the Diff colours configuration.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105
106 <table>
107 <tr><td>None</td></tr>
108 </table>
109
110 <a NAME="DiffColoursPage.__init__" ID="DiffColoursPage.__init__"></a>
111 <h4>DiffColoursPage (Constructor)</h4>
112 <b>DiffColoursPage</b>(<i></i>)
113
114 <p>
115 Constructor
116 </p>
117 <a NAME="DiffColoursPage.__initColour" ID="DiffColoursPage.__initColour"></a>
118 <h4>DiffColoursPage.__initColour</h4>
119 <b>__initColour</b>(<i>colourKey, button, initSlot, selectSlot, sampleWidget</i>)
120
121 <p>
122 Private method to initialize a colour selection button.
123 </p>
124 <dl>
125
126 <dt><i>colourKey</i> (str)</dt>
127 <dd>
128 key of the diff colour
129 </dd>
130 <dt><i>button</i> (QPushButton)</dt>
131 <dd>
132 reference to the button
133 </dd>
134 <dt><i>initSlot</i> (func)</dt>
135 <dd>
136 slot to be called to initialize the sample
137 </dd>
138 <dt><i>selectSlot</i> (func)</dt>
139 <dd>
140 slot to be called to select the colour
141 </dd>
142 <dt><i>sampleWidget</i> (QLineEdit)</dt>
143 <dd>
144 reference to the sample widget
145 </dd>
146 </dl>
147 <a NAME="DiffColoursPage.__selectBackgroundColour" ID="DiffColoursPage.__selectBackgroundColour"></a>
148 <h4>DiffColoursPage.__selectBackgroundColour</h4>
149 <b>__selectBackgroundColour</b>(<i>button</i>)
150
151 <p>
152 Private slot to select a background colour.
153 </p>
154 <dl>
155
156 <dt><i>button</i> (QPushButton)</dt>
157 <dd>
158 reference to the button been pressed
159 </dd>
160 </dl>
161 <a NAME="DiffColoursPage.__selectTextColour" ID="DiffColoursPage.__selectTextColour"></a>
162 <h4>DiffColoursPage.__selectTextColour</h4>
163 <b>__selectTextColour</b>(<i>button</i>)
164
165 <p>
166 Private slot to select the text colour.
167 </p>
168 <dl>
169
170 <dt><i>button</i> (QPushButton)</dt>
171 <dd>
172 reference to the button been pressed
173 </dd>
174 </dl>
175 <a NAME="DiffColoursPage.__updateSampleBackgroundColour" ID="DiffColoursPage.__updateSampleBackgroundColour"></a>
176 <h4>DiffColoursPage.__updateSampleBackgroundColour</h4>
177 <b>__updateSampleBackgroundColour</b>(<i>colourKey</i>)
178
179 <p>
180 Private slot to update the background colour of a sample.
181 </p>
182 <dl>
183
184 <dt><i>colourKey</i> (str)</dt>
185 <dd>
186 key of the diff colour
187 </dd>
188 </dl>
189 <a NAME="DiffColoursPage.__updateSampleTextColour" ID="DiffColoursPage.__updateSampleTextColour"></a>
190 <h4>DiffColoursPage.__updateSampleTextColour</h4>
191 <b>__updateSampleTextColour</b>(<i>colourKey</i>)
192
193 <p>
194 Private slot to update the text colour of all samples.
195 </p>
196 <dl>
197
198 <dt><i>colourKey</i> (str)</dt>
199 <dd>
200 key of the diff colour
201 </dd>
202 </dl>
203 <a NAME="DiffColoursPage.save" ID="DiffColoursPage.save"></a>
204 <h4>DiffColoursPage.save</h4>
205 <b>save</b>(<i></i>)
206
207 <p>
208 Public slot to save the Diff colours configuration.
209 </p>
210 <div align="right"><a href="#top">Up</a></div>
211 <hr />
212 <hr />
213 <a NAME="create" ID="create"></a>
214 <h2>create</h2>
215 <b>create</b>(<i>dlg</i>)
216
217 <p>
218 Module function to create the configuration page.
219 </p>
220 <dl>
221
222 <dt><i>dlg</i></dt>
223 <dd>
224 reference to the configuration dialog
225 </dd>
226 </dl>
227 <dl>
228 <dt>Return:</dt>
229 <dd>
230 reference to the instantiated page (ConfigurationPageBase)
231 </dd>
232 </dl>
233 <div align="right"><a href="#top">Up</a></div>
234 <hr />
235 </body></html>

eric ide

mercurial