sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-02-25 00:58:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

[annotations] Add framework for map tools for creating new annotation

Browse Source 
items
This commit is contained in:
Nyall Dawson 2021-09-08 10:28:23 +10:00
parent 3a082f5738
commit 01226a3294
10 changed files with 298 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
python/gui/auto_generated/annotations/qgsannotationitemguiregistry.sip.in
View File

@ -68,6 +68,13 @@ Returns an icon representing creation of the annotation item type.
virtual QgsAnnotationItemBaseWidget *createItemWidget( QgsAnnotationItem *item ) /TransferBack/;
%Docstring
Creates a configuration widget for an ``item`` of this type. Can return ``None`` if no configuration GUI is required.
%End
virtual QgsCreateAnnotationItemMapTool *createMapTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) /TransferBack/;
%Docstring
Creates a map tool for a creating a new item of this type.
May return ``None`` if no map tool is available for creating the item.
%End
virtual QgsAnnotationItem *createItem() /TransferBack/;
@ -88,6 +95,7 @@ called for items added programmatically.
class QgsAnnotationItemGuiGroup
{
%Docstring(signature="appended")

60
python/gui/auto_generated/annotations/qgscreateannotationitemmaptool.sip.in Normal file
View File

@ -0,0 +1,60 @@
/************************************************************************
* 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 QgsCreateAnnotationItemMapTool: QgsMapToolAdvancedDigitizing
{
%Docstring(signature="appended")
A base class for map tools which create annotation items.
Clients should connect to the map tool'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:
QgsCreateAnnotationItemMapTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget );
%Docstring
Constructor for QgsCreateAnnotationItemMapTool.
%End
virtual QgsAnnotationItem *takeCreatedItem() = 0 /TransferBack/;
%Docstring
Takes the newly created item from the tool, transferring ownership to the caller.
Subclasses must implement this method, and ensure that they emit the :py:func:`~QgsCreateAnnotationItemMapTool.itemCreated` signal whenever
they have a created item ready for clients to take.
%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:`~QgsCreateAnnotationItemMapTool.takeCreatedItem` to take the newly created item from the 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 *
************************************************************************/

1
python/gui/gui_auto.sip
View File

@ -227,6 +227,7 @@
%Include auto_generated/annotations/qgsannotationitemcommonpropertieswidget.sip
%Include auto_generated/annotations/qgsannotationitemguiregistry.sip
%Include auto_generated/annotations/qgsannotationitemwidget.sip
%Include auto_generated/annotations/qgscreateannotationitemmaptool.sip
%Include auto_generated/annotations/qgsmaptoolmodifyannotation.sip
%Include auto_generated/attributetable/qgsattributetabledelegate.sip
%Include auto_generated/attributetable/qgsattributetablefiltermodel.sip

3
src/gui/CMakeLists.txt
View File

@ -98,6 +98,8 @@ set(QGIS_GUI_SRCS
annotations/qgsannotationitemguiregistry.cpp
annotations/qgsannotationitemwidget.cpp
annotations/qgsannotationitemwidget_impl.cpp
annotations/qgscreateannotationitemmaptool.cpp
annotations/qgscreateannotationitemmaptool_impl.cpp
annotations/qgsmaptoolmodifyannotation.cpp
auth/qgsauthauthoritieseditor.cpp
@ -887,6 +889,7 @@ set(QGIS_GUI_HDRS
annotations/qgsannotationitemcommonpropertieswidget.h
annotations/qgsannotationitemguiregistry.h
annotations/qgsannotationitemwidget.h
annotations/qgscreateannotationitemmaptool.h
annotations/qgsmaptoolmodifyannotation.h
attributeformconfig/qgsattributeformcontaineredit.h

65
src/gui/annotations/qgsannotationitemguiregistry.cpp
View File

@ -20,6 +20,25 @@
#include "qgsannotationitemwidget_impl.h"
//
// QgsAnnotationItemAbstractGuiMetadata
//
QIcon QgsAnnotationItemAbstractGuiMetadata::creationIcon() const
{
return QgsApplication::getThemeIcon( QStringLiteral( "/mActionAddBasicRectangle.svg" ) );
}
QgsAnnotationItemBaseWidget *QgsAnnotationItemAbstractGuiMetadata::createItemWidget( QgsAnnotationItem * )
{
return nullptr;
}
QgsCreateAnnotationItemMapTool *QgsAnnotationItemAbstractGuiMetadata::createMapTool( QgsMapCanvas *, QgsAdvancedDigitizingDockWidget * )
{
return nullptr;
}
QgsAnnotationItem *QgsAnnotationItemAbstractGuiMetadata::createItem()
{
return nullptr;
@ -30,6 +49,41 @@ void QgsAnnotationItemAbstractGuiMetadata::newItemAddedToLayer( QgsAnnotationIte
}
//
// QgsAnnotationItemGuiMetadata
//
QIcon QgsAnnotationItemGuiMetadata::creationIcon() const
{
return mIcon.isNull() ? QgsAnnotationItemAbstractGuiMetadata::creationIcon() : mIcon;
}
QgsAnnotationItemBaseWidget *QgsAnnotationItemGuiMetadata::createItemWidget( QgsAnnotationItem *item )
{
return mWidgetFunc ? mWidgetFunc( item ) : nullptr;
}
QgsAnnotationItem *QgsAnnotationItemGuiMetadata::createItem()
{
return mCreateFunc ? mCreateFunc() : QgsAnnotationItemAbstractGuiMetadata::createItem();
}
void QgsAnnotationItemGuiMetadata::newItemAddedToLayer( QgsAnnotationItem *item, QgsAnnotationLayer *layer )
{
if ( mAddedToLayerFunc )
mAddedToLayerFunc( item, layer );
}
QgsCreateAnnotationItemMapTool *QgsAnnotationItemGuiMetadata::createMapTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget )
{
return mCreateMapToolFunc ? mCreateMapToolFunc( canvas, cadDockWidget ) : nullptr;
}
//
// QgsAnnotationItemGuiRegistry
//
QgsAnnotationItemGuiRegistry::QgsAnnotationItemGuiRegistry( QObject *parent )
: QObject( parent )
{
@ -164,14 +218,3 @@ void QgsAnnotationItemGuiRegistry::addDefaultItems()
return widget;
} ) );
}
QgsAnnotationItem *QgsAnnotationItemGuiMetadata::createItem()
{
return mCreateFunc ? mCreateFunc() : QgsAnnotationItemAbstractGuiMetadata::createItem();
}
void QgsAnnotationItemGuiMetadata::newItemAddedToLayer( QgsAnnotationItem *item, QgsAnnotationLayer *layer )
{
if ( mAddedToLayerFunc )
mAddedToLayerFunc( item, layer );
}

