mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-06 00:05:02 -05:00
590d1aae9d
Adds a new visitor pattern API for creation of visitors which visit all the style entities (symbols, color ramps, text formats, and label styles) associated with different objects. Can be used on a renderer, map layer, or project wide level. E.g. on a project wide level, allows collection of ALL the style symbols/color ramps/text settings inside a project, including those in layouts or annotations!
130 lines
3.6 KiB
Plaintext
130 lines
3.6 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/layout/qgsmasterlayoutinterface.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
%ModuleHeaderCode
|
|
#include "qgsprintlayout.h"
|
|
#include "qgsreport.h"
|
|
%End
|
|
|
|
class QgsMasterLayoutInterface
|
|
{
|
|
%Docstring
|
|
Interface for master layout type objects, such as print layouts and reports.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmasterlayoutinterface.h"
|
|
%End
|
|
%ConvertToSubClassCode
|
|
switch ( sipCpp->layoutType() )
|
|
{
|
|
case QgsMasterLayoutInterface::PrintLayout:
|
|
sipType = sipType_QgsPrintLayout;
|
|
*sipCppRet = static_cast<QgsPrintLayout *>( sipCpp );
|
|
break;
|
|
case QgsMasterLayoutInterface::Report:
|
|
*sipCppRet = static_cast<QgsReport *>( sipCpp );
|
|
sipType = sipType_QgsReport;
|
|
break;
|
|
default:
|
|
sipType = NULL;
|
|
}
|
|
%End
|
|
public:
|
|
|
|
enum Type
|
|
{
|
|
PrintLayout,
|
|
Report,
|
|
};
|
|
|
|
virtual ~QgsMasterLayoutInterface();
|
|
|
|
virtual QgsMasterLayoutInterface *clone() const = 0 /Factory/;
|
|
%Docstring
|
|
Creates a clone of the layout. Ownership of the returned layout
|
|
is transferred to the caller.
|
|
%End
|
|
|
|
virtual QgsMasterLayoutInterface::Type layoutType() const = 0;
|
|
%Docstring
|
|
Returns the master layout type.
|
|
%End
|
|
|
|
virtual QString name() const = 0;
|
|
%Docstring
|
|
Returns the layout's name.
|
|
|
|
.. seealso:: :py:func:`setName`
|
|
%End
|
|
|
|
virtual QIcon icon() const = 0;
|
|
%Docstring
|
|
Returns an icon for the layout.
|
|
%End
|
|
|
|
virtual void setName( const QString &name ) = 0;
|
|
%Docstring
|
|
Sets the layout's name.
|
|
|
|
.. seealso:: :py:func:`name`
|
|
%End
|
|
|
|
virtual QgsProject *layoutProject() const = 0;
|
|
%Docstring
|
|
The project associated with the layout. Used to get access to layers, map themes,
|
|
relations and various other bits. It is never ``None``.
|
|
%End
|
|
|
|
virtual QDomElement writeLayoutXml( QDomDocument &document, const QgsReadWriteContext &context ) const = 0;
|
|
%Docstring
|
|
Returns the layout's state encapsulated in a DOM element.
|
|
|
|
.. seealso:: :py:func:`readLayoutXml`
|
|
%End
|
|
|
|
virtual bool readLayoutXml( const QDomElement &layoutElement, const QDomDocument &document, const QgsReadWriteContext &context ) = 0;
|
|
%Docstring
|
|
Sets the layout's state from a DOM element. ``layoutElement`` is the DOM node corresponding to the layout.
|
|
|
|
.. seealso:: :py:func:`writeLayoutXml`
|
|
%End
|
|
|
|
virtual void updateSettings() = 0;
|
|
%Docstring
|
|
Refreshes the layout when global layout related options change.
|
|
%End
|
|
|
|
virtual bool layoutAccept( QgsStyleEntityVisitorInterface *visitor ) const;
|
|
%Docstring
|
|
Accepts the specified style entity ``visitor``, causing it to visit all style entities associated
|
|
with the layout.
|
|
|
|
Returns ``True`` if the visitor should continue visiting other objects, or ``False`` if visiting
|
|
should be canceled.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/layout/qgsmasterlayoutinterface.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|