QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Friends | List of all members
QgsComposerMapGrid Class Reference

An individual grid which is drawn above the map content in a QgsComposerMap. More...

#include <qgscomposermapgrid.h>

Inheritance diagram for QgsComposerMapGrid:
Inheritance graph
[legend]

Public Types

enum  AnnotationCoordinate { Longitude = 0, Latitude }
 Annotation coordinate type. More...
 
enum  AnnotationDirection { Horizontal = 0, Vertical, VerticalDescending, BoundaryDirection }
 Direction of grid annotations. More...
 
enum  AnnotationFormat {
  Decimal = 0, DegreeMinute, DegreeMinuteSecond, DecimalWithSuffix,
  DegreeMinuteNoSuffix, DegreeMinutePadded, DegreeMinuteSecondNoSuffix, DegreeMinuteSecondPadded
}
 Format for displaying grid annotations. More...
 
enum  AnnotationPosition { InsideMapFrame = 0, OutsideMapFrame, Disabled }
 Position for grid annotations. More...
 
enum  BorderSide { Left, Right, Bottom, Top }
 Border sides for annotations. More...
 
enum  DisplayMode { ShowAll = 0, LatitudeOnly, LongitudeOnly, HideAll }
 Display settings for grid annotations and frames. More...
 
enum  FrameSideFlag { FrameLeft = 0x01, FrameRight = 0x02, FrameTop = 0x04, FrameBottom = 0x08 }
 Flags for controlling which side of the map a frame is drawn on. More...
 
enum  FrameStyle {
  NoFrame = 0, Zebra, InteriorTicks, ExteriorTicks,
  InteriorExteriorTicks, LineBorder
}
 Style for grid frame. More...
 
enum  GridStyle { Solid = 0, Cross, Markers, FrameAnnotationsOnly }
 Grid drawing style. More...
 
enum  GridUnit { MapUnit, MM, CM }
 Unit for grid values. More...
 
- Public Types inherited from QgsComposerObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, BlendMode,
  ExcludeFromExports, MapRotation, MapScale, MapXMin,
  MapYMin, MapXMax, MapYMax, MapAtlasMargin,
  PictureSource, SourceUrl
}
 Data defined properties for different item types. More...
 
enum  PropertyValueType { EvaluatedValue = 0, OriginalValue }
 Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...
 

Public Member Functions

 QgsComposerMapGrid (const QString &name, QgsComposerMap *map)
 Constructor for QgsComposerMapGrid. More...
 
virtual ~QgsComposerMapGrid ()
 
AnnotationDirection annotationDirection (const BorderSide border) const
 Gets the direction for drawing frame annotations. More...
 
DisplayMode annotationDisplay (const BorderSide border) const
 Gets the display mode for the grid annotations on a specified side of the map frame. More...
 
bool annotationEnabled () const
 Gets whether annotations are shown for the grid. More...
 
QFont annotationFont () const
 Gets the font used for drawing grid annotations. More...
 
QColor annotationFontColor () const
 Gets the font color used for drawing grid annotations. More...
 
AnnotationFormat annotationFormat () const
 Gets the format for drawing grid annotations. More...
 
double annotationFrameDistance () const
 Gets the distance between the map frame and annotations. More...
 
AnnotationPosition annotationPosition (const BorderSide border) const
 Gets the position for the grid annotations on a specified side of the map frame. More...
 
int annotationPrecision () const
 Returns the coordinate precision for grid annotations. More...
 
QPainter::CompositionMode blendMode () const
 Retrieves the blending mode used for drawing the grid. More...
 
double crossLength () const
 Retrieves the length of the cross segments drawn for the grid. More...
 
QgsCoordinateReferenceSystem crs () const
 Retrieves the CRS for the grid. More...
 
void draw (QPainter *painter)
 Draws a grid. More...
 
DisplayMode frameDivisions (const BorderSide border) const
 Gets the type of grid divisions which are used for frames on a specified side of the map. More...
 
QColor frameFillColor1 () const
 Retrieves the first fill color for the grid frame. More...
 
QColor frameFillColor2 () const
 Retrieves the second fill color for the grid frame. More...
 
QColor framePenColor () const
 Retrieves the color of the outline drawn in the grid frame. More...
 
