QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
An abstract base class for map tool handlers which automatically handle all the necessary logic for toggling the map tool and enabling/disabling the associated action when the QGIS application is in a state permissible for the tool. More...
#include <qgsabstractmaptoolhandler.h>
Classes | |
struct | Context |
Context of a QgsAbstractMapToolHandler call. More... | |
Public Member Functions | |
QgsAbstractMapToolHandler (QgsMapTool *tool, QAction *action) | |
Constructor for a map tool handler for the specified tool. | |
virtual | ~QgsAbstractMapToolHandler () |
QAction * | action () |
Returns the action associated with toggling the tool. | |
virtual bool | isCompatibleWithLayer (QgsMapLayer *layer, const QgsAbstractMapToolHandler::Context &context)=0 |
Returns true if the associated map tool is compatible with the specified layer. | |
QgsMapTool * | mapTool () |
Returns the tool associated with this handler. | |
virtual void | setLayerForTool (QgsMapLayer *layer) |
Sets the layer to use for the tool. | |
An abstract base class for map tool handlers which automatically handle all the necessary logic for toggling the map tool and enabling/disabling the associated action when the QGIS application is in a state permissible for the tool.
Creating these handlers avoids a lot of complex setup code and manual connections which are otherwise necessary to ensure that a map tool is correctly activated and deactivated when the state of the QGIS application changes (e.g. when the active layer is changed, when edit modes are toggled, when other map tools are switched to, etc).
Definition at line 61 of file qgsabstractmaptoolhandler.h.
QgsAbstractMapToolHandler::QgsAbstractMapToolHandler | ( | QgsMapTool * | tool, |
QAction * | action | ||
) |
Constructor for a map tool handler for the specified tool.
The action argument must be set to the action associated with switching to the tool.
The ownership of neither tool nor action is transferred, and the caller is responsible for ensuring that these objects exist for the lifetime of the handler.
Definition at line 18 of file qgsabstractmaptoolhandler.cpp.
|
virtualdefault |
QAction * QgsAbstractMapToolHandler::action | ( | ) |
Returns the action associated with toggling the tool.
Definition at line 32 of file qgsabstractmaptoolhandler.cpp.
|
pure virtual |
Returns true
if the associated map tool is compatible with the specified layer.
Additional information is available through the context argument.
QgsMapTool * QgsAbstractMapToolHandler::mapTool | ( | ) |
Returns the tool associated with this handler.
Definition at line 27 of file qgsabstractmaptoolhandler.cpp.
|
virtual |
Sets the layer to use for the tool.
Called whenever a new layer should be associated with the tool, e.g. as a result of the user selecting a different active layer.
The default implementation does nothing.
Definition at line 37 of file qgsabstractmaptoolhandler.cpp.