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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
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.DiffColoursPage</h1> 23 <h1>eric6.Preferences.ConfigurationPages.DiffColoursPage</h1>
24
23 <p> 25 <p>
24 Module implementing the Diff colours configuration page. 26 Module implementing the Diff colours configuration page.
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="#DiffColoursPage">DiffColoursPage</a></td> 38 <td><a href="#DiffColoursPage">DiffColoursPage</a></td>
34 <td>Class implementing the Diff colours configuration page.</td> 39 <td>Class implementing the Diff colours configuration page.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#create">create</a></td> 47 <td><a href="#create">create</a></td>
41 <td>Module function to create the configuration page.</td> 48 <td>Module function to create the configuration page.</td>
42 </tr> 49 </tr>
43 </table> 50 </table>
44 <hr /><hr /> 51 <hr />
52 <hr />
45 <a NAME="DiffColoursPage" ID="DiffColoursPage"></a> 53 <a NAME="DiffColoursPage" ID="DiffColoursPage"></a>
46 <h2>DiffColoursPage</h2> 54 <h2>DiffColoursPage</h2>
55
47 <p> 56 <p>
48 Class implementing the Diff colours configuration page. 57 Class implementing the Diff colours configuration page.
49 </p> 58 </p>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 ConfigurationPageBase, Ui_DiffColoursPage 60 ConfigurationPageBase, Ui_DiffColoursPage
52 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
62
53 <table> 63 <table>
54 <tr><td>None</td></tr> 64 <tr><td>None</td></tr>
55 </table> 65 </table>
56 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Methods</h3> 71 <h3>Methods</h3>
61 <table> 72
73 <table>
74
62 <tr> 75 <tr>
63 <td><a href="#DiffColoursPage.__init__">DiffColoursPage</a></td> 76 <td><a href="#DiffColoursPage.__init__">DiffColoursPage</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#DiffColoursPage.__initColour">__initColour</a></td> 80 <td><a href="#DiffColoursPage.__initColour">__initColour</a></td>
67 <td>Private method to initialize a colour selection button.</td> 81 <td>Private method to initialize a colour selection button.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#DiffColoursPage.__selectBackgroundColour">__selectBackgroundColour</a></td> 84 <td><a href="#DiffColoursPage.__selectBackgroundColour">__selectBackgroundColour</a></td>
70 <td>Private slot to select a background colour.</td> 85 <td>Private slot to select a background colour.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#DiffColoursPage.__selectTextColour">__selectTextColour</a></td> 88 <td><a href="#DiffColoursPage.__selectTextColour">__selectTextColour</a></td>
73 <td>Private slot to select the text colour.</td> 89 <td>Private slot to select the text colour.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#DiffColoursPage.__updateSampleBackgroundColour">__updateSampleBackgroundColour</a></td> 92 <td><a href="#DiffColoursPage.__updateSampleBackgroundColour">__updateSampleBackgroundColour</a></td>
76 <td>Private slot to update the background colour of a sample.</td> 93 <td>Private slot to update the background colour of a sample.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#DiffColoursPage.__updateSampleTextColour">__updateSampleTextColour</a></td> 96 <td><a href="#DiffColoursPage.__updateSampleTextColour">__updateSampleTextColour</a></td>
79 <td>Private slot to update the text colour of all samples.</td> 97 <td>Private slot to update the text colour of all samples.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#DiffColoursPage.save">save</a></td> 100 <td><a href="#DiffColoursPage.save">save</a></td>
82 <td>Public slot to save the Diff colours configuration.</td> 101 <td>Public slot to save the Diff colours configuration.</td>
83 </tr> 102 </tr>
84 </table> 103 </table>
85 <h3>Static Methods</h3> 104 <h3>Static Methods</h3>
86 <table> 105
87 <tr><td>None</td></tr> 106 <table>
88 </table> 107 <tr><td>None</td></tr>
108 </table>
109
89 <a NAME="DiffColoursPage.__init__" ID="DiffColoursPage.__init__"></a> 110 <a NAME="DiffColoursPage.__init__" ID="DiffColoursPage.__init__"></a>
90 <h4>DiffColoursPage (Constructor)</h4> 111 <h4>DiffColoursPage (Constructor)</h4>
91 <b>DiffColoursPage</b>(<i></i>) 112 <b>DiffColoursPage</b>(<i></i>)
113
92 <p> 114 <p>
93 Constructor 115 Constructor
94 </p><a NAME="DiffColoursPage.__initColour" ID="DiffColoursPage.__initColour"></a> 116 </p>
117 <a NAME="DiffColoursPage.__initColour" ID="DiffColoursPage.__initColour"></a>
95 <h4>DiffColoursPage.__initColour</h4> 118 <h4>DiffColoursPage.__initColour</h4>
96 <b>__initColour</b>(<i>colourKey, button, initSlot, selectSlot, sampleWidget</i>) 119 <b>__initColour</b>(<i>colourKey, button, initSlot, selectSlot, sampleWidget</i>)
120
97 <p> 121 <p>
98 Private method to initialize a colour selection button. 122 Private method to initialize a colour selection button.
99 </p><dl> 123 </p>
124 <dl>
125
100 <dt><i>colourKey</i> (str)</dt> 126 <dt><i>colourKey</i> (str)</dt>
101 <dd> 127 <dd>
102 key of the diff colour 128 key of the diff colour
103 </dd><dt><i>button</i> (QPushButton)</dt> 129 </dd>
130 <dt><i>button</i> (QPushButton)</dt>
104 <dd> 131 <dd>
105 reference to the button 132 reference to the button
106 </dd><dt><i>initSlot</i> (func)</dt> 133 </dd>
134 <dt><i>initSlot</i> (func)</dt>
107 <dd> 135 <dd>
108 slot to be called to initialize the sample 136 slot to be called to initialize the sample
109 </dd><dt><i>selectSlot</i> (func)</dt> 137 </dd>
138 <dt><i>selectSlot</i> (func)</dt>
110 <dd> 139 <dd>
111 slot to be called to select the colour 140 slot to be called to select the colour
112 </dd><dt><i>sampleWidget</i> (QLineEdit)</dt> 141 </dd>
142 <dt><i>sampleWidget</i> (QLineEdit)</dt>
113 <dd> 143 <dd>
114 reference to the sample widget 144 reference to the sample widget
115 </dd> 145 </dd>
116 </dl><a NAME="DiffColoursPage.__selectBackgroundColour" ID="DiffColoursPage.__selectBackgroundColour"></a> 146 </dl>
147 <a NAME="DiffColoursPage.__selectBackgroundColour" ID="DiffColoursPage.__selectBackgroundColour"></a>
117 <h4>DiffColoursPage.__selectBackgroundColour</h4> 148 <h4>DiffColoursPage.__selectBackgroundColour</h4>
118 <b>__selectBackgroundColour</b>(<i>button</i>) 149 <b>__selectBackgroundColour</b>(<i>button</i>)
150
119 <p> 151 <p>
120 Private slot to select a background colour. 152 Private slot to select a background colour.
121 </p><dl> 153 </p>
154 <dl>
155
122 <dt><i>button</i> (QPushButton)</dt> 156 <dt><i>button</i> (QPushButton)</dt>
123 <dd> 157 <dd>
124 reference to the button been pressed 158 reference to the button been pressed
125 </dd> 159 </dd>
126 </dl><a NAME="DiffColoursPage.__selectTextColour" ID="DiffColoursPage.__selectTextColour"></a> 160 </dl>
161 <a NAME="DiffColoursPage.__selectTextColour" ID="DiffColoursPage.__selectTextColour"></a>
127 <h4>DiffColoursPage.__selectTextColour</h4> 162 <h4>DiffColoursPage.__selectTextColour</h4>
128 <b>__selectTextColour</b>(<i>button</i>) 163 <b>__selectTextColour</b>(<i>button</i>)
164
129 <p> 165 <p>
130 Private slot to select the text colour. 166 Private slot to select the text colour.
131 </p><dl> 167 </p>
168 <dl>
169
132 <dt><i>button</i> (QPushButton)</dt> 170 <dt><i>button</i> (QPushButton)</dt>
133 <dd> 171 <dd>
134 reference to the button been pressed 172 reference to the button been pressed
135 </dd> 173 </dd>
136 </dl><a NAME="DiffColoursPage.__updateSampleBackgroundColour" ID="DiffColoursPage.__updateSampleBackgroundColour"></a> 174 </dl>
175 <a NAME="DiffColoursPage.__updateSampleBackgroundColour" ID="DiffColoursPage.__updateSampleBackgroundColour"></a>
137 <h4>DiffColoursPage.__updateSampleBackgroundColour</h4> 176 <h4>DiffColoursPage.__updateSampleBackgroundColour</h4>
138 <b>__updateSampleBackgroundColour</b>(<i>colourKey</i>) 177 <b>__updateSampleBackgroundColour</b>(<i>colourKey</i>)
178
139 <p> 179 <p>
140 Private slot to update the background colour of a sample. 180 Private slot to update the background colour of a sample.
141 </p><dl> 181 </p>
182 <dl>
183
142 <dt><i>colourKey</i> (str)</dt> 184 <dt><i>colourKey</i> (str)</dt>
143 <dd> 185 <dd>
144 key of the diff colour 186 key of the diff colour
145 </dd> 187 </dd>
146 </dl><a NAME="DiffColoursPage.__updateSampleTextColour" ID="DiffColoursPage.__updateSampleTextColour"></a> 188 </dl>
189 <a NAME="DiffColoursPage.__updateSampleTextColour" ID="DiffColoursPage.__updateSampleTextColour"></a>
147 <h4>DiffColoursPage.__updateSampleTextColour</h4> 190 <h4>DiffColoursPage.__updateSampleTextColour</h4>
148 <b>__updateSampleTextColour</b>(<i>colourKey</i>) 191 <b>__updateSampleTextColour</b>(<i>colourKey</i>)
192
149 <p> 193 <p>
150 Private slot to update the text colour of all samples. 194 Private slot to update the text colour of all samples.
151 </p><dl> 195 </p>
196 <dl>
197
152 <dt><i>colourKey</i> (str)</dt> 198 <dt><i>colourKey</i> (str)</dt>
153 <dd> 199 <dd>
154 key of the diff colour 200 key of the diff colour
155 </dd> 201 </dd>
156 </dl><a NAME="DiffColoursPage.save" ID="DiffColoursPage.save"></a> 202 </dl>
203 <a NAME="DiffColoursPage.save" ID="DiffColoursPage.save"></a>
157 <h4>DiffColoursPage.save</h4> 204 <h4>DiffColoursPage.save</h4>
158 <b>save</b>(<i></i>) 205 <b>save</b>(<i></i>)
206
159 <p> 207 <p>
160 Public slot to save the Diff colours configuration. 208 Public slot to save the Diff colours configuration.
161 </p> 209 </p>
162 <div align="right"><a href="#top">Up</a></div> 210 <div align="right"><a href="#top">Up</a></div>
163 <hr /><hr /> 211 <hr />
212 <hr />
164 <a NAME="create" ID="create"></a> 213 <a NAME="create" ID="create"></a>
165 <h2>create</h2> 214 <h2>create</h2>
166 <b>create</b>(<i>dlg</i>) 215 <b>create</b>(<i>dlg</i>)
216
167 <p> 217 <p>
168 Module function to create the configuration page. 218 Module function to create the configuration page.
169 </p><dl> 219 </p>
220 <dl>
221
170 <dt><i>dlg</i></dt> 222 <dt><i>dlg</i></dt>
171 <dd> 223 <dd>
172 reference to the configuration dialog 224 reference to the configuration dialog
173 </dd> 225 </dd>
174 </dl><dl> 226 </dl>
227 <dl>
175 <dt>Returns:</dt> 228 <dt>Returns:</dt>
176 <dd> 229 <dd>
177 reference to the instantiated page (ConfigurationPageBase) 230 reference to the instantiated page (ConfigurationPageBase)
178 </dd> 231 </dd>
179 </dl> 232 </dl>

eric ide

mercurial