mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
263 lines
7.8 KiB
Plaintext
263 lines
7.8 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/layout/qgslayoutitemmapoverview.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsLayoutItemMapOverviewStack : QgsLayoutItemMapItemStack
|
|
{
|
|
%Docstring(signature="appended")
|
|
A collection of overviews which are drawn above the map content in a
|
|
:py:class:`QgsLayoutItemMap`. The overview stack controls which overviews are drawn and the
|
|
order they are drawn in.
|
|
|
|
.. seealso:: :py:class:`QgsLayoutItemMapOverview`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutitemmapoverview.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutItemMapOverviewStack( QgsLayoutItemMap *map );
|
|
%Docstring
|
|
Constructor for QgsLayoutItemMapOverviewStack, attached to the specified
|
|
``map``.
|
|
%End
|
|
|
|
void addOverview( QgsLayoutItemMapOverview *overview /Transfer/ );
|
|
%Docstring
|
|
Adds a new map ``overview`` to the stack and takes ownership of the overview.
|
|
The overview will be added to the end of the stack, and rendered
|
|
above any existing map overviews already present in the stack.
|
|
|
|
.. note::
|
|
|
|
After adding a overview to the stack, :py:func:`~QgsLayoutItemMapOverviewStack.update`
|
|
should be called for the :py:class:`QgsLayoutItemMap` to prevent rendering artifacts.
|
|
|
|
.. seealso:: :py:func:`removeOverview`
|
|
%End
|
|
|
|
void removeOverview( const QString &overviewId );
|
|
%Docstring
|
|
Removes an overview with matching overviewId from the stack and deletes the corresponding :py:class:`QgsLayoutItemMapOverview`
|
|
|
|
.. note::
|
|
|
|
After removing an overview from the stack, :py:func:`~QgsLayoutItemMapOverviewStack.update`
|
|
should be called for the :py:class:`QgsLayoutItemMap` to prevent rendering artifacts.
|
|
|
|
.. seealso:: :py:func:`addOverview`
|
|
%End
|
|
|
|
void moveOverviewUp( const QString &overviewId );
|
|
%Docstring
|
|
Moves an overview with matching overviewId up the stack, causing it to be rendered above other overviews.
|
|
|
|
.. note::
|
|
|
|
After moving an overview within the stack, :py:func:`~QgsLayoutItemMapOverviewStack.update` should be
|
|
called for the :py:class:`QgsLayoutItemMap` to redraw the map with the new overview stack order.
|
|
|
|
.. seealso:: :py:func:`moveOverviewDown`
|
|
%End
|
|
|
|
void moveOverviewDown( const QString &overviewId );
|
|
%Docstring
|
|
Moves an overview with matching overviewId down the stack, causing it to be rendered below other overviews.
|
|
|
|
.. note::
|
|
|
|
After moving an overview within the stack, :py:func:`~QgsLayoutItemMapOverviewStack.update` should be
|
|
called for the :py:class:`QgsLayoutItemMap` to redraw the map with the new overview stack order.
|
|
|
|
.. seealso:: :py:func:`moveOverviewUp`
|
|
%End
|
|
|
|
QgsLayoutItemMapOverview *overview( const QString &overviewId ) const;
|
|
%Docstring
|
|
Returns a reference to an overview with matching overviewId within the stack.
|
|
%End
|
|
|
|
QgsLayoutItemMapOverview *overview( int index ) const;
|
|
%Docstring
|
|
Returns a reference to an overview at the specified ``index`` within the stack.
|
|
%End
|
|
|
|
QgsLayoutItemMapOverview &operator[]( int index );
|
|
|
|
QList< QgsLayoutItemMapOverview * > asList() const;
|
|
%Docstring
|
|
Returns a list of :py:class:`QgsLayoutItemMapOverviews` contained by the stack.
|
|
%End
|
|
virtual bool readXml( const QDomElement &elem, const QDomDocument &doc, const QgsReadWriteContext &context );
|
|
|
|
|
|
QList< QgsMapLayer * > modifyMapLayerList( const QList< QgsMapLayer * > &layers );
|
|
%Docstring
|
|
Alters the list of map ``layers`` which will be rendered for the link map item, inserting
|
|
temporary layers which represent overview extents as required.
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsLayoutItemMapOverview : QgsLayoutItemMapItem
|
|
{
|
|
%Docstring(signature="appended")
|
|
An individual overview which is drawn above the map content in a
|
|
:py:class:`QgsLayoutItemMap`, and shows the extent of another :py:class:`QgsLayoutItemMap`.
|
|
|
|
.. seealso:: :py:class:`QgsLayoutItemMapOverviewStack`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutitemmapoverview.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutItemMapOverview( const QString &name, QgsLayoutItemMap *map );
|
|
%Docstring
|
|
Constructor for QgsLayoutItemMapOverview.
|
|
|
|
:param name: friendly display name for overview
|
|
:param map: :py:class:`QgsLayoutItemMap` the overview is attached to
|
|
%End
|
|
~QgsLayoutItemMapOverview();
|
|
|
|
virtual void draw( QPainter *painter );
|
|
|
|
virtual bool writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const;
|
|
|
|
virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context );
|
|
|
|
virtual void finalizeRestoreFromXml();
|
|
|
|
virtual bool usesAdvancedEffects() const;
|
|
|
|
|
|
void setLinkedMap( QgsLayoutItemMap *map );
|
|
%Docstring
|
|
Sets the ``map`` to show the overview extent of.
|
|
|
|
.. seealso:: :py:func:`linkedMap`
|
|
%End
|
|
|
|
QgsLayoutItemMap *linkedMap();
|
|
%Docstring
|
|
Returns the source map to show the overview extent of.
|
|
|
|
.. seealso:: :py:func:`setLinkedMap`
|
|
%End
|
|
|
|
void setFrameSymbol( QgsFillSymbol *symbol /Transfer/ );
|
|
%Docstring
|
|
Sets the fill ``symbol`` used for drawing the overview extent. Ownership
|
|
is transferred to the overview.
|
|
|
|
.. seealso:: :py:func:`frameSymbol`
|
|
%End
|
|
|
|
QgsFillSymbol *frameSymbol();
|
|
%Docstring
|
|
Returns the fill symbol used for drawing the overview extent.
|
|
|
|
.. seealso:: :py:func:`setFrameSymbol`
|
|
%End
|
|
|
|
QPainter::CompositionMode blendMode() const;
|
|
%Docstring
|
|
Retrieves the blending mode used for drawing the overview.
|
|
|
|
.. seealso:: :py:func:`setBlendMode`
|
|
%End
|
|
|
|
void setBlendMode( QPainter::CompositionMode mode );
|
|
%Docstring
|
|
Sets the blending ``mode`` used for drawing the overview.
|
|
|
|
.. seealso:: :py:func:`blendMode`
|
|
%End
|
|
|
|
bool inverted() const;
|
|
%Docstring
|
|
Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside
|
|
the extent of the overview map.
|
|
|
|
.. seealso:: :py:func:`setInverted`
|
|
%End
|
|
|
|
void setInverted( bool inverted );
|
|
%Docstring
|
|
Sets whether the overview frame is ``inverted``, ie, whether the shaded area is drawn outside
|
|
the extent of the overview map.
|
|
|
|
.. seealso:: :py:func:`inverted`
|
|
%End
|
|
|
|
bool centered() const;
|
|
%Docstring
|
|
Returns whether the extent of the map is forced to center on the overview.
|
|
|
|
.. seealso:: :py:func:`setCentered`
|
|
%End
|
|
|
|
void setCentered( bool centered );
|
|
%Docstring
|
|
Sets whether the extent of the map is forced to center on the overview
|
|
|
|
.. seealso:: :py:func:`centered`
|
|
%End
|
|
|
|
void connectSignals();
|
|
%Docstring
|
|
Reconnects signals for overview map, so that overview correctly follows changes to source
|
|
map's extent.
|
|
%End
|
|
|
|
QgsVectorLayer *asMapLayer();
|
|
%Docstring
|
|
Returns a vector layer to render as part of the :py:class:`QgsLayoutItemMap` render, containing
|
|
a feature representing the overview extent (and with an appropriate renderer set matching
|
|
the overview's :py:func:`~QgsLayoutItemMapOverview.frameSymbol` ).
|
|
|
|
Ownership of the layer remain with the overview item.
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
virtual QgsMapLayer *mapLayer();
|
|
|
|
|
|
virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
|
|
|
|
|
|
public slots:
|
|
|
|
void overviewExtentChanged();
|
|
%Docstring
|
|
Handles recentering of the map and redrawing of the map's overview
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/layout/qgslayoutitemmapoverview.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|