39
src/gui/annotations/qgsannotationitemguiregistry.h
View File

@ -28,6 +28,9 @@
class QgsAnnotationLayer;
class QgsAnnotationItem;
class QgsAnnotationItemBaseWidget;
class QgsCreateAnnotationItemMapTool;
class QgsMapCanvas;
class QgsAdvancedDigitizingDockWidget;
/**
* \ingroup gui
@ -82,7 +85,7 @@ class GUI_EXPORT QgsAnnotationItemAbstractGuiMetadata
/**
* Returns an icon representing creation of the annotation item type.
*/
virtual QIcon creationIcon() const { return QgsApplication::getThemeIcon( QStringLiteral( "/mActionAddBasicRectangle.svg" ) ); }
virtual QIcon creationIcon() const;
/*
* IMPORTANT: While it seems like /Factory/ would be the correct annotations here, that's not
@ -102,7 +105,14 @@ class GUI_EXPORT QgsAnnotationItemAbstractGuiMetadata
/**
* Creates a configuration widget for an \a item of this type. Can return NULLPTR if no configuration GUI is required.
*/
virtual QgsAnnotationItemBaseWidget *createItemWidget( QgsAnnotationItem *item ) SIP_TRANSFERBACK { Q_UNUSED( item ) return nullptr; }
virtual QgsAnnotationItemBaseWidget *createItemWidget( QgsAnnotationItem *item ) SIP_TRANSFERBACK;
/**
* Creates a map tool for a creating a new item of this type.
*
* May return NULLPTR if no map tool is available for creating the item.
*/
virtual QgsCreateAnnotationItemMapTool *createMapTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) SIP_TRANSFERBACK;
/**
* Creates an instance of the corresponding item type.
@ -129,6 +139,9 @@ class GUI_EXPORT QgsAnnotationItemAbstractGuiMetadata
//! Annotation item configuration widget creation function
typedef std::function<QgsAnnotationItemBaseWidget *( QgsAnnotationItem * )> QgsAnnotationItemWidgetFunc SIP_SKIP;
//! Create annotation map tool creation function
typedef std::function<QgsCreateAnnotationItemMapTool *( QgsMapCanvas *, QgsAdvancedDigitizingDockWidget * )> QgsCreateAnnotationItemMapToolFunc SIP_SKIP;
//! Annotation item added to layer callback
typedef std::function<void ( QgsAnnotationItem *, QgsAnnotationLayer *layer )> QgsAnnotationItemAddedToLayerFunc SIP_SKIP;
@ -157,11 +170,13 @@ class GUI_EXPORT QgsAnnotationItemGuiMetadata : public QgsAnnotationItemAbstract
const QgsAnnotationItemWidgetFunc &pfWidget = nullptr,
const QString &groupId = QString(),
Qgis::AnnotationItemGuiFlags flags = Qgis::AnnotationItemGuiFlags(),
const QgsAnnotationItemCreateFunc &pfCreateFunc = nullptr )
const QgsAnnotationItemCreateFunc &pfCreateFunc = nullptr,
const QgsCreateAnnotationItemMapToolFunc &pfCreateMapToolFunc = nullptr )
: QgsAnnotationItemAbstractGuiMetadata( type, visibleName, groupId, flags )
, mIcon( creationIcon )
, mWidgetFunc( pfWidget )
, mCreateFunc( pfCreateFunc )
, mCreateMapToolFunc( pfCreateMapToolFunc )
{}
/**
@ -176,6 +191,18 @@ class GUI_EXPORT QgsAnnotationItemGuiMetadata : public QgsAnnotationItemAbstract
*/
void setWidgetFunction( const QgsAnnotationItemWidgetFunc &function ) { mWidgetFunc = function; }
/**
* Returns the classes' create new item map tool creation function.
* \see setCreateMapToolFunction()
*/
QgsCreateAnnotationItemMapToolFunc createMapToolFunction() const { return mCreateMapToolFunc; }
/**
* Sets the classes' create new item map tool creation \a function.
* \see createMapToolFunction()
*/
void setCreateMapToolFunction( const QgsCreateAnnotationItemMapToolFunc &function ) { mCreateMapToolFunc = function; }
/**
* Returns the classes' item creation function.
* \see setItemCreationFunction()
@ -200,16 +227,18 @@ class GUI_EXPORT QgsAnnotationItemGuiMetadata : public QgsAnnotationItemAbstract
*/
void setItemAddedToLayerFunction( const QgsAnnotationItemAddedToLayerFunc &function ) { mAddedToLayerFunc = function; }
QIcon creationIcon() const override { return mIcon.isNull() ? QgsAnnotationItemAbstractGuiMetadata::creationIcon() : mIcon; }
QgsAnnotationItemBaseWidget *createItemWidget( QgsAnnotationItem *item ) override { return mWidgetFunc ? mWidgetFunc( item ) : nullptr; }
QIcon creationIcon() const override;
QgsAnnotationItemBaseWidget *createItemWidget( QgsAnnotationItem *item ) override;
QgsAnnotationItem *createItem() override;
void newItemAddedToLayer( QgsAnnotationItem *item, QgsAnnotationLayer *layer ) override;
QgsCreateAnnotationItemMapTool *createMapTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget ) override;
protected:
QIcon mIcon;
QgsAnnotationItemWidgetFunc mWidgetFunc = nullptr;
QgsAnnotationItemCreateFunc mCreateFunc = nullptr;
QgsCreateAnnotationItemMapToolFunc mCreateMapToolFunc = nullptr;
QgsAnnotationItemAddedToLayerFunc mAddedToLayerFunc = nullptr;
};

