QGIS/python/gui/layout/qgslayoutviewtooladditem.sip
Nyall Dawson 8ca6d3e717 Refactor layout item gui registry to allow metadata for duplicate item types
This allows registration of item creation actions which create
items with an existing item type, but custom creation functions.

E.g. allowing actions for creation of ellipse/triangles/etc
from a single layout item type.
2017-11-07 11:32:38 +10:00

67 lines
2.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layout/qgslayoutviewtooladditem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutViewToolAddItem : QgsLayoutViewTool
{
%Docstring
Layout view tool for adding items to a layout.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutviewtooladditem.h"
%End
public:
QgsLayoutViewToolAddItem( QgsLayoutView *view /TransferThis/ );
QString itemMetadataUuid() const;
%Docstring
Returns the item metadata uuid for items created by the tool.
.. seealso:: setItemMetadataUuid()
:rtype: str
%End
void setItemMetadataUuid( const QString &uuid );
%Docstring
Sets the item metadata ``uuid`` for items created by the tool.
The \uuid associates the current tool behavior with a metadata entry
from QgsLayoutItemGuiRegistry.
.. seealso:: itemMetadataUuid()
%End
virtual void layoutPressEvent( QgsLayoutViewMouseEvent *event );
virtual void layoutMoveEvent( QgsLayoutViewMouseEvent *event );
virtual void layoutReleaseEvent( QgsLayoutViewMouseEvent *event );
virtual void deactivate();
signals:
void createdItem();
%Docstring
Emitted when an item has been created using the tool.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layout/qgslayoutviewtooladditem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/