QgisInterface Class Reference
[QGIS gui library.]

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

#include <qgisinterface.h>

List of all members.

Public Slots

virtual void zoomFull ()=0
 Zoom to full extent of map layers.
virtual void zoomToPrevious ()=0
 Zoom to previous view extent.
virtual void zoomToNext ()=0
 Zoom to next view extent.
virtual void zoomToActiveLayer ()=0
 Zoom to extent of the active layer.
virtual QgsVectorLayeraddVectorLayer (QString vectorLayerPath, QString baseName, QString providerKey)=0
 Add a vector layer.
virtual QgsRasterLayeraddRasterLayer (QString rasterLayerPath, QString baseName=QString())=0
 Add a raster layer given a raster layer file name.
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.
virtual bool addProject (QString theProject)=0
 Add a project.
virtual void newProject (bool thePromptToSaveFlag=false)=0
 Start a blank project.
virtual QgsMapLayeractiveLayer ()=0
 Get pointer to the active layer (layer selected in the legend).
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.
virtual int addToolBarIcon (QAction *qAction)=0
 Add an icon to the plugins toolbar.
virtual void removeToolBarIcon (QAction *qAction)=0
 Remove an action (icon) from the plugin toolbar.
virtual QToolBar * addToolBar (QString name)=0
 Add toolbar with specified name.
virtual QgsMapCanvasmapCanvas ()=0
 Return a pointer to the map canvas.
virtual QWidget * mainWindow ()=0
 Return a pointer to the main window (instance of QgisApp in case of QGIS).
virtual QList< QgsComposerView * > activeComposers ()=0
 Return mainwindows / composer views of running composer instances (currently only one).
virtual void addPluginToMenu (QString name, QAction *action)=0
 Add action to the plugins menu.
virtual void removePluginMenu (QString name, QAction *action)=0
 Remove action from the plugins menu.
virtual void addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget)=0
 Add a dock widget to the main window.
virtual void removeDockWidget (QDockWidget *dockwidget)=0
 Remove specified dock widget from main window (doesn't delete it).
virtual void refreshLegend (QgsMapLayer *l)=0
 refresh the legend of a layer
virtual void showLayerProperties (QgsMapLayer *l)=0
 open layer properties dialog
virtual void addWindow (QAction *action)=0
 Add window to Window menu.
virtual void removeWindow (QAction *action)=0
 Remove window from Window menu.
virtual bool registerMainWindowAction (QAction *action, QString defaultShortcut)=0
 Register action to the shortcuts manager so its shortcut can be changed in GUI.
virtual bool unregisterMainWindowAction (QAction *action)=0
 Unregister a previously registered action.
virtual void openURL (QString url, bool useQgisDocDirectory=true)=0
 Open a url in the users browser.
virtual QMenu * fileMenu ()=0
 Accessors for inserting items into menus and toolbars.
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.
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 QAction * actionNewProject ()=0
 File menu actions.
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
virtual QAction * actionCutFeatures ()=0
 Edit menu actions.
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 * actionSimplifyFeature ()=0
virtual QAction * actionDeleteRing ()=0
virtual QAction * actionDeletePart ()=0
virtual QAction * actionNodeTool ()=0
virtual QAction * actionEditSeparator2 ()=0
virtual QAction * actionPan ()=0
 View menu actions.
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 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
virtual QAction * actionNewVectorLayer ()=0
 Layer menu actions.
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
virtual QAction * actionManagePlugins ()=0
 Plugin menu actions.
virtual QAction * actionPluginSeparator1 ()=0
virtual QAction * actionPluginListSeparator ()=0
virtual QAction * actionPluginSeparator2 ()=0
virtual QAction * actionPluginPythonSeparator ()=0
virtual QAction * actionShowPythonDialog ()=0
virtual QAction * actionToggleFullScreen ()=0
 Settings menu actions.
virtual QAction * actionSettingsSeparator1 ()=0
virtual QAction * actionOptions ()=0
virtual QAction * actionCustomProjection ()=0
virtual QAction * actionHelpContents ()=0
 Help menu actions.
virtual QAction * actionHelpSeparator1 ()=0
virtual QAction * actionQgisHomePage ()=0
virtual QAction * actionCheckQgisVersion ()=0
virtual QAction * actionHelpSeparator2 ()=0
virtual QAction * actionAbout ()=0
virtual bool openFeatureForm (QgsVectorLayer *vlayer, QgsFeature &f, bool updateFeatureOnly=false)=0
 Open feature form.

Signals

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

Public Member Functions

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


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 54 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 QgsLegendInterface* QgisInterface::legendInterface (  )  [pure virtual]

Get pointer to legend interface.

Note:
added in 1.4

virtual void QgisInterface::zoomFull (  )  [pure virtual, slot]

Zoom to full extent of map layers.

virtual void QgisInterface::zoomToPrevious (  )  [pure virtual, slot]

Zoom to previous view extent.

virtual void QgisInterface::zoomToNext (  )  [pure virtual, slot]

Zoom to next view extent.

virtual void QgisInterface::zoomToActiveLayer (  )  [pure virtual, slot]

Zoom to extent of the active layer.

virtual QgsVectorLayer* QgisInterface::addVectorLayer ( QString  vectorLayerPath,
QString  baseName,
QString  providerKey 
) [pure virtual, slot]

Add a vector layer.

virtual QgsRasterLayer* QgisInterface::addRasterLayer ( QString  rasterLayerPath,
QString  baseName = QString() 
) [pure virtual, slot]

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 virtual, slot]

