QGIS/python/core/annotations/qgshtmlannotation.sip
Nyall Dawson 6a72c945af [sipify] Don't autocreate Docstrings for overridden members
Skip the autocreated Docstrings with rtype annotations if the
member is overridden - better to use the base class
Docstring in this case.
2017-04-17 11:03:02 +10:00

73 lines
2.1 KiB
Plaintext

/************************************************************************
* 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
{
%Docstring
An annotation item that embeds HTML content.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgshtmlannotation.h"
%End
public:
QgsHtmlAnnotation( QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsHtmlAnnotation.
%End
~QgsHtmlAnnotation();
QSizeF minimumFrameSize() const;
void setSourceFile( const QString &htmlFile );
%Docstring
Sets the file path for the source HTML file.
\see sourceFile()
%End
QString sourceFile() const;
%Docstring
Returns the file path for the source HTML file.
\see setSourceFile()
:rtype: str
%End
virtual void writeXml( QDomElement &elem, QDomDocument &doc ) const;
virtual void readXml( const QDomElement &itemElem, const QDomDocument &doc );
void setAssociatedFeature( const QgsFeature &feature );
static QgsHtmlAnnotation *create() /Factory/;
%Docstring
Returns a new QgsHtmlAnnotation object.
:rtype: QgsHtmlAnnotation
%End
protected:
void renderAnnotation( QgsRenderContext &context, QSizeF size ) const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgshtmlannotation.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/