@@ -109,13 +109,14 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
109
109
enum AtlasScalingMode
110
110
{
111
111
Fixed, /* < The current scale of the map is used for each feature of the atlas */
112
- Predefined, /* < A scale is chosen from the predefined scales
112
+ Predefined, /* < A scale is chosen from the predefined scales. The smallest scale from
113
+ the list of scales where the atlas feature is fully visible is chosen.
113
114
@see QgsAtlasComposition::setPredefinedScales.
114
- The smallest scale from the list of scales where the atlas feature
115
- is fully visible is chosen.
116
- */
115
+ @note This mode is only valid for polygon or line atlas coverage layers
116
+ */
117
117
Auto /* < The extent is adjusted so that each feature is fully visible.
118
- A margin is applied around the center @see setAtlasMargin */
118
+ A margin is applied around the center @see setAtlasMargin
119
+ @note This mode is only valid for polygon or line atlas coverage layers*/
119
120
};
120
121
121
122
/* * \brief Draw to paint device
@@ -439,32 +440,64 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
439
440
*/
440
441
Q_DECL_DEPRECATED void sizeChangedByRotation ( double & width, double & height );
441
442
442
- /* * Returns true if the map extent is set to follow the current atlas feature */
443
+ /* *Returns whether the map extent is set to follow the current atlas feature.
444
+ * @returns true if map will follow the current atlas feature.
445
+ * @see setAtlasDriven
446
+ * @see atlasScalingMode
447
+ */
443
448
bool atlasDriven () const { return mAtlasDriven ; }
444
- /* * Set to true if the map extents should be set by the current atlas feature */
449
+
450
+ /* *Sets whether the map extent will follow the current atlas feature.
451
+ * @param enabled set to true if the map extents should be set by the current atlas feature.
452
+ * @see atlasDriven
453
+ * @see setAtlasScalingMode
454
+ */
445
455
void setAtlasDriven ( bool enabled ) { mAtlasDriven = enabled; }
446
456
447
- /* * Returns true if the map uses a fixed scale when in atlas mode
448
- @deprecated since 2.4 Use atlasScalingMode() instead
457
+ /* *Returns true if the map uses a fixed scale when in atlas mode
458
+ * @deprecated since 2.4 Use atlasScalingMode() instead
449
459
*/
450
460
Q_DECL_DEPRECATED bool atlasFixedScale () const ;
451
- /* * Set to true if the map should use a fixed scale when in atlas mode
452
- @deprecated since 2.4 Use setAtlasScalingMode() instead
461
+
462
+ /* *Set to true if the map should use a fixed scale when in atlas mode
463
+ * @deprecated since 2.4 Use setAtlasScalingMode() instead
453
464
*/
454
465
Q_DECL_DEPRECATED void setAtlasFixedScale ( bool fixed );
455
466
456
- /* * Returns the current atlas scaling mode
457
- @returns the current scaling mode
467
+ /* *Returns the current atlas scaling mode. This controls how the map's extents
468
+ * are calculated for the current atlas feature when an atlas composition
469
+ * is enabled.
470
+ * @returns the current scaling mode
471
+ * @note this parameter is only used if atlasDriven() is true
472
+ * @see setAtlasScalingMode
473
+ * @see atlasDriven
458
474
*/
459
475
AtlasScalingMode atlasScalingMode () const { return mAtlasScalingMode ; }
460
- /* * Sets the current atlas scaling mode
461
- @param mode atlas scaling mode to set
476
+
477
+ /* *Sets the current atlas scaling mode. This controls how the map's extents
478
+ * are calculated for the current atlas feature when an atlas composition
479
+ * is enabled.
480
+ * @param mode atlas scaling mode to set
481
+ * @note this parameter is only used if atlasDriven() is true
482
+ * @see atlasScalingMode
483
+ * @see atlasDriven
462
484
*/
463
485
void setAtlasScalingMode ( AtlasScalingMode mode ) { mAtlasScalingMode = mode; }
464
486
465
- /* * Returns the margin size (percentage) used when the map is in atlas mode */
487
+ /* *Returns the margin size (percentage) used when the map is in atlas mode.
488
+ * @returns margin size in percentage to leave around the atlas feature's extent
489
+ * @note this is only used if atlasScalingMode() is Auto.
490
+ * @see atlasScalingMode
491
+ * @see setAtlasMargin
492
+ */
466
493
double atlasMargin () const { return mAtlasMargin ; }
467
- /* * Sets the margin size (percentage) used when the map is in atlas mode */
494
+
495
+ /* *Sets the margin size (percentage) used when the map is in atlas mode.
496
+ * @param margin size in percentage to leave around the atlas feature's extent
497
+ * @note this is only used if atlasScalingMode() is Auto.
498
+ * @see atlasScalingMode
499
+ * @see atlasMargin
500
+ */
468
501
void setAtlasMargin ( double margin ) { mAtlasMargin = margin; }
469
502
470
503
/* * Sets whether updates to the composer map are enabled. */
0 commit comments