double framePenSize () const
 Retrieves the width of the outline drawn in the grid frame. More...
 
FrameSideFlags frameSideFlags () const
 Returns the flags which control which sides of the map item the grid frame is drawn on. More...
 
FrameStyle frameStyle () const
 Gets the grid frame style. More...
 
double frameWidth () const
 Gets the grid frame width. More...
 
double intervalX () const
 Gets the interval between grid lines in the x-direction. More...
 
double intervalY () const
 Gets the interval between grid lines in the y-direction. More...
 
const QgsLineSymbolV2lineSymbol () const
 Gets the line symbol used for drawing grid lines. More...
 
QgsLineSymbolV2lineSymbol ()
 Gets the line symbol used for drawing grid lines. More...
 
const QgsMarkerSymbolV2markerSymbol () const
 Gets the marker symbol used for drawing grid points. More...
 
QgsMarkerSymbolV2markerSymbol ()
 Gets the marker symbol used for drawing grid points. More...
 
double maxExtension () const
 Calculates the maximum distance the grid extends beyond the QgsComposerMap's item rect. More...
 
double offsetX () const
 Gets the offset for grid lines in the x-direction. More...
 
double offsetY () const
 Gets the offset for grid lines in the y-direction. More...
 
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Sets grid state from a DOM document. More...
 
void setAnnotationDirection (const AnnotationDirection direction, const BorderSide border)
 Sets the direction for drawing frame annotations. More...
 
void setAnnotationDirection (const AnnotationDirection direction)
 Sets the direction for drawing all frame annotations. More...
 
void setAnnotationDisplay (const DisplayMode display, const BorderSide border)
 Sets what types of grid annotations should be drawn for a specified side of the map frame, or whether grid annotations should be disabled for the side. More...
 
void setAnnotationEnabled (const bool enabled)
 Sets whether annotations should be shown for the grid. More...
 
void setAnnotationFont (const QFont &font)
 Sets the font used for drawing grid annotations. More...
 
void setAnnotationFontColor (const QColor &color)
 Sets the font color used for drawing grid annotations. More...
 
void setAnnotationFormat (const AnnotationFormat format)
 Sets the format for drawing grid annotations. More...
 
void setAnnotationFrameDistance (const double distance)
 Sets the distance between the map frame and annotations. More...
 
void setAnnotationPosition (const AnnotationPosition position, const BorderSide border)
 Sets the position for the grid annotations on a specified side of the map frame. More...
 
void setAnnotationPrecision (const int precision)
 Sets the coordinate precision for grid annotations. More...
 
void setBlendMode (const QPainter::CompositionMode mode)
 Sets the blending mode used for drawing the grid. More...
 
void setCrossLength (const double length)
 Sets the length of the cross segments drawn for the grid. More...
 
void setCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the CRS for the grid. More...
 
void setFrameDivisions (const DisplayMode divisions, const BorderSide border)
 Sets what type of grid divisions should be used for frames on a specified side of the map. More...
 
void setFrameFillColor1 (const QColor &color)
 Sets the first fill color used for the grid frame. More...
 
void setFrameFillColor2 (const QColor &color)
 Sets the second fill color used for the grid frame. More...
 
void setFramePenColor (const QColor &color)
 Sets the color of the outline drawn in the grid frame. More...
 
void setFramePenSize (const double width)
 Sets the width of the outline drawn in the grid frame. More...
 
void setFrameSideFlag (const FrameSideFlag flag, bool on=true)
 Sets whether the grid frame is drawn for a certain side of the map item. More...
 
void setFrameSideFlags (const FrameSideFlags flags)
 Sets flags for grid frame sides. More...
 
void setFrameStyle (const FrameStyle style)
 Sets the grid frame style. More...
 
void setFrameWidth (const double width)
 Sets the grid frame width. More...
 
void setGridLineColor (const QColor &color)
 Sets color of grid lines. More...
 
void setGridLineWidth (const double width)
 Sets width of grid lines. More...
 
void setIntervalX (const double interval)
 Sets the interval between grid lines in the x-direction. More...
 
void setIntervalY (const double interval)
 Sets the interval between grid lines in the y-direction. More...
 
