eric6/Documentation/Source/eric6.Preferences.ConfigurationPages.ProjectBrowserPage.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.ProjectBrowserPage</h1> 23 <h1>eric6.Preferences.ConfigurationPages.ProjectBrowserPage</h1>
24
23 <p> 25 <p>
24 Module implementing the Project Browser configuration page. 26 Module implementing the Project Browser 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="#ProjectBrowserPage">ProjectBrowserPage</a></td> 38 <td><a href="#ProjectBrowserPage">ProjectBrowserPage</a></td>
34 <td>Class implementing the Project Browser configuration page.</td> 39 <td>Class implementing the Project Browser 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="ProjectBrowserPage" ID="ProjectBrowserPage"></a> 53 <a NAME="ProjectBrowserPage" ID="ProjectBrowserPage"></a>
46 <h2>ProjectBrowserPage</h2> 54 <h2>ProjectBrowserPage</h2>
55
47 <p> 56 <p>
48 Class implementing the Project Browser configuration page. 57 Class implementing the Project Browser configuration page.
49 </p> 58 </p>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 ConfigurationPageBase, Ui_ProjectBrowserPage 60 ConfigurationPageBase, Ui_ProjectBrowserPage
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="#ProjectBrowserPage.__init__">ProjectBrowserPage</a></td> 76 <td><a href="#ProjectBrowserPage.__init__">ProjectBrowserPage</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#ProjectBrowserPage.__setProjectBrowsersCheckBoxes">__setProjectBrowsersCheckBoxes</a></td> 80 <td><a href="#ProjectBrowserPage.__setProjectBrowsersCheckBoxes">__setProjectBrowsersCheckBoxes</a></td>
67 <td>Private method to set the checkboxes according to the selected project type.</td> 81 <td>Private method to set the checkboxes according to the selected project type.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#ProjectBrowserPage.__storeProjectBrowserFlags">__storeProjectBrowserFlags</a></td> 84 <td><a href="#ProjectBrowserPage.__storeProjectBrowserFlags">__storeProjectBrowserFlags</a></td>
70 <td>Private method to store the flags for the selected project type.</td> 85 <td>Private method to store the flags for the selected project type.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#ProjectBrowserPage.on_followCursorLineCheckBox_toggled">on_followCursorLineCheckBox_toggled</a></td> 88 <td><a href="#ProjectBrowserPage.on_followCursorLineCheckBox_toggled">on_followCursorLineCheckBox_toggled</a></td>
73 <td>Private slot to handle the change of the 'Follow Cursor Line' checkbox.</td> 89 <td>Private slot to handle the change of the 'Follow Cursor Line' checkbox.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#ProjectBrowserPage.on_followEditorCheckBox_toggled">on_followEditorCheckBox_toggled</a></td> 92 <td><a href="#ProjectBrowserPage.on_followEditorCheckBox_toggled">on_followEditorCheckBox_toggled</a></td>
76 <td>Private slot to handle the change of the 'Follow Editor' checkbox.</td> 93 <td>Private slot to handle the change of the 'Follow Editor' checkbox.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#ProjectBrowserPage.on_projectTypeCombo_activated">on_projectTypeCombo_activated</a></td> 96 <td><a href="#ProjectBrowserPage.on_projectTypeCombo_activated">on_projectTypeCombo_activated</a></td>
79 <td>Private slot to set the browser checkboxes according to the selected project type.</td> 97 <td>Private slot to set the browser checkboxes according to the selected project type.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#ProjectBrowserPage.save">save</a></td> 100 <td><a href="#ProjectBrowserPage.save">save</a></td>
82 <td>Public slot to save the Project Browser configuration.</td> 101 <td>Public slot to save the Project Browser 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="ProjectBrowserPage.__init__" ID="ProjectBrowserPage.__init__"></a> 110 <a NAME="ProjectBrowserPage.__init__" ID="ProjectBrowserPage.__init__"></a>
90 <h4>ProjectBrowserPage (Constructor)</h4> 111 <h4>ProjectBrowserPage (Constructor)</h4>
91 <b>ProjectBrowserPage</b>(<i></i>) 112 <b>ProjectBrowserPage</b>(<i></i>)
113
92 <p> 114 <p>
93 Constructor 115 Constructor
94 </p><a NAME="ProjectBrowserPage.__setProjectBrowsersCheckBoxes" ID="ProjectBrowserPage.__setProjectBrowsersCheckBoxes"></a> 116 </p>
117 <a NAME="ProjectBrowserPage.__setProjectBrowsersCheckBoxes" ID="ProjectBrowserPage.__setProjectBrowsersCheckBoxes"></a>
95 <h4>ProjectBrowserPage.__setProjectBrowsersCheckBoxes</h4> 118 <h4>ProjectBrowserPage.__setProjectBrowsersCheckBoxes</h4>
96 <b>__setProjectBrowsersCheckBoxes</b>(<i>projectType</i>) 119 <b>__setProjectBrowsersCheckBoxes</b>(<i>projectType</i>)
120
97 <p> 121 <p>
98 Private method to set the checkboxes according to the selected project 122 Private method to set the checkboxes according to the selected project
99 type. 123 type.
100 </p><dl> 124 </p>
125 <dl>
126
101 <dt><i>projectType</i></dt> 127 <dt><i>projectType</i></dt>
102 <dd> 128 <dd>
103 type of the selected project (string) 129 type of the selected project (string)
104 </dd> 130 </dd>
105 </dl><a NAME="ProjectBrowserPage.__storeProjectBrowserFlags" ID="ProjectBrowserPage.__storeProjectBrowserFlags"></a> 131 </dl>
132 <a NAME="ProjectBrowserPage.__storeProjectBrowserFlags" ID="ProjectBrowserPage.__storeProjectBrowserFlags"></a>
106 <h4>ProjectBrowserPage.__storeProjectBrowserFlags</h4> 133 <h4>ProjectBrowserPage.__storeProjectBrowserFlags</h4>
107 <b>__storeProjectBrowserFlags</b>(<i>projectType</i>) 134 <b>__storeProjectBrowserFlags</b>(<i>projectType</i>)
135
108 <p> 136 <p>
109 Private method to store the flags for the selected project type. 137 Private method to store the flags for the selected project type.
110 </p><dl> 138 </p>
139 <dl>
140
111 <dt><i>projectType</i></dt> 141 <dt><i>projectType</i></dt>
112 <dd> 142 <dd>
113 type of the selected project (string) 143 type of the selected project (string)
114 </dd> 144 </dd>
115 </dl><a NAME="ProjectBrowserPage.on_followCursorLineCheckBox_toggled" ID="ProjectBrowserPage.on_followCursorLineCheckBox_toggled"></a> 145 </dl>
146 <a NAME="ProjectBrowserPage.on_followCursorLineCheckBox_toggled" ID="ProjectBrowserPage.on_followCursorLineCheckBox_toggled"></a>
116 <h4>ProjectBrowserPage.on_followCursorLineCheckBox_toggled</h4> 147 <h4>ProjectBrowserPage.on_followCursorLineCheckBox_toggled</h4>
117 <b>on_followCursorLineCheckBox_toggled</b>(<i>checked</i>) 148 <b>on_followCursorLineCheckBox_toggled</b>(<i>checked</i>)
149
118 <p> 150 <p>
119 Private slot to handle the change of the 'Follow Cursor Line' checkbox. 151 Private slot to handle the change of the 'Follow Cursor Line' checkbox.
120 </p><dl> 152 </p>
153 <dl>
154
121 <dt><i>checked</i></dt> 155 <dt><i>checked</i></dt>
122 <dd> 156 <dd>
123 flag indicating the state of the checkbox 157 flag indicating the state of the checkbox
124 </dd> 158 </dd>
125 </dl><a NAME="ProjectBrowserPage.on_followEditorCheckBox_toggled" ID="ProjectBrowserPage.on_followEditorCheckBox_toggled"></a> 159 </dl>
160 <a NAME="ProjectBrowserPage.on_followEditorCheckBox_toggled" ID="ProjectBrowserPage.on_followEditorCheckBox_toggled"></a>
126 <h4>ProjectBrowserPage.on_followEditorCheckBox_toggled</h4> 161 <h4>ProjectBrowserPage.on_followEditorCheckBox_toggled</h4>
127 <b>on_followEditorCheckBox_toggled</b>(<i>checked</i>) 162 <b>on_followEditorCheckBox_toggled</b>(<i>checked</i>)
163
128 <p> 164 <p>
129 Private slot to handle the change of the 'Follow Editor' checkbox. 165 Private slot to handle the change of the 'Follow Editor' checkbox.
130 </p><dl> 166 </p>
167 <dl>
168
131 <dt><i>checked</i></dt> 169 <dt><i>checked</i></dt>
132 <dd> 170 <dd>
133 flag indicating the state of the checkbox 171 flag indicating the state of the checkbox
134 </dd> 172 </dd>
135 </dl><a NAME="ProjectBrowserPage.on_projectTypeCombo_activated" ID="ProjectBrowserPage.on_projectTypeCombo_activated"></a> 173 </dl>
174 <a NAME="ProjectBrowserPage.on_projectTypeCombo_activated" ID="ProjectBrowserPage.on_projectTypeCombo_activated"></a>
136 <h4>ProjectBrowserPage.on_projectTypeCombo_activated</h4> 175 <h4>ProjectBrowserPage.on_projectTypeCombo_activated</h4>
137 <b>on_projectTypeCombo_activated</b>(<i>index</i>) 176 <b>on_projectTypeCombo_activated</b>(<i>index</i>)
177
138 <p> 178 <p>
139 Private slot to set the browser checkboxes according to the selected 179 Private slot to set the browser checkboxes according to the selected
140 project type. 180 project type.
141 </p><dl> 181 </p>
182 <dl>
183
142 <dt><i>index</i></dt> 184 <dt><i>index</i></dt>
143 <dd> 185 <dd>
144 index of the selected project type (integer) 186 index of the selected project type (integer)
145 </dd> 187 </dd>
146 </dl><a NAME="ProjectBrowserPage.save" ID="ProjectBrowserPage.save"></a> 188 </dl>
189 <a NAME="ProjectBrowserPage.save" ID="ProjectBrowserPage.save"></a>
147 <h4>ProjectBrowserPage.save</h4> 190 <h4>ProjectBrowserPage.save</h4>
148 <b>save</b>(<i></i>) 191 <b>save</b>(<i></i>)
192
149 <p> 193 <p>
150 Public slot to save the Project Browser configuration. 194 Public slot to save the Project Browser configuration.
151 </p> 195 </p>
152 <div align="right"><a href="#top">Up</a></div> 196 <div align="right"><a href="#top">Up</a></div>
153 <hr /><hr /> 197 <hr />
198 <hr />
154 <a NAME="create" ID="create"></a> 199 <a NAME="create" ID="create"></a>
155 <h2>create</h2> 200 <h2>create</h2>
156 <b>create</b>(<i>dlg</i>) 201 <b>create</b>(<i>dlg</i>)
202
157 <p> 203 <p>
158 Module function to create the configuration page. 204 Module function to create the configuration page.
159 </p><dl> 205 </p>
206 <dl>
207
160 <dt><i>dlg</i></dt> 208 <dt><i>dlg</i></dt>
161 <dd> 209 <dd>
162 reference to the configuration dialog 210 reference to the configuration dialog
163 </dd> 211 </dd>
164 </dl><dl> 212 </dl>
213 <dl>
165 <dt>Returns:</dt> 214 <dt>Returns:</dt>
166 <dd> 215 <dd>
167 reference to the instantiated page (ConfigurationPageBase) 216 reference to the instantiated page (ConfigurationPageBase)
168 </dd> 217 </dd>
169 </dl> 218 </dl>

eric ide

mercurial