mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-28 00:17:30 -05:00
Add missing docs
This commit is contained in:
parent
49c41d39c2
commit
ce0ac40a30
@ -87,6 +87,7 @@ class QgsLayoutItemMap : QgsLayoutItem
|
|||||||
item to ensure that the extent exactly matches the specified extent, with no
|
item to ensure that the extent exactly matches the specified extent, with no
|
||||||
overlap or margin. This method implicitly alters the map scale.
|
overlap or margin. This method implicitly alters the map scale.
|
||||||
.. seealso:: zoomToExtent()
|
.. seealso:: zoomToExtent()
|
||||||
|
.. seealso:: extentChanged()
|
||||||
%End
|
%End
|
||||||
|
|
||||||
void zoomToExtent( const QgsRectangle &extent );
|
void zoomToExtent( const QgsRectangle &extent );
|
||||||
@ -102,6 +103,7 @@ class QgsLayoutItemMap : QgsLayoutItem
|
|||||||
%Docstring
|
%Docstring
|
||||||
Returns the current map extent.
|
Returns the current map extent.
|
||||||
.. seealso:: visibleExtentPolygon()
|
.. seealso:: visibleExtentPolygon()
|
||||||
|
.. seealso:: extentChanged()
|
||||||
:rtype: QgsRectangle
|
:rtype: QgsRectangle
|
||||||
%End
|
%End
|
||||||
|
|
||||||
@ -274,6 +276,7 @@ Returns true if the map contains layers with blend modes or flattened layers for
|
|||||||
Sets the ``rotation`` for the map - this does not affect the composer item shape, only the
|
Sets the ``rotation`` for the map - this does not affect the composer item shape, only the
|
||||||
way the map is drawn within the item. Rotation is in degrees, clockwise.
|
way the map is drawn within the item. Rotation is in degrees, clockwise.
|
||||||
.. seealso:: mapRotation()
|
.. seealso:: mapRotation()
|
||||||
|
.. seealso:: mapRotationChanged()
|
||||||
%End
|
%End
|
||||||
|
|
||||||
double mapRotation( QgsLayoutObject::PropertyValueType valueType = QgsLayoutObject::EvaluatedValue ) const;
|
double mapRotation( QgsLayoutObject::PropertyValueType valueType = QgsLayoutObject::EvaluatedValue ) const;
|
||||||
@ -283,6 +286,7 @@ Returns true if the map contains layers with blend modes or flattened layers for
|
|||||||
or the current evaluated rotation (which may be affected by data driven rotation
|
or the current evaluated rotation (which may be affected by data driven rotation
|
||||||
settings).
|
settings).
|
||||||
.. seealso:: setMapRotation()
|
.. seealso:: setMapRotation()
|
||||||
|
.. seealso:: mapRotationChanged()
|
||||||
:rtype: float
|
:rtype: float
|
||||||
%End
|
%End
|
||||||
|
|
||||||
@ -457,11 +461,19 @@ Transforms map coordinates to item coordinates (considering rotation and move of
|
|||||||
%End
|
%End
|
||||||
|
|
||||||
signals:
|
signals:
|
||||||
|
|
||||||
void extentChanged();
|
void extentChanged();
|
||||||
|
%Docstring
|
||||||
|
Is emitted when the map's extent changes.
|
||||||
|
.. seealso:: setExtent()
|
||||||
|
.. seealso:: extent()
|
||||||
|
%End
|
||||||
|
|
||||||
void mapRotationChanged( double newRotation );
|
void mapRotationChanged( double newRotation );
|
||||||
%Docstring
|
%Docstring
|
||||||
Is emitted on rotation change to notify north arrow pictures
|
Is emitted when the map's rotation changes.
|
||||||
|
.. seealso:: setMapRotation()
|
||||||
|
.. seealso:: mapRotation()
|
||||||
%End
|
%End
|
||||||
|
|
||||||
void preparedForAtlas();
|
void preparedForAtlas();
|
||||||
@ -475,7 +487,6 @@ Is emitted when the map has been prepared for atlas rendering, just before actua
|
|||||||
associated legend items know they should update
|
associated legend items know they should update
|
||||||
%End
|
%End
|
||||||
|
|
||||||
|
|
||||||
public slots:
|
public slots:
|
||||||
|
|
||||||
virtual void invalidateCache();
|
virtual void invalidateCache();
|
||||||
|
@ -114,6 +114,7 @@ class CORE_EXPORT QgsLayoutItemMap : public QgsLayoutItem
|
|||||||
* item to ensure that the extent exactly matches the specified extent, with no
|
* item to ensure that the extent exactly matches the specified extent, with no
|
||||||
* overlap or margin. This method implicitly alters the map scale.
|
* overlap or margin. This method implicitly alters the map scale.
|
||||||
* \see zoomToExtent()
|
* \see zoomToExtent()
|
||||||
|
* \see extentChanged()
|
||||||
*/
|
*/
|
||||||
void setExtent( const QgsRectangle &extent );
|
void setExtent( const QgsRectangle &extent );
|
||||||
|
|
||||||
@ -129,6 +130,7 @@ class CORE_EXPORT QgsLayoutItemMap : public QgsLayoutItem
|
|||||||
/**
|
/**
|
||||||
* Returns the current map extent.
|
* Returns the current map extent.
|
||||||
* \see visibleExtentPolygon()
|
* \see visibleExtentPolygon()
|
||||||
|
* \see extentChanged()
|
||||||
*/
|
*/
|
||||||
QgsRectangle extent() const;
|
QgsRectangle extent() const;
|
||||||
|
|
||||||
@ -282,6 +284,7 @@ class CORE_EXPORT QgsLayoutItemMap : public QgsLayoutItem
|
|||||||
* Sets the \a rotation for the map - this does not affect the composer item shape, only the
|
* Sets the \a rotation for the map - this does not affect the composer item shape, only the
|
||||||
* way the map is drawn within the item. Rotation is in degrees, clockwise.
|
* way the map is drawn within the item. Rotation is in degrees, clockwise.
|
||||||
* \see mapRotation()
|
* \see mapRotation()
|
||||||
|
* \see mapRotationChanged()
|
||||||
*/
|
*/
|
||||||
void setMapRotation( double rotation );
|
void setMapRotation( double rotation );
|
||||||
|
|
||||||
@ -291,6 +294,7 @@ class CORE_EXPORT QgsLayoutItemMap : public QgsLayoutItem
|
|||||||
* or the current evaluated rotation (which may be affected by data driven rotation
|
* or the current evaluated rotation (which may be affected by data driven rotation
|
||||||
* settings).
|
* settings).
|
||||||
* \see setMapRotation()
|
* \see setMapRotation()
|
||||||
|
* \see mapRotationChanged()
|
||||||
*/
|
*/
|
||||||
double mapRotation( QgsLayoutObject::PropertyValueType valueType = QgsLayoutObject::EvaluatedValue ) const;
|
double mapRotation( QgsLayoutObject::PropertyValueType valueType = QgsLayoutObject::EvaluatedValue ) const;
|
||||||
|
|
||||||
@ -441,9 +445,19 @@ class CORE_EXPORT QgsLayoutItemMap : public QgsLayoutItem
|
|||||||
QgsRectangle requestedExtent() const;
|
QgsRectangle requestedExtent() const;
|
||||||
|
|
||||||
signals:
|
signals:
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Is emitted when the map's extent changes.
|
||||||
|
* \see setExtent()
|
||||||
|
* \see extent()
|
||||||
|
*/
|
||||||
void extentChanged();
|
void extentChanged();
|
||||||
|
|
||||||
//! Is emitted on rotation change to notify north arrow pictures
|
/**
|
||||||
|
* Is emitted when the map's rotation changes.
|
||||||
|
* \see setMapRotation()
|
||||||
|
* \see mapRotation()
|
||||||
|
*/
|
||||||
void mapRotationChanged( double newRotation );
|
void mapRotationChanged( double newRotation );
|
||||||
|
|
||||||
//! Is emitted when the map has been prepared for atlas rendering, just before actual rendering
|
//! Is emitted when the map has been prepared for atlas rendering, just before actual rendering
|
||||||
@ -455,7 +469,6 @@ class CORE_EXPORT QgsLayoutItemMap : public QgsLayoutItem
|
|||||||
*/
|
*/
|
||||||
void layerStyleOverridesChanged();
|
void layerStyleOverridesChanged();
|
||||||
|
|
||||||
|
|
||||||
public slots:
|
public slots:
|
||||||
|
|
||||||
void invalidateCache() override;
|
void invalidateCache() override;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user