sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-02-27 00:33:48 -05:00
Code Issues Packages Projects Releases Wiki Activity
QGIS/python/gui/qgscomposerinterface.sip

62 lines
1.9 KiB
Plaintext
Raw Normal View History

sipify gui part 2
2017-05-23 14:39:33 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgscomposerinterface.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
Add a basic interface for composer windows Not much there yet, but it adds an interface with stable API which can be used by plugins and scripts to interact with composer windows. Could be expanded in future to add hooks for toolbars, menus, etc, allowing plugins to extend composer functionality.
2017-03-18 08:36:18 +10:00
class QgsComposerInterface: QObject
{
sipify gui part 2
2017-05-23 14:39:33 +02:00
%Docstring
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.
.. versionadded:: 3.0
%End
Add a basic interface for composer windows Not much there yet, but it adds an interface with stable API which can be used by plugins and scripts to interact with composer windows. Could be expanded in future to add hooks for toolbars, menus, etc, allowing plugins to extend composer functionality.
2017-03-18 08:36:18 +10:00
%TypeHeaderCode
sipify gui part 2
2017-05-23 14:39:33 +02:00
#include "qgscomposerinterface.h"
Add a basic interface for composer windows Not much there yet, but it adds an interface with stable API which can be used by plugins and scripts to interact with composer windows. Could be expanded in future to add hooks for toolbars, menus, etc, allowing plugins to extend composer functionality.
2017-03-18 08:36:18 +10:00
%End
public:
sipify gui part 2
2017-05-23 14:39:33 +02:00
[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-18 10:46:19 +10:00
QgsComposerInterface( QObject *parent /TransferThis/ = 0 );
sipify gui part 2
2017-05-23 14:39:33 +02:00
%Docstring
Constructor for QgsComposerInterface.
%End
[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-18 10:46:19 +10:00
Add a basic interface for composer windows Not much there yet, but it adds an interface with stable API which can be used by plugins and scripts to interact with composer windows. Could be expanded in future to add hooks for toolbars, menus, etc, allowing plugins to extend composer functionality.
2017-03-18 08:36:18 +10:00
virtual ~QgsComposerInterface();
sipify gui part 2
2017-05-23 14:39:33 +02:00
[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-18 10:46:19 +10:00
virtual QgsComposerView *view() = 0;
sipify gui part 2
2017-05-23 14:39:33 +02:00
%Docstring
Returns the composer's QgsComposerView editor widget.
:rtype: QgsComposerView
%End
[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-18 10:46:19 +10:00
virtual QgsComposition *composition() = 0;
sipify gui part 2
2017-05-23 14:39:33 +02:00
%Docstring
Returns the composition displated in the composer.
:rtype: QgsComposition
%End
[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-18 10:46:19 +10:00
virtual void close() = 0;
sipify gui part 2
2017-05-23 14:39:33 +02:00
%Docstring
Closes the composer window.
%End
[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-18 10:46:19 +10:00
Add a basic interface for composer windows Not much there yet, but it adds an interface with stable API which can be used by plugins and scripts to interact with composer windows. Could be expanded in future to add hooks for toolbars, menus, etc, allowing plugins to extend composer functionality.
2017-03-18 08:36:18 +10:00
};
sipify gui part 2
2017-05-23 14:39:33 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgscomposerinterface.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
Reference in New Issue Copy Permalink