The QgsIdentifyMenu class builds a menu to be used with identify results (.
More...
#include <qgsidentifymenu.h>
The QgsIdentifyMenu class builds a menu to be used with identify results (.
- See also
- QgsMapToolIdentify). It is customizable and can display attribute actions (
-
QgsAction) 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 49 of file qgsidentifymenu.h.
◆ MenuLevel
◆ QgsIdentifyMenu()
◆ ~QgsIdentifyMenu()
QgsIdentifyMenu::~QgsIdentifyMenu |
( |
| ) |
|
|
override |
◆ addCustomAction()
◆ allowMultipleReturn()
bool QgsIdentifyMenu::allowMultipleReturn |
( |
| ) |
|
|
inline |
◆ closeEvent()
void QgsIdentifyMenu::closeEvent |
( |
QCloseEvent * |
e | ) |
|
|
overrideprotected |
◆ exec()
exec
- Parameters
-
idResults | the list of identify results to choose within |
pos | the position where the menu will be executed |
Definition at line 127 of file qgsidentifymenu.cpp.
◆ execWithSingleResult()
bool QgsIdentifyMenu::execWithSingleResult |
( |
| ) |
|
|
inline |
◆ expressionContextScope()
Returns an expression context scope used to resolve underlying actions.
Definition at line 737 of file qgsidentifymenu.cpp.
◆ findFeaturesOnCanvas()
Searches for features on the map canvas, which are located at the specified event point.
The geometryTypes argument lists acceptable geometry types.
This method searches through all layers on the canvas, attempting to find matching features at the event point.
- Since
- QGIS 3.26
Definition at line 51 of file qgsidentifymenu.cpp.
◆ maxFeatureDisplay()
int QgsIdentifyMenu::maxFeatureDisplay |
( |
| ) |
|
|
inline |
◆ maxLayerDisplay()
int QgsIdentifyMenu::maxLayerDisplay |
( |
| ) |
|
|
inline |
◆ removeCustomActions()
void QgsIdentifyMenu::removeCustomActions |
( |
| ) |
|
◆ resultsIfExternalAction()
bool QgsIdentifyMenu::resultsIfExternalAction |
( |
| ) |
|
|
inline |
◆ setAllowMultipleReturn()
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 113 of file qgsidentifymenu.h.
◆ setExecWithSingleResult()
void QgsIdentifyMenu::setExecWithSingleResult |
( |
bool |
execWithSingleResult | ) |
|
|
inline |
define if the menu will be shown with a single identify result
Definition at line 117 of file qgsidentifymenu.h.
◆ setExpressionContextScope()
Sets an expression context scope used to resolve underlying actions.
Definition at line 732 of file qgsidentifymenu.cpp.
◆ setMaxFeatureDisplay()
void QgsIdentifyMenu::setMaxFeatureDisplay |
( |
int |
maxFeatureDisplay | ) |
|
Defines the maximum number of features displayed in the menu for vector layers (default is 10).
- Note
- 0 is unlimited.
Definition at line 117 of file qgsidentifymenu.cpp.
◆ setMaxLayerDisplay()
void QgsIdentifyMenu::setMaxLayerDisplay |
( |
int |
maxLayerDisplay | ) |
|
Defines the maximum number of layers displayed in the menu (default is 10).
- Note
- 0 is unlimited.
Definition at line 107 of file qgsidentifymenu.cpp.
◆ setResultsIfExternalAction()
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 145 of file qgsidentifymenu.h.
◆ setShowFeatureActions()
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
- QgsAction
- 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 138 of file qgsidentifymenu.h.
◆ showFeatureActions()
bool QgsIdentifyMenu::showFeatureActions |
( |
| ) |
|
|
inline |
◆ styleHighlight()
void QgsIdentifyMenu::styleHighlight |
( |
QgsHighlight * |
highlight | ) |
|
|
static |
The documentation for this class was generated from the following files: