-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsidentifymenu.sip
86 lines (69 loc) · 3.03 KB
/
qgsidentifymenu.sip
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
class QgsIdentifyMenu : QMenu
{
%TypeHeaderCode
#include <qgsidentifymenu.h>
%End
public:
enum MenuLevel
{
LayerLevel,
FeatureLevel
};
struct ActionData
{
ActionData();
ActionData( QgsMapLayer* layer, QgsMapLayerAction* mapLayerAction = 0 );
ActionData( QgsMapLayer* layer, QgsFeatureId fid, QgsMapLayerAction* mapLayerAction = 0 );
bool mIsValid;
bool mAllResults;
bool mIsExternalAction;
QgsMapLayer* mLayer;
QgsFeatureId mFeatureId;
MenuLevel mLevel;
QgsMapLayerAction* mMapLayerAction;
};
/**
* @brief QgsIdentifyMenu is a menu to be used to choose within a list of QgsMapTool::IdentifyReults
*/
explicit QgsIdentifyMenu( QgsMapCanvas* canvas );
~QgsIdentifyMenu();
//! define if the menu executed can return multiple results (e.g. all results or all identified features of a vector layer)
void setAllowMultipleReturn( bool multipleReturn );
bool allowMultipleReturn();
//! define if the menu will be shown with a single idetify result
void setExecWithSingleResult( bool execWithSingleResult );
bool execWithSingleResult();
/**
* @brief 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.
* @note (1) attribute actions are defined by the user in the layer properties @see QgsAttributeAction
* @note (2) map layer actions are built-in c++ actions or actions which are defined by a python plugin @see QgsMapLayerActionRegistry
*/
void setShowFeatureActions( bool showFeatureActions );
bool showFeatureActions();
/**
* @brief 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 setShowFeatureActions)
*/
void setResultsIfExternalAction( bool resultsIfExternalAction );
bool resultsIfExternalAction();
//! Defines the maximimum number of layers displayed in the menu (default is 10).
//! @note 0 is unlimited.
void setMaxLayerDisplay( int maxLayerDisplay );
int maxLayerDisplay();
//! Defines the maximimum number of features displayed in the menu for vector layers (default is 10).
//! @note 0 is unlimited.
void setMaxFeatureDisplay( int maxFeatureDisplay );
int maxFeatureDisplay();
//! adds a new custom action to the menu
void addCustomAction( QgsMapLayerAction* action );
//! remove all custom actions from the menu to be built
void removeCustomActions();
/**
* @brief exec
* @param idResults the list of identify results to choose within
* @param pos the position where the menu will be executed
* @param selectedAction if specified, this will allow to know which action has been triggered
*/
QList<QgsMapToolIdentify::IdentifyResult> exec( const QList<QgsMapToolIdentify::IdentifyResult> idResults, QPoint pos );
};