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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9530
c30f02ea1b27
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.ProjectBrowserPage</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.ProjectBrowserPage</h1>
10
11 <p>
12 Module implementing the Project Browser 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="#ProjectBrowserPage">ProjectBrowserPage</a></td>
25 <td>Class implementing the Project Browser 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="ProjectBrowserPage" ID="ProjectBrowserPage"></a>
40 <h2>ProjectBrowserPage</h2>
41
42 <p>
43 Class implementing the Project Browser configuration page.
44 </p>
45 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_ProjectBrowserPage
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="#ProjectBrowserPage.__init__">ProjectBrowserPage</a></td>
63 <td>Constructor</td>
64 </tr>
65 <tr>
66 <td><a href="#ProjectBrowserPage.__setProjectBrowsersCheckBoxes">__setProjectBrowsersCheckBoxes</a></td>
67 <td>Private method to set the checkboxes according to the selected project type.</td>
68 </tr>
69 <tr>
70 <td><a href="#ProjectBrowserPage.__storeProjectBrowserFlags">__storeProjectBrowserFlags</a></td>
71 <td>Private method to store the flags for the selected project type.</td>
72 </tr>
73 <tr>
74 <td><a href="#ProjectBrowserPage.on_followCursorLineCheckBox_toggled">on_followCursorLineCheckBox_toggled</a></td>
75 <td>Private slot to handle the change of the 'Follow Cursor Line' checkbox.</td>
76 </tr>
77 <tr>
78 <td><a href="#ProjectBrowserPage.on_followEditorCheckBox_toggled">on_followEditorCheckBox_toggled</a></td>
79 <td>Private slot to handle the change of the 'Follow Editor' checkbox.</td>
80 </tr>
81 <tr>
82 <td><a href="#ProjectBrowserPage.on_projectTypeCombo_activated">on_projectTypeCombo_activated</a></td>
83 <td>Private slot to set the browser checkboxes according to the selected project type.</td>
84 </tr>
85 <tr>
86 <td><a href="#ProjectBrowserPage.save">save</a></td>
87 <td>Public slot to save the Project Browser 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="ProjectBrowserPage.__init__" ID="ProjectBrowserPage.__init__"></a>
97 <h4>ProjectBrowserPage (Constructor)</h4>
98 <b>ProjectBrowserPage</b>(<i></i>)
99
100 <p>
101 Constructor
102 </p>
103 <a NAME="ProjectBrowserPage.__setProjectBrowsersCheckBoxes" ID="ProjectBrowserPage.__setProjectBrowsersCheckBoxes"></a>
104 <h4>ProjectBrowserPage.__setProjectBrowsersCheckBoxes</h4>
105 <b>__setProjectBrowsersCheckBoxes</b>(<i>projectType</i>)
106
107 <p>
108 Private method to set the checkboxes according to the selected project
109 type.
110 </p>
111 <dl>
112
113 <dt><i>projectType</i></dt>
114 <dd>
115 type of the selected project (string)
116 </dd>
117 </dl>
118 <a NAME="ProjectBrowserPage.__storeProjectBrowserFlags" ID="ProjectBrowserPage.__storeProjectBrowserFlags"></a>
119 <h4>ProjectBrowserPage.__storeProjectBrowserFlags</h4>
120 <b>__storeProjectBrowserFlags</b>(<i>projectType</i>)
121
122 <p>
123 Private method to store the flags for the selected project 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.on_followCursorLineCheckBox_toggled" ID="ProjectBrowserPage.on_followCursorLineCheckBox_toggled"></a>
133 <h4>ProjectBrowserPage.on_followCursorLineCheckBox_toggled</h4>
134 <b>on_followCursorLineCheckBox_toggled</b>(<i>checked</i>)
135
136 <p>
137 Private slot to handle the change of the 'Follow Cursor Line' checkbox.
138 </p>
139 <dl>
140
141 <dt><i>checked</i></dt>
142 <dd>
143 flag indicating the state of the checkbox
144 </dd>
145 </dl>
146 <a NAME="ProjectBrowserPage.on_followEditorCheckBox_toggled" ID="ProjectBrowserPage.on_followEditorCheckBox_toggled"></a>
147 <h4>ProjectBrowserPage.on_followEditorCheckBox_toggled</h4>
148 <b>on_followEditorCheckBox_toggled</b>(<i>checked</i>)
149
150 <p>
151 Private slot to handle the change of the 'Follow Editor' 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_projectTypeCombo_activated" ID="ProjectBrowserPage.on_projectTypeCombo_activated"></a>
161 <h4>ProjectBrowserPage.on_projectTypeCombo_activated</h4>
162 <b>on_projectTypeCombo_activated</b>(<i>index</i>)
163
164 <p>
165 Private slot to set the browser checkboxes according to the selected
166 project type.
167 </p>
168 <dl>
169
170 <dt><i>index</i></dt>
171 <dd>
172 index of the selected project type (integer)
173 </dd>
174 </dl>
175 <a NAME="ProjectBrowserPage.save" ID="ProjectBrowserPage.save"></a>
176 <h4>ProjectBrowserPage.save</h4>
177 <b>save</b>(<i></i>)
178
179 <p>
180 Public slot to save the Project Browser configuration.
181 </p>
182 <div align="right"><a href="#top">Up</a></div>
183 <hr />
184 <hr />
185 <a NAME="create" ID="create"></a>
186 <h2>create</h2>
187 <b>create</b>(<i>dlg</i>)
188
189 <p>
190 Module function to create the configuration page.
191 </p>
192 <dl>
193
194 <dt><i>dlg</i></dt>
195 <dd>
196 reference to the configuration dialog
197 </dd>
198 </dl>
199 <dl>
200 <dt>Return:</dt>
201 <dd>
202 reference to the instantiated page (ConfigurationPageBase)
203 </dd>
204 </dl>
205 <div align="right"><a href="#top">Up</a></div>
206 <hr />
207 </body></html>

eric ide

mercurial