Quantum GIS API Documentation  1.7.5-Wroclaw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Slots | Signals | Public Member Functions | List of all members
QgisInterface Class Referenceabstract

QgisInterface Abstract base class defining interfaces exposed by QgisApp and made available to plugins. More...

#include <qgisinterface.h>

Inheritance diagram for QgisInterface:
Inheritance graph
[legend]
Collaboration diagram for QgisInterface:
Collaboration graph
[legend]

Public Slots

virtual void zoomFull ()=0
 Zoom to full extent of map layers. More...
 
virtual void zoomToPrevious ()=0
 Zoom to previous view extent. More...
 
virtual void zoomToNext ()=0
 Zoom to next view extent. More...
 
virtual void zoomToActiveLayer ()=0
 Zoom to extent of the active layer. More...
 
virtual QgsVectorLayeraddVectorLayer (QString vectorLayerPath, QString baseName, QString providerKey)=0
 Add a vector layer. More...
 
virtual QgsRasterLayeraddRasterLayer (QString rasterLayerPath, QString baseName=QString())=0
 Add a raster layer given a raster layer file name. More...
 
virtual QgsRasterLayeraddRasterLayer (const QString &url, const QString &layerName, const QString &providerKey, const QStringList &layers, const QStringList &styles, const QString &format, const QString &crs)=0
 Add a WMS layer. More...
 
virtual bool addProject (QString theProject)=0
 Add a project. More...
 
virtual void newProject (bool thePromptToSaveFlag=false)=0
 Start a blank project. More...
 
virtual QgsMapLayeractiveLayer ()=0
 Get pointer to the active layer (layer selected in the legend) More...
 
virtual bool setActiveLayer (QgsMapLayer *)=0
 Set the active layer (layer gets selected in the legend) returns true if the layer exists, false otherwise added in 1.4. More...
 
virtual int addToolBarIcon (QAction *qAction)=0
 Add an icon to the plugins toolbar. More...
 
virtual void removeToolBarIcon (QAction *qAction)=0
 Remove an action (icon) from the plugin toolbar. More...
 
virtual QToolBar * addToolBar (QString name)=0
 Add toolbar with specified name. More...
 
virtual QgsMapCanvasmapCanvas ()=0
 Return a pointer to the map canvas. More...
 
virtual QWidget * mainWindow ()=0
 Return a pointer to the main window (instance of QgisApp in case of QGIS) More...
 
virtual QList< QgsComposerView * > activeComposers ()=0
 Return mainwindows / composer views of running composer instances (currently only one) More...
 
virtual void addPluginToMenu (QString name, QAction *action)=0
 Add action to the plugins menu. More...
 
virtual void removePluginMenu (QString name, QAction *action)=0
 Remove action from the plugins menu. More...
 
virtual void insertAddLayerAction (QAction *action)=0
 Add "add layer" action to layer menu. More...
 
virtual void removeAddLayerAction (QAction *action)=0
 Remove "add layer" action from layer menu. More...
 
virtual void addPluginToDatabaseMenu (QString name, QAction *action)=0
 Add action to the Database menu. More...
 
virtual void removePluginDatabaseMenu (QString name, QAction *action)=0
 Remove action from the Database menu. More...
 
virtual void addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget)=0
 Add a dock widget to the main window. More...
 
