sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-03-04 00:30:59 -05:00
Code Issues Packages Projects Releases Wiki Activity
QGIS/python/core/annotations/qgshtmlannotation.sip

84 lines
2.2 KiB
Plaintext
Raw Normal View History

More sipify blacklist removal
2017-04-02 21:24:19 +10:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgshtmlannotation.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsHtmlAnnotation: QgsAnnotation
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
{
[sipify] Fix loss of class docstring if newline present between class doxygen and class definition
2017-04-17 10:49:29 +10:00
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
An annotation item that embeds HTML content.
[sipify] Fix loss of class docstring if newline present between class doxygen and class definition
2017-04-17 10:49:29 +10:00
.. versionadded:: 3.0
%End
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
%TypeHeaderCode
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
#include "qgshtmlannotation.h"
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
%End
public:
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
QgsHtmlAnnotation( QObject *parent /TransferThis/ = 0 );
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
Constructor for QgsHtmlAnnotation.
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
%End
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
Add methods to clone annotations
2017-04-20 13:39:36 +10:00
virtual QgsHtmlAnnotation *clone() const /Factory/;
sipify all
2017-04-20 13:48:50 +02:00
[sipify] Always add virtual keyword for overridden methods sip often requires the virtual keyword to be present, or it chokes on covariant return types in overridden methods
2017-04-18 11:00:13 +10:00
virtual QSizeF minimumFrameSize() const;
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
sipify all
2017-04-20 13:48:50 +02:00
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
void setSourceFile( const QString &htmlFile );
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
Sets the file path for the source HTML file.
run sipify
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`sourceFile()`
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
%End
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
QString sourceFile() const;
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
Returns the file path for the source HTML file.
:rtype: str
run sipify
2017-12-05 20:04:14 -04:00
.. seealso:: :py:func:`setSourceFile()`
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
%End
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
Introduce QgsReadWriteContext that encapsulates QgsPathResolver This should make the read/write methods more flexible if we need to give them extra context.
2017-05-12 17:31:01 +08:00
virtual void writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const;
Drop redundant virtual keywords on overrides Run clang-tidy modernize-use-override to remove all the redundant virtual keywords from overridden methods, and add some missing overrides. Another benefit is that this has also added the overrides on destructors, which will cause a build failure if a base class is missing a virtual destructor.
2017-12-15 08:57:22 +10:00
Introduce QgsReadWriteContext that encapsulates QgsPathResolver This should make the read/write methods more flexible if we need to give them extra context.
2017-05-12 17:31:01 +08:00
virtual void readXml( const QDomElement &itemElem, const QgsReadWriteContext &context );
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
Drop redundant virtual keywords on overrides Run clang-tidy modernize-use-override to remove all the redundant virtual keywords from overridden methods, and add some missing overrides. Another benefit is that this has also added the overrides on destructors, which will cause a build failure if a base class is missing a virtual destructor.
2017-12-15 08:57:22 +10:00
[sipify] Always add virtual keyword for overridden methods sip often requires the virtual keyword to be present, or it chokes on covariant return types in overridden methods
2017-04-18 11:00:13 +10:00
virtual void setAssociatedFeature( const QgsFeature &feature );
Port annotation feature handling to QgsAnnotation Not an ideal implementation (too much logic resides in the gui QgsMapCanvasAnnotationItem class), but any approach using current api will be dependant on some hacks. Ideally we need a QgsVectorDataProvider method for finding the closest feature(s) to a point(/line/polygon) within a certain tolerance, with provider specific implementations which offload this to the data store's spatial indices. Then this handling could be bumped up to reside in QgsAnnotation.
2017-01-29 23:14:58 +10:00
sipify all
2017-04-20 13:48:50 +02:00
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
static QgsHtmlAnnotation *create() /Factory/;
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
Returns a new QgsHtmlAnnotation object.
:rtype: QgsHtmlAnnotation
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
%End
Annotations are now handled at a project level This commit implements a new QgsAnnotationManager class, which handles storage, writing and retrieval of annotations. QgsProject has an annotationManager() attached to it. Map canvases sync their visible QgsMapCanvasAnnotationItems to the annotations contained within the project's annotation manager. This moves all management, storage and retrieval of annotations up to core and out of app/canvas.
2017-01-30 14:57:16 +10:00
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
protected:
[sipify] Always add virtual keyword for overridden methods sip often requires the virtual keyword to be present, or it chokes on covariant return types in overridden methods
2017-04-18 11:00:13 +10:00
virtual void renderAnnotation( QgsRenderContext &context, QSizeF size ) const;
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
sipify all
2017-04-20 13:48:50 +02:00
Refactor annotations Splits the rendering component of annotations out from map canvas item component. A new core abstract base class QgsAnnotation handles the management of the common properties associated with an annotation, and handles rendering the annotation onto a QgsRenderContext destination. Existing annotation classes have been ported to this, and with the exception of the form annotation moved into core. Form annotations are dependant on editor widgets and must remain in GUI. A new QgsMapCanvasAnnotationItem item class implements a QgsMapCanvasItem which draws an annotation inside the canvas, and handles synchronising the position and size of the canvas item with the QgsAnnotation position/size. This allows annotations to be safely used in a multi-canvas environment, with a single QgsAnnotation being displayed in multiple canvases (even if the canvases have different extent/crs/etc). Additionally it allows annotations to be directly rendered to a map (eg in composer) without going through the gui based Qt graphics scene framework. Also removes lots of duplicate code, and adds some basic unit tests for annotations.
2017-01-26 18:02:52 +10:00
};
More sipify blacklist removal
2017-04-02 21:24:19 +10:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgshtmlannotation.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
Reference in New Issue Copy Permalink