void setLineSymbol (QgsLineSymbolV2 *symbol)
 Sets the line symbol used for drawing grid lines. More...
 
void setMarkerSymbol (QgsMarkerSymbolV2 *symbol)
 Sets the marker symbol used for drawing grid points. More...
 
void setOffsetX (const double offset)
 Sets the offset for grid lines in the x-direction. More...
 
void setOffsetY (const double offset)
 Sets the offset for grid lines in the y-direction. More...
 
void setStyle (const GridStyle style)
 Sets the grid style, which controls how the grid is drawn over the map's contents. More...
 
void setUnits (const GridUnit unit)
 Sets the units to use for grid measurements such as the interval and offset for grid lines. More...
 
GridStyle style () const
 Gets the grid's style, which controls how the grid is drawn over the map's contents. More...
 
bool testFrameSideFlag (const FrameSideFlag flag) const
 Tests whether the grid frame should be drawn on a specified side of the map item. More...
 
GridUnit units () const
 Gets the units used for grid measurements such as the interval and offset for grid lines. More...
 
bool usesAdvancedEffects () const
 Returns true if the item is drawn using advanced effects, such as blend modes. More...
 
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 Stores grid state in DOM element. More...
 
- Public Member Functions inherited from QgsComposerMapItem
 QgsComposerMapItem (const QString &name, QgsComposerMap *map)
 Constructor for QgsComposerMapItem. More...
 
virtual ~QgsComposerMapItem ()
 
virtual const QgsComposerMapcomposerMap () const
 Get composer map for the item. More...
 
virtual bool enabled () const
 Returns whether the item will be drawn. More...
 
QString id () const
 Get the unique id for the map item. More...
 
virtual QString name () const
 Get friendly display name for the item. More...
 
virtual void setComposerMap (QgsComposerMap *map)
 Sets composer map for the item. More...
 
virtual void setEnabled (const bool enabled)
 Controls whether the item will be drawn. More...
 
virtual void setName (const QString &name)
 Sets the friendly display name for the item. More...
 
- Public Member Functions inherited from QgsComposerObject
 QgsComposerObject (QgsComposition *composition)
 Constructor. More...
 
virtual ~QgsComposerObject ()
 
const QgsCompositioncomposition () const
 Returns the composition the item is attached to. More...
 
QgsCompositioncomposition ()
 
QgsDataDefineddataDefinedProperty (const DataDefinedProperty property) const
 Returns a reference to the data defined settings for one of the item's data defined properties. More...
 
void setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field)
 Sets parameters for a data defined property for the item. More...
 

Friends

class TestQgsComposerMapGrid
 

Additional Inherited Members

- Public Slots inherited from QgsComposerObject
virtual void refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties)
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
virtual void repaint ()
 Triggers a redraw for the item. More...
 
- Signals inherited from QgsComposerObject
void itemChanged ()
 Emitted when the item changes. More...
 
- Protected Member Functions inherited from QgsComposerObject
bool dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
 Evaluate a data defined property and return the calculated value. More...
 
- Protected Attributes inherited from QgsComposerMapItem
QgsComposerMapmComposerMap
 Associated composer map. More...
 
bool mEnabled
 True if item is to be displayed on map. More...
 
QString mName
 Friendly display name. More...
 
QString mUuid
 Unique id. More...
 
- Protected Attributes inherited from QgsComposerObject
QgsCompositionmComposition
 
QMap
< QgsComposerObject::DataDefinedProperty,
QString > 
mDataDefinedNames
 Map of data defined properties for the item to string name to use when exporting item to xml. More...
 

Detailed Description

An individual grid which is drawn above the map content in a QgsComposerMap.

Note
added in QGIS 2.5
See also
QgsComposerMapGridStack

Definition at line 151 of file qgscomposermapgrid.h.

Member Enumeration Documentation

Annotation coordinate type.

Enumerator
Longitude 
Latitude 

Definition at line 256 of file qgscomposermapgrid.h.

Direction of grid annotations.

Enumerator
Horizontal 
Vertical 
VerticalDescending 
BoundaryDirection 

Definition at line 199 of file qgscomposermapgrid.h.

Format for displaying grid annotations.

