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



class QgsLayoutViewToolAddItem : QgsLayoutViewTool
{
%Docstring(signature="appended")
Layout view tool for adding items to a layout.
%End

%TypeHeaderCode
#include "qgslayoutviewtooladditem.h"
%End
  public:
    QgsLayoutViewToolAddItem( QgsLayoutView *view /TransferThis/ );
%Docstring
Constructs a QgsLayoutViewToolAddItem 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 activate();

    virtual void deactivate();


    QVariantMap customProperties() const;
%Docstring
Returns any custom properties set for the tool.

.. seealso:: :py:func:`setCustomProperties`

.. versionadded:: 3.18
%End

    void setCustomProperties( const QVariantMap &properties );
%Docstring
Sets custom ``properties`` for the tool.

These properties are transient, and are cleared whenever the tool is
activated. Callers must ensure that the properties are set only after
the tool is activated.

.. seealso:: :py:func:`customProperties`

.. versionadded:: 3.18
%End

  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.py again   *
 ************************************************************************/