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