sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-14 00:07:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Sipify

Browse Source
This commit is contained in:
Nyall Dawson 2017-12-05 15:27:49 +10:00
parent 17656f23c6
commit 89420fccd6
8 changed files with 169 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
python/core/composer/qgslayoutmanager.sip
View File

@ -15,13 +15,13 @@ class QgsLayoutManager : QObject
%Docstring
.. versionadded:: 3.0
Manages storage of a set of compositions.
Manages storage of a set of layouts.
QgsLayoutManager handles the storage, serializing and deserializing
of QgsCompositions. Usually this class is not constructed directly, but
of QgsLayouts. Usually this class is not constructed directly, but
rather accessed through a QgsProject via QgsProject.layoutManager().
QgsLayoutManager retains ownership of all the compositions contained
QgsLayoutManager retains ownership of all the layouts contained
in the manager.
%End
@ -48,6 +48,16 @@ class QgsLayoutManager : QObject
:rtype: bool
%End
bool addLayout( QgsLayout *layout /Transfer/ );
%Docstring
Adds a ``layout`` to the manager. Ownership of the layout is transferred to the manager.
Returns true if the addition was successful, or false if the layout could not be added (eg
as a result of a duplicate layout name).
.. seealso:: :py:func:`removeLayout()`
.. seealso:: :py:func:`layoutAdded()`
:rtype: bool
%End
bool removeComposition( QgsComposition *composition );
%Docstring
Removes a composition from the manager. The composition is deleted.
@ -56,14 +66,26 @@ class QgsLayoutManager : QObject
.. seealso:: :py:func:`addComposition()`
.. seealso:: :py:func:`compositionRemoved()`
.. seealso:: :py:func:`compositionAboutToBeRemoved()`
.. seealso:: :py:func:`clear()`
:rtype: bool
%End
bool removeLayout( QgsLayout *layout );
%Docstring
Removes a ``layout`` from the manager. The layout is deleted.
Returns true if the removal was successful, or false if the removal failed (eg as a result
of removing a layout which is not contained in the manager).
.. seealso:: :py:func:`addLayout()`
.. seealso:: :py:func:`layoutRemoved()`
.. seealso:: :py:func:`layoutAboutToBeRemoved()`
.. seealso:: :py:func:`clear()`
:rtype: bool
%End
void clear();
%Docstring
Removes and deletes all compositions from the manager.
.. seealso:: :py:func:`removeComposition()`
Removes and deletes all layouts from the manager.
.. seealso:: :py:func:`removeLayout()`
%End
QList< QgsComposition * > compositions() const;
@ -72,6 +94,12 @@ class QgsLayoutManager : QObject
:rtype: list of QgsComposition
%End
QList< QgsLayout * > layouts() const;
%Docstring
Returns a list of all layouts contained in the manager.
:rtype: list of QgsLayout
%End
QgsComposition *compositionByName( const QString &name ) const;
%Docstring
Returns the composition with a matching name, or None if no matching compositions
@ -79,9 +107,16 @@ class QgsLayoutManager : QObject
:rtype: QgsComposition
%End
QgsLayout *layoutByName( const QString &name ) const;
%Docstring
Returns the layout with a matching name, or None if no matching layouts
were found.
:rtype: QgsLayout
%End
bool readXml( const QDomElement &element, const QDomDocument &doc );
%Docstring
Reads the manager's state from a DOM element, restoring all compositions
Reads the manager's state from a DOM element, restoring all layouts
present in the XML document.
.. seealso:: :py:func:`writeXml()`
:rtype: bool
@ -117,38 +152,70 @@ class QgsLayoutManager : QObject
:rtype: QgsLayout
%End
QString generateUniqueTitle() const;
QString generateUniqueComposerTitle() const;
%Docstring
Generates a unique title for a new composition, which does not
clash with any already contained by the manager.
:rtype: str
%End
QString generateUniqueTitle() const;
%Docstring
Generates a unique title for a new layout, which does not
clash with any already contained by the manager.
:rtype: str
%End
signals:
void compositionAboutToBeAdded( const QString &name );
%Docstring
Emitted when a composition is about to be added to the manager
%End
void layoutAboutToBeAdded( const QString &name );
%Docstring
Emitted when a layout is about to be added to the manager
%End
void compositionAdded( const QString &name );
%Docstring
Emitted when a composition has been added to the manager
%End
void layoutAdded( const QString &name );
%Docstring
Emitted when a layout has been added to the manager
%End
void compositionRemoved( const QString &name );
%Docstring
Emitted when a composition was removed from the manager
%End
void layoutRemoved( const QString &name );
%Docstring
Emitted when a layout was removed from the manager
%End
void compositionAboutToBeRemoved( const QString &name );
%Docstring
Emitted when a composition is about to be removed from the manager
%End
void layoutAboutToBeRemoved( const QString &name );
%Docstring
Emitted when a layout is about to be removed from the manager
%End
void compositionRenamed( QgsComposition *composition, const QString &newName );
%Docstring
Emitted when a composition is renamed
%End
void layoutRenamed( QgsLayout *layout, const QString &newName );
%Docstring
Emitted when a layout is renamed
%End
};

