mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
164 lines
4.7 KiB
Plaintext
164 lines
4.7 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/annotations/qgsannotationpointtextitem.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsAnnotationPointTextItem : QgsAnnotationItem
|
|
{
|
|
%Docstring(signature="appended")
|
|
An annotation item which renders a text string at a point location.
|
|
|
|
.. versionadded:: 3.16
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsannotationpointtextitem.h"
|
|
%End
|
|
public:
|
|
|
|
QgsAnnotationPointTextItem( const QString &text, QgsPointXY point );
|
|
%Docstring
|
|
Constructor for QgsAnnotationPointTextItem, containing the specified ``text`` at the specified ``point``.
|
|
%End
|
|
~QgsAnnotationPointTextItem();
|
|
|
|
virtual Qgis::AnnotationItemFlags flags() const;
|
|
|
|
virtual QString type() const;
|
|
|
|
virtual void render( QgsRenderContext &context, QgsFeedback *feedback );
|
|
|
|
virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
|
|
|
|
|
|
static QgsAnnotationPointTextItem *create() /Factory/;
|
|
%Docstring
|
|
Creates a new text at point annotation item.
|
|
%End
|
|
|
|
virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
|
|
|
|
virtual QgsAnnotationPointTextItem *clone() const /Factory/;
|
|
|
|
virtual QgsRectangle boundingBox() const;
|
|
|
|
virtual QgsRectangle boundingBox( QgsRenderContext &context ) const;
|
|
|
|
virtual QList< QgsAnnotationItemNode > nodesV2( const QgsAnnotationItemEditContext &context ) const;
|
|
|
|
virtual Qgis::AnnotationItemEditOperationResult applyEditV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context );
|
|
|
|
virtual QgsAnnotationItemEditOperationTransientResults *transientEditResultsV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context ) /Factory/;
|
|
|
|
|
|
QgsPointXY point() const;
|
|
%Docstring
|
|
Returns the point location of the text.
|
|
|
|
The coordinate reference system for the point will be the parent layer's :py:func:`QgsAnnotationLayer.crs()`.
|
|
|
|
.. seealso:: :py:func:`setPoint`
|
|
%End
|
|
|
|
void setPoint( QgsPointXY point );
|
|
%Docstring
|
|
Sets the ``point`` location of the text.
|
|
|
|
The coordinate reference system for the point will be the parent layer's :py:func:`QgsAnnotationLayer.crs()`.
|
|
|
|
.. seealso:: :py:func:`point`
|
|
%End
|
|
|
|
QString text() const;
|
|
%Docstring
|
|
Returns the text rendered by the item.
|
|
|
|
.. seealso:: :py:func:`setText`
|
|
%End
|
|
|
|
void setText( const QString &text );
|
|
%Docstring
|
|
Sets the ``text`` rendered by the item.
|
|
|
|
.. seealso:: :py:func:`text`
|
|
%End
|
|
|
|
QgsTextFormat format() const;
|
|
%Docstring
|
|
Returns the text format used to render the text.
|
|
|
|
.. seealso:: :py:func:`setFormat`
|
|
%End
|
|
|
|
void setFormat( const QgsTextFormat &format );
|
|
%Docstring
|
|
Sets the text ``format`` used to render the text.
|
|
|
|
.. seealso:: :py:func:`format`
|
|
%End
|
|
|
|
double angle() const;
|
|
%Docstring
|
|
Returns the text's rotation angle, in degrees clockwise.
|
|
|
|
.. seealso:: :py:func:`setAngle`
|
|
%End
|
|
|
|
void setAngle( double angle );
|
|
%Docstring
|
|
Sets the text's rotation ``angle``, in degrees clockwise.
|
|
|
|
.. seealso:: :py:func:`angle`
|
|
%End
|
|
|
|
Qt::Alignment alignment() const;
|
|
%Docstring
|
|
Returns the text's alignment relative to the reference :py:func:`~QgsAnnotationPointTextItem.point`.
|
|
|
|
.. seealso:: :py:func:`setAlignment`
|
|
%End
|
|
|
|
void setAlignment( Qt::Alignment alignment );
|
|
%Docstring
|
|
Sets the text's ``alignment`` relative to the reference :py:func:`~QgsAnnotationPointTextItem.point`.
|
|
|
|
.. seealso:: :py:func:`alignment`
|
|
%End
|
|
|
|
Qgis::SymbolRotationMode rotationMode() const;
|
|
%Docstring
|
|
Returns the rotation mode for the text item.
|
|
|
|
.. seealso:: :py:func:`setRotationMode`
|
|
|
|
.. versionadded:: 3.32
|
|
%End
|
|
|
|
void setRotationMode( Qgis::SymbolRotationMode mode );
|
|
%Docstring
|
|
Sets the rotation ``mode`` for the text item.
|
|
|
|
.. seealso:: :py:func:`rotationMode`
|
|
|
|
.. versionadded:: 3.32
|
|
%End
|
|
|
|
private:
|
|
QgsAnnotationPointTextItem( const QgsAnnotationPointTextItem &other );
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/annotations/qgsannotationpointtextitem.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|