Enumerator
Decimal 
DegreeMinute 
DegreeMinuteSecond 
DecimalWithSuffix 
DegreeMinuteNoSuffix 
DegreeMinutePadded 
DegreeMinuteSecondNoSuffix 
DegreeMinuteSecondPadded 

Definition at line 209 of file qgscomposermapgrid.h.

Position for grid annotations.

Enumerator
InsideMapFrame 
OutsideMapFrame 
Disabled 

Definition at line 189 of file qgscomposermapgrid.h.

Border sides for annotations.

Enumerator
Left 
Right 
Bottom 
Top 

Definition at line 223 of file qgscomposermapgrid.h.

Display settings for grid annotations and frames.

Enumerator
ShowAll 
LatitudeOnly 
LongitudeOnly 
HideAll 

Definition at line 179 of file qgscomposermapgrid.h.

Flags for controlling which side of the map a frame is drawn on.

Enumerator
FrameLeft 
FrameRight 
FrameTop 
FrameBottom 

Definition at line 245 of file qgscomposermapgrid.h.

Style for grid frame.

Enumerator
NoFrame 
Zebra 
InteriorTicks 
ExteriorTicks 
InteriorExteriorTicks 
LineBorder 

Definition at line 233 of file qgscomposermapgrid.h.

Grid drawing style.

Enumerator
Solid 
Cross 
Markers 
FrameAnnotationsOnly 

Definition at line 169 of file qgscomposermapgrid.h.

Unit for grid values.

Enumerator
MapUnit 
MM 
CM 

Definition at line 160 of file qgscomposermapgrid.h.

Constructor & Destructor Documentation

QgsComposerMapGrid::QgsComposerMapGrid ( const QString &  name,
QgsComposerMap map 
)

Constructor for QgsComposerMapGrid.

Parameters
namefriendly display name for grid
mapQgsComposerMap the grid is attached to

Definition at line 146 of file qgscomposermapgrid.cpp.

QgsComposerMapGrid::~QgsComposerMapGrid ( )
virtual

Definition at line 206 of file qgscomposermapgrid.cpp.

Member Function Documentation

QgsComposerMapGrid::AnnotationDirection QgsComposerMapGrid::annotationDirection ( const BorderSide  border) const

Gets the direction for drawing frame annotations.

Parameters
borderside of map for annotations
Returns
direction for frame annotations
See also
setAnnotationDirection

Definition at line 2202 of file qgscomposermapgrid.cpp.

QgsComposerMapGrid::DisplayMode QgsComposerMapGrid::annotationDisplay ( const BorderSide  border) const

Gets the display mode for the grid annotations on a specified side of the map frame.

This property also specifies whether annotations have been disabled from a side of the map frame.

Parameters
borderside of map for annotations
Returns
display mode for grid annotations
See also
setAnnotationDisplay
Note
added in QGIS 2.7

Definition at line 1930 of file qgscomposermapgrid.cpp.

bool QgsComposerMapGrid::annotationEnabled ( ) const
inline

Gets whether annotations are shown for the grid.

Returns
true if annotations are drawn for the grid
See also
setAnnotationEnabled

Definition at line 521 of file qgscomposermapgrid.h.

QFont QgsComposerMapGrid::annotationFont ( ) const
inline

Gets the font used for drawing grid annotations.

Returns
font for annotations
See also
setAnnotationFont

Definition at line 533 of file qgscomposermapgrid.h.

QColor QgsComposerMapGrid::annotationFontColor ( ) const
inline

Gets the font color used for drawing grid annotations.

Returns
font color for annotations
See also
setAnnotationFontColor

Definition at line 545 of file qgscomposermapgrid.h.

AnnotationFormat QgsComposerMapGrid::annotationFormat ( ) const
inline

Gets the format for drawing grid annotations.

Returns
format for grid annotations
See also
setAnnotationFormat

Definition at line 636 of file qgscomposermapgrid.h.

double QgsComposerMapGrid::annotationFrameDistance ( ) const
inline

Gets the distance between the map frame and annotations.

Units are in millimetres.

Returns
margin between map frame and annotations
See also
setAnnotationFrameDistance

Definition at line 604 of file qgscomposermapgrid.h.

QgsComposerMapGrid::AnnotationPosition QgsComposerMapGrid::annotationPosition ( const BorderSide  border) const

