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

#include <qgscomposermapoverview.h>

Inheritance diagram for QgsComposerMapOverview:
Inheritance graph
[legend]

Public Slots

void overviewExtentChanged ()
 

Public Member Functions

 QgsComposerMapOverview (const QString &name, QgsComposerMap *map)
 
 ~QgsComposerMapOverview ()
 
void drawOverview (QPainter *painter) const
 
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 stores state in Dom element More...
 
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document More...
 
void setName (const QString &name)
 
QString name () const
 
QString id () const
 
void setEnabled (const bool enabled)
 
bool enabled () const
 
void setFrameMap (const int mapId)
 Sets overview frame map. More...
 
int frameMapId () const
 Returns id of overview frame (or -1 if no overfiew frame) More...
 
void setFrameSymbol (QgsFillSymbolV2 *symbol)
 
QgsFillSymbolV2frameSymbol ()
 
const QgsFillSymbolV2frameSymbol () const
 
QPainter::CompositionMode blendMode () const
 Returns the overview's blending mode. More...
 
void setBlendMode (const QPainter::CompositionMode blendMode)
 Sets the overview's blending mode. More...
 
bool inverted () const
 Returns true if the overview frame is inverted. More...
 
void setInverted (const bool inverted)
 Sets the overview's inversion mode. More...
 
bool centered () const
 Returns true if the extent is forced to center on the overview. More...
 
void setCentered (const bool centered)
 Set the overview's centering mode. More...
 
void connectSignals ()
 Reconnects signals for overview map, so that overview correctly follows changes to source map's extent. More...
 

Constructor & Destructor Documentation

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

Member Function Documentation

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

Returns the overview's blending mode.

bool QgsComposerMapOverview::centered ( ) const
inline

Returns true if the extent is forced to center on the overview.

void QgsComposerMapOverview::connectSignals ( )

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

void QgsComposerMapOverview::drawOverview ( QPainter *  painter) const
bool QgsComposerMapOverview::enabled ( ) const
inline
int QgsComposerMapOverview::frameMapId ( ) const
inline

Returns id of overview frame (or -1 if no overfiew frame)

Note
: this function was added in version 2.5
QgsFillSymbolV2* QgsComposerMapOverview::frameSymbol ( )
inline
const QgsFillSymbolV2* QgsComposerMapOverview::frameSymbol ( ) const
inline
QString QgsComposerMapOverview::id ( ) const
inline
bool QgsComposerMapOverview::inverted ( ) const
inline

Returns true if the overview frame is inverted.

QString QgsComposerMapOverview::name ( ) const
inline
void QgsComposerMapOverview::overviewExtentChanged ( )
slot
bool QgsComposerMapOverview::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)

sets state from Dom document

Parameters
itemElemis Dom node corresponding to item tag
docis Dom document
void QgsComposerMapOverview::setBlendMode ( const QPainter::CompositionMode  blendMode)

Sets the overview's blending mode.

void QgsComposerMapOverview::setCentered ( const bool  centered)

Set the overview's centering mode.

void QgsComposerMapOverview::setEnabled ( const bool  enabled)
inline
void QgsComposerMapOverview::setFrameMap ( const int  mapId)

Sets overview frame map.

-1 disables the overview frame

Note
: this function was added in version 2.5
void QgsComposerMapOverview::setFrameSymbol ( QgsFillSymbolV2 symbol)
void QgsComposerMapOverview::setInverted ( const bool  inverted)

Sets the overview's inversion mode.

void QgsComposerMapOverview::setName ( const QString &  name)
inline
bool QgsComposerMapOverview::writeXML ( QDomElement &  elem,
QDomDocument &  doc 
) const

stores state in Dom element

Parameters
elemis Dom element corresponding to 'ComposerMap' tag
docDom document

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