mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
ef25d914e6
If we require all annotation item map tools to inherit from QgsMapToolAdvancedDigitizing, then we lose the flexibility to subclasss other map tools for annotation item creation (e.g. QgsMapToolCapture)
108 lines
3.7 KiB
Plaintext
108 lines
3.7 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/annotations/qgscreateannotationitemmaptool.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
class QgsCreateAnnotationItemMapToolHandler : QObject
|
|
{
|
|
%Docstring(signature="appended")
|
|
|
|
A handler object for map tools which create annotation items.
|
|
|
|
This object is designed to be used by map tools which implement the
|
|
:py:class:`QgsCreateAnnotationItemMapToolInterface`, following the composition pattern.
|
|
|
|
Clients should connect to the handler's :py:func:`~itemCreated` signal, and call the
|
|
:py:func:`~takeCreatedItem` implementation to take ownership of the newly created item
|
|
whenever this signal is emitted.
|
|
|
|
.. versionadded:: 3.22
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgscreateannotationitemmaptool.h"
|
|
%End
|
|
public:
|
|
|
|
QgsCreateAnnotationItemMapToolHandler( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget, QObject *parent = 0 );
|
|
%Docstring
|
|
Constructor for QgsCreateAnnotationItemMapToolHandler, with the specified ``parent`` object.
|
|
%End
|
|
|
|
~QgsCreateAnnotationItemMapToolHandler();
|
|
|
|
QgsAnnotationItem *takeCreatedItem() /TransferBack/;
|
|
%Docstring
|
|
Takes the newly created item from the tool, transferring ownership to the caller.
|
|
%End
|
|
|
|
QgsAnnotationLayer *targetLayer();
|
|
%Docstring
|
|
Returns the target layer for newly created items.
|
|
%End
|
|
|
|
void pushCreatedItem( QgsAnnotationItem *item /Transfer/ );
|
|
%Docstring
|
|
Pushes a created ``item`` to the handler.
|
|
|
|
Ownership of ``item`` is transferred to the handler.
|
|
|
|
Calling this method causes the object to emit the :py:func:`~QgsCreateAnnotationItemMapToolHandler.itemCreated` signal, and queue the item
|
|
ready for collection via a call to :py:func:`~QgsCreateAnnotationItemMapToolHandler.takeCreatedItem`.
|
|
%End
|
|
|
|
signals:
|
|
|
|
void itemCreated();
|
|
%Docstring
|
|
Emitted by the tool when a new annotation item has been created.
|
|
|
|
Clients should connect to this signal and call :py:func:`~QgsCreateAnnotationItemMapToolHandler.takeCreatedItem` to take the newly created item from the map tool.
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsCreateAnnotationItemMapToolInterface
|
|
{
|
|
%Docstring(signature="appended")
|
|
|
|
An interface for map tools which create annotation items.
|
|
|
|
Clients should connect to the map tool's :py:func:`~QgsCreateAnnotationItemMapToolHandler.itemCreated` signal, and call the
|
|
:py:func:`~QgsCreateAnnotationItemMapToolHandler.takeCreatedItem` implementation to take ownership of the newly created item
|
|
whenever this signal is emitted.
|
|
|
|
.. versionadded:: 3.22
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgscreateannotationitemmaptool.h"
|
|
%End
|
|
public:
|
|
|
|
virtual ~QgsCreateAnnotationItemMapToolInterface();
|
|
|
|
virtual QgsCreateAnnotationItemMapToolHandler *handler() = 0;
|
|
%Docstring
|
|
Returns the handler object for the map tool.
|
|
%End
|
|
|
|
virtual QgsMapTool *mapTool() = 0;
|
|
%Docstring
|
|
Returns a reference to the associated map tool.
|
|
%End
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/annotations/qgscreateannotationitemmaptool.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|