Gets the position for the grid annotations on a specified side of the map frame.

Parameters
borderside of map for annotations
Returns
position that grid annotations are drawn in
See also
setAnnotationPosition

Definition at line 2182 of file qgscomposermapgrid.cpp.

int QgsComposerMapGrid::annotationPrecision ( ) const
inline

Returns the coordinate precision for grid annotations.

Returns
number of decimal places shown when drawing grid annotations
See also
setAnnotationPrecision

Definition at line 557 of file qgscomposermapgrid.h.

QPainter::CompositionMode QgsComposerMapGrid::blendMode ( ) const
inline

Retrieves the blending mode used for drawing the grid.

Returns
blending mode for grid
See also
setBlendMode

Definition at line 311 of file qgscomposermapgrid.h.

double QgsComposerMapGrid::crossLength ( ) const
inline

Retrieves the length of the cross segments drawn for the grid.

This is only used for grids with QgsComposerMapGrid::Cross styles

Returns
cross length in millimetres
See also
setCrossLength

Definition at line 433 of file qgscomposermapgrid.h.

QgsCoordinateReferenceSystem QgsComposerMapGrid::crs ( ) const
inline

Retrieves the CRS for the grid.

Returns
coordinate reference system for grid
See also
setCrs

Definition at line 299 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::draw ( QPainter *  painter)
virtual

Draws a grid.

Parameters
painterdestination QPainter

Implements QgsComposerMapItem.

Definition at line 607 of file qgscomposermapgrid.cpp.

QgsComposerMapGrid::DisplayMode QgsComposerMapGrid::frameDivisions ( const BorderSide  border) const

Gets the type of grid divisions which are used for frames on a specified side of the map.

Parameters
borderside of map for frame
Returns
grid divisions for frame
See also
setFrameDivisions
Note
added in QGIS 2.7

Definition at line 2253 of file qgscomposermapgrid.cpp.

QColor QgsComposerMapGrid::frameFillColor1 ( ) const
inline

Retrieves the first fill color for the grid frame.

Returns
first fill color for grid frame
See also
setFrameFillColor1
framePenColor
frameFillColor2

Definition at line 769 of file qgscomposermapgrid.h.

QColor QgsComposerMapGrid::frameFillColor2 ( ) const
inline

Retrieves the second fill color for the grid frame.

Returns
second fill color for grid frame
See also
setFrameFillColor2
framePenColor
frameFillColor1

Definition at line 785 of file qgscomposermapgrid.h.

QColor QgsComposerMapGrid::framePenColor ( ) const
inline

Retrieves the color of the outline drawn in the grid frame.

Returns
color of grid frame outline
See also
setFramePenColor
framePenSize
frameFillColor1
frameFillColor2

Definition at line 753 of file qgscomposermapgrid.h.

double QgsComposerMapGrid::framePenSize ( ) const
inline

Retrieves the width of the outline drawn in the grid frame.

Returns
width of grid frame outline
See also
setFramePenSize
framePenColor

Definition at line 735 of file qgscomposermapgrid.h.

QgsComposerMapGrid::FrameSideFlags QgsComposerMapGrid::frameSideFlags ( ) const

Returns the flags which control which sides of the map item the grid frame is drawn on.

Returns
flags for side of map grid is drawn on
See also
setFrameSideFlags
setFrameSideFlag
testFrameSideFlag

Definition at line 2137 of file qgscomposermapgrid.cpp.

FrameStyle QgsComposerMapGrid::frameStyle ( ) const
inline

Gets the grid frame style.

Returns
style for grid frame
See also
setFrameStyle

Definition at line 652 of file qgscomposermapgrid.h.

double QgsComposerMapGrid::frameWidth ( ) const
inline

Gets the grid frame width.

This property controls how wide the grid frame is. The size of the line outlines drawn in the frame can be retrieved via the framePenSize method.

Returns
width of grid frame in millimetres
See also
setFrameWidth

Definition at line 721 of file qgscomposermapgrid.h.

double QgsComposerMapGrid::intervalX ( ) const
inline

Gets the interval between grid lines in the x-direction.

The units are retrieved through the units() method.

Returns
interval between horizontal grid lines
See also
setIntervalX
intervalY

