Skip to content
Permalink
Browse files

fix doxygen warnings

  • Loading branch information
jef-n committed Apr 30, 2014
1 parent eacb5bd commit 208fdb6f6fc8dcb15cc55068e3141471b2bb132e
Showing with 34 additions and 33 deletions.
  1. +31 −30 src/core/composer/qgscomposerpicture.h
  2. +3 −3 src/core/composer/qgscomposition.h
@@ -107,37 +107,38 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
*/
double pictureRotation() const { return mPictureRotation; }

/**Sets the map object for rotation (by id). A value of -1 disables the map rotation.
* If this is set then the picture will be rotated by the same amount as the specified
* map object. This is useful especially for syncing north arrows with a map item.
* @param id composer map id to sync rotation with
/**Sets the map object for rotation (by id). A value of -1 disables the map
* rotation. If this is set then the picture will be rotated by the same
* amount as the specified map object. This is useful especially for
* syncing north arrows with a map item.
* @param composerMapId composer map id to sync rotation with
* @see setPictureRotation
* @see rotationMap
*/
*/
void setRotationMap( int composerMapId );

/**Returns the id of the rotation map. A value of -1 means map rotation is disabled.
* If this is set then the picture is rotated by the same amount as the specified
* map object.
/**Returns the id of the rotation map. A value of -1 means map rotation is
* disabled. If this is set then the picture is rotated by the same amount
* as the specified map object.
* @returns id of map object
* @see setRotationMap
* @see useRotationMap
*/
*/
int rotationMap() const;

/**True if the picture rotation is matched to a map item.
* @returns true if rotation map is in use
* @see rotationMap
* @see setRotationMap
*/
*/
bool useRotationMap() const { return mRotationMap; }

/**Returns the resize mode used for drawing the picture within the composer item's
* frame.
/**Returns the resize mode used for drawing the picture within the composer
* item's frame.
* @returns resize mode of picture
* @note added in 2.3
* @see setResizeMode
*/
*/
ResizeMode resizeMode() const { return mResizeMode; }

/**Returns whether the picture item is using an expression for the image source.
@@ -147,7 +148,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* @see setUsePictureExpression
* @see pictureFile
* @see pictureExpression
*/
*/
bool usePictureExpression() const { return mUseSourceExpression; }

/**Returns the expression the item is using for the picture source. This is only
@@ -156,7 +157,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* @note added in 2.3
* @see setPictureExpression
* @see usePictureExpression
*/
*/
QString pictureExpression() const { return mSourceExpression; }

/**Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation
@@ -170,37 +171,37 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
*/
Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect( double& x, double& y, double width, double height ) const;
/**Calculates width / height of the bounding box of a rotated rectangle
* @deprecated Use QgsComposerItem::sizeChangedByRotation( double& width, double& height, double rotation )
* instead
*/
* @deprecated Use QgsComposerItem::sizeChangedByRotation( double& width, double& height, double rotation )
* instead
*/
Q_DECL_DEPRECATED void sizeChangedByRotation( double& width, double& height );

/**Returns the current picture mode (image format).
* @returns picture mode
* @note added in 2.3
*/
*/
Mode mode() const { return mMode; }

public slots:
/**Sets the picture rotation within the item bounds. This does not affect the item rectangle,
only the way the picture is drawn within the item.
/**Sets the picture rotation within the item bounds. This does not affect
* the item rectangle, only the way the picture is drawn within the item.
* @deprecated Use setPictureRotation( double rotation ) instead
*/
virtual void setRotation( double r );

/**Sets the picture rotation within the item bounds. This does not affect the item's frame,
* only the way the picture is drawn within the item.
/**Sets the picture rotation within the item bounds. This does not affect
* the item's frame, only the way the picture is drawn within the item.
* @param r rotation in degrees clockwise
* @see pictureRotation
* @note added in 2.2
*/
*/
virtual void setPictureRotation( double r );

/**Sets the resize mode used for drawing the picture within the item bounds.
* @param mode ResizeMode to use for image file
* @note added in 2.3
* @see resizeMode
*/
*/
virtual void setResizeMode( ResizeMode mode );

/**Sets whether the picture should use an expression based image source path
@@ -210,7 +211,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* @see usePictureExpression
* @see setPictureFile
* @see setPictureExpression
*/
*/
virtual void setUsePictureExpression( bool useExpression );

/**Sets an expression to use for the picture source. This expression is only
@@ -219,24 +220,24 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* @note added in 2.3
* @see setUsePictureExpression
* @see pictureExpression
*/
*/
virtual void setPictureExpression( QString expression );

/**Recalculates the source image (if using an expression for picture's source)
* and reloads and redraws the picture.
* @note added in 2.3
*/
*/
void refreshPicture();

/**Prepares the picture's source expression after it is altered or the compositions
* atlas coverage layer changes.
* @note added in 2.3
*/
*/
void updatePictureExpression();

/**Forces a recalculation of the picture's frame size
* @note added in 2.3
*/
*/
void recalculateSize();

signals:
@@ -220,9 +220,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene
/**Returns the composer html with specified id (a string as named in the
composer user interface item properties).
@note Added in QGIS 2.0
@param id - A QString representing the id of the item.
@param item the item.
@return QgsComposerHtml pointer or 0 pointer if no such item exists.
*/
*/
const QgsComposerHtml* getComposerHtmlByItem( QgsComposerItem *item ) const;

/**Returns a composer item given its text identifier.
@@ -231,7 +231,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene
@param theId - A QString representing the identifier of the item to
retrieve.
@return QgsComposerItem pointer or 0 pointer if no such item exists.
**/
*/
const QgsComposerItem* getComposerItemById( QString theId ) const;

/**Returns a composer item given its unique identifier.

0 comments on commit 208fdb6

Please sign in to comment.
You can’t perform that action at this time.