2017-07-03 12:14:56 +10:00
|
|
|
/************************************************************************
|
|
|
|
|
* 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 ~QgsLayoutDesignerInterface();
|
|
|
|
|
|
|
|
|
|
virtual QgsLayout *layout() = 0;
|
|
|
|
|
%Docstring
|
|
|
|
|
Returns the layout displayed in the designer.
|
2017-12-05 20:04:14 -04:00
|
|
|
.. seealso:: :py:func:`view()`
|
2017-07-03 12:14:56 +10:00
|
|
|
:rtype: QgsLayout
|
|
|
|
|
%End
|
|
|
|
|
|
2017-07-05 18:02:06 +10:00
|
|
|
|
|
|
|
|
virtual QgsLayoutView *view() = 0;
|
|
|
|
|
%Docstring
|
|
|
|
|
Returns the layout view utilized by the designer.
|
2017-12-05 20:04:14 -04:00
|
|
|
.. seealso:: :py:func:`layout()`
|
2017-07-05 18:02:06 +10:00
|
|
|
:rtype: QgsLayoutView
|
|
|
|
|
%End
|
|
|
|
|
|
2017-12-04 15:36:14 +10:00
|
|
|
virtual void selectItems( const QList< QgsLayoutItem * > items ) = 0;
|
|
|
|
|
%Docstring
|
|
|
|
|
Selects the specified ``items``.
|
|
|
|
|
%End
|
|
|
|
|
|
2017-07-03 12:14:56 +10:00
|
|
|
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 *
|
|
|
|
|
************************************************************************/
|