Definition at line 353 of file qgscomposermapgrid.h.

double QgsComposerMapGrid::intervalY ( ) const
inline

Gets the interval between grid lines in the y-direction.

The units are retrieved through the units() method.

Returns
interval between vertical grid lines
See also
setIntervalY
intervalX

Definition at line 369 of file qgscomposermapgrid.h.

const QgsLineSymbolV2* QgsComposerMapGrid::lineSymbol ( ) const
inline

Gets the line symbol used for drawing grid lines.

This is only used for grids with QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles.

Returns
line symbol for grid lines
See also
setLineSymbol
markerSymbol
style

Definition at line 469 of file qgscomposermapgrid.h.

QgsLineSymbolV2* QgsComposerMapGrid::lineSymbol ( )
inline

Gets the line symbol used for drawing grid lines.

This is only used for grids with QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles.

Returns
line symbol for grid lines
See also
setLineSymbol
markerSymbol
style

Definition at line 478 of file qgscomposermapgrid.h.

const QgsMarkerSymbolV2* QgsComposerMapGrid::markerSymbol ( ) const
inline

Gets the marker symbol used for drawing grid points.

This is only used for grids with a QgsComposerMapGrid::Markers style.

Returns
marker symbol for grid intersection points
See also
setMarkerSymbol
lineSymbol
style

Definition at line 496 of file qgscomposermapgrid.h.

QgsMarkerSymbolV2* QgsComposerMapGrid::markerSymbol ( )
inline

Gets the marker symbol used for drawing grid points.

This is only used for grids with a QgsComposerMapGrid::Markers style.

Returns
marker symbol for grid intersection points
See also
setMarkerSymbol
lineSymbol
style

Definition at line 505 of file qgscomposermapgrid.h.

double QgsComposerMapGrid::maxExtension ( ) const

Calculates the maximum distance the grid extends beyond the QgsComposerMap's item rect.

Returns
maximum extension in millimetres

Definition at line 1950 of file qgscomposermapgrid.cpp.

double QgsComposerMapGrid::offsetX ( ) const
inline

Gets the offset for grid lines in the x-direction.

The units are retrieved through the units() method.

Returns
offset for horizontal grid lines
See also
setOffsetX
offsetY

Definition at line 385 of file qgscomposermapgrid.h.

double QgsComposerMapGrid::offsetY ( ) const
inline

Gets the offset for grid lines in the y-direction.

The units are retrieved through the units() method.

Returns
offset for vertical grid lines
See also
setOffsetY
offsetX

Definition at line 401 of file qgscomposermapgrid.h.

bool QgsComposerMapGrid::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
virtual

Sets grid state from a DOM document.

Parameters
itemElemis DOM node corresponding to a 'ComposerMapGrid' tag
docis DOM document
See also
writeXML

Reimplemented from QgsComposerMapItem.

Definition at line 315 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setAnnotationDirection ( const AnnotationDirection  direction,
const BorderSide  border 
)

Sets the direction for drawing frame annotations.

Parameters
directiondirection for frame annotations
borderside of map for annotations
See also
annotationDirection

Definition at line 2096 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setAnnotationDirection ( const AnnotationDirection  direction)

Sets the direction for drawing all frame annotations.

Parameters
directiondirection for frame annotations
See also
annotationDirection

Definition at line 2147 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setAnnotationDisplay ( const DisplayMode  display,
const BorderSide  border 
)

Sets what types of grid annotations should be drawn for a specified side of the map frame, or whether grid annotations should be disabled for the side.

Parameters
displaydisplay mode for annotations
borderside of map for annotations
See also
annotationDisplay
Note
added in QGIS 2.7

Definition at line 1903 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setAnnotationEnabled ( const bool  enabled)
inline

Sets whether annotations should be shown for the grid.

Parameters
enabledset to true to draw annotations for the grid
See also
annotationEnabled

Definition at line 515 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setAnnotationFont ( const QFont &  font)
inline

Sets the font used for drawing grid annotations.

Parameters
fontfont for annotations
See also
annotationFont

Definition at line 527 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setAnnotationFontColor ( const QColor &  color)
inline

Sets the font color used for drawing grid annotations.

