QGIS/python/gui/qgsformannotation.sip

79 lines
2.4 KiB
Plaintext
Raw Normal View History

2017-05-23 14:44:34 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsformannotation.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsFormAnnotation: QgsAnnotation
2017-01-30 17:40:41 +10:00
{
2017-05-23 14:44:34 +02:00
%Docstring
An annotation item that embeds a designer form showing the feature attribute
.. versionadded:: 3.0
%End
2017-01-30 17:40:41 +10:00
%TypeHeaderCode
2017-05-23 14:44:34 +02:00
#include "qgsformannotation.h"
2017-01-30 17:40:41 +10:00
%End
public:
QgsFormAnnotation( QObject *parent /TransferThis/ = 0 );
2017-05-23 14:44:34 +02:00
%Docstring
Constructor for QgsFormAnnotation.
%End
2017-01-30 17:40:41 +10:00
2017-04-20 13:39:36 +10:00
virtual QgsFormAnnotation *clone() const /Factory/;
2017-05-23 14:44:34 +02:00
virtual QSizeF minimumFrameSize() const;
2017-01-30 17:40:41 +10:00
QSizeF preferredFrameSize() const;
2017-05-23 14:44:34 +02:00
%Docstring
Returns the optimal frame size
:rtype: QSizeF
%End
2017-01-30 17:40:41 +10:00
void setDesignerForm( const QString &uiFile );
2017-05-23 14:44:34 +02:00
%Docstring
Sets the path to the Qt Designer UI file to show in the annotation.
.. seealso:: designerForm()
%End
2017-01-30 17:40:41 +10:00
QString designerForm() const;
2017-05-23 14:44:34 +02:00
%Docstring
Returns the path to the Qt Designer UI file to show in the annotation.
.. seealso:: setDesignerForm()
:rtype: str
%End
2017-01-30 17:40:41 +10:00
2017-05-23 14:44:34 +02:00
virtual void writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const;
virtual void readXml( const QDomElement &itemElem, const QgsReadWriteContext &context );
virtual void setAssociatedFeature( const QgsFeature &feature );
2017-01-30 17:40:41 +10:00
static QgsFormAnnotation *create() /Factory/;
2017-05-23 14:44:34 +02:00
%Docstring
Returns a new QgsFormAnnotation object.
:rtype: QgsFormAnnotation
%End
2017-01-30 17:40:41 +10:00
protected:
2017-05-23 14:44:34 +02:00
virtual void renderAnnotation( QgsRenderContext &context, QSizeF size ) const;
2017-01-30 17:40:41 +10:00
};
2017-05-23 14:44:34 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsformannotation.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/