2
python/core/core_auto.sip
View File

@ -51,6 +51,7 @@
%Include qgsfeaturestore.sip
%Include qgsfieldformatter.sip
%Include qgsfields.sip
%Include qgsfileutils.sip
%Include qgsfontutils.sip
%Include qgsgeometrysimplifier.sip
%Include qgshistogram.sip
@ -313,7 +314,6 @@
%Include qgsfieldmodel.sip
%Include qgsfieldproxymodel.sip
%Include qgsfiledownloader.sip
%Include qgsfileutils.sip
%Include qgsfeaturefiltermodel.sip
%Include qgsgeometryvalidator.sip
%Include qgsgml.sip

10
python/core/layout/qgslayout.sip
View File

@ -178,10 +178,14 @@ class QgsLayout : QGraphicsScene, QgsExpressionContextGenerator, QgsLayoutUndoOb
which deferred z-order updates.
%End
QgsLayoutItem *itemByUuid( const QString &uuid );
QgsLayoutItem *itemByUuid( const QString &uuid, bool includeTemplateUuids = false );
%Docstring
Returns the layout item with matching ``uuid`` unique identifier, or a None
if a matching item could not be found.
If ``includeTemplateUuids`` is true, then item's QgsLayoutItem.templateUuid()
will also be tested when trying to match the uuid.
.. seealso:: :py:func:`multiFrameByUuid()`
:rtype: QgsLayoutItem
%End
@ -421,7 +425,7 @@ class QgsLayout : QGraphicsScene, QgsExpressionContextGenerator, QgsLayoutUndoOb
%Docstring
Saves the layout as a template at the given file ``path``.
Returns true if save was successful.
.. seealso:: loadFromTemplate()
.. seealso:: :py:func:`loadFromTemplate()`
:rtype: bool
%End
@ -540,7 +544,7 @@ class QgsLayout : QGraphicsScene, QgsExpressionContextGenerator, QgsLayoutUndoOb
void nameChanged( const QString &name );
%Docstring
Emitted when the layout's name is changed.
.. seealso:: setName()
.. seealso:: :py:func:`setName()`
%End
};

65
python/core/layout/qgslayoutitem.sip
View File

