Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Preferences.ConfigurationPages.DiffColoursPage.html
Documentation/Source/eric6.Preferences.ConfigurationPages.DiffColoursPage.html
- changeset 5765
- 39d8b26ff557
- child 6123
- 39cd368143db
equal
deleted
inserted
replaced
| 5764:51ceecf32585 | 5765:39d8b26ff557 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Preferences.ConfigurationPages.DiffColoursPage</h1> | |
| 23 <p> | |
| 24 Module implementing the Diff colours configuration page. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#DiffColoursPage">DiffColoursPage</a></td> | |
| 34 <td>Class implementing the Diff colours configuration page.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#create">create</a></td> | |
| 41 <td>Module function to create the configuration page.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="DiffColoursPage" ID="DiffColoursPage"></a> | |
| 46 <h2>DiffColoursPage</h2> | |
| 47 <p> | |
| 48 Class implementing the Diff colours configuration page. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 ConfigurationPageBase, Ui_DiffColoursPage | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#DiffColoursPage.__init__">DiffColoursPage</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#DiffColoursPage.__initColour">__initColour</a></td> | |
| 67 <td>Private method to initialize a colour selection button.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#DiffColoursPage.__selectBackgroundColour">__selectBackgroundColour</a></td> | |
| 70 <td>Private slot to select a background colour.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#DiffColoursPage.__selectTextColour">__selectTextColour</a></td> | |
| 73 <td>Private slot to select the text colour.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#DiffColoursPage.__updateSampleBackgroundColour">__updateSampleBackgroundColour</a></td> | |
| 76 <td>Private slot to update the background colour of a sample.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#DiffColoursPage.__updateSampleTextColour">__updateSampleTextColour</a></td> | |
| 79 <td>Private slot to update the text colour of all samples.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#DiffColoursPage.save">save</a></td> | |
| 82 <td>Public slot to save the Diff colours configuration.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <h3>Static Methods</h3> | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <a NAME="DiffColoursPage.__init__" ID="DiffColoursPage.__init__"></a> | |
| 90 <h4>DiffColoursPage (Constructor)</h4> | |
| 91 <b>DiffColoursPage</b>(<i></i>) | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p><a NAME="DiffColoursPage.__initColour" ID="DiffColoursPage.__initColour"></a> | |
| 95 <h4>DiffColoursPage.__initColour</h4> | |
| 96 <b>__initColour</b>(<i>colourKey, button, initSlot, selectSlot, sampleWidget</i>) | |
| 97 <p> | |
| 98 Private method to initialize a colour selection button. | |
| 99 </p><dl> | |
| 100 <dt><i>colourKey</i> (str)</dt> | |
| 101 <dd> | |
| 102 key of the diff colour | |
| 103 </dd><dt><i>button</i> (QPushButton)</dt> | |
| 104 <dd> | |
| 105 reference to the button | |
| 106 </dd><dt><i>initSlot</i> (func)</dt> | |
| 107 <dd> | |
| 108 slot to be called to initialize the sample | |
| 109 </dd><dt><i>selectSlot</i> (func)</dt> | |
| 110 <dd> | |
| 111 slot to be called to select the colour | |
| 112 </dd><dt><i>sampleWidget</i> (QLineEdit)</dt> | |
| 113 <dd> | |
| 114 reference to the sample widget | |
| 115 </dd> | |
| 116 </dl><a NAME="DiffColoursPage.__selectBackgroundColour" ID="DiffColoursPage.__selectBackgroundColour"></a> | |
| 117 <h4>DiffColoursPage.__selectBackgroundColour</h4> | |
| 118 <b>__selectBackgroundColour</b>(<i></i>) | |
| 119 <p> | |
| 120 Private slot to select a background colour. | |
| 121 </p><a NAME="DiffColoursPage.__selectTextColour" ID="DiffColoursPage.__selectTextColour"></a> | |
| 122 <h4>DiffColoursPage.__selectTextColour</h4> | |
| 123 <b>__selectTextColour</b>(<i></i>) | |
| 124 <p> | |
| 125 Private slot to select the text colour. | |
| 126 </p><a NAME="DiffColoursPage.__updateSampleBackgroundColour" ID="DiffColoursPage.__updateSampleBackgroundColour"></a> | |
| 127 <h4>DiffColoursPage.__updateSampleBackgroundColour</h4> | |
| 128 <b>__updateSampleBackgroundColour</b>(<i>colourKey</i>) | |
| 129 <p> | |
| 130 Private slot to update the background colour of a sample. | |
| 131 </p><dl> | |
| 132 <dt><i>colourKey</i> (str)</dt> | |
| 133 <dd> | |
| 134 key of the diff colour | |
| 135 </dd> | |
| 136 </dl><a NAME="DiffColoursPage.__updateSampleTextColour" ID="DiffColoursPage.__updateSampleTextColour"></a> | |
| 137 <h4>DiffColoursPage.__updateSampleTextColour</h4> | |
| 138 <b>__updateSampleTextColour</b>(<i>colourKey</i>) | |
| 139 <p> | |
| 140 Private slot to update the text colour of all samples. | |
| 141 </p><dl> | |
| 142 <dt><i>colourKey</i> (str)</dt> | |
| 143 <dd> | |
| 144 key of the diff colour | |
| 145 </dd> | |
| 146 </dl><a NAME="DiffColoursPage.save" ID="DiffColoursPage.save"></a> | |
| 147 <h4>DiffColoursPage.save</h4> | |
| 148 <b>save</b>(<i></i>) | |
| 149 <p> | |
| 150 Public slot to save the Diff colours configuration. | |
| 151 </p> | |
| 152 <div align="right"><a href="#top">Up</a></div> | |
| 153 <hr /><hr /> | |
| 154 <a NAME="create" ID="create"></a> | |
| 155 <h2>create</h2> | |
| 156 <b>create</b>(<i>dlg</i>) | |
| 157 <p> | |
| 158 Module function to create the configuration page. | |
| 159 </p><dl> | |
| 160 <dt><i>dlg</i></dt> | |
| 161 <dd> | |
| 162 reference to the configuration dialog | |
| 163 </dd> | |
| 164 </dl><dl> | |
| 165 <dt>Returns:</dt> | |
| 166 <dd> | |
| 167 reference to the instantiated page (ConfigurationPageBase) | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <div align="right"><a href="#top">Up</a></div> | |
| 171 <hr /> | |
| 172 </body></html> |
