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

An individual overview which is drawn above the map content in a QgsComposerMap, and shows the extent of another QgsComposerMap. More...

#include <qgscomposermapoverview.h>

Inheritance diagram for QgsComposerMapOverview:
Inheritance graph
[legend]

Public Slots

void overviewExtentChanged ()
 Handles recentering of the map and redrawing of the map's overview. More...
 
- Public Slots inherited from QgsComposerObject
virtual void repaint ()
 Triggers a redraw for the item. More...
 
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...
 

Public Member Functions

 QgsComposerMapOverview (const QString &name, QgsComposerMap *map)
 Constructor for QgsComposerMapOverview. More...
 
virtual ~QgsComposerMapOverview ()
 
void draw (QPainter *painter)
 Draws an overview. More...
 
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 Stores overview state in DOM element. More...
 
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Sets overview state from a DOM document. More...
 
bool usesAdvancedEffects () const
 Returns true if the item is drawn using advanced effects, such as blend modes. More...
 
void setFrameMap (const int mapId)
 Sets overview frame map. More...
 
int frameMapId () const
 Returns id of source map. More...
 
void setFrameSymbol (QgsFillSymbolV2 *symbol)
 Sets the fill symbol used for drawing the overview extent. More...
 
QgsFillSymbolV2frameSymbol ()
 Gets the fill symbol used for drawing the overview extent. More...
 
const QgsFillSymbolV2frameSymbol () const
 Gets the fill symbol used for drawing the overview extent. More...
 
QPainter::CompositionMode blendMode () const
 Retrieves the blending mode used for drawing the overview. More...
 
void setBlendMode (const QPainter::CompositionMode blendMode)
 Sets the blending mode used for drawing the overview. More...
 
bool inverted () const
 Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map. More...
 
void setInverted (const bool inverted)
 Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map. More...
 
bool centered () const
 Returns whether the extent of the map is forced to center on the overview. More...
 
void setCentered (const bool centered)
 Sets whether the extent of the map is forced to center on the overview. More...
 
void connectSignals ()
 Reconnects signals for overview map, so that overview correctly follows changes to source map's extent. More...
 
- Public Member Functions inherited from QgsComposerMapItem
 QgsComposerMapItem (const QString &name, QgsComposerMap *map)
 Constructor for QgsComposerMapItem. More...
 
virtual ~QgsComposerMapItem ()
 
virtual void setComposerMap (QgsComposerMap *map)
 Sets composer map for the item. More...
 
virtual const QgsComposerMapcomposerMap () const
 Get composer map for the item. More...
 
QString id () const
 Get the unique id for the map item. More...
 
virtual void setName (const QString &name)
 Sets the friendly display name for the item. More...
 
virtual QString name () const
 Get friendly display name for the item. More...
 
virtual void setEnabled (const bool enabled)
 Controls whether the item will be drawn. More...
 
virtual bool enabled () const
 Returns whether the item will be drawn. 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...
 

Additional Inherited Members

- 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...
 
- 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
QString mName
 Friendly display name. More...
 
QgsComposerMapmComposerMap
 Associated composer map. More...
 
QString mUuid
 Unique id. More...
 
bool mEnabled
 True if item is to be displayed on map. 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 overview which is drawn above the map content in a QgsComposerMap, and shows the extent of another QgsComposerMap.

Note
added in QGIS 2.5
See also
QgsComposerMapOverviewStack

Constructor & Destructor Documentation

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

Constructor for QgsComposerMapOverview.

Parameters
namefriendly display name for overview
mapQgsComposerMap the overview is attached to
QgsComposerMapOverview::~QgsComposerMapOverview ( )
virtual

Member Function Documentation

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

Retrieves the blending mode used for drawing the overview.

Returns
blending mode for overview
See also
setBlendMode
bool QgsComposerMapOverview::centered ( ) const
inline

Returns whether the extent of the map is forced to center on the overview.

Returns
true if map will be centered on overview
See also
setCentered
void QgsComposerMapOverview::connectSignals ( )

Reconnects signals for overview map, so that overview correctly follows changes to source map's extent.

void QgsComposerMapOverview::draw ( QPainter *  painter)
virtual

Draws an overview.

Parameters
painterdestination QPainter

Implements QgsComposerMapItem.

int QgsComposerMapOverview::frameMapId ( ) const
inline

Returns id of source map.

Returns
source map id, or -1 if no source map set
QgsFillSymbolV2* QgsComposerMapOverview::frameSymbol ( )
inline

Gets the fill symbol used for drawing the overview extent.

Returns
fill symbol for overview
See also
setFrameSymbol
const QgsFillSymbolV2* QgsComposerMapOverview::frameSymbol ( ) const
inline

Gets the fill symbol used for drawing the overview extent.

Returns
fill symbol for overview
See also
setFrameSymbol
bool QgsComposerMapOverview::inverted ( ) const
inline

Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.

Returns
true if overview frame is inverted
See also
setInverted
void QgsComposerMapOverview::overviewExtentChanged ( )
slot

Handles recentering of the map and redrawing of the map's overview.

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

Sets overview state from a DOM document.

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

Reimplemented from QgsComposerMapItem.

void QgsComposerMapOverview::setBlendMode ( const QPainter::CompositionMode  blendMode)

Sets the blending mode used for drawing the overview.

Parameters
blendModeblending mode for overview
See also
blendMode
void QgsComposerMapOverview::setCentered ( const bool  centered)

Sets whether the extent of the map is forced to center on the overview.

Parameters
centeredset to true if map will be centered on overview
See also
centered
void QgsComposerMapOverview::setFrameMap ( const int  mapId)

Sets overview frame map.

Parameters
mapIdsource map id. -1 disables the overview frame
See also
frameMapId
void QgsComposerMapOverview::setFrameSymbol ( QgsFillSymbolV2 symbol)

Sets the fill symbol used for drawing the overview extent.

Parameters
symbolfill symbol for overview
See also
frameSymbol
void QgsComposerMapOverview::setInverted ( const bool  inverted)

Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside the extent of the overview map.

Parameters
invertedset to true if overview frame is to be inverted
See also
inverted
bool QgsComposerMapOverview::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.

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

Stores overview state in DOM element.

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

Reimplemented from QgsComposerMapItem.


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