Skip to content
Permalink
Browse files
Added notes about new classes and methods in 1.1
git-svn-id: http://svn.osgeo.org/qgis/trunk@10492 c8812cc2-4d05-0410-92ff-de0c093fc19c
  • Loading branch information
mhugent committed Apr 7, 2009
1 parent 0af72a7 commit ba33f558276ad0078537ea075fa3f225a8ff5e81
@@ -24,7 +24,9 @@
class QgsPoint;

/**A simple position manager implementation which positions the overlay objects on the center point of
a feature. It does not consider conflicts in case of several overlay layers*/
a feature. It does not consider conflicts in case of several overlay layers
* \note This class has been added in version 1.1
*/
class QgsCentralPointPositionManager: public QgsOverlayObjectPositionManager
{
public:
@@ -118,7 +118,8 @@ class CORE_EXPORT QgsGeometry
*/
size_t wkbSize();

/**Returns a geos geomtry. QgsGeometry keeps ownership, don't delete this object!*/
/**Returns a geos geomtry. QgsGeometry keeps ownership, don't delete the returned object!
@note this method was added in version 1.1*/
GEOSGeometry* asGeos();

/** Returns type of wkb (point / linestring / polygon etc.) */
@@ -179,7 +179,8 @@ class CORE_EXPORT QgsMapRenderer : public QObject
*/
bool splitLayersExtent( QgsMapLayer* layer, QgsRectangle& extent, QgsRectangle& r2 );

/**Creates an overlay object position manager subclass according to the current settings*/
/**Creates an overlay object position manager subclass according to the current settings
@note this method was added in version 1.1*/
QgsOverlayObjectPositionManager* overlayManagerFromSettings();

protected:
@@ -25,8 +25,10 @@
class QgsGeometry;

/**An object that holds information about the position and bounding box size of
an overlay object. It stores a copy of the feature geometry as this information is commonly used
to calculate object placement*/
* an overlay object. It stores a copy of the feature geometry as this information is commonly used
* to calculate object placement
* \note This class has been added in version 1.1
*/
class CORE_EXPORT QgsOverlayObject: public pal::PalGeometry
{
public:
@@ -25,7 +25,9 @@ class QgsRenderContext;
class QgsVectorLayer;
class QgsVectorOverlay;

/**Interface for classes that arrange overlay objects of different layers on the map*/
/**Interface for classes that arrange overlay objects of different layers on the map
* \note This class has been added in version 1.1
*/
class QgsOverlayObjectPositionManager
{
public:
@@ -21,6 +21,9 @@
#include "qgsoverlayobjectpositionmanager.h"
#include "pal.h"

/**A class that uses the PAL library for overlay object placement
* \note This class has been added in version 1.1
*/
class QgsPALObjectPositionManager: public QgsOverlayObjectPositionManager
{
public:
@@ -427,16 +427,24 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
/**access range */
RangeData &range( int idx );

/**Adds a new overlay to this class. QgsVectorLayer takes ownership of the object*/
/**Adds a new overlay to this class. QgsVectorLayer takes ownership of the object
@note this method was added in version 1.1
*/
void addOverlay( QgsVectorOverlay* overlay );

/**Removes all overlays of a given type*/
/**Removes all overlays of a given type
@note this method was added in version 1.1
*/
void removeOverlay( const QString& typeName );

/**Returns pointers to the overlays of this layer*/
/**Returns pointers to the overlays of this layer
@note this method was added in version 1.1
*/
void vectorOverlays( QList<QgsVectorOverlay*>& overlayList );

/**Returns the (first) overlay of a type, e.g. diagram or label*/
/**Returns the (first) overlay of a type, e.g. diagram or label
@note this method was added in version 1.1
*/
QgsVectorOverlay* findOverlayByType( const QString& typeName );

public slots:
@@ -25,7 +25,9 @@ class QgsOverlayObject;
class QgsRect;
class QgsRenderContext;

/**Base class for vector layer overlays (e.g. Diagrams, labels, etc.). For each object, the position of the bounding box is stored in a QgsOberlayObject. The vector overlays are drawn on top of all layers*/
/**Base class for vector layer overlays (e.g. Diagrams, labels, etc.). For each object, the position of the bounding box is *stored in a QgsOberlayObject. The vector overlays are drawn on top of all layers
* \note This class has been added in version 1.1
*/
class CORE_EXPORT QgsVectorOverlay
{
public:

0 comments on commit ba33f55

Please sign in to comment.