Parameters
colorfont color for annotations
See also
annotationFontColor

Definition at line 539 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setAnnotationFormat ( const AnnotationFormat  format)
inline

Sets the format for drawing grid annotations.

Parameters
formatformat for grid annotations
See also
annotationFormat

Definition at line 630 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setAnnotationFrameDistance ( const double  distance)
inline

Sets the distance between the map frame and annotations.

Units are in millimetres.

Parameters
distancemargin between map frame and annotations
See also
annotationFrameDistance

Definition at line 598 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setAnnotationPosition ( const AnnotationPosition  position,
const BorderSide  border 
)

Sets the position for the grid annotations on a specified side of the map frame.

Parameters
positionposition to draw grid annotations
borderside of map for annotations
See also
annotationPosition

Definition at line 2155 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setAnnotationPrecision ( const int  precision)
inline

Sets the coordinate precision for grid annotations.

Parameters
precisionnumber of decimal places to show when drawing grid annotations
See also
annotationPrecision

Definition at line 551 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setBlendMode ( const QPainter::CompositionMode  mode)
inline

Sets the blending mode used for drawing the grid.

Parameters
modeblending mode for grid
See also
blendMode

Definition at line 305 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setCrossLength ( const double  length)
inline

Sets the length of the cross segments drawn for the grid.

This is only used for grids with QgsComposerMapGrid::Cross styles

Parameters
lengthcross length in millimetres
See also
crossLength

Definition at line 426 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setCrs ( const QgsCoordinateReferenceSystem crs)

Sets the CRS for the grid.

Parameters
crscoordinate reference system for grid
See also
crs

Definition at line 433 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setFrameDivisions ( const DisplayMode  divisions,
const BorderSide  border 
)

Sets what type of grid divisions should be used for frames on a specified side of the map.

Parameters
divisionsgrid divisions for frame
borderside of map for frame
See also
frameDivisions
Note
added in QGIS 2.7

Definition at line 2227 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setFrameFillColor1 ( const QColor &  color)
inline

Sets the first fill color used for the grid frame.

Parameters
colorfirst fill color for grid frame
See also
frameFillColor1
setFramePenColor
setFrameFillColor2

Definition at line 761 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setFrameFillColor2 ( const QColor &  color)
inline

Sets the second fill color used for the grid frame.

Parameters
colorsecond fill color for grid frame
See also
frameFillColor2
setFramePenColor
setFrameFillColor1

Definition at line 777 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setFramePenColor ( const QColor &  color)
inline

Sets the color of the outline drawn in the grid frame.

Parameters
colorcolor of grid frame outline
See also
framePenColor
setFramePenSize
setFrameFillColor1
setFrameFillColor2

Definition at line 744 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setFramePenSize ( const double  width)
inline

Sets the width of the outline drawn in the grid frame.

Parameters
widthwidth of grid frame outline
See also
framePenSize
setFramePenColor

Definition at line 728 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setFrameSideFlag ( const FrameSideFlag  flag,
bool  on = true 
)

Sets whether the grid frame is drawn for a certain side of the map item.

Parameters
flagflag for grid frame side
onset to true to draw grid frame on that side of the map
See also
setFrameSideFlags
frameSideFlags
testFrameSideFlag

Definition at line 2129 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setFrameSideFlags ( const FrameSideFlags  flags)

Sets flags for grid frame sides.

Setting these flags controls which sides of the map item the grid frame is drawn on.

Parameters
flagsflags for grid frame sides
See also
setFrameSideFlag
frameSideFlags
testFrameSideFlag

Definition at line 2124 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setFrameStyle ( const FrameStyle  style)
inline

Sets the grid frame style.

Parameters
stylestyle for grid frame
See also
frameStyle

Definition at line 646 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setFrameWidth ( const double  width)
inline

Sets the grid frame width.

This property controls how wide the grid frame is. The size of the line outlines drawn in the frame is controlled through the setFramePenSize method.

Parameters
widthwidth of grid frame in millimetres
See also
frameWidth

Definition at line 713 of file qgscomposermapgrid.h.

void QgsComposerMapGrid::setGridLineColor ( const QColor &  color)

Sets color of grid lines.

This is only used for grids with QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles. For more control over grid line appearance, use setLineSymbol instead.

