/
qgscomposerinterface.h
71 lines (59 loc) · 2.03 KB
/
qgscomposerinterface.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/***************************************************************************
qgscomposerinterface.h
---------------------
Date : March 2017
Copyright : (C) 2017 Nyall Dawson
Email : nyall dot dawson at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSCOMPOSERINTERFACE_H
#define QGSCOMPOSERINTERFACE_H
#include "qgis_gui.h"
#include "qgis_sip.h"
#include <QObject>
class QgsComposerView;
class QgsComposition;
#define SIP_NO_FILE
/**
* \ingroup gui
* \class QgsComposerInterface
* 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
* \note Not available in Python bindings
* \deprecated Will be removed in QGIS 3.2
*/
class GUI_EXPORT QgsComposerInterface: public QObject
{
Q_OBJECT
public:
/**
* Constructor for QgsComposerInterface.
*/
QgsComposerInterface( QObject *parent SIP_TRANSFERTHIS = nullptr )
: QObject( parent )
{}
/**
* Returns the composer's QgsComposerView editor widget.
*/
virtual QgsComposerView *view() = 0;
/**
* Returns the composition displated in the composer.
*/
virtual QgsComposition *composition() = 0;
/**
* Closes the composer window.
*/
virtual void close() = 0;
};
#endif // QGSCOMPOSERINTERFACE_H