@ -261,20 +261,12 @@ class QgsLayoutItem : QgsLayoutObject, QGraphicsRectItem, QgsLayoutUndoObjectInt
virtual int type() const;
%Docstring
Return correct graphics item type
.. seealso:: :py:func:`stringType()`
Return unique graphics item type identifier.
Plugin based subclasses should return an identifier greater than QgsLayoutItemRegistry.PluginItem.
:rtype: int
%End
virtual QString stringType() const = 0;
%Docstring
Return the item type as a string.
This string must be a unique, single word, character only representation of the item type, eg "LayoutScaleBar"
.. seealso:: :py:func:`type()`
:rtype: str
%End
virtual QString uuid() const;
%Docstring
Returns the item identification string. This is a unique random string set for the item
@ -284,6 +276,17 @@ class QgsLayoutItem : QgsLayoutObject, QGraphicsRectItem, QgsLayoutUndoObjectInt
There is no corresponding setter for the uuid - it's created automatically.
.. seealso:: :py:func:`id()`
.. seealso:: :py:func:`setId()`
.. seealso:: :py:func:`templateUuid()`
:rtype: str
%End
QString templateUuid() const;
%Docstring
Returns the item's original identification string. This may differ from the item's uuid()
for items which have been added to an existing layout from a template. In this case
templateUuid() returns the original item UUID at the time the template was created,
while uuid() returns the current instance of the item's unique identifier.
.. seealso:: :py:func:`uuid()`
:rtype: str
%End
@ -457,6 +460,7 @@ class QgsLayoutItem : QgsLayoutObject, QGraphicsRectItem, QgsLayoutUndoObjectInt
Note that the final position of the item may not match the specified target position,
as data defined item position may override the specified value.
.. seealso:: :py:func:`attemptMoveBy()`
.. seealso:: :py:func:`attemptResize()`
.. seealso:: :py:func:`referencePoint()`
.. seealso:: :py:func:`positionWithUnits()`
@ -473,6 +477,20 @@ class QgsLayoutItem : QgsLayoutObject, QGraphicsRectItem, QgsLayoutUndoObjectInt
Note that the final position and size of the item may not match the specified target rect,
as data defined item position and size may override the specified value.
.. seealso:: :py:func:`attemptResize()`
.. seealso:: :py:func:`attemptMove()`
.. seealso:: :py:func:`referencePoint()`
.. seealso:: :py:func:`positionWithUnits()`
%End
void attemptMoveBy( double deltaX, double deltaY );
%Docstring
Attempts to shift the item's position by a specified ``deltaX`` and ``deltaY``, in layout
units.
Note that the final position of the item may not match the specified offsets,
as data defined item position and size may override the specified value.
.. seealso:: :py:func:`attemptResize()`
.. seealso:: :py:func:`attemptMove()`
.. seealso:: :py:func:`referencePoint()`
@ -550,10 +568,28 @@ class QgsLayoutItem : QgsLayoutObject, QGraphicsRectItem, QgsLayoutUndoObjectInt
\param itemElement is the DOM node corresponding to item (e.g. 'LayoutItem' element)
\param document DOM document
\param context read write context
Note that item subclasses should not rely on all other items being present in the
layout at the time this method is called. Instead, any connections and links to
other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring
a scalebar, the connection to the linked map's signals should be implemented
in finalizeRestoreFromXml(), not readXml().
.. seealso:: :py:func:`writeXml()`
.. seealso:: :py:func:`finalizeRestoreFromXml()`
:rtype: bool
%End
virtual void finalizeRestoreFromXml();
%Docstring
Called after all pending items have been restored from XML. Items can use
this method to run steps which must take place after all items have been restored to the layout,
such as connecting to signals emitted by other items, which may not have existed in the layout
at the time readXml() was called. E.g. a scalebar can use this to connect to its linked
map item after restoration from XML.
.. seealso:: :py:func:`readXml()`
%End
virtual QgsAbstractLayoutUndoCommand *createCommand( const QString &text, int id, QUndoCommand *parent = 0 ) /Factory/;
@ -995,6 +1031,13 @@ class QgsLayoutItem : QgsLayoutObject, QGraphicsRectItem, QgsLayoutUndoObjectInt
\param element is the DOM element for the item
\param document DOM document
\param context read write context
Note that item subclasses should not rely on all other items being present in the
layout at the time this method is called. Instead, any connections and links to
other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring
a scalebar, the connection to the linked map's signals should be implemented
in finalizeRestoreFromXml(), not readPropertiesFromElement().
.. seealso:: :py:func:`writePropertiesToElement()`
.. seealso:: :py:func:`readXml()`
:rtype: bool

26
python/core/layout/qgslayoutmultiframe.sip
View File

@ -76,15 +76,6 @@ class QgsLayoutMultiFrame: QgsLayoutObject, QgsLayoutUndoObjectInterface
:rtype: int
%End
virtual QString stringType() const = 0;
%Docstring
Return the multiframe type as a string.
This string must be a unique, single word, character only representation of the item type, eg "LayoutHtml"
.. seealso:: :py:func:`type()`
:rtype: str
%End
virtual QSizeF fixedFrameSize( const int frameIndex = -1 ) const;
%Docstring
Returns the fixed size for a frame, if desired. If the fixed frame size changes,
@ -262,6 +253,16 @@ class QgsLayoutMultiFrame: QgsLayoutObject, QgsLayoutUndoObjectInterface
Cancels the current item command and discards it.
.. seealso:: :py:func:`beginCommand()`
.. seealso:: :py:func:`endCommand()`
%End
virtual void finalizeRestoreFromXml();
%Docstring
Called after all pending items have been restored from XML. Multiframes can use
this method to run steps which must take place after all items have been restored to the layout,
such as connecting to signals emitted by other items, which may not have existed in the layout
at the time readXml() was called. E.g. a scalebar can use this to connect to its linked
map item after restoration from XML.
.. seealso:: :py:func:`readXml()`
%End
public slots:
@ -338,6 +339,13 @@ class QgsLayoutMultiFrame: QgsLayoutObject, QgsLayoutUndoObjectInterface
\param document DOM document
\param context read write context
.. seealso:: :py:func:`writePropertiesToElement()`
Note that item subclasses should not rely on all other items being present in the
layout at the time this method is called. Instead, any connections and links to
other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring
a scalebar, the connection to the linked map's signals should be implemented
in finalizeRestoreFromXml(), not readPropertiesFromElement().
.. seealso:: :py:func:`readXml()`
:rtype: bool
%End

