QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
QgsMapHitTest Class Reference

Class that runs a hit test with given map settings. More...

#include <qgsmaphittest.h>

Public Member Functions

 QgsMapHitTest (const QgsMapSettings &settings)
void run ()
QSet< QgsSymbolV2 * > symbolsForLayer (QgsVectorLayer *layer) const

Protected Types

typedef QSet< QgsSymbolV2 * > SymbolV2Set
typedef QMap< QgsVectorLayer
*, SymbolV2Set

Protected Member Functions

void runHitTestLayer (QgsVectorLayer *vl, SymbolV2Set &usedSymbols, QgsRenderContext &context)

Protected Attributes

QgsMapSettings mSettings
HitTest mHitTest

Detailed Description

Class that runs a hit test with given map settings.

Based on the hit test it returns which symbols will be visible on the map - this is useful for content based legend.

added in 2.6

Member Typedef Documentation

typedef QSet<QgsSymbolV2*> QgsMapHitTest::SymbolV2Set

Constructor & Destructor Documentation

QgsMapHitTest::QgsMapHitTest ( const QgsMapSettings settings)

Member Function Documentation

void QgsMapHitTest::run ( )
void QgsMapHitTest::runHitTestLayer ( QgsVectorLayer vl,
SymbolV2Set usedSymbols,
QgsRenderContext context 
QSet<QgsSymbolV2*> QgsMapHitTest::symbolsForLayer ( QgsVectorLayer layer) const

Member Data Documentation

HitTest QgsMapHitTest::mHitTest
QgsMapSettings QgsMapHitTest::mSettings

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