QgsIdentifyMenu Class Reference

The QgsIdentifyMenu class builds a menu to be used with identify results (. More...

#include <qgsidentifymenu.h>

Classes
struct	ActionData
class	CustomActionRegistry

Public Types
enum	MenuLevel { LayerLevel, FeatureLevel }

Public Member Functions
	QgsIdentifyMenu (QgsMapCanvas *canvas)
	QgsIdentifyMenu is a menu to be used to choose within a list of QgsMapTool::IdentifyReults.
	~QgsIdentifyMenu ()
void	addCustomAction (QgsMapLayerAction *action)
	adds a new custom action to the menu
bool	allowMultipleReturn ()
QList < QgsMapToolIdentify::IdentifyResult >	exec (const QList< QgsMapToolIdentify::IdentifyResult > idResults, QPoint pos)
	exec
bool	execWithSingleResult ()
int	maxFeatureDisplay ()
int	maxLayerDisplay ()
void	removeCustomActions ()
	remove all custom actions from the menu to be built
bool	resultsIfExternalAction ()
void	setAllowMultipleReturn (bool multipleReturn)
	define if the menu executed can return multiple results (e.g. all results or all identified features of a vector layer)
void	setExecWithSingleResult (bool execWithSingleResult)
	define if the menu will be shown with a single idetify result
void	setMaxFeatureDisplay (int maxFeatureDisplay)
	Defines the maximimum number of features displayed in the menu for vector layers (default is 10).
void	setMaxLayerDisplay (int maxLayerDisplay)
	Defines the maximimum number of layers displayed in the menu (default is 10).
void	setResultsIfExternalAction (bool resultsIfExternalAction)
	setResultsIfExternalAction if set to false (default) the menu will not return any results if an external action has been triggered
void	setShowFeatureActions (bool showFeatureActions)
	define if attribute actions(1) and map layer actions(2) can be listed and run from the menu
bool	showFeatureActions ()

Protected Member Functions
virtual void	closeEvent (QCloseEvent *e) override

Detailed Description

The QgsIdentifyMenu class builds a menu to be used with identify results (.

See Also

QgsMapToolIdentify). It is customizable and can display attribute actions (

QgsAttributeAction) as well as map layer actions (

QgsMapLayerAction). It can also embed custom map layer actions, defined for this menu exclusively. If used in a QgsMapToolIdentify, it is accessible via QgsMapToolIdentify::identifyMenu() and can be customized in the map tool sub-class.

Definition at line 32 of file qgsidentifymenu.h.

Member Enumeration Documentation

enum QgsIdentifyMenu::MenuLevel

Enumerator:

LayerLevel
FeatureLevel

Definition at line 38 of file qgsidentifymenu.h.

Constructor & Destructor Documentation

QgsIdentifyMenu::QgsIdentifyMenu ( QgsMapCanvas *  canvas )

explicit

QgsIdentifyMenu is a menu to be used to choose within a list of QgsMapTool::IdentifyReults.

Definition at line 30 of file qgsidentifymenu.cpp.

QgsIdentifyMenu::~QgsIdentifyMenu

(

)

Definition at line 44 of file qgsidentifymenu.cpp.

Member Function Documentation

void QgsIdentifyMenu::addCustomAction ( QgsMapLayerAction *  action )

inline

adds a new custom action to the menu

Definition at line 127 of file qgsidentifymenu.h.

bool QgsIdentifyMenu::allowMultipleReturn ( )

inline

Definition at line 94 of file qgsidentifymenu.h.

void QgsIdentifyMenu::closeEvent ( QCloseEvent *  e )

overrideprotectedvirtual

Definition at line 155 of file qgsidentifymenu.cpp.

QList< QgsMapToolIdentify::IdentifyResult > QgsIdentifyMenu::exec	(	const QList< QgsMapToolIdentify::IdentifyResult >	idResults,
		QPoint	pos
	)

exec

Parameters

idResults	the list of identify results to choose within
pos	the position where the menu will be executed

Definition at line 70 of file qgsidentifymenu.cpp.

bool QgsIdentifyMenu::execWithSingleResult ( )

inline

Definition at line 98 of file qgsidentifymenu.h.

int QgsIdentifyMenu::maxFeatureDisplay ( )

inline

Definition at line 124 of file qgsidentifymenu.h.

int QgsIdentifyMenu::maxLayerDisplay ( )

inline

Definition at line 119 of file qgsidentifymenu.h.

void QgsIdentifyMenu::removeCustomActions

(

)

remove all custom actions from the menu to be built

Definition at line 625 of file qgsidentifymenu.cpp.

bool QgsIdentifyMenu::resultsIfExternalAction ( )

inline

Definition at line 114 of file qgsidentifymenu.h.

void QgsIdentifyMenu::setAllowMultipleReturn ( bool  multipleReturn )

inline

define if the menu executed can return multiple results (e.g. all results or all identified features of a vector layer)

Definition at line 93 of file qgsidentifymenu.h.

void QgsIdentifyMenu::setExecWithSingleResult ( bool  execWithSingleResult )

inline

define if the menu will be shown with a single idetify result

Definition at line 97 of file qgsidentifymenu.h.

void QgsIdentifyMenu::setMaxFeatureDisplay

(

int

maxFeatureDisplay

)

Defines the maximimum number of features displayed in the menu for vector layers (default is 10).

Note

0 is unlimited.

Definition at line 60 of file qgsidentifymenu.cpp.

void QgsIdentifyMenu::setMaxLayerDisplay

(

int

maxLayerDisplay

)

Defines the maximimum number of layers displayed in the menu (default is 10).

Note

0 is unlimited.

Definition at line 50 of file qgsidentifymenu.cpp.

void QgsIdentifyMenu::setResultsIfExternalAction ( bool  resultsIfExternalAction )

inline

setResultsIfExternalAction if set to false (default) the menu will not return any results if an external action has been triggered

Note

external action can be either custom actions or feature / map layer actions (

See Also

setShowFeatureActions)

Definition at line 113 of file qgsidentifymenu.h.

void QgsIdentifyMenu::setShowFeatureActions ( bool  showFeatureActions )

inline

define if attribute actions(1) and map layer actions(2) can be listed and run from the menu

Note

custom actions will be shown in any case if they exist.

(1) attribute actions are defined by the user in the layer properties

See Also

QgsAttributeAction

Note

(2) map layer actions are built-in c++ actions or actions which are defined by a python plugin

See Also

QgsMapLayerActionRegistry

Definition at line 106 of file qgsidentifymenu.h.

bool QgsIdentifyMenu::showFeatureActions ( )

inline

Definition at line 107 of file qgsidentifymenu.h.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgsidentifymenu.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgsidentifymenu.cpp