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

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Preferences.ConfigurationPages.ProjectBrowserPage</h1>
23 <p>
24 Module implementing the Project Browser 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="#ProjectBrowserPage">ProjectBrowserPage</a></td>
34 <td>Class implementing the Project Browser 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="ProjectBrowserPage" ID="ProjectBrowserPage"></a>
46 <h2>ProjectBrowserPage</h2>
47 <p>
48 Class implementing the Project Browser configuration page.
49 </p>
50 <h3>Derived from</h3>
51 ConfigurationPageBase, Ui_ProjectBrowserPage
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="#ProjectBrowserPage.__init__">ProjectBrowserPage</a></td>
64 <td>Constructor</td>
65 </tr><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><tr>
69 <td><a href="#ProjectBrowserPage.__storeProjectBrowserFlags">__storeProjectBrowserFlags</a></td>
70 <td>Private method to store the flags for the selected project type.</td>
71 </tr><tr>
72 <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>
74 </tr><tr>
75 <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>
77 </tr><tr>
78 <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>
80 </tr><tr>
81 <td><a href="#ProjectBrowserPage.save">save</a></td>
82 <td>Public slot to save the Project Browser configuration.</td>
83 </tr>
84 </table>
85 <h3>Static Methods</h3>
86 <table>
87 <tr><td>None</td></tr>
88 </table>
89 <a NAME="ProjectBrowserPage.__init__" ID="ProjectBrowserPage.__init__"></a>
90 <h4>ProjectBrowserPage (Constructor)</h4>
91 <b>ProjectBrowserPage</b>(<i></i>)
92 <p>
93 Constructor
94 </p><a NAME="ProjectBrowserPage.__setProjectBrowsersCheckBoxes" ID="ProjectBrowserPage.__setProjectBrowsersCheckBoxes"></a>
95 <h4>ProjectBrowserPage.__setProjectBrowsersCheckBoxes</h4>
96 <b>__setProjectBrowsersCheckBoxes</b>(<i>projectType</i>)
97 <p>
98 Private method to set the checkboxes according to the selected project
99 type.
100 </p><dl>
101 <dt><i>projectType</i></dt>
102 <dd>
103 type of the selected project (string)
104 </dd>
105 </dl><a NAME="ProjectBrowserPage.__storeProjectBrowserFlags" ID="ProjectBrowserPage.__storeProjectBrowserFlags"></a>
106 <h4>ProjectBrowserPage.__storeProjectBrowserFlags</h4>
107 <b>__storeProjectBrowserFlags</b>(<i>projectType</i>)
108 <p>
109 Private method to store the flags for the selected project type.
110 </p><dl>
111 <dt><i>projectType</i></dt>
112 <dd>
113 type of the selected project (string)
114 </dd>
115 </dl><a NAME="ProjectBrowserPage.on_followCursorLineCheckBox_toggled" ID="ProjectBrowserPage.on_followCursorLineCheckBox_toggled"></a>
116 <h4>ProjectBrowserPage.on_followCursorLineCheckBox_toggled</h4>
117 <b>on_followCursorLineCheckBox_toggled</b>(<i>checked</i>)
118 <p>
119 Private slot to handle the change of the 'Follow Cursor Line' checkbox.
120 </p><dl>
121 <dt><i>checked</i></dt>
122 <dd>
123 flag indicating the state of the checkbox
124 </dd>
125 </dl><a NAME="ProjectBrowserPage.on_followEditorCheckBox_toggled" ID="ProjectBrowserPage.on_followEditorCheckBox_toggled"></a>
126 <h4>ProjectBrowserPage.on_followEditorCheckBox_toggled</h4>
127 <b>on_followEditorCheckBox_toggled</b>(<i>checked</i>)
128 <p>
129 Private slot to handle the change of the 'Follow Editor' checkbox.
130 </p><dl>
131 <dt><i>checked</i></dt>
132 <dd>
133 flag indicating the state of the checkbox
134 </dd>
135 </dl><a NAME="ProjectBrowserPage.on_projectTypeCombo_activated" ID="ProjectBrowserPage.on_projectTypeCombo_activated"></a>
136 <h4>ProjectBrowserPage.on_projectTypeCombo_activated</h4>
137 <b>on_projectTypeCombo_activated</b>(<i>index</i>)
138 <p>
139 Private slot to set the browser checkboxes according to the selected
140 project type.
141 </p><dl>
142 <dt><i>index</i></dt>
143 <dd>
144 index of the selected project type (integer)
145 </dd>
146 </dl><a NAME="ProjectBrowserPage.save" ID="ProjectBrowserPage.save"></a>
147 <h4>ProjectBrowserPage.save</h4>
148 <b>save</b>(<i></i>)
149 <p>
150 Public slot to save the Project Browser 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>

eric ide

mercurial