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

branch
eric7
changeset 10479
856476537696
parent 10428
a071d4065202
child 10684
58c7f23ae1cb
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.DiffColoursPage</h1> 9 <h1>eric7.Preferences.ConfigurationPages.DiffColoursPage</h1>
10
11 <p> 10 <p>
12 Module implementing the Diff colours configuration page. 11 Module implementing the Diff colours configuration page.
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="#DiffColoursPage">DiffColoursPage</a></td> 22 <td><a href="#DiffColoursPage">DiffColoursPage</a></td>
25 <td>Class implementing the Diff colours configuration page.</td> 23 <td>Class implementing the Diff colours configuration page.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#create">create</a></td> 30 <td><a href="#create">create</a></td>
34 <td>Module function to create the configuration page.</td> 31 <td>Module function to create the configuration page.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="DiffColoursPage" ID="DiffColoursPage"></a> 37 <a NAME="DiffColoursPage" ID="DiffColoursPage"></a>
40 <h2>DiffColoursPage</h2> 38 <h2>DiffColoursPage</h2>
41
42 <p> 39 <p>
43 Class implementing the Diff colours configuration page. 40 Class implementing the Diff colours configuration page.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_DiffColoursPage 44 ConfigurationPageBase, Ui_DiffColoursPage
47 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
48 46 <table>
49 <table> 47 <tr><td>None</td></tr>
50 <tr><td>None</td></tr> 48 </table>
51 </table> 49
52 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
53 51 <table>
54 <table> 52 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 53 </table>
56 </table> 54
57 <h3>Methods</h3> 55 <h3>Methods</h3>
58 56 <table>
59 <table>
60
61 <tr> 57 <tr>
62 <td><a href="#DiffColoursPage.__init__">DiffColoursPage</a></td> 58 <td><a href="#DiffColoursPage.__init__">DiffColoursPage</a></td>
63 <td>Constructor</td> 59 <td>Constructor</td>
64 </tr> 60 </tr>
65 <tr> 61 <tr>
85 <tr> 81 <tr>
86 <td><a href="#DiffColoursPage.save">save</a></td> 82 <td><a href="#DiffColoursPage.save">save</a></td>
87 <td>Public slot to save the Diff colours configuration.</td> 83 <td>Public slot to save the Diff colours configuration.</td>
88 </tr> 84 </tr>
89 </table> 85 </table>
86
90 <h3>Static Methods</h3> 87 <h3>Static Methods</h3>
91 88 <table>
92 <table> 89 <tr><td>None</td></tr>
93 <tr><td>None</td></tr> 90 </table>
94 </table> 91
95 92
96 <a NAME="DiffColoursPage.__init__" ID="DiffColoursPage.__init__"></a> 93 <a NAME="DiffColoursPage.__init__" ID="DiffColoursPage.__init__"></a>
97 <h4>DiffColoursPage (Constructor)</h4> 94 <h4>DiffColoursPage (Constructor)</h4>
98 <b>DiffColoursPage</b>(<i></i>) 95 <b>DiffColoursPage</b>(<i></i>)
99
100 <p> 96 <p>
101 Constructor 97 Constructor
102 </p> 98 </p>
99
103 <a NAME="DiffColoursPage.__initColour" ID="DiffColoursPage.__initColour"></a> 100 <a NAME="DiffColoursPage.__initColour" ID="DiffColoursPage.__initColour"></a>
104 <h4>DiffColoursPage.__initColour</h4> 101 <h4>DiffColoursPage.__initColour</h4>
105 <b>__initColour</b>(<i>colourKey, button, initSlot, selectSlot, sampleWidget</i>) 102 <b>__initColour</b>(<i>colourKey, button, initSlot, selectSlot, sampleWidget</i>)
106
107 <p> 103 <p>
108 Private method to initialize a colour selection button. 104 Private method to initialize a colour selection button.
109 </p> 105 </p>
106
110 <dl> 107 <dl>
111 108
112 <dt><i>colourKey</i> (str)</dt> 109 <dt><i>colourKey</i> (str)</dt>
113 <dd> 110 <dd>
114 key of the diff colour 111 key of the diff colour
131 </dd> 128 </dd>
132 </dl> 129 </dl>
133 <a NAME="DiffColoursPage.__selectBackgroundColour" ID="DiffColoursPage.__selectBackgroundColour"></a> 130 <a NAME="DiffColoursPage.__selectBackgroundColour" ID="DiffColoursPage.__selectBackgroundColour"></a>
134 <h4>DiffColoursPage.__selectBackgroundColour</h4> 131 <h4>DiffColoursPage.__selectBackgroundColour</h4>
135 <b>__selectBackgroundColour</b>(<i>button</i>) 132 <b>__selectBackgroundColour</b>(<i>button</i>)
136
137 <p> 133 <p>
138 Private slot to select a background colour. 134 Private slot to select a background colour.
139 </p> 135 </p>
136
140 <dl> 137 <dl>
141 138
142 <dt><i>button</i> (QPushButton)</dt> 139 <dt><i>button</i> (QPushButton)</dt>
143 <dd> 140 <dd>
144 reference to the button been pressed 141 reference to the button been pressed
145 </dd> 142 </dd>
146 </dl> 143 </dl>
147 <a NAME="DiffColoursPage.__selectTextColour" ID="DiffColoursPage.__selectTextColour"></a> 144 <a NAME="DiffColoursPage.__selectTextColour" ID="DiffColoursPage.__selectTextColour"></a>
148 <h4>DiffColoursPage.__selectTextColour</h4> 145 <h4>DiffColoursPage.__selectTextColour</h4>
149 <b>__selectTextColour</b>(<i>button</i>) 146 <b>__selectTextColour</b>(<i>button</i>)
150
151 <p> 147 <p>
152 Private slot to select the text colour. 148 Private slot to select the text colour.
153 </p> 149 </p>
150
154 <dl> 151 <dl>
155 152
156 <dt><i>button</i> (QPushButton)</dt> 153 <dt><i>button</i> (QPushButton)</dt>
157 <dd> 154 <dd>
158 reference to the button been pressed 155 reference to the button been pressed
159 </dd> 156 </dd>
160 </dl> 157 </dl>
161 <a NAME="DiffColoursPage.__updateSampleBackgroundColour" ID="DiffColoursPage.__updateSampleBackgroundColour"></a> 158 <a NAME="DiffColoursPage.__updateSampleBackgroundColour" ID="DiffColoursPage.__updateSampleBackgroundColour"></a>
162 <h4>DiffColoursPage.__updateSampleBackgroundColour</h4> 159 <h4>DiffColoursPage.__updateSampleBackgroundColour</h4>
163 <b>__updateSampleBackgroundColour</b>(<i>colourKey</i>) 160 <b>__updateSampleBackgroundColour</b>(<i>colourKey</i>)
164
165 <p> 161 <p>
166 Private slot to update the background colour of a sample. 162 Private slot to update the background colour of a sample.
167 </p> 163 </p>
164
168 <dl> 165 <dl>
169 166
170 <dt><i>colourKey</i> (str)</dt> 167 <dt><i>colourKey</i> (str)</dt>
171 <dd> 168 <dd>
172 key of the diff colour 169 key of the diff colour
173 </dd> 170 </dd>
174 </dl> 171 </dl>
175 <a NAME="DiffColoursPage.__updateSampleTextColour" ID="DiffColoursPage.__updateSampleTextColour"></a> 172 <a NAME="DiffColoursPage.__updateSampleTextColour" ID="DiffColoursPage.__updateSampleTextColour"></a>
176 <h4>DiffColoursPage.__updateSampleTextColour</h4> 173 <h4>DiffColoursPage.__updateSampleTextColour</h4>
177 <b>__updateSampleTextColour</b>(<i>colourKey</i>) 174 <b>__updateSampleTextColour</b>(<i>colourKey</i>)
178
179 <p> 175 <p>
180 Private slot to update the text colour of all samples. 176 Private slot to update the text colour of all samples.
181 </p> 177 </p>
178
182 <dl> 179 <dl>
183 180
184 <dt><i>colourKey</i> (str)</dt> 181 <dt><i>colourKey</i> (str)</dt>
185 <dd> 182 <dd>
186 key of the diff colour 183 key of the diff colour
187 </dd> 184 </dd>
188 </dl> 185 </dl>
189 <a NAME="DiffColoursPage.save" ID="DiffColoursPage.save"></a> 186 <a NAME="DiffColoursPage.save" ID="DiffColoursPage.save"></a>
190 <h4>DiffColoursPage.save</h4> 187 <h4>DiffColoursPage.save</h4>
191 <b>save</b>(<i></i>) 188 <b>save</b>(<i></i>)
192
193 <p> 189 <p>
194 Public slot to save the Diff colours configuration. 190 Public slot to save the Diff colours configuration.
195 </p> 191 </p>
192
196 <div align="right"><a href="#top">Up</a></div> 193 <div align="right"><a href="#top">Up</a></div>
197 <hr /> 194 <hr />
198 <hr /> 195 <hr />
199 <a NAME="create" ID="create"></a> 196 <a NAME="create" ID="create"></a>
200 <h2>create</h2> 197 <h2>create</h2>
201 <b>create</b>(<i>dlg</i>) 198 <b>create</b>(<i>dlg</i>)
202
203 <p> 199 <p>
204 Module function to create the configuration page. 200 Module function to create the configuration page.
205 </p> 201 </p>
202
206 <dl> 203 <dl>
207 204
208 <dt><i>dlg</i> (ConfigurationDialog)</dt> 205 <dt><i>dlg</i> (ConfigurationDialog)</dt>
209 <dd> 206 <dd>
210 reference to the configuration dialog 207 reference to the configuration dialog

eric ide

mercurial