22
src/gui/annotations/qgscreateannotationitemmaptool.cpp Normal file
View File

@ -0,0 +1,22 @@
/***************************************************************************
qgscreateannotationitemmaptool.cpp
------------------------
Date : September 2021
Copyright : (C) 2021 Nyall Dawson
Email : nyall dot dawson at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include "qgscreateannotationitemmaptool.h"
QgsCreateAnnotationItemMapTool::QgsCreateAnnotationItemMapTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget )
: QgsMapToolAdvancedDigitizing( canvas, cadDockWidget )
{
}

67
src/gui/annotations/qgscreateannotationitemmaptool.h Normal file
View File

@ -0,0 +1,67 @@
/***************************************************************************
qgscreateannotationitemmaptool.h
------------------------
Date : September 2021
Copyright : (C) 2021 Nyall Dawson
Email : nyall dot dawson at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSCREATEANNOTATIONITEMMAPTOOL_H
#define QGSCREATEANNOTATIONITEMMAPTOOL_H
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsmaptooladvanceddigitizing.h"
class QgsAnnotationItem;
/**
* \class QgsCreateAnnotationItemMapTool
* \ingroup gui
*
* \brief A base class for map tools which create annotation items.
*
* Clients should connect to the map tool's itemCreated() signal, and call the
* takeCreatedItem() implementation to take ownership of the newly created item
* whenever this signal is emitted.
*
* \since QGIS 3.22
*/
class GUI_EXPORT QgsCreateAnnotationItemMapTool: public QgsMapToolAdvancedDigitizing
{
Q_OBJECT
public:
/**
* Constructor for QgsCreateAnnotationItemMapTool.
*/
QgsCreateAnnotationItemMapTool( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget );
/**
* Takes the newly created item from the tool, transferring ownership to the caller.
*
* Subclasses must implement this method, and ensure that they emit the itemCreated() signal whenever
* they have a created item ready for clients to take.
*/
virtual QgsAnnotationItem *takeCreatedItem() = 0 SIP_TRANSFERBACK;
signals:
/**
* Emitted by the tool when a new annotation item has been created.
*
* Clients should connect to this signal and call takeCreatedItem() to take the newly created item from the map tool.
*/
void itemCreated();
};
#endif // QGSCREATEANNOTATIONITEMMAPTOOL_H

21
src/gui/annotations/qgscreateannotationitemmaptool_impl.cpp Normal file
View File

@ -0,0 +1,21 @@
/***************************************************************************
qgscreateannotationitemmaptool_impl.cpp
------------------------
Date : September 2021
Copyright : (C) 2021 Nyall Dawson
Email : nyall dot dawson at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include "qgscreateannotationitemmaptool_impl.h"
///@cond PRIVATE
///@endcond PRIVATE

28
src/gui/annotations/qgscreateannotationitemmaptool_impl.h Normal file
View File

@ -0,0 +1,28 @@
/***************************************************************************
qgscreateannotationitemmaptool_impl.h
------------------------
Date : September 2021
Copyright : (C) 2021 Nyall Dawson
Email : nyall dot dawson at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSCREATEANNOTATIONITEMMAPTOOLIMPL_H
#define QGSCREATEANNOTATIONITEMMAPTOOLIMPL_H
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgscreateannotationitemmaptool.h"
#define SIP_NO_FILE
///@cond PRIVATE
///@endcond PRIVATE
#endif // QGSCREATEANNOTATIONITEMMAPTOOLIMPL_H