QGIS/python/gui/qgscomposerinterface.sip
Nyall Dawson 3aef32a191 [composer] Rework interface composer methods
Since composer windows are now only created on demand, and
destroyed when the window is closed, the old interface methods
no longer apply. The new interface methods openComposers(),
openComposer(), closeComposer(), composerOpened(),
composerWillBeClosed() and composerClosed() are similar, but
only apply to composer windows when they are exist (i.e.
are currently open).

To access all compositions from a project, the project's
layoutManager() should be used instead.

Additionally, the new interface methods work with
QgsComposerInterface objects instead of QgsComposerView
objects. This should allow future hooks for plugins to interact
with open composer windows in a more useful way.
2017-03-21 10:32:53 +10:00

16 lines
328 B
Plaintext

class QgsComposerInterface: QObject
{
%TypeHeaderCode
#include <qgscomposerinterface.h>
%End
public:
QgsComposerInterface( QObject *parent /TransferThis/ = 0 );
virtual ~QgsComposerInterface();
virtual QgsComposerView *view() = 0;
virtual QgsComposition *composition() = 0;
virtual void close() = 0;
};