-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgisappinterface.h
482 lines (415 loc) · 18.1 KB
/
qgisappinterface.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
/***************************************************************************
qgisappinterface.h
Interface class for exposing functions in QgisApp for use by plugins
-------------------
begin : 2004-02-11
copyright : (C) 2004 by Gary E.Sherman
email : sherman at mrcc.com
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGISIFACE_H
#define QGISIFACE_H
#include "qgisinterface.h"
#include "qgsapplegendinterface.h"
class QgisApp;
#ifdef _MSC_VER
# pragma warning( push )
# pragma warning( disable: 4996 ) // declared deprecated
#endif
/** \class QgisAppInterface
* \brief Interface class to provide access to private methods in QgisApp
* for use by plugins.
*
* Only those functions "exposed" by QgisInterface can be called from within a
* plugin.
*/
class QgisAppInterface : public QgisInterface
{
Q_OBJECT
public:
/**
* Constructor.
* @param qgis Pointer to the QgisApp object
*/
QgisAppInterface( QgisApp *qgisapp );
~QgisAppInterface();
QgsLegendInterface* legendInterface();
/* Exposed functions */
//! Zoom map to full extent
void zoomFull();
//! Zoom map to previous extent
void zoomToPrevious();
//! Zoom map to next extent
void zoomToNext();
//! Zoom to active layer
void zoomToActiveLayer();
//! Add a vector layer
QgsVectorLayer* addVectorLayer( QString vectorLayerPath, QString baseName, QString providerKey );
//! Add a raster layer given its file name
QgsRasterLayer* addRasterLayer( QString rasterLayerPath, QString baseName );
//! Add a WMS layer
QgsRasterLayer* addRasterLayer( const QString& url, const QString& baseName, const QString& providerKey );
//! Add a project
bool addProject( QString theProjectName );
//! Start a new blank project
void newProject( bool thePromptToSaveFlag = false );
//! Get pointer to the active layer (layer selected in the legend)
QgsMapLayer *activeLayer();
//! set the active layer (layer selected in the legend)
bool setActiveLayer( QgsMapLayer *layer );
//! Add an icon to the plugins toolbar
int addToolBarIcon( QAction *qAction );
/**
* Add a widget to the plugins toolbar.
* To remove this widget again, call {@link removeToolBarIcon}
* with the returned QAction.
*
* @param widget widget to add. The toolbar will take ownership of this widget
* @return the QAction you can use to remove this widget from the toolbar
*/
QAction* addToolBarWidget( QWidget* widget );
//! Remove an icon (action) from the plugin toolbar
void removeToolBarIcon( QAction *qAction );
//! Add an icon to the Raster toolbar
int addRasterToolBarIcon( QAction *qAction );
/**
* Add a widget to the raster toolbar.
* To remove this widget again, call {@link removeRasterToolBarIcon}
* with the returned QAction.
*
* @param widget widget to add. The toolbar will take ownership of this widget
* @return the QAction you can use to remove this widget from the toolbar
*/
QAction* addRasterToolBarWidget( QWidget* widget );
//! Remove an icon (action) from the Raster toolbar
void removeRasterToolBarIcon( QAction *qAction );
//! Add an icon to the Vector toolbar
int addVectorToolBarIcon( QAction *qAction );
/**
* Add a widget to the vector toolbar.
* To remove this widget again, call {@link removeVectorToolBarIcon}
* with the returned QAction.
*
* @param widget widget to add. The toolbar will take ownership of this widget
* @return the QAction you can use to remove this widget from the toolbar
*/
QAction* addVectorToolBarWidget( QWidget* widget );
//! Remove an icon (action) from the Vector toolbar
void removeVectorToolBarIcon( QAction *qAction );
//! Add an icon to the Database toolbar
int addDatabaseToolBarIcon( QAction *qAction );
/**
* Add a widget to the database toolbar.
* To remove this widget again, call {@link removeDatabaseToolBarIcon}
* with the returned QAction.
*
* @param widget widget to add. The toolbar will take ownership of this widget
* @return the QAction you can use to remove this widget from the toolbar
*/
QAction* addDatabaseToolBarWidget( QWidget* widget );
//! Remove an icon (action) from the Database toolbar
void removeDatabaseToolBarIcon( QAction *qAction );
//! Add an icon to the Web toolbar
int addWebToolBarIcon( QAction *qAction );
/**
* Add a widget to the web toolbar.
* To remove this widget again, call {@link removeWebToolBarIcon}
* with the returned QAction.
*
* @param widget widget to add. The toolbar will take ownership of this widget
* @return the QAction you can use to remove this widget from the toolbar
*/
QAction* addWebToolBarWidget( QWidget* widget );
//! Remove an icon (action) from the Web toolbar
void removeWebToolBarIcon( QAction *qAction );
//! Add toolbar with specified name
QToolBar* addToolBar( QString name );
/** Open a url in the users browser. By default the QGIS doc directory is used
* as the base for the URL. To open a URL that is not relative to the installed
* QGIS documentation, set useQgisDocDirectory to false.
* @param url URL to open
* @param useQgisDocDirectory If true, the URL will be formed by concatenating
* url to the QGIS documentation directory path (<prefix>/share/doc)
*/
void openURL( QString url, bool useQgisDocDirectory = true );
/** Return a pointer to the map canvas used by qgisapp */
QgsMapCanvas * mapCanvas();
/** Gives access to main QgisApp object
Plugins don't need to know about QgisApp, as we pass it as QWidget,
it can be used for connecting slots and using as widget's parent
*/
QWidget * mainWindow();
QgsMessageBar * messageBar();
QList<QgsComposerView*> activeComposers();
/** Create a new composer
* @param title window title for new composer (one will be generated if empty)
* @return pointer to composer's view
* @note new composer window will be shown and activated (added in 1.9)
*/
QgsComposerView* createNewComposer( QString title = QString( "" ) );
/** Duplicate an existing parent composer from composer view
* @param composerView pointer to existing composer view
* @param title window title for duplicated composer (one will be generated if empty)
* @return pointer to duplicate composer's view
* @note dupicate composer window will be hidden until loaded, then shown and activated (added in 1.9)
*/
QgsComposerView* duplicateComposer( QgsComposerView* composerView, QString title = QString( "" ) );
/** Deletes parent composer of composer view, after closing composer window
* @note (added in 1.9)
*/
void deleteComposer( QgsComposerView* composerView );
/** Return changeable options built from settings and/or defaults
* @note (added in 1.9)
*/
QMap<QString, QVariant> defaultStyleSheetOptions();
/** Generate stylesheet
* @param opts generated default option values, or a changed copy of them
* @note added in 1.9
*/
void buildStyleSheet( const QMap<QString, QVariant>& opts );
/** Save changed default option keys/values to user settings
* @note added in 1.9
*/
void saveStyleSheetOptions( const QMap<QString, QVariant>& opts );
/** Get reference font for initial qApp (may not be same as QgisApp)
* @note added in 1.9
*/
QFont defaultStyleSheetFont();
/** Add action to the plugins menu */
void addPluginToMenu( QString name, QAction* action );
/** Remove action from the plugins menu */
void removePluginMenu( QString name, QAction* action );
/** Add action to the Database menu */
void addPluginToDatabaseMenu( QString name, QAction* action );
/** Remove action from the Database menu */
void removePluginDatabaseMenu( QString name, QAction* action );
/** Add action to the Raster menu */
void addPluginToRasterMenu( QString name, QAction* action );
/** Remove action from the Raster menu */
void removePluginRasterMenu( QString name, QAction* action );
/** Add action to the Vector menu */
void addPluginToVectorMenu( QString name, QAction* action );
/** Remove action from the Raster menu */
void removePluginVectorMenu( QString name, QAction* action );
/** Add action to the Web menu */
void addPluginToWebMenu( QString name, QAction* action );
/** Remove action from the Web menu */
void removePluginWebMenu( QString name, QAction* action );
/** Add "add layer" action to the layer menu */
void insertAddLayerAction( QAction *action );
/** remove "add layer" action from the layer menu */
void removeAddLayerAction( QAction *action );
/** Add a dock widget to the main window */
void addDockWidget( Qt::DockWidgetArea area, QDockWidget * dockwidget );
/** Remove specified dock widget from main window (doesn't delete it). Added in QGIS 1.1. */
void removeDockWidget( QDockWidget * dockwidget );
/** show layer properties dialog for layer
* @param l layer to show properties table for
* @note added in added in 1.5
*/
virtual void showLayerProperties( QgsMapLayer *l );
/** show layer attribute dialog for layer
* @param l layer to show attribute table for
* @note added in added in 1.7
*/
virtual void showAttributeTable( QgsVectorLayer *l );
/** Add window to Window menu. The action title is the window title
* and the action should raise, unminimize and activate the window. */
virtual void addWindow( QAction *action );
/** Remove window from Window menu. Calling this is necessary only for
* windows which are hidden rather than deleted when closed. */
virtual void removeWindow( QAction *action );
/** Register action to the shortcuts manager so its shortcut can be changed in GUI.
@note added in version 1.2. */
virtual bool registerMainWindowAction( QAction* action, QString defaultShortcut );
/** Unregister a previously registered action. (e.g. when plugin is going to be unloaded.
@note added in version 1.2. */
virtual bool unregisterMainWindowAction( QAction* action );
/** Accessors for inserting items into menus and toolbars.
* An item can be inserted before any existing action.
*/
//! Menus
virtual QMenu *fileMenu();
virtual QMenu *editMenu();
virtual QMenu *viewMenu();
virtual QMenu *layerMenu();
//! @note added in 2.0
virtual QMenu *newLayerMenu();
virtual QMenu *settingsMenu();
virtual QMenu *pluginMenu();
virtual QMenu *rasterMenu();
virtual QMenu *vectorMenu();
virtual QMenu *databaseMenu();
virtual QMenu *webMenu();
virtual QMenu *firstRightStandardMenu();
virtual QMenu *windowMenu();
virtual QMenu *helpMenu();
//! ToolBars
virtual QToolBar *fileToolBar();
virtual QToolBar *layerToolBar();
virtual QToolBar *mapNavToolToolBar();
virtual QToolBar *digitizeToolBar();
virtual QToolBar *advancedDigitizeToolBar();
virtual QToolBar *attributesToolBar();
virtual QToolBar *pluginToolBar();
virtual QToolBar *helpToolBar();
virtual QToolBar *rasterToolBar();
virtual QToolBar *vectorToolBar();
virtual QToolBar *databaseToolBar();
virtual QToolBar *webToolBar();
//! File menu actions
virtual QAction *actionNewProject();
virtual QAction *actionOpenProject();
virtual QAction *actionSaveProject();
virtual QAction *actionSaveProjectAs();
virtual QAction *actionSaveMapAsImage();
virtual QAction *actionProjectProperties();
virtual QAction *actionPrintComposer();
virtual QAction *actionShowComposerManager();
virtual QAction *actionExit();
//! Edit menu actions
virtual QAction *actionCutFeatures();
virtual QAction *actionCopyFeatures();
virtual QAction *actionPasteFeatures();
virtual QAction *actionAddFeature();
virtual QAction *actionDeleteSelected();
virtual QAction *actionMoveFeature();
virtual QAction *actionSplitFeatures();
virtual QAction *actionAddRing();
virtual QAction *actionAddPart();
virtual QAction *actionSimplifyFeature();
virtual QAction *actionDeleteRing();
virtual QAction *actionDeletePart();
virtual QAction *actionNodeTool();
//! View menu actions
virtual QAction *actionPan();
virtual QAction *actionTouch();
virtual QAction *actionPanToSelected();
virtual QAction *actionZoomIn();
virtual QAction *actionZoomOut();
virtual QAction *actionSelect();
virtual QAction *actionSelectRectangle();
virtual QAction *actionSelectPolygon();
virtual QAction *actionSelectFreehand();
virtual QAction *actionSelectRadius();
virtual QAction *actionIdentify();
virtual QAction *actionFeatureAction();
virtual QAction *actionMeasure();
virtual QAction *actionMeasureArea();
virtual QAction *actionZoomFullExtent();
virtual QAction *actionZoomToLayer();
virtual QAction *actionZoomToSelected();
virtual QAction *actionZoomLast();
virtual QAction *actionZoomNext();
virtual QAction *actionZoomActualSize();
virtual QAction *actionMapTips();
virtual QAction *actionNewBookmark();
virtual QAction *actionShowBookmarks();
virtual QAction *actionDraw();
//! Layer menu actions
virtual QAction *actionNewVectorLayer();
virtual QAction *actionAddOgrLayer();
virtual QAction *actionAddRasterLayer();
virtual QAction *actionAddPgLayer();
virtual QAction *actionAddWmsLayer();
/** @note added in 1.9 */
virtual QAction *actionCopyLayerStyle();
/** @note added in 1.9 */
virtual QAction *actionPasteLayerStyle();
virtual QAction *actionOpenTable();
virtual QAction *actionOpenFieldCalculator();
virtual QAction *actionToggleEditing();
/** @note added in 1.9 */
virtual QAction *actionSaveActiveLayerEdits();
/** @note added in 1.9 */
virtual QAction *actionAllEdits();
/** @note added in 1.9 */
virtual QAction *actionSaveEdits();
/** @note added in 1.9 */
virtual QAction *actionSaveAllEdits();
/** @note added in 1.9 */
virtual QAction *actionRollbackEdits();
/** @note added in 1.9 */
virtual QAction *actionRollbackAllEdits();
/** @note added in 1.9 */
virtual QAction *actionCancelEdits();
/** @note added in 1.9 */
virtual QAction *actionCancelAllEdits();
virtual QAction *actionLayerSaveAs();
virtual QAction *actionLayerSelectionSaveAs();
virtual QAction *actionRemoveLayer();
/** @note added in 1.9 */
virtual QAction *actionDuplicateLayer();
virtual QAction *actionLayerProperties();
virtual QAction *actionAddToOverview();
virtual QAction *actionAddAllToOverview();
virtual QAction *actionRemoveAllFromOverview();
virtual QAction *actionHideAllLayers();
virtual QAction *actionShowAllLayers();
//! Plugin menu actions
virtual QAction *actionManagePlugins();
virtual QAction *actionPluginListSeparator();
virtual QAction *actionShowPythonDialog();
//! Settings menu actions
virtual QAction *actionToggleFullScreen();
virtual QAction *actionOptions();
virtual QAction *actionCustomProjection();
//! Help menu actions
virtual QAction *actionHelpContents();
virtual QAction *actionQgisHomePage();
virtual QAction *actionCheckQgisVersion();
virtual QAction *actionAbout();
//! open feature form
// returns true when dialog was accepted
// @param l vector layer
// @param f feature to show/modify
// @param updateFeatureOnly only update the feature update (don't change any attributes of the layer)
// @added in 1.6
virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false );
virtual QDialog* getFeatureForm( QgsVectorLayer *l, QgsFeature &f );
/** This method is only needed when using a UI form with a custom widget plugin and calling
* openFeatureForm or getFeatureForm from Python (PyQt4) and you havn't used the info tool first.
* Python will crash bringing QGIS wtih it
* if the custom form is not loaded from a C++ method call.
*
* This method uses a QTimer to call QUiLoader in order to load the form via C++
* you only need to call this once after that you can call openFeatureForm/getFeatureForm
* like normal
*
* More information here: http://qt-project.org/forums/viewthread/27098/
*/
virtual void preloadForm( QString uifile );
/** Return vector layers in edit mode
* @param modified whether to return only layers that have been modified
* @returns list of layers in legend order, or empty list
* @note added in 1.9 */
virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const;
/** Get timeout for timed messages: default of 5 seconds
* @note added in 1.9 */
virtual int messageTimeout();
signals:
void currentThemeChanged( QString );
private slots:
void cacheloadForm( QString uifile );
private:
/// QgisInterface aren't copied
QgisAppInterface( QgisAppInterface const & );
/// QgisInterface aren't copied
QgisAppInterface & operator=( QgisAppInterface const & );
//! Pointer to the QgisApp object
QgisApp *qgis;
QTimer *mTimer;
//! Pointer to the LegendInterface object
QgsAppLegendInterface legendIface;
};
#ifdef _MSC_VER
# pragma warning( pop )
#endif
#endif //#define QGISAPPINTERFACE_H