Add a WMS layer.

virtual bool QgisInterface::addProject ( QString  theProject  )  [pure virtual, slot]

Add a project.

virtual void QgisInterface::newProject ( bool  thePromptToSaveFlag = false  )  [pure virtual, slot]

Start a blank project.

virtual QgsMapLayer* QgisInterface::activeLayer (  )  [pure virtual, slot]

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

virtual bool QgisInterface::setActiveLayer ( QgsMapLayer  )  [pure virtual, slot]

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

virtual int QgisInterface::addToolBarIcon ( QAction *  qAction  )  [pure virtual, slot]

Add an icon to the plugins toolbar.

virtual void QgisInterface::removeToolBarIcon ( QAction *  qAction  )  [pure virtual, slot]

Remove an action (icon) from the plugin toolbar.

virtual QToolBar* QgisInterface::addToolBar ( QString  name  )  [pure virtual, slot]

Add toolbar with specified name.

virtual QgsMapCanvas* QgisInterface::mapCanvas (  )  [pure virtual, slot]

Return a pointer to the map canvas.

virtual QWidget* QgisInterface::mainWindow (  )  [pure virtual, slot]

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

virtual QList<QgsComposerView*> QgisInterface::activeComposers (  )  [pure virtual, slot]

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

virtual void QgisInterface::addPluginToMenu ( QString  name,
QAction *  action 
) [pure virtual, slot]

Add action to the plugins menu.

virtual void QgisInterface::removePluginMenu ( QString  name,
QAction *  action 
) [pure virtual, slot]

Remove action from the plugins menu.

virtual void QgisInterface::addDockWidget ( Qt::DockWidgetArea  area,
QDockWidget *  dockwidget 
) [pure virtual, slot]

Add a dock widget to the main window.

virtual void QgisInterface::removeDockWidget ( QDockWidget *  dockwidget  )  [pure virtual, slot]

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

Added in QGIS 1.1.

virtual void QgisInterface::refreshLegend ( QgsMapLayer l  )  [pure virtual, slot]

refresh the legend of a layer

Note:
deprecated - use QgsLegendInterface::refreshLayerSymbology

virtual void QgisInterface::showLayerProperties ( QgsMapLayer l  )  [pure virtual, slot]

open layer properties dialog

Note:
added in 1.5

virtual void QgisInterface::addWindow ( QAction *  action  )  [pure virtual, slot]

Add window to Window menu.

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

virtual void QgisInterface::removeWindow ( QAction *  action  )  [pure virtual, slot]

Remove window from Window menu.

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

virtual bool QgisInterface::registerMainWindowAction ( QAction *  action,
QString  defaultShortcut 
) [pure virtual, slot]

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

Note:
added in 1.2

virtual bool QgisInterface::unregisterMainWindowAction ( QAction *  action  )  [pure virtual, slot]

Unregister a previously registered action.

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

Note:
added in 1.2

virtual void QgisInterface::openURL ( QString  url,
bool  useQgisDocDirectory = true 
) [pure virtual, slot]

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:
url URL to open
useQgisDocDirectory If true, the URL will be formed by concatenating url to the QGIS documentation directory path (prefix/share/doc)

virtual QMenu* QgisInterface::fileMenu (  )  [pure virtual, slot]

Accessors for inserting items into menus and toolbars.

An item can be inserted before any existing action. Menus

virtual QMenu* QgisInterface::editMenu (  )  [pure virtual, slot]

virtual QMenu* QgisInterface::viewMenu (  )  [pure virtual, slot]

virtual QMenu* QgisInterface::layerMenu (  )  [pure virtual, slot]

virtual QMenu* QgisInterface::settingsMenu (  )  [pure virtual, slot]

virtual QMenu* QgisInterface::pluginMenu (  )  [pure virtual, slot]

