QGIS/python/gui/layout/qgslayoutdesignerinterface.sip.in

81 lines
2.3 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layout/qgslayoutdesignerinterface.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutDesignerInterface: QObject
{
%Docstring
A common interface for layout designer dialogs and widgets.
Provides a common interface and stable API for layout designer dialogs and widgets.
This interface can be used by plugins and scripts to interact with
open layout designer dialogs.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutdesignerinterface.h"
%End
public:
QgsLayoutDesignerInterface( QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsLayoutDesignerInterface.
%End
virtual QgsLayout *layout() = 0;
%Docstring
Returns the current layout displayed in the designer.
.. seealso:: :py:func:`view`
%End
virtual QgsMasterLayoutInterface *masterLayout() = 0;
%Docstring
Returns the master layout displayed in the designer.
.. seealso:: :py:func:`layout`
%End
virtual QgsLayoutView *view() = 0;
%Docstring
Returns the layout view utilized by the designer.
.. seealso:: :py:func:`layout`
%End
virtual QgsMessageBar *messageBar() = 0;
%Docstring
Returns the designer's message bar.
%End
virtual void selectItems( const QList< QgsLayoutItem * > items ) = 0;
%Docstring
Selects the specified ``items``.
%End
public slots:
virtual void close() = 0;
%Docstring
Closes the layout designer.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layout/qgslayoutdesignerinterface.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/