6
python/core/layout/qgslayoutpagecollection.sip
View File

@ -145,7 +145,7 @@ class QgsLayoutPageCollection : QObject, QgsLayoutSerializableObject
Calling deletePage() automatically triggers a reflow() of pages.
.. seealso:: clear()
.. seealso:: :py:func:`clear()`
%End
void deletePage( QgsLayoutItemPage *page );
@ -155,13 +155,13 @@ class QgsLayoutPageCollection : QObject, QgsLayoutSerializableObject
Calling deletePage() automatically triggers a reflow() of pages.
.. seealso:: clear()
.. seealso:: :py:func:`clear()`
%End
void clear();
%Docstring
Removes all pages from the collection.
.. seealso:: deletePage()
.. seealso:: :py:func:`deletePage()`
%End
QgsLayoutItemPage *takePage( QgsLayoutItemPage *page ) /TransferBack/;

22
python/gui/layout/qgslayoutview.sip
View File

@ -195,15 +195,15 @@ class QgsLayoutView: QGraphicsView
void copySelectedItems( ClipboardOperation operation );
%Docstring
Cuts or copies the selected items, respecting the specified ``operation``.
.. seealso:: copyItems()
.. seealso:: pasteItems()
.. seealso:: :py:func:`copyItems()`
.. seealso:: :py:func:`pasteItems()`
%End
void copyItems( const QList< QgsLayoutItem * > &items, ClipboardOperation operation );
%Docstring
Cuts or copies the a list of ``items``, respecting the specified ``operation``.
.. seealso:: copySelectedItems()
.. seealso:: pasteItems()
.. seealso:: :py:func:`copySelectedItems()`
.. seealso:: :py:func:`pasteItems()`
%End
QList< QgsLayoutItem * > pasteItems( PasteMode mode );
@ -212,8 +212,8 @@ class QgsLayoutView: QGraphicsView
A list of pasted items is returned.
.. seealso:: copySelectedItems()
.. seealso:: hasItemsInClipboard()
.. seealso:: :py:func:`copySelectedItems()`
.. seealso:: :py:func:`hasItemsInClipboard()`
:rtype: list of QgsLayoutItem
%End
@ -224,15 +224,15 @@ class QgsLayoutView: QGraphicsView
A list of pasted items is returned.
.. seealso:: copySelectedItems()
.. seealso:: hasItemsInClipboard()
.. seealso:: :py:func:`copySelectedItems()`
.. seealso:: :py:func:`hasItemsInClipboard()`
:rtype: list of QgsLayoutItem
%End
bool hasItemsInClipboard() const;
%Docstring
Returns true if the current clipboard contains layout items.
.. seealso:: pasteItems()
.. seealso:: :py:func:`pasteItems()`
:rtype: bool
%End
@ -376,13 +376,13 @@ class QgsLayoutView: QGraphicsView
void deleteSelectedItems();
%Docstring
Deletes all selected items.
.. seealso:: deleteItems()
.. seealso:: :py:func:`deleteItems()`
%End
void deleteItems( const QList< QgsLayoutItem * > &items );
%Docstring
Delete the specified ``items``.
.. seealso:: deleteSelectedItems()
.. seealso:: :py:func:`deleteSelectedItems()`
%End
void groupSelectedItems();

4
python/gui/qgisinterface.sip
View File

@ -1130,14 +1130,14 @@ Unregister a previously registered action. (e.g. when plugin is going to be unlo
Ownership of the factory is not transferred, and the factory must
be unregistered when plugin is unloaded.
.. seealso:: unregisterCustomLayoutDropHandler() *
.. seealso:: :py:func:`unregisterCustomLayoutDropHandler()`
%End
virtual void unregisterCustomLayoutDropHandler( QgsLayoutCustomDropHandler *handler ) = 0;
%Docstring
Unregister a previously registered custom drop ``handler`` for layout windows.
.. versionadded:: 3.0
.. seealso:: registerCustomLayoutDropHandler() *
.. seealso:: :py:func:`registerCustomLayoutDropHandler()`
%End