sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-13 00:03:09 -04:00
Code Issues Packages Projects Releases Wiki Activity

[composer] Small improvements to api docs

Browse Source
This commit is contained in:
Nyall Dawson 2014-06-01 13:05:36 +10:00
parent b7423cf24b
commit 166f8fc534
4 changed files with 46 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
python/core/composer/qgscomposeritem.sip
View File

@ -179,13 +179,30 @@ class QgsComposerItem : QObject, QGraphicsRectItem
@param y y-position of mouse cursor (in item coordinates)*/
virtual void zoomContent( int delta, double x, double y );
/** gets the page the item is currently on */
/**Gets the page the item is currently on.
* @returns page number for item
* @see pagePos
* @see updatePagePos
* @note this method was added in version 2.4
*/
int page() const;
/** Returns the position relative to the current page */
/**Returns the item's position relative to its current page.
* @returns position relative to the page's top left corner.
* @see page
* @see updatePagePos
* @note this method was added in version 2.4
*/
QPointF pagePos() const;
/** Updates the page relative position for the new paper size */
/**Moves the item so that it retains its relative position on the page
* when the paper size changes.
* @param newPageWidth new width of the page in mm
* @param newPageHeight new height of the page in mm
* @see page
* @see pagePos
* @note this method was added in version 2.4
*/
void updatePagePos( double newPageWidth, double newPageHeight );
/**Moves the item to a new position (in canvas coordinates)*/

4
python/core/composer/qgscomposition.sip
View File

@ -48,7 +48,9 @@ class QgsComposition : QGraphicsScene
~QgsComposition();
/**Changes size of paper item*/
/**Changes size of paper item. Also moves all items so that they retain
* their same relative position to the top left corner of their current page.
*/
void setPaperSize( double width, double height );
/**Returns height of paper item*/

23
src/core/composer/qgscomposeritem.h
View File

@ -133,13 +133,30 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
@param y y-position of mouse cursor (in item coordinates)*/
virtual void zoomContent( int delta, double x, double y ) { Q_UNUSED( delta ); Q_UNUSED( x ); Q_UNUSED( y ); }
/** gets the page the item is currently on */
/**Gets the page the item is currently on.
* @returns page number for item
* @see pagePos
* @see updatePagePos
* @note this method was added in version 2.4
*/
int page() const;
/** Returns the position relative to the current page */
/**Returns the item's position relative to its current page.
* @returns position relative to the page's top left corner.
* @see page
* @see updatePagePos
* @note this method was added in version 2.4
*/
QPointF pagePos() const;
/** Updates the page relative position for the new paper size */
/**Moves the item so that it retains its relative position on the page
* when the paper size changes.
* @param newPageWidth new width of the page in mm
* @param newPageHeight new height of the page in mm
* @see page
* @see pagePos
* @note this method was added in version 2.4
*/
void updatePagePos( double newPageWidth, double newPageHeight );
/**Moves the item to a new position (in canvas coordinates)*/

4
src/core/composer/qgscomposition.h
View File

@ -104,7 +104,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene
~QgsComposition();
/**Changes size of paper item*/
/**Changes size of paper item. Also moves all items so that they retain
* their same relative position to the top left corner of their current page.
*/
void setPaperSize( double width, double height );
/**Returns height of paper item*/