QGIS/python/gui/auto_generated/layout/qgslayoutviewtooladdnodeitem.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/layout/qgslayoutviewtooladdnodeitem.h                        *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/



class QgsLayoutViewToolAddNodeItem : QgsLayoutViewTool
{
%Docstring
Layout view tool for adding node based items to a layout.

.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgslayoutviewtooladdnodeitem.h"
%End
  public:

    QgsLayoutViewToolAddNodeItem( QgsLayoutView *view /TransferThis/ );
%Docstring
Constructs a QgsLayoutViewToolAddNodeItem for the given layout ``view``.
%End

    int itemMetadataId() const;
%Docstring
Returns the item metadata id for items created by the tool.

.. seealso:: :py:func:`setItemMetadataId`
%End

    void setItemMetadataId( int metadataId );
%Docstring
Sets the item metadata ``metadataId`` for items created by the tool.

The ``metadataId`` associates the current tool behavior with a metadata entry
from :py:class:`QgsLayoutItemGuiRegistry`.

.. seealso:: :py:func:`itemMetadataId`
%End

    virtual void layoutPressEvent( QgsLayoutViewMouseEvent *event );

    virtual void layoutMoveEvent( QgsLayoutViewMouseEvent *event );

    virtual void layoutReleaseEvent( QgsLayoutViewMouseEvent *event );

    virtual void keyPressEvent( QKeyEvent *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/qgslayoutviewtooladdnodeitem.h                        *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/