Skip to content
Permalink
Browse files
Updates for doxygen for gui module
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@9221 c8812cc2-4d05-0410-92ff-de0c093fc19c
  • Loading branch information
timlinux committed Aug 30, 2008
1 parent 630ee1b commit 3d1144eec02425a42c3c10628b75ae63f40f41b4
@@ -18,9 +18,9 @@

#include <Qt>

/*!
/** \ingroup gui
* /namespace QgisGui
* /brief The QgisGui namespace contains constants used throughout the QGIS GUI.
* The QgisGui namespace contains constants used throughout the QGIS GUI.
*/
namespace QgisGui
{
@@ -34,9 +34,9 @@ class QgsMapCanvas;
class QgsRasterLayer;
class QgsVectorLayer;

/**
* \class QgisInterface
* \brief Abstract base class defining interfaces exposed by QgisApp and
/** \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.
@@ -18,6 +18,9 @@

#include <QToolButton>

/** \ingroup gui
* A cross platform button subclass for selecting colors.
*/
class GUI_EXPORT QgsColorButton: public QToolButton
{
public:
@@ -31,6 +31,7 @@ class QgsComposerPicture;
class QgsComposerScaleBar;

/** \ingroup MapComposer
* \ingroup gui
* Widget to display the composer items. Manages the composer tools and the
* mouse/key events.
* Creates the composer items according to the current map tools and keeps track
@@ -18,6 +18,9 @@
#ifndef QGSCURSORS_H
#define QGSCURSORS_H

/** \ingroup gui
* Bitmap cursors for map operations.
*/
extern GUI_EXPORT const char *zoom_in[];
extern GUI_EXPORT const char *zoom_out[];

@@ -23,7 +23,8 @@
#include <QString>
#include <QPixmap>

/** This class is the data only representation of a
/** \ingroup gui
* This class is the data only representation of a
* QgsDetailedItemWidget, designed to be used in custom views.
*/
class GUI_EXPORT QgsDetailedItemData
@@ -27,6 +27,11 @@ class QgsDetailedItemData;
class QFontMetrics;
class QFont;

/** \ingroup gui
* A custom model/view delegate that can display an icon, heading
* and detail sections.
* @see also QgsDetailedItemData
*/
class GUI_EXPORT QgsDetailedItemDelegate :
public QAbstractItemDelegate
{
@@ -21,6 +21,10 @@
#include <ui_qgsdetaileditemwidgetbase.h>
#include <qgsdetaileditemdata.h>

/** \ingroup gui
* A widget renderer for detailed item views.
* @see also QgsDetailedItem and QgsDetailedItemData.
*/
class QgsDetailedItemWidget :
public QWidget, private Ui::QgsDetailedItemWidgetBase
{
@@ -19,7 +19,9 @@
#include <QFileDialog>
class QComboBox;

/**A file dialog which lets the user select the prefered encoding type for a data provider*/
/** \ingroup gui
* A file dialog which lets the user select the prefered encoding type for a data provider.
**/
class GUI_EXPORT QgsEncodingFileDialog: public QFileDialog
{
Q_OBJECT
@@ -18,6 +18,10 @@

#include <QLineEdit>

/** \ingroup gui
* A line edit for capturing file names that can have files dropped onto
* it via drag & drop.
*/
class GUI_EXPORT QgsFileDropEdit: public QLineEdit
{
public:
@@ -38,6 +38,9 @@
* mEpsgId = mySelector.getSelectedEpsg();
* }
* \endcode
*
* If you wish to embed the projection selector into an existing dialog
* the you probably want to look at QgsProjectionSelector rather.
*/

class GUI_EXPORT QgsGenericProjectionSelector : public QDialog, private Ui::QgsGenericProjectionSelectorBase
@@ -55,8 +55,10 @@ class QgsMapCanvasMap;
class QgsMapOverviewCanvas;
class QgsMapTool;

/** \class QgsMapCanvasLayer
\brief class that stores additional layer's flags together with pointer to the layer
/** \ingroup gui
* A class that stores visibility and presence in overview flags together
* with pointer to the layer.
*
*/
class GUI_EXPORT QgsMapCanvasLayer
{
@@ -23,6 +23,10 @@
class QgsMapCanvas;
class QPainter;

/** \ingroup gui
* An abstract class for items that can be placed on the
* map canvas.
*/
class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem
{
protected:
@@ -24,6 +24,9 @@
class QgsMapRenderer;
class QgsMapCanvas;

/** \ingroup gui
* A rectangular graphics item representing the map on the canvas.
*/
class GUI_EXPORT QgsMapCanvasMap : public QGraphicsRectItem
{
public:
@@ -25,10 +25,12 @@ class QgsMapCanvas;
class QPoint;
class QgsSnapper;

/**This class reads the snapping properties from the
current project and configures a QgsSnapper to perform the snapping.
Snapping can be done to the active layer (usefull for selecting a vertex to manipulate)
or to background layers*/
/** \ingroup gui
* This class reads the snapping properties from the current project and
* configures a QgsSnapper to perform the snapping.
* Snapping can be done to the active layer (usefull for selecting a vertex to
* manipulate) or to background layers
*/
class GUI_EXPORT QgsMapCanvasSnapper
{
public:
@@ -32,6 +32,9 @@ class QgsMapRenderer;
class QgsPanningWidget; // defined in .cpp
class QgsRect;

/** \ingroup gui
* A widget that displays an overview map.
*/
class GUI_EXPORT QgsMapOverviewCanvas : public QWidget
{
Q_OBJECT
@@ -31,6 +31,12 @@ class QPoint;
class QAction;
class QAbstractButton;

/** \ingroup gui
* Abstract base class for all map tools.
* Map tools are user interactive tools for manipulating the
* map canvas. For example map pan and zoom features are
* implemented as map tools.
*/
class GUI_EXPORT QgsMapTool : public QObject
{
public:
@@ -22,6 +22,11 @@
class QgsMapCanvas;


/** \ingroup gui
* A map tool that simple emits a point when clicking on the map.
* Connecting a slot to its gotPoint() signal will
* let you implement custom behaviour for the passed in point.
*/
class GUI_EXPORT QgsMapToolEmitPoint : public QgsMapTool
{
Q_OBJECT
@@ -21,6 +21,10 @@
class QgsMapCanvas;


/** \ingroup gui
* A map tool for panning the map.
* @see QgsMapTool
*/
class GUI_EXPORT QgsMapToolPan : public QgsMapTool
{
public:
@@ -23,6 +23,10 @@

class QRubberBand;

/** \ingroup gui
* A map tool for zooming into the map.
* @see QgsMapTool
*/
class GUI_EXPORT QgsMapToolZoom : public QgsMapTool
{
public:
@@ -24,6 +24,10 @@

#include <QString>


/** \ingroup gui
* A generic message view for displaying QGIS messages.
*/
class GUI_EXPORT QgsMessageViewer: public QDialog, public QgsMessageOutput, private Ui::QgsMessageViewer
{
Q_OBJECT
@@ -17,7 +17,9 @@

class QResizeEvent;

/**
/** \ingroup gui
* A widget for selecting a Coordinate reference system from a tree.
* @see QgsGenericProjectionSelector.
@author Tim Sutton
*/
class GUI_EXPORT QgsProjectionSelector: public QWidget, private Ui::QgsProjectionSelectorBase
@@ -29,9 +29,8 @@
#include <qgsmapcanvas.h>


/**
* \class QgsQgsQuickPrint
* \brief A convenience class for quickly printing a map.
/** \ingroup gui
* A convenience class for quickly printing a map.
* Prints a map with a map title, scale bar, north arrow, legend etc.
*/
class GUI_EXPORT QgsQuickPrint: public QObject
@@ -26,6 +26,9 @@ class QgsGeometry;
class QgsVectorLayer;
class QPaintEvent;

/** \ingroup gui
* A class for drawing transient features (e.g. digitising lines) on the map.
*/
class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
{
public:
@@ -22,6 +22,9 @@

class QPainter;

/** \ingroup gui
* A class for marking vertices of features using e.g. circles or 'x'.
*/
class GUI_EXPORT QgsVertexMarker : public QgsMapCanvasItem
{
public:

0 comments on commit 3d1144e

Please sign in to comment.