virtual void removeDockWidget (QDockWidget *dockwidget)=0
 Remove specified dock widget from main window (doesn't delete it). More...
 
virtual Q_DECL_DEPRECATED void refreshLegend (QgsMapLayer *l)=0
 refresh the legend of a layer More...
 
virtual void showLayerProperties (QgsMapLayer *l)=0
 open layer properties dialog More...
 
virtual void showAttributeTable (QgsVectorLayer *l)=0
 open attribute table dialog More...
 
virtual void addWindow (QAction *action)=0
 Add window to Window menu. More...
 
virtual void removeWindow (QAction *action)=0
 Remove window from Window menu. More...
 
virtual bool registerMainWindowAction (QAction *action, QString defaultShortcut)=0
 Register action to the shortcuts manager so its shortcut can be changed in GUI. More...
 
virtual bool unregisterMainWindowAction (QAction *action)=0
 Unregister a previously registered action. More...
 
virtual Q_DECL_DEPRECATED void openURL (QString url, bool useQgisDocDirectory=true)=0
 Open a url in the users browser. More...
 
virtual QMenu * fileMenu ()=0
 Accessors for inserting items into menus and toolbars. More...
 
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
 
virtual QToolBar * fileToolBar ()=0
 ToolBars. More...
 
virtual QToolBar * layerToolBar ()=0
 
virtual QToolBar * mapNavToolToolBar ()=0
 
virtual QToolBar * digitizeToolBar ()=0
 
virtual QToolBar * advancedDigitizeToolBar ()=0
 
virtual QToolBar * attributesToolBar ()=0
 
virtual QToolBar * pluginToolBar ()=0
 
virtual QToolBar * helpToolBar ()=0
 
virtual QToolBar * rasterToolBar ()=0
 
virtual QAction * actionNewProject ()=0
 File menu actions. More...
 
virtual QAction * actionOpenProject ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionFileSeparator1 ()=0
 
virtual QAction * actionSaveProject ()=0
 
virtual QAction * actionSaveProjectAs ()=0
 
virtual QAction * actionSaveMapAsImage ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionFileSeparator2 ()=0
 
virtual QAction * actionProjectProperties ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionFileSeparator3 ()=0
 
virtual QAction * actionPrintComposer ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionFileSeparator4 ()=0
 
virtual QAction * actionExit ()=0
 
virtual QAction * actionCutFeatures ()=0
 Edit menu actions. More...
 
virtual QAction * actionCopyFeatures ()=0
 
virtual QAction * actionPasteFeatures ()=0
 
virtual Q_DECL_DEPRECATED 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 Q_DECL_DEPRECATED QAction * actionAddVertex ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionDeleteVertex ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionMoveVertex ()=0
 
virtual QAction * actionAddRing ()=0
 
virtual QAction * actionAddIsland ()=0
 
virtual QAction * actionSimplifyFeature ()=0
 
virtual QAction * actionDeleteRing ()=0
 
virtual QAction * actionDeletePart ()=0
 
virtual QAction * actionNodeTool ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionEditSeparator2 ()=0
 
virtual QAction * actionPan ()=0
 View menu actions. More...
 
virtual QAction * actionZoomIn ()=0
 
virtual QAction * actionZoomOut ()=0
 
virtual QAction * actionSelect ()=0
 
virtual QAction * actionSelectRectangle ()=0
 
virtual QAction * actionSelectPolygon ()=0
 
virtual QAction * actionSelectFreehand ()=0
 
virtual QAction * actionSelectRadius ()=0
 
virtual QAction * actionIdentify ()=0
 
virtual QAction * actionMeasure ()=0
 
virtual QAction * actionMeasureArea ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionViewSeparator1 ()=0
 
virtual QAction * actionZoomFullExtent ()=0
 
virtual QAction * actionZoomToLayer ()=0
 
virtual QAction * actionZoomToSelected ()=0
 
virtual QAction * actionZoomLast ()=0
 
virtual QAction * actionZoomActualSize ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionViewSeparator2 ()=0
 
virtual QAction * actionMapTips ()=0
 
virtual QAction * actionNewBookmark ()=0
 
virtual QAction * actionShowBookmarks ()=0
 
virtual QAction * actionDraw ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionViewSeparator3 ()=0
 
virtual QAction * actionNewVectorLayer ()=0
 Layer menu actions. More...
 
virtual QAction * actionAddOgrLayer ()=0
 
virtual QAction * actionAddRasterLayer ()=0
 
virtual QAction * actionAddPgLayer ()=0
 
virtual QAction * actionAddWmsLayer ()=0
 
virtual Q_DECL_DEPRECATED 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 Q_DECL_DEPRECATED QAction * actionLayerSeparator2 ()=0
 
virtual QAction * actionAddToOverview ()=0
 
virtual QAction * actionAddAllToOverview ()=0
 
virtual QAction * actionRemoveAllFromOverview ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionLayerSeparator3 ()=0
 
virtual QAction * actionHideAllLayers ()=0
 
virtual QAction * actionShowAllLayers ()=0
 
virtual QAction * actionManagePlugins ()=0
 Plugin menu actions. More...
 
virtual Q_DECL_DEPRECATED QAction * actionPluginSeparator1 ()=0
 
virtual QAction * actionPluginListSeparator ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionPluginSeparator2 ()=0
 
virtual QAction * actionPluginPythonSeparator ()=0
 
virtual QAction * actionShowPythonDialog ()=0
 
virtual QAction * actionToggleFullScreen ()=0
 Settings menu actions. More...
 
virtual Q_DECL_DEPRECATED QAction * actionSettingsSeparator1 ()=0
 
virtual QAction * actionOptions ()=0
 
virtual QAction * actionCustomProjection ()=0
 
virtual QAction * actionHelpContents ()=0
 Help menu actions. More...
 
virtual Q_DECL_DEPRECATED QAction * actionHelpSeparator1 ()=0
 
virtual QAction * actionQgisHomePage ()=0
 
virtual QAction * actionCheckQgisVersion ()=0
 
virtual Q_DECL_DEPRECATED QAction * actionHelpSeparator2 ()=0
 
virtual QAction * actionAbout ()=0
 
virtual bool openFeatureForm (QgsVectorLayer *vlayer, QgsFeature &f, bool updateFeatureOnly=false)=0
 Open feature form. More...
 

Signals

void currentLayerChanged (QgsMapLayer *layer)
 Emited whenever current (selected) layer changes. More...
 
void composerAdded (QgsComposerView *v)
 This signal is emitted when a new composer instance has been created. More...
 
void composerWillBeRemoved (QgsComposerView *v)
 This signal is emitted before a new composer instance is going to be removed. More...
 
void initializationCompleted ()
 This signal is emitted when the initialization is complete. More...
 
void projectRead ()
 emitted when a project file is successfully read More...
 
void newProjectCreated ()
 emitted when starting an entirely new project More...
 

Public Member Functions

 QgisInterface ()
 Constructor. More...
 
virtual ~QgisInterface ()
 Virtual destructor. More...
 
virtual QgsLegendInterfacelegendInterface ()=0
 Get pointer to legend interface. More...
 

Detailed Description

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.

Definition at line 60 of file qgisinterface.h.

Constructor & Destructor Documentation

QgisInterface::QgisInterface ( )

Constructor.

Definition at line 22 of file qgisinterface.cpp.

QgisInterface::~QgisInterface ( )
virtual

Virtual destructor.

Definition at line 28 of file qgisinterface.cpp.

Member Function Documentation

virtual QAction* QgisInterface::actionAbout ( )
pure virtualslot
virtual QAction* QgisInterface::actionAddAllToOverview ( )
pure virtualslot
virtual QAction* QgisInterface::actionAddIsland ( )
pure virtualslot
virtual QAction* QgisInterface::actionAddOgrLayer ( )
pure virtualslot
virtual QAction* QgisInterface::actionAddPgLayer ( )
pure virtualslot
virtual QAction* QgisInterface::actionAddRasterLayer ( )
pure virtualslot
virtual QAction* QgisInterface::actionAddRing ( )
pure virtualslot
virtual QAction* QgisInterface::actionAddToOverview ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionAddVertex ( )
pure virtualslot
virtual QAction* QgisInterface::actionAddWmsLayer ( )
pure virtualslot
virtual QAction* QgisInterface::actionCaptureLine ( )
pure virtualslot
virtual QAction* QgisInterface::actionCapturePoint ( )
pure virtualslot
virtual QAction* QgisInterface::actionCapturePolygon ( )
pure virtualslot
virtual QAction* QgisInterface::actionCheckQgisVersion ( )
pure virtualslot
virtual QAction* QgisInterface::actionCopyFeatures ( )
pure virtualslot
virtual QAction* QgisInterface::actionCustomProjection ( )
pure virtualslot
virtual QAction* QgisInterface::actionCutFeatures ( )
pure virtualslot

Edit menu actions.

virtual QAction* QgisInterface::actionDeletePart ( )
pure virtualslot
virtual QAction* QgisInterface::actionDeleteRing ( )
pure virtualslot
virtual QAction* QgisInterface::actionDeleteSelected ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionDeleteVertex ( )
pure virtualslot
virtual QAction* QgisInterface::actionDraw ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionEditSeparator1 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionEditSeparator2 ( )
pure virtualslot
virtual QAction* QgisInterface::actionExit ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionFileSeparator1 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionFileSeparator2 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionFileSeparator3 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionFileSeparator4 ( )
pure virtualslot
virtual QAction* QgisInterface::actionHelpContents ( )
pure virtualslot

Help menu actions.

virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionHelpSeparator1 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionHelpSeparator2 ( )
pure virtualslot
virtual QAction* QgisInterface::actionHideAllLayers ( )
pure virtualslot
virtual QAction* QgisInterface::actionIdentify ( )
pure virtualslot
virtual QAction* QgisInterface::actionLayerProperties ( )
pure virtualslot
virtual QAction* QgisInterface::actionLayerSaveAs ( )
pure virtualslot
virtual QAction* QgisInterface::actionLayerSelectionSaveAs ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionLayerSeparator1 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionLayerSeparator2 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionLayerSeparator3 ( )
pure virtualslot
virtual QAction* QgisInterface::actionManagePlugins ( )
pure virtualslot

Plugin menu actions.

virtual QAction* QgisInterface::actionMapTips ( )
pure virtualslot
virtual QAction* QgisInterface::actionMeasure ( )
pure virtualslot
virtual QAction* QgisInterface::actionMeasureArea ( )
pure virtualslot
virtual QAction* QgisInterface::actionMoveFeature ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionMoveVertex ( )
pure virtualslot
virtual QAction* QgisInterface::actionNewBookmark ( )
pure virtualslot
virtual QAction* QgisInterface::actionNewProject ( )
pure virtualslot

File menu actions.

virtual QAction* QgisInterface::actionNewVectorLayer ( )
pure virtualslot

Layer menu actions.

virtual QAction* QgisInterface::actionNodeTool ( )
pure virtualslot
virtual QAction* QgisInterface::actionOpenProject ( )
pure virtualslot
virtual QAction* QgisInterface::actionOpenTable ( )
pure virtualslot
virtual QAction* QgisInterface::actionOptions ( )
pure virtualslot
virtual QAction* QgisInterface::actionPan ( )
pure virtualslot

View menu actions.

virtual QAction* QgisInterface::actionPasteFeatures ( )
pure virtualslot
virtual QAction* QgisInterface::actionPluginListSeparator ( )
pure virtualslot
virtual QAction* QgisInterface::actionPluginPythonSeparator ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionPluginSeparator1 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionPluginSeparator2 ( )
pure virtualslot
virtual QAction* QgisInterface::actionPrintComposer ( )
pure virtualslot
virtual QAction* QgisInterface::actionProjectProperties ( )
pure virtualslot
virtual QAction* QgisInterface::actionQgisHomePage ( )
pure virtualslot
virtual QAction* QgisInterface::actionRemoveAllFromOverview ( )
pure virtualslot
virtual QAction* QgisInterface::actionRemoveLayer ( )
pure virtualslot
virtual QAction* QgisInterface::actionSaveMapAsImage ( )
pure virtualslot
virtual QAction* QgisInterface::actionSaveProject ( )
pure virtualslot
virtual QAction* QgisInterface::actionSaveProjectAs ( )
pure virtualslot
virtual QAction* QgisInterface::actionSelect ( )
pure virtualslot
virtual QAction* QgisInterface::actionSelectFreehand ( )
pure virtualslot
virtual QAction* QgisInterface::actionSelectPolygon ( )
pure virtualslot
virtual QAction* QgisInterface::actionSelectRadius ( )
pure virtualslot
virtual QAction* QgisInterface::actionSelectRectangle ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionSettingsSeparator1 ( )
pure virtualslot
virtual QAction* QgisInterface::actionShowAllLayers ( )
pure virtualslot
virtual QAction* QgisInterface::actionShowBookmarks ( )
pure virtualslot
virtual QAction* QgisInterface::actionShowPythonDialog ( )
pure virtualslot
virtual QAction* QgisInterface::actionSimplifyFeature ( )
pure virtualslot
virtual QAction* QgisInterface::actionSplitFeatures ( )
pure virtualslot
virtual QAction* QgisInterface::actionToggleEditing ( )
pure virtualslot
virtual QAction* QgisInterface::actionToggleFullScreen ( )
pure virtualslot

Settings menu actions.

virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionViewSeparator1 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionViewSeparator2 ( )
pure virtualslot
virtual Q_DECL_DEPRECATED QAction* QgisInterface::actionViewSeparator3 ( )
pure virtualslot
virtual QAction* QgisInterface::actionZoomActualSize ( )
pure virtualslot
virtual QAction* QgisInterface::actionZoomFullExtent ( )
pure virtualslot
virtual QAction* QgisInterface::actionZoomIn ( )
pure virtualslot
virtual QAction* QgisInterface::actionZoomLast ( )
pure virtualslot
virtual QAction* QgisInterface::actionZoomOut ( )
pure virtualslot
virtual QAction* QgisInterface::actionZoomToLayer ( )
pure virtualslot
virtual QAction* QgisInterface::actionZoomToSelected ( )
pure virtualslot
virtual QList<QgsComposerView*> QgisInterface::activeComposers ( )
pure virtualslot

Return mainwindows / composer views of running composer instances (currently only one)

virtual QgsMapLayer* QgisInterface::activeLayer ( )
pure virtualslot

Get pointer to the active layer (layer selected in the legend)

virtual void QgisInterface::addDockWidget ( Qt::DockWidgetArea  area,
QDockWidget *  dockwidget 
)
pure virtualslot

Add a dock widget to the main window.

virtual void QgisInterface::addPluginToDatabaseMenu ( QString  name,
QAction *  action 
)
pure virtualslot

Add action to the Database menu.

Note
added in 1.7
virtual void QgisInterface::addPluginToMenu ( QString  name,
QAction *  action 
)
pure virtualslot

Add action to the plugins menu.

virtual bool QgisInterface::addProject ( QString  theProject)
pure virtualslot

Add a project.

virtual QgsRasterLayer* QgisInterface::addRasterLayer ( QString  rasterLayerPath,
QString  baseName = QString() 
)
pure virtualslot

Add a raster layer given a raster layer file name.

virtual QgsRasterLayer* QgisInterface::addRasterLayer ( const QString &  url,
const QString &  layerName,
const QString &  providerKey,
const QStringList &  layers,
const QStringList &  styles,
const QString &  format,
const QString &  crs 
)
pure virtualslot

Add a WMS layer.

virtual QToolBar* QgisInterface::addToolBar ( QString  name)
pure virtualslot

Add toolbar with specified name.

virtual int QgisInterface::addToolBarIcon ( QAction *  qAction)
pure virtualslot

Add an icon to the plugins toolbar.

virtual QgsVectorLayer* QgisInterface::addVectorLayer ( QString  vectorLayerPath,
QString  baseName,
QString  providerKey 
)
pure virtualslot

Add a vector layer.

virtual void QgisInterface::addWindow ( QAction *  action)
pure virtualslot

Add window to Window menu.

The action title is the window title and the action should raise, unminimize and activate the window.

virtual QToolBar* QgisInterface::advancedDigitizeToolBar ( )
pure virtualslot
virtual QToolBar* QgisInterface::attributesToolBar ( )
pure virtualslot
void QgisInterface::composerAdded ( QgsComposerView v)
signal

This signal is emitted when a new composer instance has been created.

Note
added in 1.4
void QgisInterface::composerWillBeRemoved ( QgsComposerView v)
signal

This signal is emitted before a new composer instance is going to be removed.

Note
added in 1.4
void QgisInterface::currentLayerChanged ( QgsMapLayer layer)
signal

Emited whenever current (selected) layer changes.

The pointer to layer can be null if no layer is selected

virtual QToolBar* QgisInterface::digitizeToolBar ( )
pure virtualslot
virtual QMenu* QgisInterface::editMenu ( )
pure virtualslot
virtual QMenu* QgisInterface::fileMenu ( )
pure virtualslot

Accessors for inserting items into menus and toolbars.

An item can be inserted before any existing action.Menus

virtual QToolBar* QgisInterface::fileToolBar ( )
pure virtualslot

ToolBars.

virtual QMenu* QgisInterface::firstRightStandardMenu ( )
pure virtualslot
virtual QMenu* QgisInterface::helpMenu ( )
pure virtualslot
virtual QToolBar* QgisInterface::helpToolBar ( )
pure virtualslot
void QgisInterface::initializationCompleted ( )
signal

This signal is emitted when the initialization is complete.

Note
added in version 1.6
virtual void QgisInterface::insertAddLayerAction ( QAction *  action)
pure virtualslot

Add "add layer" action to layer menu.

Note
added in 1.7
virtual QMenu* QgisInterface::layerMenu ( )
pure virtualslot
virtual QToolBar* QgisInterface::layerToolBar ( )
pure virtualslot
virtual QgsLegendInterface* QgisInterface::legendInterface ( )
pure virtual

Get pointer to legend interface.

Note
added in 1.4
virtual QWidget* QgisInterface::mainWindow ( )
pure virtualslot

Return a pointer to the main window (instance of QgisApp in case of QGIS)

virtual QgsMapCanvas* QgisInterface::mapCanvas ( )
pure virtualslot

Return a pointer to the map canvas.

virtual QToolBar* QgisInterface::mapNavToolToolBar ( )
pure virtualslot
virtual void QgisInterface::newProject ( bool  thePromptToSaveFlag = false)
pure virtualslot

Start a blank project.

void QgisInterface::newProjectCreated ( )
signal

emitted when starting an entirely new project

Note
This is similar to projectRead(); plug-ins might want to be notified that they're in a new project. Yes, projectRead() could have been overloaded to be used in the case of new projects instead. However, it's probably more semantically correct to have an entirely separate signal for when this happens.

Added in v1.6

virtual bool QgisInterface::openFeatureForm ( QgsVectorLayer vlayer,
QgsFeature f,
bool  updateFeatureOnly = false 
)
pure virtualslot

Open feature form.

virtual Q_DECL_DEPRECATED void QgisInterface::openURL ( QString  url,
bool  useQgisDocDirectory = true 
)
pure virtualslot

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.

Parameters
urlURL to open
useQgisDocDirectoryIf true, the URL will be formed by concatenating url to the QGIS documentation directory path (prefix/share/doc)
virtual QMenu* QgisInterface::pluginMenu ( )
pure virtualslot
virtual QToolBar* QgisInterface::pluginToolBar ( )
pure virtualslot
void QgisInterface::projectRead ( )
signal

emitted when a project file is successfully read

Note
This is useful for plug-ins that store properties with project files. A plug-in can connect to this signal. When it is emitted, the plug-in knows to then check the project properties for any relevant state.

Added in v1.6

virtual QToolBar* QgisInterface::rasterToolBar ( )
pure virtualslot
Note
added in 1.7
virtual Q_DECL_DEPRECATED void QgisInterface::refreshLegend ( QgsMapLayer l)
pure virtualslot

refresh the legend of a layer

Deprecated:
use QgsLegendInterface::refreshLayerSymbology
virtual bool QgisInterface::registerMainWindowAction ( QAction *  action,
QString  defaultShortcut 
)
pure virtualslot

Register action to the shortcuts manager so its shortcut can be changed in GUI.

Note
added in 1.2
virtual void QgisInterface::removeAddLayerAction ( QAction *  action)
pure virtualslot

Remove "add layer" action from layer menu.

Note
added in 1.7
virtual void QgisInterface::removeDockWidget ( QDockWidget *  dockwidget)
pure virtualslot

Remove specified dock widget from main window (doesn't delete it).

Note
Added in 1.1
virtual void QgisInterface::removePluginDatabaseMenu ( QString  name,
QAction *  action 
)
pure virtualslot

Remove action from the Database menu.

Note
added in 1.7
virtual void QgisInterface::removePluginMenu ( QString  name,
QAction *  action 
)
pure virtualslot

Remove action from the plugins menu.

virtual void QgisInterface::removeToolBarIcon ( QAction *  qAction)
pure virtualslot

Remove an action (icon) from the plugin toolbar.

virtual void QgisInterface::removeWindow ( QAction *  action)
pure virtualslot

Remove window from Window menu.

Calling this is necessary only for windows which are hidden rather than deleted when closed.

virtual bool QgisInterface::setActiveLayer ( QgsMapLayer )
pure virtualslot

Set the active layer (layer gets selected in the legend) returns true if the layer exists, false otherwise added in 1.4.

virtual QMenu* QgisInterface::settingsMenu ( )
pure virtualslot
virtual void QgisInterface::showAttributeTable ( QgsVectorLayer l)
pure virtualslot

open attribute table dialog

Note
added in 1.7
virtual void QgisInterface::showLayerProperties ( QgsMapLayer l)
pure virtualslot

open layer properties dialog

Note
added in 1.5
virtual bool QgisInterface::unregisterMainWindowAction ( QAction *  action)
pure virtualslot

Unregister a previously registered action.

(e.g. when plugin is going to be unloaded)

Note
added in 1.2
virtual QMenu* QgisInterface::viewMenu ( )
pure virtualslot
virtual QMenu* QgisInterface::windowMenu ( )
pure virtualslot
virtual void QgisInterface::zoomFull ( )
pure virtualslot

Zoom to full extent of map layers.

virtual void QgisInterface::zoomToActiveLayer ( )
pure virtualslot

Zoom to extent of the active layer.

virtual void QgisInterface::zoomToNext ( )
pure virtualslot

Zoom to next view extent.

virtual void QgisInterface::zoomToPrevious ( )
pure virtualslot

Zoom to previous view extent.


The documentation for this class was generated from the following files: