API documentation for QgisInterface

qgis · Oct 17, 2013 · 2b74e89 · 2b74e89
1 parent b114dce
commit 2b74e89
Showing 1 changed file with 31 additions and 9 deletions.
diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h
@@ -373,7 +373,7 @@ class GUI_EXPORT QgisInterface : public QObject
      * An item can be inserted before any existing action.
      */
 
-    //! Menus
+    // Menus
 #ifndef Q_MOC_RUN
     Q_DECL_DEPRECATED
 #endif
@@ -401,7 +401,7 @@ class GUI_EXPORT QgisInterface : public QObject
     virtual QMenu *windowMenu() = 0;
     virtual QMenu *helpMenu() = 0;
 
-    //! ToolBars
+    // ToolBars
     virtual QToolBar *fileToolBar() = 0;
     virtual QToolBar *layerToolBar() = 0;
     virtual QToolBar *mapNavToolToolBar() = 0;
@@ -423,7 +423,7 @@ class GUI_EXPORT QgisInterface : public QObject
     */
     virtual QToolBar *webToolBar() = 0;
 
-    //! Project menu actions
+    // Project menu actions
     virtual QAction *actionNewProject() = 0;
     virtual QAction *actionOpenProject() = 0;
     virtual QAction *actionSaveProject() = 0;
@@ -434,7 +434,7 @@ class GUI_EXPORT QgisInterface : public QObject
     virtual QAction *actionShowComposerManager() = 0;
     virtual QAction *actionExit() = 0;
 
-    //! Edit menu actions
+    // Edit menu actions
     virtual QAction *actionCutFeatures() = 0;
     virtual QAction *actionCopyFeatures() = 0;
     virtual QAction *actionPasteFeatures() = 0;
@@ -450,31 +450,53 @@ class GUI_EXPORT QgisInterface : public QObject
     virtual QAction *actionDeletePart() = 0;
     virtual QAction *actionNodeTool() = 0;
 
-    //! View menu actions
+    // View menu actions
+    //! Get access to the native pan action. Call trigger() on it to set the default pan map tool.
     virtual QAction *actionPan() = 0;
+    //! Get access to the native touch action.
     virtual QAction *actionTouch() = 0;
+    //! Get access to the native pan to selected action. Call trigger() on it to pan the map canvas to the selection.
     virtual QAction *actionPanToSelected() = 0;
+    //! Get access to the native zoom in action. Call trigger() on it to set the default zoom in map tool.
     virtual QAction *actionZoomIn() = 0;
+    //! Get access to the native zoom out action. Call trigger() on it to set the default zoom out map tool.
     virtual QAction *actionZoomOut() = 0;
+    //! Get access to the native select action. Call trigger() on it to set the default select map tool.
     virtual QAction *actionSelect() = 0;
+    //! Get access to the native select rectangle action. Call trigger() on it to set the default select rectangle map tool.
     virtual QAction *actionSelectRectangle() = 0;
+    //! Get access to the native select polygon action. Call trigger() on it to set the default select polygon map tool.
     virtual QAction *actionSelectPolygon() = 0;
+    //! Get access to the native select freehand action. Call trigger() on it to set the default select freehand map tool.
     virtual QAction *actionSelectFreehand() = 0;
+    //! Get access to the native select radius action. Call trigger() on it to set the default select radius map tool.
     virtual QAction *actionSelectRadius() = 0;
+    //! Get access to the native identify action. Call trigger() on it to set the default identify map tool.
     virtual QAction *actionIdentify() = 0;
+    //! Get access to the native measure action. Call trigger() on it to set the default measure map tool.
     virtual QAction *actionMeasure() = 0;
+    //! Get access to the native measure area action. Call trigger() on it to set the default measure area map tool.
     virtual QAction *actionMeasureArea() = 0;
+    //! Get access to the native zoom full extent action. Call trigger() on it to zoom to the full extent.
     virtual QAction *actionZoomFullExtent() = 0;
+    //! Get access to the native zoom to layer action. Call trigger() on it to zoom to the active layer.
     virtual QAction *actionZoomToLayer() = 0;
+    //! Get access to the native zoom to selected action. Call trigger() on it to zoom to the current selection.
     virtual QAction *actionZoomToSelected() = 0;
+    //! Get access to the native zoom last action. Call trigger() on it to zoom to last.
     virtual QAction *actionZoomLast() = 0;
+    //! Get access to the native zoom actual size action. Call trigger() on it to zoom to actual size.
     virtual QAction *actionZoomActualSize() = 0;
+    //! Get access to the native map tips action. Call trigger() on it to toggle map tips.
     virtual QAction *actionMapTips() = 0;
+    //! Get access to the native new bookmark action. Call trigger() on it to open the new bookmark dialog.
     virtual QAction *actionNewBookmark() = 0;
+    //! Get access to the native show bookmarks action. Call trigger() on it to open the bookmarks dialog.
     virtual QAction *actionShowBookmarks() = 0;
+    //! Get access to the native draw action.
     virtual QAction *actionDraw() = 0;
 
-    //! Layer menu actions
+    // Layer menu actions
     virtual QAction *actionNewVectorLayer() = 0;
     virtual QAction *actionAddOgrLayer() = 0;
     virtual QAction *actionAddRasterLayer() = 0;
@@ -515,17 +537,17 @@ class GUI_EXPORT QgisInterface : public QObject
     virtual QAction *actionHideAllLayers() = 0;
     virtual QAction *actionShowAllLayers() = 0;
 
-    //! Plugin menu actions
+    // Plugin menu actions
     virtual QAction *actionManagePlugins() = 0;
     virtual QAction *actionPluginListSeparator() = 0;
     virtual QAction *actionShowPythonDialog() = 0;
 
-    //! Settings menu actions
+    // Settings menu actions
     virtual QAction *actionToggleFullScreen() = 0;
     virtual QAction *actionOptions() = 0;
     virtual QAction *actionCustomProjection() = 0;
 
-    //! Help menu actions
+    // Help menu actions
     virtual QAction *actionHelpContents() = 0;
     virtual QAction *actionQgisHomePage() = 0;
     virtual QAction *actionCheckQgisVersion() = 0;