Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ProjectBrowserPage.html
src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ProjectBrowserPage.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.ProjectBrowserPage</h1> | 9 <h1>eric7.Preferences.ConfigurationPages.ProjectBrowserPage</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the Project Browser configuration page. | 11 Module implementing the Project Browser 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="#ProjectBrowserPage">ProjectBrowserPage</a></td> | 22 <td><a href="#ProjectBrowserPage">ProjectBrowserPage</a></td> |
| 25 <td>Class implementing the Project Browser configuration page.</td> | 23 <td>Class implementing the Project Browser 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="ProjectBrowserPage" ID="ProjectBrowserPage"></a> | 37 <a NAME="ProjectBrowserPage" ID="ProjectBrowserPage"></a> |
| 40 <h2>ProjectBrowserPage</h2> | 38 <h2>ProjectBrowserPage</h2> |
| 41 | |
| 42 <p> | 39 <p> |
| 43 Class implementing the Project Browser configuration page. | 40 Class implementing the Project Browser configuration page. |
| 44 </p> | 41 </p> |
| 42 | |
| 45 <h3>Derived from</h3> | 43 <h3>Derived from</h3> |
| 46 ConfigurationPageBase, Ui_ProjectBrowserPage | 44 ConfigurationPageBase, Ui_ProjectBrowserPage |
| 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="#ProjectBrowserPage.__init__">ProjectBrowserPage</a></td> | 58 <td><a href="#ProjectBrowserPage.__init__">ProjectBrowserPage</a></td> |
| 63 <td>Constructor</td> | 59 <td>Constructor</td> |
| 64 </tr> | 60 </tr> |
| 65 <tr> | 61 <tr> |
| 89 <tr> | 85 <tr> |
| 90 <td><a href="#ProjectBrowserPage.save">save</a></td> | 86 <td><a href="#ProjectBrowserPage.save">save</a></td> |
| 91 <td>Public slot to save the Project Browser configuration.</td> | 87 <td>Public slot to save the Project Browser configuration.</td> |
| 92 </tr> | 88 </tr> |
| 93 </table> | 89 </table> |
| 90 | |
| 94 <h3>Static Methods</h3> | 91 <h3>Static Methods</h3> |
| 95 | 92 <table> |
| 96 <table> | 93 <tr><td>None</td></tr> |
| 97 <tr><td>None</td></tr> | 94 </table> |
| 98 </table> | 95 |
| 99 | 96 |
| 100 <a NAME="ProjectBrowserPage.__init__" ID="ProjectBrowserPage.__init__"></a> | 97 <a NAME="ProjectBrowserPage.__init__" ID="ProjectBrowserPage.__init__"></a> |
| 101 <h4>ProjectBrowserPage (Constructor)</h4> | 98 <h4>ProjectBrowserPage (Constructor)</h4> |
| 102 <b>ProjectBrowserPage</b>(<i></i>) | 99 <b>ProjectBrowserPage</b>(<i></i>) |
| 103 | |
| 104 <p> | 100 <p> |
| 105 Constructor | 101 Constructor |
| 106 </p> | 102 </p> |
| 103 | |
| 107 <a NAME="ProjectBrowserPage.__populateProjectBrowserList" ID="ProjectBrowserPage.__populateProjectBrowserList"></a> | 104 <a NAME="ProjectBrowserPage.__populateProjectBrowserList" ID="ProjectBrowserPage.__populateProjectBrowserList"></a> |
| 108 <h4>ProjectBrowserPage.__populateProjectBrowserList</h4> | 105 <h4>ProjectBrowserPage.__populateProjectBrowserList</h4> |
| 109 <b>__populateProjectBrowserList</b>(<i></i>) | 106 <b>__populateProjectBrowserList</b>(<i></i>) |
| 110 | |
| 111 <p> | 107 <p> |
| 112 Private method to populate the project browsers list. | 108 Private method to populate the project browsers list. |
| 113 </p> | 109 </p> |
| 110 | |
| 114 <a NAME="ProjectBrowserPage.__setProjectBrowsersList" ID="ProjectBrowserPage.__setProjectBrowsersList"></a> | 111 <a NAME="ProjectBrowserPage.__setProjectBrowsersList" ID="ProjectBrowserPage.__setProjectBrowsersList"></a> |
| 115 <h4>ProjectBrowserPage.__setProjectBrowsersList</h4> | 112 <h4>ProjectBrowserPage.__setProjectBrowsersList</h4> |
| 116 <b>__setProjectBrowsersList</b>(<i>projectType</i>) | 113 <b>__setProjectBrowsersList</b>(<i>projectType</i>) |
| 117 | |
| 118 <p> | 114 <p> |
| 119 Private method to check the project browser entries according to the selected | 115 Private method to check the project browser entries according to the selected |
| 120 project type. | 116 project type. |
| 121 </p> | 117 </p> |
| 118 | |
| 122 <dl> | 119 <dl> |
| 123 | 120 |
| 124 <dt><i>projectType</i> (str)</dt> | 121 <dt><i>projectType</i> (str)</dt> |
| 125 <dd> | 122 <dd> |
| 126 selected project type | 123 selected project type |
| 127 </dd> | 124 </dd> |
| 128 </dl> | 125 </dl> |
| 129 <a NAME="ProjectBrowserPage.__storeProjectBrowsersList" ID="ProjectBrowserPage.__storeProjectBrowsersList"></a> | 126 <a NAME="ProjectBrowserPage.__storeProjectBrowsersList" ID="ProjectBrowserPage.__storeProjectBrowsersList"></a> |
| 130 <h4>ProjectBrowserPage.__storeProjectBrowsersList</h4> | 127 <h4>ProjectBrowserPage.__storeProjectBrowsersList</h4> |
| 131 <b>__storeProjectBrowsersList</b>(<i>projectType</i>) | 128 <b>__storeProjectBrowsersList</b>(<i>projectType</i>) |
| 132 | |
| 133 <p> | 129 <p> |
| 134 Private method to store the list of enabled browsers for the selected project | 130 Private method to store the list of enabled browsers for the selected project |
| 135 type. | 131 type. |
| 136 </p> | 132 </p> |
| 133 | |
| 137 <dl> | 134 <dl> |
| 138 | 135 |
| 139 <dt><i>projectType</i> (str)</dt> | 136 <dt><i>projectType</i> (str)</dt> |
| 140 <dd> | 137 <dd> |
| 141 type of the selected project | 138 type of the selected project |
| 142 </dd> | 139 </dd> |
| 143 </dl> | 140 </dl> |
| 144 <a NAME="ProjectBrowserPage.on_followCursorLineCheckBox_toggled" ID="ProjectBrowserPage.on_followCursorLineCheckBox_toggled"></a> | 141 <a NAME="ProjectBrowserPage.on_followCursorLineCheckBox_toggled" ID="ProjectBrowserPage.on_followCursorLineCheckBox_toggled"></a> |
| 145 <h4>ProjectBrowserPage.on_followCursorLineCheckBox_toggled</h4> | 142 <h4>ProjectBrowserPage.on_followCursorLineCheckBox_toggled</h4> |
| 146 <b>on_followCursorLineCheckBox_toggled</b>(<i>checked</i>) | 143 <b>on_followCursorLineCheckBox_toggled</b>(<i>checked</i>) |
| 147 | |
| 148 <p> | 144 <p> |
| 149 Private slot to handle the change of the 'Follow Cursor Line' checkbox. | 145 Private slot to handle the change of the 'Follow Cursor Line' checkbox. |
| 150 </p> | 146 </p> |
| 147 | |
| 151 <dl> | 148 <dl> |
| 152 | 149 |
| 153 <dt><i>checked</i> (bool)</dt> | 150 <dt><i>checked</i> (bool)</dt> |
| 154 <dd> | 151 <dd> |
| 155 flag indicating the state of the checkbox | 152 flag indicating the state of the checkbox |
| 156 </dd> | 153 </dd> |
| 157 </dl> | 154 </dl> |
| 158 <a NAME="ProjectBrowserPage.on_followEditorCheckBox_toggled" ID="ProjectBrowserPage.on_followEditorCheckBox_toggled"></a> | 155 <a NAME="ProjectBrowserPage.on_followEditorCheckBox_toggled" ID="ProjectBrowserPage.on_followEditorCheckBox_toggled"></a> |
| 159 <h4>ProjectBrowserPage.on_followEditorCheckBox_toggled</h4> | 156 <h4>ProjectBrowserPage.on_followEditorCheckBox_toggled</h4> |
| 160 <b>on_followEditorCheckBox_toggled</b>(<i>checked</i>) | 157 <b>on_followEditorCheckBox_toggled</b>(<i>checked</i>) |
| 161 | |
| 162 <p> | 158 <p> |
| 163 Private slot to handle the change of the 'Follow Editor' checkbox. | 159 Private slot to handle the change of the 'Follow Editor' checkbox. |
| 164 </p> | 160 </p> |
| 161 | |
| 165 <dl> | 162 <dl> |
| 166 | 163 |
| 167 <dt><i>checked</i> (bool)</dt> | 164 <dt><i>checked</i> (bool)</dt> |
| 168 <dd> | 165 <dd> |
| 169 flag indicating the state of the checkbox | 166 flag indicating the state of the checkbox |
| 170 </dd> | 167 </dd> |
| 171 </dl> | 168 </dl> |
| 172 <a NAME="ProjectBrowserPage.on_projectTypeCombo_activated" ID="ProjectBrowserPage.on_projectTypeCombo_activated"></a> | 169 <a NAME="ProjectBrowserPage.on_projectTypeCombo_activated" ID="ProjectBrowserPage.on_projectTypeCombo_activated"></a> |
| 173 <h4>ProjectBrowserPage.on_projectTypeCombo_activated</h4> | 170 <h4>ProjectBrowserPage.on_projectTypeCombo_activated</h4> |
| 174 <b>on_projectTypeCombo_activated</b>(<i>index</i>) | 171 <b>on_projectTypeCombo_activated</b>(<i>index</i>) |
| 175 | |
| 176 <p> | 172 <p> |
| 177 Private slot to set the browser checkboxes according to the selected | 173 Private slot to set the browser checkboxes according to the selected |
| 178 project type. | 174 project type. |
| 179 </p> | 175 </p> |
| 176 | |
| 180 <dl> | 177 <dl> |
| 181 | 178 |
| 182 <dt><i>index</i> (int)</dt> | 179 <dt><i>index</i> (int)</dt> |
| 183 <dd> | 180 <dd> |
| 184 index of the selected project type | 181 index of the selected project type |
| 185 </dd> | 182 </dd> |
| 186 </dl> | 183 </dl> |
| 187 <a NAME="ProjectBrowserPage.save" ID="ProjectBrowserPage.save"></a> | 184 <a NAME="ProjectBrowserPage.save" ID="ProjectBrowserPage.save"></a> |
| 188 <h4>ProjectBrowserPage.save</h4> | 185 <h4>ProjectBrowserPage.save</h4> |
| 189 <b>save</b>(<i></i>) | 186 <b>save</b>(<i></i>) |
| 190 | |
| 191 <p> | 187 <p> |
| 192 Public slot to save the Project Browser configuration. | 188 Public slot to save the Project Browser configuration. |
| 193 </p> | 189 </p> |
| 190 | |
| 194 <div align="right"><a href="#top">Up</a></div> | 191 <div align="right"><a href="#top">Up</a></div> |
| 195 <hr /> | 192 <hr /> |
| 196 <hr /> | 193 <hr /> |
| 197 <a NAME="create" ID="create"></a> | 194 <a NAME="create" ID="create"></a> |
| 198 <h2>create</h2> | 195 <h2>create</h2> |
| 199 <b>create</b>(<i>dlg</i>) | 196 <b>create</b>(<i>dlg</i>) |
| 200 | |
| 201 <p> | 197 <p> |
| 202 Module function to create the configuration page. | 198 Module function to create the configuration page. |
| 203 </p> | 199 </p> |
| 200 | |
| 204 <dl> | 201 <dl> |
| 205 | 202 |
| 206 <dt><i>dlg</i> (ConfigurationDialog)</dt> | 203 <dt><i>dlg</i> (ConfigurationDialog)</dt> |
| 207 <dd> | 204 <dd> |
| 208 reference to the configuration dialog | 205 reference to the configuration dialog |