virtual QMenu* QgisInterface::firstRightStandardMenu (  )  [pure virtual, slot]

virtual QMenu* QgisInterface::windowMenu (  )  [pure virtual, slot]

virtual QMenu* QgisInterface::helpMenu (  )  [pure virtual, slot]

virtual QToolBar* QgisInterface::fileToolBar (  )  [pure virtual, slot]

ToolBars.

virtual QToolBar* QgisInterface::layerToolBar (  )  [pure virtual, slot]

virtual QToolBar* QgisInterface::mapNavToolToolBar (  )  [pure virtual, slot]

virtual QToolBar* QgisInterface::digitizeToolBar (  )  [pure virtual, slot]

virtual QToolBar* QgisInterface::advancedDigitizeToolBar (  )  [pure virtual, slot]

virtual QToolBar* QgisInterface::attributesToolBar (  )  [pure virtual, slot]

virtual QToolBar* QgisInterface::pluginToolBar (  )  [pure virtual, slot]

virtual QToolBar* QgisInterface::helpToolBar (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionNewProject (  )  [pure virtual, slot]

File menu actions.

virtual QAction* QgisInterface::actionOpenProject (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionFileSeparator1 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSaveProject (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSaveProjectAs (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSaveMapAsImage (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionFileSeparator2 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionProjectProperties (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionFileSeparator3 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionPrintComposer (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionFileSeparator4 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionExit (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionCutFeatures (  )  [pure virtual, slot]

Edit menu actions.

virtual QAction* QgisInterface::actionCopyFeatures (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionPasteFeatures (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionEditSeparator1 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionCapturePoint (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionCaptureLine (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionCapturePolygon (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionDeleteSelected (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionMoveFeature (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSplitFeatures (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionAddVertex (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionDeleteVertex (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionMoveVertex (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionAddRing (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionAddIsland (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSimplifyFeature (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionDeleteRing (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionDeletePart (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionNodeTool (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionEditSeparator2 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionPan (  )  [pure virtual, slot]

View menu actions.

virtual QAction* QgisInterface::actionZoomIn (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionZoomOut (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSelect (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSelectRectangle (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSelectPolygon (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSelectFreehand (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionSelectRadius (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionIdentify (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionMeasure (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionMeasureArea (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionViewSeparator1 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionZoomFullExtent (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionZoomToLayer (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionZoomToSelected (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionZoomLast (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionZoomActualSize (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionViewSeparator2 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionMapTips (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionNewBookmark (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionShowBookmarks (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionDraw (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionViewSeparator3 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionNewVectorLayer (  )  [pure virtual, slot]

Layer menu actions.

virtual QAction* QgisInterface::actionAddOgrLayer (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionAddRasterLayer (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionAddPgLayer (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionAddWmsLayer (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSeparator1 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionOpenTable (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionToggleEditing (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSaveAs (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSelectionSaveAs (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionRemoveLayer (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionLayerProperties (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSeparator2 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionAddToOverview (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionAddAllToOverview (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionRemoveAllFromOverview (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionLayerSeparator3 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionHideAllLayers (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionShowAllLayers (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionManagePlugins (  )  [pure virtual, slot]

Plugin menu actions.

virtual QAction* QgisInterface::actionPluginSeparator1 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionPluginListSeparator (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionPluginSeparator2 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionPluginPythonSeparator (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionShowPythonDialog (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionToggleFullScreen (  )  [pure virtual, slot]

Settings menu actions.

virtual QAction* QgisInterface::actionSettingsSeparator1 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionOptions (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionCustomProjection (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionHelpContents (  )  [pure virtual, slot]

Help menu actions.

virtual QAction* QgisInterface::actionHelpSeparator1 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionQgisHomePage (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionCheckQgisVersion (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionHelpSeparator2 (  )  [pure virtual, slot]

virtual QAction* QgisInterface::actionAbout (  )  [pure virtual, slot]

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

Open feature form.

void QgisInterface::currentLayerChanged ( QgsMapLayer layer  )  [signal]

Emited whenever current (selected) layer changes.

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

void QgisInterface::composerAdded ( QgsComposerView v  )  [signal]

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

Note:
added in version 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 version 1.4

void QgisInterface::initializationCompleted (  )  [signal]

This signal is emitted when the initialization is complete.

Note:
added in version 1.6

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

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


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

Generated on Sat Feb 4 19:17:23 2012 for Quantum GIS API Documentation by  doxygen 1.5.6