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.Project.ProjectBaseBrowser</h1> |
23 <h1>eric6.Project.ProjectBaseBrowser</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing the baseclass for the various project browsers. |
26 Module implementing the baseclass for the various project browsers. |
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> |
|
34 |
31 <table> |
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#ProjectBaseBrowser">ProjectBaseBrowser</a></td> |
38 <td><a href="#ProjectBaseBrowser">ProjectBaseBrowser</a></td> |
34 <td>Baseclass implementing common functionality for the various project browsers.</td> |
39 <td>Baseclass implementing common functionality for the various project browsers.</td> |
35 </tr> |
40 </tr> |
36 </table> |
41 </table> |
37 <h3>Functions</h3> |
42 <h3>Functions</h3> |
|
43 |
38 <table> |
44 <table> |
39 <tr><td>None</td></tr> |
45 <tr><td>None</td></tr> |
40 </table> |
46 </table> |
41 <hr /><hr /> |
47 <hr /> |
|
48 <hr /> |
42 <a NAME="ProjectBaseBrowser" ID="ProjectBaseBrowser"></a> |
49 <a NAME="ProjectBaseBrowser" ID="ProjectBaseBrowser"></a> |
43 <h2>ProjectBaseBrowser</h2> |
50 <h2>ProjectBaseBrowser</h2> |
|
51 |
44 <p> |
52 <p> |
45 Baseclass implementing common functionality for the various project |
53 Baseclass implementing common functionality for the various project |
46 browsers. |
54 browsers. |
47 </p><h3>Signals</h3> |
55 </p> |
48 <dl> |
56 <h3>Signals</h3> |
|
57 <dl> |
|
58 |
49 <dt>closeSourceWindow(str)</dt> |
59 <dt>closeSourceWindow(str)</dt> |
50 <dd> |
60 <dd> |
51 emitted to close a source file |
61 emitted to close a source file |
52 </dd> |
62 </dd> |
53 </dl> |
63 </dl> |
54 <h3>Derived from</h3> |
64 <h3>Derived from</h3> |
55 Browser |
65 Browser |
56 <h3>Class Attributes</h3> |
66 <h3>Class Attributes</h3> |
|
67 |
57 <table> |
68 <table> |
58 <tr><td>None</td></tr> |
69 <tr><td>None</td></tr> |
59 </table> |
70 </table> |
60 <h3>Class Methods</h3> |
71 <h3>Class Methods</h3> |
|
72 |
61 <table> |
73 <table> |
62 <tr><td>None</td></tr> |
74 <tr><td>None</td></tr> |
63 </table> |
75 </table> |
64 <h3>Methods</h3> |
76 <h3>Methods</h3> |
|
77 |
65 <table> |
78 <table> |
|
79 |
66 <tr> |
80 <tr> |
67 <td><a href="#ProjectBaseBrowser.__init__">ProjectBaseBrowser</a></td> |
81 <td><a href="#ProjectBaseBrowser.__init__">ProjectBaseBrowser</a></td> |
68 <td>Constructor</td> |
82 <td>Constructor</td> |
69 </tr><tr> |
83 </tr> |
|
84 <tr> |
70 <td><a href="#ProjectBaseBrowser.__checkHookKey">__checkHookKey</a></td> |
85 <td><a href="#ProjectBaseBrowser.__checkHookKey">__checkHookKey</a></td> |
71 <td>Private method to check a hook key.</td> |
86 <td>Private method to check a hook key.</td> |
72 </tr><tr> |
87 </tr> |
|
88 <tr> |
73 <td><a href="#ProjectBaseBrowser.__modelRowsInserted">__modelRowsInserted</a></td> |
89 <td><a href="#ProjectBaseBrowser.__modelRowsInserted">__modelRowsInserted</a></td> |
74 <td>Private slot called after rows have been inserted into the model.</td> |
90 <td>Private slot called after rows have been inserted into the model.</td> |
75 </tr><tr> |
91 </tr> |
|
92 <tr> |
76 <td><a href="#ProjectBaseBrowser._collapseAllDirs">_collapseAllDirs</a></td> |
93 <td><a href="#ProjectBaseBrowser._collapseAllDirs">_collapseAllDirs</a></td> |
77 <td>Protected slot to handle the 'Collapse all directories' menu action.</td> |
94 <td>Protected slot to handle the 'Collapse all directories' menu action.</td> |
78 </tr><tr> |
95 </tr> |
|
96 <tr> |
79 <td><a href="#ProjectBaseBrowser._completeRepopulateItem">_completeRepopulateItem</a></td> |
97 <td><a href="#ProjectBaseBrowser._completeRepopulateItem">_completeRepopulateItem</a></td> |
80 <td>Protected slot to handle the completeRepopulateItem signal.</td> |
98 <td>Protected slot to handle the completeRepopulateItem signal.</td> |
81 </tr><tr> |
99 </tr> |
|
100 <tr> |
82 <td><a href="#ProjectBaseBrowser._configure">_configure</a></td> |
101 <td><a href="#ProjectBaseBrowser._configure">_configure</a></td> |
83 <td>Protected method to open the configuration dialog.</td> |
102 <td>Protected method to open the configuration dialog.</td> |
84 </tr><tr> |
103 </tr> |
|
104 <tr> |
85 <td><a href="#ProjectBaseBrowser._connectExpandedCollapsed">_connectExpandedCollapsed</a></td> |
105 <td><a href="#ProjectBaseBrowser._connectExpandedCollapsed">_connectExpandedCollapsed</a></td> |
86 <td>Protected method to connect the expanded and collapsed signals.</td> |
106 <td>Protected method to connect the expanded and collapsed signals.</td> |
87 </tr><tr> |
107 </tr> |
|
108 <tr> |
88 <td><a href="#ProjectBaseBrowser._contextMenuRequested">_contextMenuRequested</a></td> |
109 <td><a href="#ProjectBaseBrowser._contextMenuRequested">_contextMenuRequested</a></td> |
89 <td>Protected slot to show the context menu.</td> |
110 <td>Protected slot to show the context menu.</td> |
90 </tr><tr> |
111 </tr> |
|
112 <tr> |
91 <td><a href="#ProjectBaseBrowser._copyToClipboard">_copyToClipboard</a></td> |
113 <td><a href="#ProjectBaseBrowser._copyToClipboard">_copyToClipboard</a></td> |
92 <td>Protected method to copy the path of an entry to the clipboard.</td> |
114 <td>Protected method to copy the path of an entry to the clipboard.</td> |
93 </tr><tr> |
115 </tr> |
|
116 <tr> |
94 <td><a href="#ProjectBaseBrowser._createPopupMenus">_createPopupMenus</a></td> |
117 <td><a href="#ProjectBaseBrowser._createPopupMenus">_createPopupMenus</a></td> |
95 <td>Protected overloaded method to generate the popup menus.</td> |
118 <td>Protected overloaded method to generate the popup menus.</td> |
96 </tr><tr> |
119 </tr> |
|
120 <tr> |
97 <td><a href="#ProjectBaseBrowser._deleteDirectory">_deleteDirectory</a></td> |
121 <td><a href="#ProjectBaseBrowser._deleteDirectory">_deleteDirectory</a></td> |
98 <td>Protected method to delete the selected directory from the project data area.</td> |
122 <td>Protected method to delete the selected directory from the project data area.</td> |
99 </tr><tr> |
123 </tr> |
|
124 <tr> |
100 <td><a href="#ProjectBaseBrowser._disconnectExpandedCollapsed">_disconnectExpandedCollapsed</a></td> |
125 <td><a href="#ProjectBaseBrowser._disconnectExpandedCollapsed">_disconnectExpandedCollapsed</a></td> |
101 <td>Protected method to disconnect the expanded and collapsed signals.</td> |
126 <td>Protected method to disconnect the expanded and collapsed signals.</td> |
102 </tr><tr> |
127 </tr> |
|
128 <tr> |
103 <td><a href="#ProjectBaseBrowser._expandAllDirs">_expandAllDirs</a></td> |
129 <td><a href="#ProjectBaseBrowser._expandAllDirs">_expandAllDirs</a></td> |
104 <td>Protected slot to handle the 'Expand all directories' menu action.</td> |
130 <td>Protected slot to handle the 'Expand all directories' menu action.</td> |
105 </tr><tr> |
131 </tr> |
|
132 <tr> |
106 <td><a href="#ProjectBaseBrowser._initHookMethods">_initHookMethods</a></td> |
133 <td><a href="#ProjectBaseBrowser._initHookMethods">_initHookMethods</a></td> |
107 <td>Protected method to initialize the hooks dictionary.</td> |
134 <td>Protected method to initialize the hooks dictionary.</td> |
108 </tr><tr> |
135 </tr> |
|
136 <tr> |
109 <td><a href="#ProjectBaseBrowser._initMenusAndVcs">_initMenusAndVcs</a></td> |
137 <td><a href="#ProjectBaseBrowser._initMenusAndVcs">_initMenusAndVcs</a></td> |
110 <td>Protected slot to initialize the menus and the Vcs interface.</td> |
138 <td>Protected slot to initialize the menus and the Vcs interface.</td> |
111 </tr><tr> |
139 </tr> |
|
140 <tr> |
112 <td><a href="#ProjectBaseBrowser._keyboardSearchType">_keyboardSearchType</a></td> |
141 <td><a href="#ProjectBaseBrowser._keyboardSearchType">_keyboardSearchType</a></td> |
113 <td>Protected method to check, if the item is of the correct type.</td> |
142 <td>Protected method to check, if the item is of the correct type.</td> |
114 </tr><tr> |
143 </tr> |
|
144 <tr> |
115 <td><a href="#ProjectBaseBrowser._newProject">_newProject</a></td> |
145 <td><a href="#ProjectBaseBrowser._newProject">_newProject</a></td> |
116 <td>Protected slot to handle the newProject signal.</td> |
146 <td>Protected slot to handle the newProject signal.</td> |
117 </tr><tr> |
147 </tr> |
|
148 <tr> |
118 <td><a href="#ProjectBaseBrowser._prepareRepopulateItem">_prepareRepopulateItem</a></td> |
149 <td><a href="#ProjectBaseBrowser._prepareRepopulateItem">_prepareRepopulateItem</a></td> |
119 <td>Protected slot to handle the prepareRepopulateItem signal.</td> |
150 <td>Protected slot to handle the prepareRepopulateItem signal.</td> |
120 </tr><tr> |
151 </tr> |
|
152 <tr> |
121 <td><a href="#ProjectBaseBrowser._projectClosed">_projectClosed</a></td> |
153 <td><a href="#ProjectBaseBrowser._projectClosed">_projectClosed</a></td> |
122 <td>Protected slot to handle the projectClosed signal.</td> |
154 <td>Protected slot to handle the projectClosed signal.</td> |
123 </tr><tr> |
155 </tr> |
|
156 <tr> |
124 <td><a href="#ProjectBaseBrowser._projectOpened">_projectOpened</a></td> |
157 <td><a href="#ProjectBaseBrowser._projectOpened">_projectOpened</a></td> |
125 <td>Protected slot to handle the projectOpened signal.</td> |
158 <td>Protected slot to handle the projectOpened signal.</td> |
126 </tr><tr> |
159 </tr> |
|
160 <tr> |
127 <td><a href="#ProjectBaseBrowser._removeDir">_removeDir</a></td> |
161 <td><a href="#ProjectBaseBrowser._removeDir">_removeDir</a></td> |
128 <td>Protected method to remove a (single) directory from the project.</td> |
162 <td>Protected method to remove a (single) directory from the project.</td> |
129 </tr><tr> |
163 </tr> |
|
164 <tr> |
130 <td><a href="#ProjectBaseBrowser._removeFile">_removeFile</a></td> |
165 <td><a href="#ProjectBaseBrowser._removeFile">_removeFile</a></td> |
131 <td>Protected method to remove a file or files from the project.</td> |
166 <td>Protected method to remove a file or files from the project.</td> |
132 </tr><tr> |
167 </tr> |
|
168 <tr> |
133 <td><a href="#ProjectBaseBrowser._renameFile">_renameFile</a></td> |
169 <td><a href="#ProjectBaseBrowser._renameFile">_renameFile</a></td> |
134 <td>Protected method to rename a file of the project.</td> |
170 <td>Protected method to rename a file of the project.</td> |
135 </tr><tr> |
171 </tr> |
|
172 <tr> |
136 <td><a href="#ProjectBaseBrowser._selectEntries">_selectEntries</a></td> |
173 <td><a href="#ProjectBaseBrowser._selectEntries">_selectEntries</a></td> |
137 <td>Protected method to select entries based on their VCS status.</td> |
174 <td>Protected method to select entries based on their VCS status.</td> |
138 </tr><tr> |
175 </tr> |
|
176 <tr> |
139 <td><a href="#ProjectBaseBrowser._selectSingleItem">_selectSingleItem</a></td> |
177 <td><a href="#ProjectBaseBrowser._selectSingleItem">_selectSingleItem</a></td> |
140 <td>Protected method to select a single item.</td> |
178 <td>Protected method to select a single item.</td> |
141 </tr><tr> |
179 </tr> |
|
180 <tr> |
142 <td><a href="#ProjectBaseBrowser._setItemRangeSelected">_setItemRangeSelected</a></td> |
181 <td><a href="#ProjectBaseBrowser._setItemRangeSelected">_setItemRangeSelected</a></td> |
143 <td>Protected method to set the selection status of a range of items.</td> |
182 <td>Protected method to set the selection status of a range of items.</td> |
144 </tr><tr> |
183 </tr> |
|
184 <tr> |
145 <td><a href="#ProjectBaseBrowser._setItemSelected">_setItemSelected</a></td> |
185 <td><a href="#ProjectBaseBrowser._setItemSelected">_setItemSelected</a></td> |
146 <td>Protected method to set the selection status of an item.</td> |
186 <td>Protected method to set the selection status of an item.</td> |
147 </tr><tr> |
187 </tr> |
|
188 <tr> |
148 <td><a href="#ProjectBaseBrowser._showContextMenu">_showContextMenu</a></td> |
189 <td><a href="#ProjectBaseBrowser._showContextMenu">_showContextMenu</a></td> |
149 <td>Protected slot called before the context menu is shown.</td> |
190 <td>Protected slot called before the context menu is shown.</td> |
150 </tr><tr> |
191 </tr> |
|
192 <tr> |
151 <td><a href="#ProjectBaseBrowser._showContextMenuBack">_showContextMenuBack</a></td> |
193 <td><a href="#ProjectBaseBrowser._showContextMenuBack">_showContextMenuBack</a></td> |
152 <td>Protected slot called before the context menu is shown.</td> |
194 <td>Protected slot called before the context menu is shown.</td> |
153 </tr><tr> |
195 </tr> |
|
196 <tr> |
154 <td><a href="#ProjectBaseBrowser._showContextMenuDir">_showContextMenuDir</a></td> |
197 <td><a href="#ProjectBaseBrowser._showContextMenuDir">_showContextMenuDir</a></td> |
155 <td>Protected slot called before the context menu is shown.</td> |
198 <td>Protected slot called before the context menu is shown.</td> |
156 </tr><tr> |
199 </tr> |
|
200 <tr> |
157 <td><a href="#ProjectBaseBrowser._showContextMenuDirMulti">_showContextMenuDirMulti</a></td> |
201 <td><a href="#ProjectBaseBrowser._showContextMenuDirMulti">_showContextMenuDirMulti</a></td> |
158 <td>Protected slot called before the context menu is shown.</td> |
202 <td>Protected slot called before the context menu is shown.</td> |
159 </tr><tr> |
203 </tr> |
|
204 <tr> |
160 <td><a href="#ProjectBaseBrowser._showContextMenuMulti">_showContextMenuMulti</a></td> |
205 <td><a href="#ProjectBaseBrowser._showContextMenuMulti">_showContextMenuMulti</a></td> |
161 <td>Protected slot called before the context menu (multiple selections) is shown.</td> |
206 <td>Protected slot called before the context menu (multiple selections) is shown.</td> |
162 </tr><tr> |
207 </tr> |
|
208 <tr> |
163 <td><a href="#ProjectBaseBrowser.addHookMethod">addHookMethod</a></td> |
209 <td><a href="#ProjectBaseBrowser.addHookMethod">addHookMethod</a></td> |
164 <td>Public method to add a hook method to the dictionary.</td> |
210 <td>Public method to add a hook method to the dictionary.</td> |
165 </tr><tr> |
211 </tr> |
|
212 <tr> |
166 <td><a href="#ProjectBaseBrowser.addHookMethodAndMenuEntry">addHookMethodAndMenuEntry</a></td> |
213 <td><a href="#ProjectBaseBrowser.addHookMethodAndMenuEntry">addHookMethodAndMenuEntry</a></td> |
167 <td>Public method to add a hook method to the dictionary.</td> |
214 <td>Public method to add a hook method to the dictionary.</td> |
168 </tr><tr> |
215 </tr> |
|
216 <tr> |
169 <td><a href="#ProjectBaseBrowser.currentItem">currentItem</a></td> |
217 <td><a href="#ProjectBaseBrowser.currentItem">currentItem</a></td> |
170 <td>Public method to get a reference to the current item.</td> |
218 <td>Public method to get a reference to the current item.</td> |
171 </tr><tr> |
219 </tr> |
|
220 <tr> |
172 <td><a href="#ProjectBaseBrowser.expandItemsByName">expandItemsByName</a></td> |
221 <td><a href="#ProjectBaseBrowser.expandItemsByName">expandItemsByName</a></td> |
173 <td>Public method to expand items given their names.</td> |
222 <td>Public method to expand items given their names.</td> |
174 </tr><tr> |
223 </tr> |
|
224 <tr> |
175 <td><a href="#ProjectBaseBrowser.getExpandedItemNames">getExpandedItemNames</a></td> |
225 <td><a href="#ProjectBaseBrowser.getExpandedItemNames">getExpandedItemNames</a></td> |
176 <td>Public method to get the file/directory names of all expanded items.</td> |
226 <td>Public method to get the file/directory names of all expanded items.</td> |
177 </tr><tr> |
227 </tr> |
|
228 <tr> |
178 <td><a href="#ProjectBaseBrowser.removeHookMethod">removeHookMethod</a></td> |
229 <td><a href="#ProjectBaseBrowser.removeHookMethod">removeHookMethod</a></td> |
179 <td>Public method to remove a hook method from the dictionary.</td> |
230 <td>Public method to remove a hook method from the dictionary.</td> |
180 </tr><tr> |
231 </tr> |
|
232 <tr> |
181 <td><a href="#ProjectBaseBrowser.selectFile">selectFile</a></td> |
233 <td><a href="#ProjectBaseBrowser.selectFile">selectFile</a></td> |
182 <td>Public method to highlight a node given its filename.</td> |
234 <td>Public method to highlight a node given its filename.</td> |
183 </tr><tr> |
235 </tr> |
|
236 <tr> |
184 <td><a href="#ProjectBaseBrowser.selectFileLine">selectFileLine</a></td> |
237 <td><a href="#ProjectBaseBrowser.selectFileLine">selectFileLine</a></td> |
185 <td>Public method to highlight a node given its filename.</td> |
238 <td>Public method to highlight a node given its filename.</td> |
186 </tr><tr> |
239 </tr> |
|
240 <tr> |
187 <td><a href="#ProjectBaseBrowser.selectLocalDirEntries">selectLocalDirEntries</a></td> |
241 <td><a href="#ProjectBaseBrowser.selectLocalDirEntries">selectLocalDirEntries</a></td> |
188 <td>Public slot to handle the select local directories context menu entries.</td> |
242 <td>Public slot to handle the select local directories context menu entries.</td> |
189 </tr><tr> |
243 </tr> |
|
244 <tr> |
190 <td><a href="#ProjectBaseBrowser.selectLocalEntries">selectLocalEntries</a></td> |
245 <td><a href="#ProjectBaseBrowser.selectLocalEntries">selectLocalEntries</a></td> |
191 <td>Public slot to handle the select local files context menu entries.</td> |
246 <td>Public slot to handle the select local files context menu entries.</td> |
192 </tr><tr> |
247 </tr> |
|
248 <tr> |
193 <td><a href="#ProjectBaseBrowser.selectVCSDirEntries">selectVCSDirEntries</a></td> |
249 <td><a href="#ProjectBaseBrowser.selectVCSDirEntries">selectVCSDirEntries</a></td> |
194 <td>Public slot to handle the select VCS directories context menu entries.</td> |
250 <td>Public slot to handle the select VCS directories context menu entries.</td> |
195 </tr><tr> |
251 </tr> |
|
252 <tr> |
196 <td><a href="#ProjectBaseBrowser.selectVCSEntries">selectVCSEntries</a></td> |
253 <td><a href="#ProjectBaseBrowser.selectVCSEntries">selectVCSEntries</a></td> |
197 <td>Public slot to handle the select VCS files context menu entries.</td> |
254 <td>Public slot to handle the select VCS files context menu entries.</td> |
198 </tr> |
255 </tr> |
199 </table> |
256 </table> |
200 <h3>Static Methods</h3> |
257 <h3>Static Methods</h3> |
|
258 |
201 <table> |
259 <table> |
202 <tr><td>None</td></tr> |
260 <tr><td>None</td></tr> |
203 </table> |
261 </table> |
|
262 |
204 <a NAME="ProjectBaseBrowser.__init__" ID="ProjectBaseBrowser.__init__"></a> |
263 <a NAME="ProjectBaseBrowser.__init__" ID="ProjectBaseBrowser.__init__"></a> |
205 <h4>ProjectBaseBrowser (Constructor)</h4> |
264 <h4>ProjectBaseBrowser (Constructor)</h4> |
206 <b>ProjectBaseBrowser</b>(<i>project, type_, parent=None</i>) |
265 <b>ProjectBaseBrowser</b>(<i>project, type_, parent=None</i>) |
|
266 |
207 <p> |
267 <p> |
208 Constructor |
268 Constructor |
209 </p><dl> |
269 </p> |
|
270 <dl> |
|
271 |
210 <dt><i>project</i></dt> |
272 <dt><i>project</i></dt> |
211 <dd> |
273 <dd> |
212 reference to the project object |
274 reference to the project object |
213 </dd><dt><i>type_</i></dt> |
275 </dd> |
|
276 <dt><i>type_</i></dt> |
214 <dd> |
277 <dd> |
215 project browser type (string) |
278 project browser type (string) |
216 </dd><dt><i>parent</i></dt> |
279 </dd> |
|
280 <dt><i>parent</i></dt> |
217 <dd> |
281 <dd> |
218 parent widget of this browser |
282 parent widget of this browser |
219 </dd> |
283 </dd> |
220 </dl><a NAME="ProjectBaseBrowser.__checkHookKey" ID="ProjectBaseBrowser.__checkHookKey"></a> |
284 </dl> |
|
285 <a NAME="ProjectBaseBrowser.__checkHookKey" ID="ProjectBaseBrowser.__checkHookKey"></a> |
221 <h4>ProjectBaseBrowser.__checkHookKey</h4> |
286 <h4>ProjectBaseBrowser.__checkHookKey</h4> |
222 <b>__checkHookKey</b>(<i>key</i>) |
287 <b>__checkHookKey</b>(<i>key</i>) |
|
288 |
223 <p> |
289 <p> |
224 Private method to check a hook key. |
290 Private method to check a hook key. |
225 </p><dl> |
291 </p> |
|
292 <dl> |
|
293 |
226 <dt><i>key</i></dt> |
294 <dt><i>key</i></dt> |
227 <dd> |
295 <dd> |
228 key of the hook to check (string) |
296 key of the hook to check (string) |
229 </dd> |
297 </dd> |
230 </dl><dl> |
298 </dl> |
|
299 <dl> |
|
300 |
231 <dt>Raises <b>KeyError</b>:</dt> |
301 <dt>Raises <b>KeyError</b>:</dt> |
232 <dd> |
302 <dd> |
233 raised to indicate an invalid hook |
303 raised to indicate an invalid hook |
234 </dd> |
304 </dd> |
235 </dl><a NAME="ProjectBaseBrowser.__modelRowsInserted" ID="ProjectBaseBrowser.__modelRowsInserted"></a> |
305 </dl> |
|
306 <a NAME="ProjectBaseBrowser.__modelRowsInserted" ID="ProjectBaseBrowser.__modelRowsInserted"></a> |
236 <h4>ProjectBaseBrowser.__modelRowsInserted</h4> |
307 <h4>ProjectBaseBrowser.__modelRowsInserted</h4> |
237 <b>__modelRowsInserted</b>(<i>parent, start, end</i>) |
308 <b>__modelRowsInserted</b>(<i>parent, start, end</i>) |
|
309 |
238 <p> |
310 <p> |
239 Private slot called after rows have been inserted into the model. |
311 Private slot called after rows have been inserted into the model. |
240 </p><dl> |
312 </p> |
|
313 <dl> |
|
314 |
241 <dt><i>parent</i></dt> |
315 <dt><i>parent</i></dt> |
242 <dd> |
316 <dd> |
243 parent index of inserted rows (QModelIndex) |
317 parent index of inserted rows (QModelIndex) |
244 </dd><dt><i>start</i></dt> |
318 </dd> |
|
319 <dt><i>start</i></dt> |
245 <dd> |
320 <dd> |
246 start row number (integer) |
321 start row number (integer) |
247 </dd><dt><i>end</i></dt> |
322 </dd> |
|
323 <dt><i>end</i></dt> |
248 <dd> |
324 <dd> |
249 end row number (integer) |
325 end row number (integer) |
250 </dd> |
326 </dd> |
251 </dl><a NAME="ProjectBaseBrowser._collapseAllDirs" ID="ProjectBaseBrowser._collapseAllDirs"></a> |
327 </dl> |
|
328 <a NAME="ProjectBaseBrowser._collapseAllDirs" ID="ProjectBaseBrowser._collapseAllDirs"></a> |
252 <h4>ProjectBaseBrowser._collapseAllDirs</h4> |
329 <h4>ProjectBaseBrowser._collapseAllDirs</h4> |
253 <b>_collapseAllDirs</b>(<i></i>) |
330 <b>_collapseAllDirs</b>(<i></i>) |
|
331 |
254 <p> |
332 <p> |
255 Protected slot to handle the 'Collapse all directories' menu action. |
333 Protected slot to handle the 'Collapse all directories' menu action. |
256 </p><a NAME="ProjectBaseBrowser._completeRepopulateItem" ID="ProjectBaseBrowser._completeRepopulateItem"></a> |
334 </p> |
|
335 <a NAME="ProjectBaseBrowser._completeRepopulateItem" ID="ProjectBaseBrowser._completeRepopulateItem"></a> |
257 <h4>ProjectBaseBrowser._completeRepopulateItem</h4> |
336 <h4>ProjectBaseBrowser._completeRepopulateItem</h4> |
258 <b>_completeRepopulateItem</b>(<i>name</i>) |
337 <b>_completeRepopulateItem</b>(<i>name</i>) |
|
338 |
259 <p> |
339 <p> |
260 Protected slot to handle the completeRepopulateItem signal. |
340 Protected slot to handle the completeRepopulateItem signal. |
261 </p><dl> |
341 </p> |
|
342 <dl> |
|
343 |
262 <dt><i>name</i></dt> |
344 <dt><i>name</i></dt> |
263 <dd> |
345 <dd> |
264 relative name of file item to be repopulated (string) |
346 relative name of file item to be repopulated (string) |
265 </dd> |
347 </dd> |
266 </dl><a NAME="ProjectBaseBrowser._configure" ID="ProjectBaseBrowser._configure"></a> |
348 </dl> |
|
349 <a NAME="ProjectBaseBrowser._configure" ID="ProjectBaseBrowser._configure"></a> |
267 <h4>ProjectBaseBrowser._configure</h4> |
350 <h4>ProjectBaseBrowser._configure</h4> |
268 <b>_configure</b>(<i></i>) |
351 <b>_configure</b>(<i></i>) |
|
352 |
269 <p> |
353 <p> |
270 Protected method to open the configuration dialog. |
354 Protected method to open the configuration dialog. |
271 </p><a NAME="ProjectBaseBrowser._connectExpandedCollapsed" ID="ProjectBaseBrowser._connectExpandedCollapsed"></a> |
355 </p> |
|
356 <a NAME="ProjectBaseBrowser._connectExpandedCollapsed" ID="ProjectBaseBrowser._connectExpandedCollapsed"></a> |
272 <h4>ProjectBaseBrowser._connectExpandedCollapsed</h4> |
357 <h4>ProjectBaseBrowser._connectExpandedCollapsed</h4> |
273 <b>_connectExpandedCollapsed</b>(<i></i>) |
358 <b>_connectExpandedCollapsed</b>(<i></i>) |
|
359 |
274 <p> |
360 <p> |
275 Protected method to connect the expanded and collapsed signals. |
361 Protected method to connect the expanded and collapsed signals. |
276 </p><a NAME="ProjectBaseBrowser._contextMenuRequested" ID="ProjectBaseBrowser._contextMenuRequested"></a> |
362 </p> |
|
363 <a NAME="ProjectBaseBrowser._contextMenuRequested" ID="ProjectBaseBrowser._contextMenuRequested"></a> |
277 <h4>ProjectBaseBrowser._contextMenuRequested</h4> |
364 <h4>ProjectBaseBrowser._contextMenuRequested</h4> |
278 <b>_contextMenuRequested</b>(<i>coord</i>) |
365 <b>_contextMenuRequested</b>(<i>coord</i>) |
|
366 |
279 <p> |
367 <p> |
280 Protected slot to show the context menu. |
368 Protected slot to show the context menu. |
281 </p><dl> |
369 </p> |
|
370 <dl> |
|
371 |
282 <dt><i>coord</i></dt> |
372 <dt><i>coord</i></dt> |
283 <dd> |
373 <dd> |
284 the position of the mouse pointer (QPoint) |
374 the position of the mouse pointer (QPoint) |
285 </dd> |
375 </dd> |
286 </dl><a NAME="ProjectBaseBrowser._copyToClipboard" ID="ProjectBaseBrowser._copyToClipboard"></a> |
376 </dl> |
|
377 <a NAME="ProjectBaseBrowser._copyToClipboard" ID="ProjectBaseBrowser._copyToClipboard"></a> |
287 <h4>ProjectBaseBrowser._copyToClipboard</h4> |
378 <h4>ProjectBaseBrowser._copyToClipboard</h4> |
288 <b>_copyToClipboard</b>(<i></i>) |
379 <b>_copyToClipboard</b>(<i></i>) |
|
380 |
289 <p> |
381 <p> |
290 Protected method to copy the path of an entry to the clipboard. |
382 Protected method to copy the path of an entry to the clipboard. |
291 </p><a NAME="ProjectBaseBrowser._createPopupMenus" ID="ProjectBaseBrowser._createPopupMenus"></a> |
383 </p> |
|
384 <a NAME="ProjectBaseBrowser._createPopupMenus" ID="ProjectBaseBrowser._createPopupMenus"></a> |
292 <h4>ProjectBaseBrowser._createPopupMenus</h4> |
385 <h4>ProjectBaseBrowser._createPopupMenus</h4> |
293 <b>_createPopupMenus</b>(<i></i>) |
386 <b>_createPopupMenus</b>(<i></i>) |
|
387 |
294 <p> |
388 <p> |
295 Protected overloaded method to generate the popup menus. |
389 Protected overloaded method to generate the popup menus. |
296 </p><a NAME="ProjectBaseBrowser._deleteDirectory" ID="ProjectBaseBrowser._deleteDirectory"></a> |
390 </p> |
|
391 <a NAME="ProjectBaseBrowser._deleteDirectory" ID="ProjectBaseBrowser._deleteDirectory"></a> |
297 <h4>ProjectBaseBrowser._deleteDirectory</h4> |
392 <h4>ProjectBaseBrowser._deleteDirectory</h4> |
298 <b>_deleteDirectory</b>(<i></i>) |
393 <b>_deleteDirectory</b>(<i></i>) |
|
394 |
299 <p> |
395 <p> |
300 Protected method to delete the selected directory from the project |
396 Protected method to delete the selected directory from the project |
301 data area. |
397 data area. |
302 </p><a NAME="ProjectBaseBrowser._disconnectExpandedCollapsed" ID="ProjectBaseBrowser._disconnectExpandedCollapsed"></a> |
398 </p> |
|
399 <a NAME="ProjectBaseBrowser._disconnectExpandedCollapsed" ID="ProjectBaseBrowser._disconnectExpandedCollapsed"></a> |
303 <h4>ProjectBaseBrowser._disconnectExpandedCollapsed</h4> |
400 <h4>ProjectBaseBrowser._disconnectExpandedCollapsed</h4> |
304 <b>_disconnectExpandedCollapsed</b>(<i></i>) |
401 <b>_disconnectExpandedCollapsed</b>(<i></i>) |
|
402 |
305 <p> |
403 <p> |
306 Protected method to disconnect the expanded and collapsed signals. |
404 Protected method to disconnect the expanded and collapsed signals. |
307 </p><a NAME="ProjectBaseBrowser._expandAllDirs" ID="ProjectBaseBrowser._expandAllDirs"></a> |
405 </p> |
|
406 <a NAME="ProjectBaseBrowser._expandAllDirs" ID="ProjectBaseBrowser._expandAllDirs"></a> |
308 <h4>ProjectBaseBrowser._expandAllDirs</h4> |
407 <h4>ProjectBaseBrowser._expandAllDirs</h4> |
309 <b>_expandAllDirs</b>(<i></i>) |
408 <b>_expandAllDirs</b>(<i></i>) |
|
409 |
310 <p> |
410 <p> |
311 Protected slot to handle the 'Expand all directories' menu action. |
411 Protected slot to handle the 'Expand all directories' menu action. |
312 </p><a NAME="ProjectBaseBrowser._initHookMethods" ID="ProjectBaseBrowser._initHookMethods"></a> |
412 </p> |
|
413 <a NAME="ProjectBaseBrowser._initHookMethods" ID="ProjectBaseBrowser._initHookMethods"></a> |
313 <h4>ProjectBaseBrowser._initHookMethods</h4> |
414 <h4>ProjectBaseBrowser._initHookMethods</h4> |
314 <b>_initHookMethods</b>(<i></i>) |
415 <b>_initHookMethods</b>(<i></i>) |
|
416 |
315 <p> |
417 <p> |
316 Protected method to initialize the hooks dictionary. |
418 Protected method to initialize the hooks dictionary. |
317 </p><p> |
419 </p> |
|
420 <p> |
318 This method should be overridden by subclasses. All supported |
421 This method should be overridden by subclasses. All supported |
319 hook methods should be initialized with a None value. The keys |
422 hook methods should be initialized with a None value. The keys |
320 must be strings. |
423 must be strings. |
321 </p><a NAME="ProjectBaseBrowser._initMenusAndVcs" ID="ProjectBaseBrowser._initMenusAndVcs"></a> |
424 </p> |
|
425 <a NAME="ProjectBaseBrowser._initMenusAndVcs" ID="ProjectBaseBrowser._initMenusAndVcs"></a> |
322 <h4>ProjectBaseBrowser._initMenusAndVcs</h4> |
426 <h4>ProjectBaseBrowser._initMenusAndVcs</h4> |
323 <b>_initMenusAndVcs</b>(<i></i>) |
427 <b>_initMenusAndVcs</b>(<i></i>) |
|
428 |
324 <p> |
429 <p> |
325 Protected slot to initialize the menus and the Vcs interface. |
430 Protected slot to initialize the menus and the Vcs interface. |
326 </p><a NAME="ProjectBaseBrowser._keyboardSearchType" ID="ProjectBaseBrowser._keyboardSearchType"></a> |
431 </p> |
|
432 <a NAME="ProjectBaseBrowser._keyboardSearchType" ID="ProjectBaseBrowser._keyboardSearchType"></a> |
327 <h4>ProjectBaseBrowser._keyboardSearchType</h4> |
433 <h4>ProjectBaseBrowser._keyboardSearchType</h4> |
328 <b>_keyboardSearchType</b>(<i>item</i>) |
434 <b>_keyboardSearchType</b>(<i>item</i>) |
|
435 |
329 <p> |
436 <p> |
330 Protected method to check, if the item is of the correct type. |
437 Protected method to check, if the item is of the correct type. |
331 </p><dl> |
438 </p> |
|
439 <dl> |
|
440 |
332 <dt><i>item</i> (BrowserItem)</dt> |
441 <dt><i>item</i> (BrowserItem)</dt> |
333 <dd> |
442 <dd> |
334 reference to the item |
443 reference to the item |
335 </dd> |
444 </dd> |
336 </dl><dl> |
445 </dl> |
|
446 <dl> |
337 <dt>Returns:</dt> |
447 <dt>Returns:</dt> |
338 <dd> |
448 <dd> |
339 flag indicating a correct type |
449 flag indicating a correct type |
340 </dd> |
450 </dd> |
341 </dl><dl> |
451 </dl> |
|
452 <dl> |
342 <dt>Return Type:</dt> |
453 <dt>Return Type:</dt> |
343 <dd> |
454 <dd> |
344 bool |
455 bool |
345 </dd> |
456 </dd> |
346 </dl><a NAME="ProjectBaseBrowser._newProject" ID="ProjectBaseBrowser._newProject"></a> |
457 </dl> |
|
458 <a NAME="ProjectBaseBrowser._newProject" ID="ProjectBaseBrowser._newProject"></a> |
347 <h4>ProjectBaseBrowser._newProject</h4> |
459 <h4>ProjectBaseBrowser._newProject</h4> |
348 <b>_newProject</b>(<i></i>) |
460 <b>_newProject</b>(<i></i>) |
|
461 |
349 <p> |
462 <p> |
350 Protected slot to handle the newProject signal. |
463 Protected slot to handle the newProject signal. |
351 </p><a NAME="ProjectBaseBrowser._prepareRepopulateItem" ID="ProjectBaseBrowser._prepareRepopulateItem"></a> |
464 </p> |
|
465 <a NAME="ProjectBaseBrowser._prepareRepopulateItem" ID="ProjectBaseBrowser._prepareRepopulateItem"></a> |
352 <h4>ProjectBaseBrowser._prepareRepopulateItem</h4> |
466 <h4>ProjectBaseBrowser._prepareRepopulateItem</h4> |
353 <b>_prepareRepopulateItem</b>(<i>name</i>) |
467 <b>_prepareRepopulateItem</b>(<i>name</i>) |
|
468 |
354 <p> |
469 <p> |
355 Protected slot to handle the prepareRepopulateItem signal. |
470 Protected slot to handle the prepareRepopulateItem signal. |
356 </p><dl> |
471 </p> |
|
472 <dl> |
|
473 |
357 <dt><i>name</i></dt> |
474 <dt><i>name</i></dt> |
358 <dd> |
475 <dd> |
359 relative name of file item to be repopulated (string) |
476 relative name of file item to be repopulated (string) |
360 </dd> |
477 </dd> |
361 </dl><a NAME="ProjectBaseBrowser._projectClosed" ID="ProjectBaseBrowser._projectClosed"></a> |
478 </dl> |
|
479 <a NAME="ProjectBaseBrowser._projectClosed" ID="ProjectBaseBrowser._projectClosed"></a> |
362 <h4>ProjectBaseBrowser._projectClosed</h4> |
480 <h4>ProjectBaseBrowser._projectClosed</h4> |
363 <b>_projectClosed</b>(<i></i>) |
481 <b>_projectClosed</b>(<i></i>) |
|
482 |
364 <p> |
483 <p> |
365 Protected slot to handle the projectClosed signal. |
484 Protected slot to handle the projectClosed signal. |
366 </p><a NAME="ProjectBaseBrowser._projectOpened" ID="ProjectBaseBrowser._projectOpened"></a> |
485 </p> |
|
486 <a NAME="ProjectBaseBrowser._projectOpened" ID="ProjectBaseBrowser._projectOpened"></a> |
367 <h4>ProjectBaseBrowser._projectOpened</h4> |
487 <h4>ProjectBaseBrowser._projectOpened</h4> |
368 <b>_projectOpened</b>(<i></i>) |
488 <b>_projectOpened</b>(<i></i>) |
|
489 |
369 <p> |
490 <p> |
370 Protected slot to handle the projectOpened signal. |
491 Protected slot to handle the projectOpened signal. |
371 </p><a NAME="ProjectBaseBrowser._removeDir" ID="ProjectBaseBrowser._removeDir"></a> |
492 </p> |
|
493 <a NAME="ProjectBaseBrowser._removeDir" ID="ProjectBaseBrowser._removeDir"></a> |
372 <h4>ProjectBaseBrowser._removeDir</h4> |
494 <h4>ProjectBaseBrowser._removeDir</h4> |
373 <b>_removeDir</b>(<i></i>) |
495 <b>_removeDir</b>(<i></i>) |
|
496 |
374 <p> |
497 <p> |
375 Protected method to remove a (single) directory from the project. |
498 Protected method to remove a (single) directory from the project. |
376 </p><a NAME="ProjectBaseBrowser._removeFile" ID="ProjectBaseBrowser._removeFile"></a> |
499 </p> |
|
500 <a NAME="ProjectBaseBrowser._removeFile" ID="ProjectBaseBrowser._removeFile"></a> |
377 <h4>ProjectBaseBrowser._removeFile</h4> |
501 <h4>ProjectBaseBrowser._removeFile</h4> |
378 <b>_removeFile</b>(<i></i>) |
502 <b>_removeFile</b>(<i></i>) |
|
503 |
379 <p> |
504 <p> |
380 Protected method to remove a file or files from the project. |
505 Protected method to remove a file or files from the project. |
381 </p><a NAME="ProjectBaseBrowser._renameFile" ID="ProjectBaseBrowser._renameFile"></a> |
506 </p> |
|
507 <a NAME="ProjectBaseBrowser._renameFile" ID="ProjectBaseBrowser._renameFile"></a> |
382 <h4>ProjectBaseBrowser._renameFile</h4> |
508 <h4>ProjectBaseBrowser._renameFile</h4> |
383 <b>_renameFile</b>(<i></i>) |
509 <b>_renameFile</b>(<i></i>) |
|
510 |
384 <p> |
511 <p> |
385 Protected method to rename a file of the project. |
512 Protected method to rename a file of the project. |
386 </p><a NAME="ProjectBaseBrowser._selectEntries" ID="ProjectBaseBrowser._selectEntries"></a> |
513 </p> |
|
514 <a NAME="ProjectBaseBrowser._selectEntries" ID="ProjectBaseBrowser._selectEntries"></a> |
387 <h4>ProjectBaseBrowser._selectEntries</h4> |
515 <h4>ProjectBaseBrowser._selectEntries</h4> |
388 <b>_selectEntries</b>(<i>local=True, filterList=None</i>) |
516 <b>_selectEntries</b>(<i>local=True, filterList=None</i>) |
|
517 |
389 <p> |
518 <p> |
390 Protected method to select entries based on their VCS status. |
519 Protected method to select entries based on their VCS status. |
391 </p><dl> |
520 </p> |
|
521 <dl> |
|
522 |
392 <dt><i>local</i></dt> |
523 <dt><i>local</i></dt> |
393 <dd> |
524 <dd> |
394 flag indicating local (i.e. non VCS controlled) |
525 flag indicating local (i.e. non VCS controlled) |
395 file/directory entries should be selected (boolean) |
526 file/directory entries should be selected (boolean) |
396 </dd><dt><i>filterList</i></dt> |
527 </dd> |
|
528 <dt><i>filterList</i></dt> |
397 <dd> |
529 <dd> |
398 list of classes to check against |
530 list of classes to check against |
399 </dd> |
531 </dd> |
400 </dl><a NAME="ProjectBaseBrowser._selectSingleItem" ID="ProjectBaseBrowser._selectSingleItem"></a> |
532 </dl> |
|
533 <a NAME="ProjectBaseBrowser._selectSingleItem" ID="ProjectBaseBrowser._selectSingleItem"></a> |
401 <h4>ProjectBaseBrowser._selectSingleItem</h4> |
534 <h4>ProjectBaseBrowser._selectSingleItem</h4> |
402 <b>_selectSingleItem</b>(<i>index</i>) |
535 <b>_selectSingleItem</b>(<i>index</i>) |
|
536 |
403 <p> |
537 <p> |
404 Protected method to select a single item. |
538 Protected method to select a single item. |
405 </p><dl> |
539 </p> |
|
540 <dl> |
|
541 |
406 <dt><i>index</i></dt> |
542 <dt><i>index</i></dt> |
407 <dd> |
543 <dd> |
408 index of item to be selected (QModelIndex) |
544 index of item to be selected (QModelIndex) |
409 </dd> |
545 </dd> |
410 </dl><a NAME="ProjectBaseBrowser._setItemRangeSelected" ID="ProjectBaseBrowser._setItemRangeSelected"></a> |
546 </dl> |
|
547 <a NAME="ProjectBaseBrowser._setItemRangeSelected" ID="ProjectBaseBrowser._setItemRangeSelected"></a> |
411 <h4>ProjectBaseBrowser._setItemRangeSelected</h4> |
548 <h4>ProjectBaseBrowser._setItemRangeSelected</h4> |
412 <b>_setItemRangeSelected</b>(<i>startIndex, endIndex, selected</i>) |
549 <b>_setItemRangeSelected</b>(<i>startIndex, endIndex, selected</i>) |
|
550 |
413 <p> |
551 <p> |
414 Protected method to set the selection status of a range of items. |
552 Protected method to set the selection status of a range of items. |
415 </p><dl> |
553 </p> |
|
554 <dl> |
|
555 |
416 <dt><i>startIndex</i></dt> |
556 <dt><i>startIndex</i></dt> |
417 <dd> |
557 <dd> |
418 start index of range of items to set (QModelIndex) |
558 start index of range of items to set (QModelIndex) |
419 </dd><dt><i>endIndex</i></dt> |
559 </dd> |
|
560 <dt><i>endIndex</i></dt> |
420 <dd> |
561 <dd> |
421 end index of range of items to set (QModelIndex) |
562 end index of range of items to set (QModelIndex) |
422 </dd><dt><i>selected</i></dt> |
563 </dd> |
|
564 <dt><i>selected</i></dt> |
423 <dd> |
565 <dd> |
424 flag giving the new selection status (boolean) |
566 flag giving the new selection status (boolean) |
425 </dd> |
567 </dd> |
426 </dl><a NAME="ProjectBaseBrowser._setItemSelected" ID="ProjectBaseBrowser._setItemSelected"></a> |
568 </dl> |
|
569 <a NAME="ProjectBaseBrowser._setItemSelected" ID="ProjectBaseBrowser._setItemSelected"></a> |
427 <h4>ProjectBaseBrowser._setItemSelected</h4> |
570 <h4>ProjectBaseBrowser._setItemSelected</h4> |
428 <b>_setItemSelected</b>(<i>index, selected</i>) |
571 <b>_setItemSelected</b>(<i>index, selected</i>) |
|
572 |
429 <p> |
573 <p> |
430 Protected method to set the selection status of an item. |
574 Protected method to set the selection status of an item. |
431 </p><dl> |
575 </p> |
|
576 <dl> |
|
577 |
432 <dt><i>index</i></dt> |
578 <dt><i>index</i></dt> |
433 <dd> |
579 <dd> |
434 index of item to set (QModelIndex) |
580 index of item to set (QModelIndex) |
435 </dd><dt><i>selected</i></dt> |
581 </dd> |
|
582 <dt><i>selected</i></dt> |
436 <dd> |
583 <dd> |
437 flag giving the new selection status (boolean) |
584 flag giving the new selection status (boolean) |
438 </dd> |
585 </dd> |
439 </dl><a NAME="ProjectBaseBrowser._showContextMenu" ID="ProjectBaseBrowser._showContextMenu"></a> |
586 </dl> |
|
587 <a NAME="ProjectBaseBrowser._showContextMenu" ID="ProjectBaseBrowser._showContextMenu"></a> |
440 <h4>ProjectBaseBrowser._showContextMenu</h4> |
588 <h4>ProjectBaseBrowser._showContextMenu</h4> |
441 <b>_showContextMenu</b>(<i>menu</i>) |
589 <b>_showContextMenu</b>(<i>menu</i>) |
|
590 |
442 <p> |
591 <p> |
443 Protected slot called before the context menu is shown. |
592 Protected slot called before the context menu is shown. |
444 </p><p> |
593 </p> |
|
594 <p> |
445 It enables/disables the VCS menu entries depending on the overall |
595 It enables/disables the VCS menu entries depending on the overall |
446 VCS status and the file status. |
596 VCS status and the file status. |
447 </p><dl> |
597 </p> |
|
598 <dl> |
|
599 |
448 <dt><i>menu</i></dt> |
600 <dt><i>menu</i></dt> |
449 <dd> |
601 <dd> |
450 reference to the menu to be shown (QMenu) |
602 reference to the menu to be shown (QMenu) |
451 </dd> |
603 </dd> |
452 </dl><a NAME="ProjectBaseBrowser._showContextMenuBack" ID="ProjectBaseBrowser._showContextMenuBack"></a> |
604 </dl> |
|
605 <a NAME="ProjectBaseBrowser._showContextMenuBack" ID="ProjectBaseBrowser._showContextMenuBack"></a> |
453 <h4>ProjectBaseBrowser._showContextMenuBack</h4> |
606 <h4>ProjectBaseBrowser._showContextMenuBack</h4> |
454 <b>_showContextMenuBack</b>(<i>menu</i>) |
607 <b>_showContextMenuBack</b>(<i>menu</i>) |
|
608 |
455 <p> |
609 <p> |
456 Protected slot called before the context menu is shown. |
610 Protected slot called before the context menu is shown. |
457 </p><dl> |
611 </p> |
|
612 <dl> |
|
613 |
458 <dt><i>menu</i></dt> |
614 <dt><i>menu</i></dt> |
459 <dd> |
615 <dd> |
460 reference to the menu to be shown (QMenu) |
616 reference to the menu to be shown (QMenu) |
461 </dd> |
617 </dd> |
462 </dl><a NAME="ProjectBaseBrowser._showContextMenuDir" ID="ProjectBaseBrowser._showContextMenuDir"></a> |
618 </dl> |
|
619 <a NAME="ProjectBaseBrowser._showContextMenuDir" ID="ProjectBaseBrowser._showContextMenuDir"></a> |
463 <h4>ProjectBaseBrowser._showContextMenuDir</h4> |
620 <h4>ProjectBaseBrowser._showContextMenuDir</h4> |
464 <b>_showContextMenuDir</b>(<i>menu</i>) |
621 <b>_showContextMenuDir</b>(<i>menu</i>) |
|
622 |
465 <p> |
623 <p> |
466 Protected slot called before the context menu is shown. |
624 Protected slot called before the context menu is shown. |
467 </p><p> |
625 </p> |
|
626 <p> |
468 It enables/disables the VCS menu entries depending on the overall |
627 It enables/disables the VCS menu entries depending on the overall |
469 VCS status and the directory status. |
628 VCS status and the directory status. |
470 </p><dl> |
629 </p> |
|
630 <dl> |
|
631 |
471 <dt><i>menu</i></dt> |
632 <dt><i>menu</i></dt> |
472 <dd> |
633 <dd> |
473 reference to the menu to be shown (QMenu) |
634 reference to the menu to be shown (QMenu) |
474 </dd> |
635 </dd> |
475 </dl><a NAME="ProjectBaseBrowser._showContextMenuDirMulti" ID="ProjectBaseBrowser._showContextMenuDirMulti"></a> |
636 </dl> |
|
637 <a NAME="ProjectBaseBrowser._showContextMenuDirMulti" ID="ProjectBaseBrowser._showContextMenuDirMulti"></a> |
476 <h4>ProjectBaseBrowser._showContextMenuDirMulti</h4> |
638 <h4>ProjectBaseBrowser._showContextMenuDirMulti</h4> |
477 <b>_showContextMenuDirMulti</b>(<i>menu</i>) |
639 <b>_showContextMenuDirMulti</b>(<i>menu</i>) |
|
640 |
478 <p> |
641 <p> |
479 Protected slot called before the context menu is shown. |
642 Protected slot called before the context menu is shown. |
480 </p><p> |
643 </p> |
|
644 <p> |
481 It enables/disables the VCS menu entries depending on the overall |
645 It enables/disables the VCS menu entries depending on the overall |
482 VCS status and the directory status. |
646 VCS status and the directory status. |
483 </p><dl> |
647 </p> |
|
648 <dl> |
|
649 |
484 <dt><i>menu</i></dt> |
650 <dt><i>menu</i></dt> |
485 <dd> |
651 <dd> |
486 reference to the menu to be shown (QMenu) |
652 reference to the menu to be shown (QMenu) |
487 </dd> |
653 </dd> |
488 </dl><a NAME="ProjectBaseBrowser._showContextMenuMulti" ID="ProjectBaseBrowser._showContextMenuMulti"></a> |
654 </dl> |
|
655 <a NAME="ProjectBaseBrowser._showContextMenuMulti" ID="ProjectBaseBrowser._showContextMenuMulti"></a> |
489 <h4>ProjectBaseBrowser._showContextMenuMulti</h4> |
656 <h4>ProjectBaseBrowser._showContextMenuMulti</h4> |
490 <b>_showContextMenuMulti</b>(<i>menu</i>) |
657 <b>_showContextMenuMulti</b>(<i>menu</i>) |
|
658 |
491 <p> |
659 <p> |
492 Protected slot called before the context menu (multiple selections) is |
660 Protected slot called before the context menu (multiple selections) is |
493 shown. |
661 shown. |
494 </p><p> |
662 </p> |
|
663 <p> |
495 It enables/disables the VCS menu entries depending on the overall |
664 It enables/disables the VCS menu entries depending on the overall |
496 VCS status and the files status. |
665 VCS status and the files status. |
497 </p><dl> |
666 </p> |
|
667 <dl> |
|
668 |
498 <dt><i>menu</i></dt> |
669 <dt><i>menu</i></dt> |
499 <dd> |
670 <dd> |
500 reference to the menu to be shown (QMenu) |
671 reference to the menu to be shown (QMenu) |
501 </dd> |
672 </dd> |
502 </dl><a NAME="ProjectBaseBrowser.addHookMethod" ID="ProjectBaseBrowser.addHookMethod"></a> |
673 </dl> |
|
674 <a NAME="ProjectBaseBrowser.addHookMethod" ID="ProjectBaseBrowser.addHookMethod"></a> |
503 <h4>ProjectBaseBrowser.addHookMethod</h4> |
675 <h4>ProjectBaseBrowser.addHookMethod</h4> |
504 <b>addHookMethod</b>(<i>key, method</i>) |
676 <b>addHookMethod</b>(<i>key, method</i>) |
|
677 |
505 <p> |
678 <p> |
506 Public method to add a hook method to the dictionary. |
679 Public method to add a hook method to the dictionary. |
507 </p><dl> |
680 </p> |
|
681 <dl> |
|
682 |
508 <dt><i>key</i></dt> |
683 <dt><i>key</i></dt> |
509 <dd> |
684 <dd> |
510 for the hook method (string) |
685 for the hook method (string) |
511 </dd><dt><i>method</i></dt> |
686 </dd> |
|
687 <dt><i>method</i></dt> |
512 <dd> |
688 <dd> |
513 reference to the hook method (method object) |
689 reference to the hook method (method object) |
514 </dd> |
690 </dd> |
515 </dl><a NAME="ProjectBaseBrowser.addHookMethodAndMenuEntry" ID="ProjectBaseBrowser.addHookMethodAndMenuEntry"></a> |
691 </dl> |
|
692 <a NAME="ProjectBaseBrowser.addHookMethodAndMenuEntry" ID="ProjectBaseBrowser.addHookMethodAndMenuEntry"></a> |
516 <h4>ProjectBaseBrowser.addHookMethodAndMenuEntry</h4> |
693 <h4>ProjectBaseBrowser.addHookMethodAndMenuEntry</h4> |
517 <b>addHookMethodAndMenuEntry</b>(<i>key, method, menuEntry</i>) |
694 <b>addHookMethodAndMenuEntry</b>(<i>key, method, menuEntry</i>) |
|
695 |
518 <p> |
696 <p> |
519 Public method to add a hook method to the dictionary. |
697 Public method to add a hook method to the dictionary. |
520 </p><dl> |
698 </p> |
|
699 <dl> |
|
700 |
521 <dt><i>key</i></dt> |
701 <dt><i>key</i></dt> |
522 <dd> |
702 <dd> |
523 for the hook method (string) |
703 for the hook method (string) |
524 </dd><dt><i>method</i></dt> |
704 </dd> |
|
705 <dt><i>method</i></dt> |
525 <dd> |
706 <dd> |
526 reference to the hook method (method object) |
707 reference to the hook method (method object) |
527 </dd><dt><i>menuEntry</i></dt> |
708 </dd> |
|
709 <dt><i>menuEntry</i></dt> |
528 <dd> |
710 <dd> |
529 entry to be shown in the context menu (string) |
711 entry to be shown in the context menu (string) |
530 </dd> |
712 </dd> |
531 </dl><a NAME="ProjectBaseBrowser.currentItem" ID="ProjectBaseBrowser.currentItem"></a> |
713 </dl> |
|
714 <a NAME="ProjectBaseBrowser.currentItem" ID="ProjectBaseBrowser.currentItem"></a> |
532 <h4>ProjectBaseBrowser.currentItem</h4> |
715 <h4>ProjectBaseBrowser.currentItem</h4> |
533 <b>currentItem</b>(<i></i>) |
716 <b>currentItem</b>(<i></i>) |
|
717 |
534 <p> |
718 <p> |
535 Public method to get a reference to the current item. |
719 Public method to get a reference to the current item. |
536 </p><dl> |
720 </p> |
|
721 <dl> |
537 <dt>Returns:</dt> |
722 <dt>Returns:</dt> |
538 <dd> |
723 <dd> |
539 reference to the current item |
724 reference to the current item |
540 </dd> |
725 </dd> |
541 </dl><a NAME="ProjectBaseBrowser.expandItemsByName" ID="ProjectBaseBrowser.expandItemsByName"></a> |
726 </dl> |
|
727 <a NAME="ProjectBaseBrowser.expandItemsByName" ID="ProjectBaseBrowser.expandItemsByName"></a> |
542 <h4>ProjectBaseBrowser.expandItemsByName</h4> |
728 <h4>ProjectBaseBrowser.expandItemsByName</h4> |
543 <b>expandItemsByName</b>(<i>names</i>) |
729 <b>expandItemsByName</b>(<i>names</i>) |
|
730 |
544 <p> |
731 <p> |
545 Public method to expand items given their names. |
732 Public method to expand items given their names. |
546 </p><dl> |
733 </p> |
|
734 <dl> |
|
735 |
547 <dt><i>names</i></dt> |
736 <dt><i>names</i></dt> |
548 <dd> |
737 <dd> |
549 list of item names to be expanded (list of string) |
738 list of item names to be expanded (list of string) |
550 </dd> |
739 </dd> |
551 </dl><a NAME="ProjectBaseBrowser.getExpandedItemNames" ID="ProjectBaseBrowser.getExpandedItemNames"></a> |
740 </dl> |
|
741 <a NAME="ProjectBaseBrowser.getExpandedItemNames" ID="ProjectBaseBrowser.getExpandedItemNames"></a> |
552 <h4>ProjectBaseBrowser.getExpandedItemNames</h4> |
742 <h4>ProjectBaseBrowser.getExpandedItemNames</h4> |
553 <b>getExpandedItemNames</b>(<i></i>) |
743 <b>getExpandedItemNames</b>(<i></i>) |
|
744 |
554 <p> |
745 <p> |
555 Public method to get the file/directory names of all expanded items. |
746 Public method to get the file/directory names of all expanded items. |
556 </p><dl> |
747 </p> |
|
748 <dl> |
557 <dt>Returns:</dt> |
749 <dt>Returns:</dt> |
558 <dd> |
750 <dd> |
559 list of expanded items names (list of string) |
751 list of expanded items names (list of string) |
560 </dd> |
752 </dd> |
561 </dl><a NAME="ProjectBaseBrowser.removeHookMethod" ID="ProjectBaseBrowser.removeHookMethod"></a> |
753 </dl> |
|
754 <a NAME="ProjectBaseBrowser.removeHookMethod" ID="ProjectBaseBrowser.removeHookMethod"></a> |
562 <h4>ProjectBaseBrowser.removeHookMethod</h4> |
755 <h4>ProjectBaseBrowser.removeHookMethod</h4> |
563 <b>removeHookMethod</b>(<i>key</i>) |
756 <b>removeHookMethod</b>(<i>key</i>) |
|
757 |
564 <p> |
758 <p> |
565 Public method to remove a hook method from the dictionary. |
759 Public method to remove a hook method from the dictionary. |
566 </p><dl> |
760 </p> |
|
761 <dl> |
|
762 |
567 <dt><i>key</i></dt> |
763 <dt><i>key</i></dt> |
568 <dd> |
764 <dd> |
569 for the hook method (string) |
765 for the hook method (string) |
570 </dd> |
766 </dd> |
571 </dl><a NAME="ProjectBaseBrowser.selectFile" ID="ProjectBaseBrowser.selectFile"></a> |
767 </dl> |
|
768 <a NAME="ProjectBaseBrowser.selectFile" ID="ProjectBaseBrowser.selectFile"></a> |
572 <h4>ProjectBaseBrowser.selectFile</h4> |
769 <h4>ProjectBaseBrowser.selectFile</h4> |
573 <b>selectFile</b>(<i>fn</i>) |
770 <b>selectFile</b>(<i>fn</i>) |
|
771 |
574 <p> |
772 <p> |
575 Public method to highlight a node given its filename. |
773 Public method to highlight a node given its filename. |
576 </p><dl> |
774 </p> |
|
775 <dl> |
|
776 |
577 <dt><i>fn</i></dt> |
777 <dt><i>fn</i></dt> |
578 <dd> |
778 <dd> |
579 filename of file to be highlighted (string) |
779 filename of file to be highlighted (string) |
580 </dd> |
780 </dd> |
581 </dl><a NAME="ProjectBaseBrowser.selectFileLine" ID="ProjectBaseBrowser.selectFileLine"></a> |
781 </dl> |
|
782 <a NAME="ProjectBaseBrowser.selectFileLine" ID="ProjectBaseBrowser.selectFileLine"></a> |
582 <h4>ProjectBaseBrowser.selectFileLine</h4> |
783 <h4>ProjectBaseBrowser.selectFileLine</h4> |
583 <b>selectFileLine</b>(<i>fn, lineno</i>) |
784 <b>selectFileLine</b>(<i>fn, lineno</i>) |
|
785 |
584 <p> |
786 <p> |
585 Public method to highlight a node given its filename. |
787 Public method to highlight a node given its filename. |
586 </p><dl> |
788 </p> |
|
789 <dl> |
|
790 |
587 <dt><i>fn</i></dt> |
791 <dt><i>fn</i></dt> |
588 <dd> |
792 <dd> |
589 filename of file to be highlighted (string) |
793 filename of file to be highlighted (string) |
590 </dd><dt><i>lineno</i></dt> |
794 </dd> |
|
795 <dt><i>lineno</i></dt> |
591 <dd> |
796 <dd> |
592 one based line number of the item (integer) |
797 one based line number of the item (integer) |
593 </dd> |
798 </dd> |
594 </dl><a NAME="ProjectBaseBrowser.selectLocalDirEntries" ID="ProjectBaseBrowser.selectLocalDirEntries"></a> |
799 </dl> |
|
800 <a NAME="ProjectBaseBrowser.selectLocalDirEntries" ID="ProjectBaseBrowser.selectLocalDirEntries"></a> |
595 <h4>ProjectBaseBrowser.selectLocalDirEntries</h4> |
801 <h4>ProjectBaseBrowser.selectLocalDirEntries</h4> |
596 <b>selectLocalDirEntries</b>(<i></i>) |
802 <b>selectLocalDirEntries</b>(<i></i>) |
|
803 |
597 <p> |
804 <p> |
598 Public slot to handle the select local directories context menu |
805 Public slot to handle the select local directories context menu |
599 entries. |
806 entries. |
600 </p><a NAME="ProjectBaseBrowser.selectLocalEntries" ID="ProjectBaseBrowser.selectLocalEntries"></a> |
807 </p> |
|
808 <a NAME="ProjectBaseBrowser.selectLocalEntries" ID="ProjectBaseBrowser.selectLocalEntries"></a> |
601 <h4>ProjectBaseBrowser.selectLocalEntries</h4> |
809 <h4>ProjectBaseBrowser.selectLocalEntries</h4> |
602 <b>selectLocalEntries</b>(<i></i>) |
810 <b>selectLocalEntries</b>(<i></i>) |
|
811 |
603 <p> |
812 <p> |
604 Public slot to handle the select local files context menu entries. |
813 Public slot to handle the select local files context menu entries. |
605 </p><a NAME="ProjectBaseBrowser.selectVCSDirEntries" ID="ProjectBaseBrowser.selectVCSDirEntries"></a> |
814 </p> |
|
815 <a NAME="ProjectBaseBrowser.selectVCSDirEntries" ID="ProjectBaseBrowser.selectVCSDirEntries"></a> |
606 <h4>ProjectBaseBrowser.selectVCSDirEntries</h4> |
816 <h4>ProjectBaseBrowser.selectVCSDirEntries</h4> |
607 <b>selectVCSDirEntries</b>(<i></i>) |
817 <b>selectVCSDirEntries</b>(<i></i>) |
|
818 |
608 <p> |
819 <p> |
609 Public slot to handle the select VCS directories context menu entries. |
820 Public slot to handle the select VCS directories context menu entries. |
610 </p><a NAME="ProjectBaseBrowser.selectVCSEntries" ID="ProjectBaseBrowser.selectVCSEntries"></a> |
821 </p> |
|
822 <a NAME="ProjectBaseBrowser.selectVCSEntries" ID="ProjectBaseBrowser.selectVCSEntries"></a> |
611 <h4>ProjectBaseBrowser.selectVCSEntries</h4> |
823 <h4>ProjectBaseBrowser.selectVCSEntries</h4> |
612 <b>selectVCSEntries</b>(<i></i>) |
824 <b>selectVCSEntries</b>(<i></i>) |
|
825 |
613 <p> |
826 <p> |
614 Public slot to handle the select VCS files context menu entries. |
827 Public slot to handle the select VCS files context menu entries. |
615 </p> |
828 </p> |
616 <div align="right"><a href="#top">Up</a></div> |
829 <div align="right"><a href="#top">Up</a></div> |
617 <hr /> |
830 <hr /> |