Parameters
colorcolor of grid lines
See also
setLineSymbol
setGridLineWidth

Definition at line 240 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setGridLineWidth ( const double  width)

Sets width of grid lines.

This is only used for grids with QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles. For more control over grid line appearance, use setLineSymbol instead.

Parameters
widthgrid line width
See also
setLineSymbol
setGridLineColor

Definition at line 232 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setIntervalX ( const double  interval)

Sets the interval between grid lines in the x-direction.

The units are controlled through the setUnits method

Parameters
intervalinterval between horizontal grid lines
See also
setIntervalY
intervalX

Definition at line 2046 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setIntervalY ( const double  interval)

Sets the interval between grid lines in the y-direction.

The units are controlled through the setUnits method

Parameters
intervalinterval between vertical grid lines
See also
setIntervalX
intervalY

Definition at line 2056 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setLineSymbol ( QgsLineSymbolV2 symbol)

Sets the line symbol used for drawing grid lines.

This is only used for grids with QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles.

Parameters
symbolline symbol for grid lines
See also
lineSymbol
setMarkerSymbol
setStyle

Definition at line 1891 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setMarkerSymbol ( QgsMarkerSymbolV2 symbol)

Sets the marker symbol used for drawing grid points.

This is only used for grids with a QgsComposerMapGrid::Markers style.

Parameters
symbolmarker symbol for grid intersection points
See also
markerSymbol
setLineSymbol
setStyle

Definition at line 1897 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setOffsetX ( const double  offset)

Sets the offset for grid lines in the x-direction.

The units are controlled through the setUnits method

Parameters
offsetoffset for horizontal grid lines
See also
setOffsetY
offsetX

Definition at line 2066 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setOffsetY ( const double  offset)

Sets the offset for grid lines in the y-direction.

The units are controlled through the setUnits method

Parameters
offsetoffset for vertical grid lines
See also
setOffsetX
offsetY

Definition at line 2076 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setStyle ( const GridStyle  style)

Sets the grid style, which controls how the grid is drawn over the map's contents.

Parameters
styledesired grid style
See also
style

Definition at line 2086 of file qgscomposermapgrid.cpp.

void QgsComposerMapGrid::setUnits ( const GridUnit  unit)

Sets the units to use for grid measurements such as the interval and offset for grid lines.

Parameters
unitunit for grid measurements
See also
units

Definition at line 2036 of file qgscomposermapgrid.cpp.

GridStyle QgsComposerMapGrid::style ( ) const
inline

Gets the grid's style, which controls how the grid is drawn over the map's contents.

Returns
current grid style
See also
setStyle

Definition at line 419 of file qgscomposermapgrid.h.

bool QgsComposerMapGrid::testFrameSideFlag ( const FrameSideFlag  flag) const

Tests whether the grid frame should be drawn on a specified side of the map item.

Parameters
flagflag for grid frame side
Returns
true if grid frame should be drawn for that side of the map
See also
setFrameSideFlags
setFrameSideFlag
frameSideFlags

Definition at line 2142 of file qgscomposermapgrid.cpp.

GridUnit QgsComposerMapGrid::units ( ) const
inline

Gets the units used for grid measurements such as the interval and offset for grid lines.

Returns
for grid measurements
See also
setUnits

Definition at line 337 of file qgscomposermapgrid.h.

bool QgsComposerMapGrid::usesAdvancedEffects ( ) const
virtual

Returns true if the item is drawn using advanced effects, such as blend modes.

Returns
true if item uses advanced effects

Reimplemented from QgsComposerMapItem.

Definition at line 439 of file qgscomposermapgrid.cpp.

bool QgsComposerMapGrid::writeXML ( QDomElement &  elem,
QDomDocument &  doc 
) const
virtual

Stores grid state in DOM element.

Parameters
elemis DOM element corresponding to a 'ComposerMap' tag
docDOM document
See also
readXML

Reimplemented from QgsComposerMapItem.

Definition at line 248 of file qgscomposermapgrid.cpp.

Friends And Related Function Documentation

friend class TestQgsComposerMapGrid
friend

Definition at line 962 of file qgscomposermapgrid.h.


The documentation for this class was generated from the following files: