eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.ProjectBrowserPage.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.ProjectBrowserPage</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Preferences.ConfigurationPages.ProjectBrowserPage</h1>
24
25 <p>
26 Module implementing the Project Browser configuration page.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#ProjectBrowserPage">ProjectBrowserPage</a></td>
39 <td>Class implementing the Project Browser configuration page.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45
46 <tr>
47 <td><a href="#create">create</a></td>
48 <td>Module function to create the configuration page.</td>
49 </tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="ProjectBrowserPage" ID="ProjectBrowserPage"></a>
54 <h2>ProjectBrowserPage</h2>
55
56 <p>
57 Class implementing the Project Browser configuration page.
58 </p>
59 <h3>Derived from</h3>
60 ConfigurationPageBase, Ui_ProjectBrowserPage
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#ProjectBrowserPage.__init__">ProjectBrowserPage</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#ProjectBrowserPage.__setProjectBrowsersCheckBoxes">__setProjectBrowsersCheckBoxes</a></td>
81 <td>Private method to set the checkboxes according to the selected project type.</td>
82 </tr>
83 <tr>
84 <td><a href="#ProjectBrowserPage.__storeProjectBrowserFlags">__storeProjectBrowserFlags</a></td>
85 <td>Private method to store the flags for the selected project type.</td>
86 </tr>
87 <tr>
88 <td><a href="#ProjectBrowserPage.on_followCursorLineCheckBox_toggled">on_followCursorLineCheckBox_toggled</a></td>
89 <td>Private slot to handle the change of the 'Follow Cursor Line' checkbox.</td>
90 </tr>
91 <tr>
92 <td><a href="#ProjectBrowserPage.on_followEditorCheckBox_toggled">on_followEditorCheckBox_toggled</a></td>
93 <td>Private slot to handle the change of the 'Follow Editor' checkbox.</td>
94 </tr>
95 <tr>
96 <td><a href="#ProjectBrowserPage.on_projectTypeCombo_activated">on_projectTypeCombo_activated</a></td>
97 <td>Private slot to set the browser checkboxes according to the selected project type.</td>
98 </tr>
99 <tr>
100 <td><a href="#ProjectBrowserPage.save">save</a></td>
101 <td>Public slot to save the Project Browser configuration.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105
106 <table>
107 <tr><td>None</td></tr>
108 </table>
109
110 <a NAME="ProjectBrowserPage.__init__" ID="ProjectBrowserPage.__init__"></a>
111 <h4>ProjectBrowserPage (Constructor)</h4>
112 <b>ProjectBrowserPage</b>(<i></i>)
113
114 <p>
115 Constructor
116 </p>
117 <a NAME="ProjectBrowserPage.__setProjectBrowsersCheckBoxes" ID="ProjectBrowserPage.__setProjectBrowsersCheckBoxes"></a>
118 <h4>ProjectBrowserPage.__setProjectBrowsersCheckBoxes</h4>
119 <b>__setProjectBrowsersCheckBoxes</b>(<i>projectType</i>)
120
121 <p>
122 Private method to set the checkboxes according to the selected project
123 type.
124 </p>
125 <dl>
126
127 <dt><i>projectType</i></dt>
128 <dd>
129 type of the selected project (string)
130 </dd>
131 </dl>
132 <a NAME="ProjectBrowserPage.__storeProjectBrowserFlags" ID="ProjectBrowserPage.__storeProjectBrowserFlags"></a>
133 <h4>ProjectBrowserPage.__storeProjectBrowserFlags</h4>
134 <b>__storeProjectBrowserFlags</b>(<i>projectType</i>)
135
136 <p>
137 Private method to store the flags for the selected project type.
138 </p>
139 <dl>
140
141 <dt><i>projectType</i></dt>
142 <dd>
143 type of the selected project (string)
144 </dd>
145 </dl>
146 <a NAME="ProjectBrowserPage.on_followCursorLineCheckBox_toggled" ID="ProjectBrowserPage.on_followCursorLineCheckBox_toggled"></a>
147 <h4>ProjectBrowserPage.on_followCursorLineCheckBox_toggled</h4>
148 <b>on_followCursorLineCheckBox_toggled</b>(<i>checked</i>)
149
150 <p>
151 Private slot to handle the change of the 'Follow Cursor Line' checkbox.
152 </p>
153 <dl>
154
155 <dt><i>checked</i></dt>
156 <dd>
157 flag indicating the state of the checkbox
158 </dd>
159 </dl>
160 <a NAME="ProjectBrowserPage.on_followEditorCheckBox_toggled" ID="ProjectBrowserPage.on_followEditorCheckBox_toggled"></a>
161 <h4>ProjectBrowserPage.on_followEditorCheckBox_toggled</h4>
162 <b>on_followEditorCheckBox_toggled</b>(<i>checked</i>)
163
164 <p>
165 Private slot to handle the change of the 'Follow Editor' checkbox.
166 </p>
167 <dl>
168
169 <dt><i>checked</i></dt>
170 <dd>
171 flag indicating the state of the checkbox
172 </dd>
173 </dl>
174 <a NAME="ProjectBrowserPage.on_projectTypeCombo_activated" ID="ProjectBrowserPage.on_projectTypeCombo_activated"></a>
175 <h4>ProjectBrowserPage.on_projectTypeCombo_activated</h4>
176 <b>on_projectTypeCombo_activated</b>(<i>index</i>)
177
178 <p>
179 Private slot to set the browser checkboxes according to the selected
180 project type.
181 </p>
182 <dl>
183
184 <dt><i>index</i></dt>
185 <dd>
186 index of the selected project type (integer)
187 </dd>
188 </dl>
189 <a NAME="ProjectBrowserPage.save" ID="ProjectBrowserPage.save"></a>
190 <h4>ProjectBrowserPage.save</h4>
191 <b>save</b>(<i></i>)
192
193 <p>
194 Public slot to save the Project Browser 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>

eric ide

mercurial