QGIS API Documentation  2.99.0-Master (0cba29c)
Public Member Functions | List of all members
QgsComposerInterface Class Referenceabstract

A common interface for composer dialogs. More...

#include <qgscomposerinterface.h>

Inheritance diagram for QgsComposerInterface:
Inheritance graph
[legend]

Public Member Functions

 QgsComposerInterface (QObject *parent=0)
 Constructor for QgsComposerInterface. More...
 
virtual ~QgsComposerInterface ()=default
 
virtual void close ()=0
 Closes the composer window. More...
 
virtual QgsCompositioncomposition ()=0
 Returns the composition displated in the composer. More...
 
virtual QgsComposerViewview ()=0
 Returns the composer's QgsComposerView editor widget. More...
 

Detailed Description

A common interface for composer dialogs.

Provides a common interface and stable API for composer editor dialogs. This interface can be used by plugins and scripts to interact with open composer dialogs.

Since
QGIS 3.0

Definition at line 36 of file qgscomposerinterface.h.

Constructor & Destructor Documentation

◆ QgsComposerInterface()

QgsComposerInterface::QgsComposerInterface ( QObject *  parent = 0)
inline

Constructor for QgsComposerInterface.

Definition at line 45 of file qgscomposerinterface.h.

◆ ~QgsComposerInterface()

virtual QgsComposerInterface::~QgsComposerInterface ( )
virtualdefault

Member Function Documentation

◆ close()

virtual void QgsComposerInterface::close ( )
pure virtual

Closes the composer window.

◆ composition()

virtual QgsComposition* QgsComposerInterface::composition ( )
pure virtual

Returns the composition displated in the composer.

◆ view()

virtual QgsComposerView* QgsComposerInterface::view ( )
pure virtual

Returns the composer's QgsComposerView editor widget.


The documentation for this class was generated from the following file: