QGIS/python/gui/auto_generated/annotations/qgsannotationitemwidget.sip.in
Nyall Dawson adcd793b89 Add QgsAnnotationItemCommonPropertiesWidget widget for controlling
common properties of annotation items (e.g. reference scale, z order)

And include this in the point text item configuration widget
2021-09-07 18:44:57 +10:00

82 lines
2.5 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/annotations/qgsannotationitemwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsAnnotationItemBaseWidget: QgsPanelWidget
{
%Docstring(signature="appended")
A base class for property widgets for annotation items.
All annotation item widgets should inherit from this base class.
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsannotationitemwidget.h"
%End
public:
QgsAnnotationItemBaseWidget( QWidget *parent /TransferThis/ );
%Docstring
Constructor for QgsAnnotationItemBaseWidget.
%End
virtual QgsAnnotationItem *createItem() = 0 /Factory/;
%Docstring
Creates a new item matching the settings defined in the widget.
%End
virtual void updateItem( QgsAnnotationItem *item ) = 0;
%Docstring
Updates an existing item to match the settings defined in the widget.
%End
bool setItem( QgsAnnotationItem *item );
%Docstring
Sets the current ``item`` to show in the widget. If ``True`` is returned, ``item``
was an acceptable type for display in this widget and the widget has been
updated to match ``item``'s properties.
If ``False`` is returned, then the widget could not be successfully updated
to show the properties of ``item``.
%End
signals:
void itemChanged();
%Docstring
Emitted when the annotation item definition in the widget is changed by the user.
%End
protected:
virtual bool setNewItem( QgsAnnotationItem *item );
%Docstring
Attempts to update the widget to show the properties
for the specified ``item``.
Subclasses can override this if they support changing items in place.
Implementations must return ``True`` if the item was accepted and
the widget was updated.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/annotations/qgsannotationitemwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/