/
qgisinterface.h
316 lines (264 loc) · 11.8 KB
/
qgisinterface.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
/***************************************************************************
qgisinterface.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. *
* *
***************************************************************************/
/* $Id$ */
#ifndef QGISINTERFACE_H
#define QGISINTERFACE_H
class QAction;
class QMenu;
class QToolBar;
class QDockWidget;
class QMainWindow;
class QWidget;
#include <QObject>
#include <QPair>
#include <map>
class QgisApp;
class QgsComposerView;
class QgsMapLayer;
class QgsMapCanvas;
class QgsRasterLayer;
class QgsVectorLayer;
class QgsLegendInterface;
/** \ingroup gui
* QgisInterface
* Abstract base class defining interfaces exposed by QgisApp and
* made available to plugins.
*
* Only functionality exposed by QgisInterface can be used in plugins.
* This interface has to be implemented with application specific details.
*
* QGIS implements it in QgisAppInterface class, 3rd party applications
* could provide their own implementation to be able to use plugins.
*/
class GUI_EXPORT QgisInterface : public QObject
{
Q_OBJECT
public:
/** Constructor */
QgisInterface();
/** Virtual destructor */
virtual ~QgisInterface();
/** Get pointer to legend interface
\note added in 1.4
*/
virtual QgsLegendInterface* legendInterface() = 0;
public slots: // TODO: do these functions really need to be slots?
//! Zoom to full extent of map layers
virtual void zoomFull() = 0;
//! Zoom to previous view extent
virtual void zoomToPrevious() = 0;
//! Zoom to next view extent
virtual void zoomToNext() = 0;
//! Zoom to extent of the active layer
virtual void zoomToActiveLayer() = 0;
//! Add a vector layer
virtual QgsVectorLayer* addVectorLayer( QString vectorLayerPath, QString baseName, QString providerKey ) = 0;
//! Add a raster layer given a raster layer file name
virtual QgsRasterLayer* addRasterLayer( QString rasterLayerPath, QString baseName = QString() ) = 0;
//! Add a WMS layer
virtual QgsRasterLayer* addRasterLayer( const QString& url, const QString& layerName, const QString& providerKey, const QStringList& layers,
const QStringList& styles, const QString& format, const QString& crs ) = 0;
//! Add a project
virtual bool addProject( QString theProject ) = 0;
//! Start a blank project
virtual void newProject( bool thePromptToSaveFlag = false ) = 0;
//! Get pointer to the active layer (layer selected in the legend)
virtual QgsMapLayer *activeLayer() = 0;
//! Set the active layer (layer gets selected in the legend)
//! returns true if the layer exists, false otherwise
//! added in 1.4
virtual bool setActiveLayer( QgsMapLayer * ) = 0;
//! Add an icon to the plugins toolbar
virtual int addToolBarIcon( QAction *qAction ) = 0;
//! Remove an action (icon) from the plugin toolbar
virtual void removeToolBarIcon( QAction *qAction ) = 0;
//! Add toolbar with specified name
virtual QToolBar * addToolBar( QString name ) = 0;
/** Return a pointer to the map canvas */
virtual QgsMapCanvas * mapCanvas() = 0;
/** Return a pointer to the main window (instance of QgisApp in case of QGIS) */
virtual QWidget * mainWindow() = 0;
/**Return mainwindows / composer views of running composer instances (currently only one)*/
virtual QList<QgsComposerView*> activeComposers() = 0;
/** Add action to the plugins menu */
virtual void addPluginToMenu( QString name, QAction* action ) = 0;
/** Remove action from the plugins menu */
virtual void removePluginMenu( QString name, QAction* action ) = 0;
/** Add a dock widget to the main window */
virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget * dockwidget ) = 0;
/** Remove specified dock widget from main window (doesn't delete it). Added in QGIS 1.1. */
virtual void removeDockWidget( QDockWidget * dockwidget ) = 0;
/** refresh the legend of a layer */
virtual void refreshLegend( QgsMapLayer *l ) = 0;
/** 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 ) = 0;
/** 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 ) = 0;
/** Register action to the shortcuts manager so its shortcut can be changed in GUI
\note added in 1.2
*/
virtual bool registerMainWindowAction( QAction* action, QString defaultShortcut ) = 0;
/** Unregister a previously registered action. (e.g. when plugin is going to be unloaded)
\note added in 1.2
*/
virtual bool unregisterMainWindowAction( QAction* action ) = 0;
// TODO: is this deprecated in favour of QgsContextHelp?
/** 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)
*/
virtual void openURL( QString url, bool useQgisDocDirectory = true ) = 0;
/** Accessors for inserting items into menus and toolbars.
* An item can be inserted before any existing action.
*/
//! Menus
virtual QMenu *fileMenu() = 0;
virtual QMenu *editMenu() = 0;
virtual QMenu *viewMenu() = 0;
virtual QMenu *layerMenu() = 0;
virtual QMenu *settingsMenu() = 0;
virtual QMenu *pluginMenu() = 0;
virtual QMenu *firstRightStandardMenu() = 0;
virtual QMenu *windowMenu() = 0;
virtual QMenu *helpMenu() = 0;
//! ToolBars
virtual QToolBar *fileToolBar() = 0;
virtual QToolBar *layerToolBar() = 0;
virtual QToolBar *mapNavToolToolBar() = 0;
virtual QToolBar *digitizeToolBar() = 0;
virtual QToolBar *attributesToolBar() = 0;
virtual QToolBar *pluginToolBar() = 0;
virtual QToolBar *helpToolBar() = 0;
//! File menu actions
virtual QAction *actionNewProject() = 0;
virtual QAction *actionOpenProject() = 0;
virtual QAction *actionFileSeparator1() = 0;
virtual QAction *actionSaveProject() = 0;
virtual QAction *actionSaveProjectAs() = 0;
virtual QAction *actionSaveMapAsImage() = 0;
virtual QAction *actionFileSeparator2() = 0;
virtual QAction *actionProjectProperties() = 0;
virtual QAction *actionFileSeparator3() = 0;
virtual QAction *actionPrintComposer() = 0;
virtual QAction *actionFileSeparator4() = 0;
virtual QAction *actionExit() = 0;
//! Edit menu actions
virtual QAction *actionCutFeatures() = 0;
virtual QAction *actionCopyFeatures() = 0;
virtual QAction *actionPasteFeatures() = 0;
virtual QAction *actionEditSeparator1() = 0;
virtual QAction *actionCapturePoint() = 0;
virtual QAction *actionCaptureLine() = 0;
virtual QAction *actionCapturePolygon() = 0;
virtual QAction *actionDeleteSelected() = 0;
virtual QAction *actionMoveFeature() = 0;
virtual QAction *actionSplitFeatures() = 0;
virtual QAction *actionAddVertex() = 0;
virtual QAction *actionDeleteVertex() = 0;
virtual QAction *actionMoveVertex() = 0;
virtual QAction *actionAddRing() = 0;
virtual QAction *actionAddIsland() = 0;
virtual QAction *actionEditSeparator2() = 0;
//! View menu actions
virtual QAction *actionPan() = 0;
virtual QAction *actionZoomIn() = 0;
virtual QAction *actionZoomOut() = 0;
virtual QAction *actionSelect() = 0;
virtual QAction *actionIdentify() = 0;
virtual QAction *actionMeasure() = 0;
virtual QAction *actionMeasureArea() = 0;
virtual QAction *actionViewSeparator1() = 0;
virtual QAction *actionZoomFullExtent() = 0;
virtual QAction *actionZoomToLayer() = 0;
virtual QAction *actionZoomToSelected() = 0;
virtual QAction *actionZoomLast() = 0;
virtual QAction *actionZoomActualSize() = 0;
virtual QAction *actionViewSeparator2() = 0;
virtual QAction *actionMapTips() = 0;
virtual QAction *actionNewBookmark() = 0;
virtual QAction *actionShowBookmarks() = 0;
virtual QAction *actionDraw() = 0;
virtual QAction *actionViewSeparator3() = 0;
//! Layer menu actions
virtual QAction *actionNewVectorLayer() = 0;
virtual QAction *actionAddOgrLayer() = 0;
virtual QAction *actionAddRasterLayer() = 0;
virtual QAction *actionAddPgLayer() = 0;
virtual QAction *actionAddWmsLayer() = 0;
virtual QAction *actionLayerSeparator1() = 0;
virtual QAction *actionOpenTable() = 0;
virtual QAction *actionToggleEditing() = 0;
virtual QAction *actionLayerSaveAs() = 0;
virtual QAction *actionLayerSelectionSaveAs() = 0;
virtual QAction *actionRemoveLayer() = 0;
virtual QAction *actionLayerProperties() = 0;
virtual QAction *actionLayerSeparator2() = 0;
virtual QAction *actionAddToOverview() = 0;
virtual QAction *actionAddAllToOverview() = 0;
virtual QAction *actionRemoveAllFromOverview() = 0;
virtual QAction *actionLayerSeparator3() = 0;
virtual QAction *actionHideAllLayers() = 0;
virtual QAction *actionShowAllLayers() = 0;
//! Plugin menu actions
virtual QAction *actionManagePlugins() = 0;
virtual QAction *actionPluginSeparator1() = 0;
virtual QAction *actionPluginListSeparator() = 0;
virtual QAction *actionPluginSeparator2() = 0;
virtual QAction *actionPluginPythonSeparator() = 0;
virtual QAction *actionShowPythonDialog() = 0;
//! Settings menu actions
virtual QAction *actionToggleFullScreen() = 0;
virtual QAction *actionSettingsSeparator1() = 0;
virtual QAction *actionOptions() = 0;
virtual QAction *actionCustomProjection() = 0;
//! Help menu actions
virtual QAction *actionHelpContents() = 0;
virtual QAction *actionHelpSeparator1() = 0;
virtual QAction *actionQgisHomePage() = 0;
virtual QAction *actionCheckQgisVersion() = 0;
virtual QAction *actionHelpSeparator2() = 0;
virtual QAction *actionAbout() = 0;
signals:
/** Emited whenever current (selected) layer changes.
* The pointer to layer can be null if no layer is selected
*/
void currentLayerChanged( QgsMapLayer * layer );
/**This signal is emitted when a new composer instance has been created
@note added in version 1.4*/
void composerAdded( QgsComposerView* v );
/**This signal is emitted before a new composer instance is going to be removed
@note added in version 1.4*/
void composerWillBeRemoved( QgsComposerView* v );
};
// FIXME: also in core/qgis.h
#ifndef QGISEXTERN
#ifdef WIN32
# define QGISEXTERN extern "C" __declspec( dllexport )
# ifdef _MSC_VER
// do not warn about C bindings returning QString
# pragma warning(disable:4190)
# endif
#else
# define QGISEXTERN extern "C"
#endif
#endif
#endif //#ifndef QGISINTERFACE_H