mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-01 00:46:20 -05:00
110 lines
3.0 KiB
Plaintext
110 lines
3.0 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
|
|
|
|
virtual void setAtlasPreviewEnabled( bool enabled ) = 0;
|
|
%Docstring
|
|
Toggles whether the atlas preview mode should be ``enabled`` in the designer.
|
|
|
|
.. seealso:: :py:func:`atlasPreviewModeEnabled`
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
virtual bool atlasPreviewEnabled() const = 0;
|
|
%Docstring
|
|
Returns whether the atlas preview mode is enabled in the designer.
|
|
|
|
.. seealso:: :py:func:`setAtlasPreviewEnabled`
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
virtual void showItemOptions( QgsLayoutItem *item, bool bringPanelToFront = true ) = 0;
|
|
%Docstring
|
|
Shows the configuration widget for the specified layout ``item``.
|
|
|
|
If ``bringPanelToFront`` is true, then the item properties panel will be automatically
|
|
shown and raised to the top of the interface.
|
|
|
|
.. versionadded:: 3.4
|
|
%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 *
|
|
************************************************************************/
|