mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
630 lines
15 KiB
Plaintext
630 lines
15 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/layout/qgslayoutview.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsLayoutView : QGraphicsView
|
|
{
|
|
%Docstring(signature="appended")
|
|
A graphical widget to display and interact with :py:class:`QgsLayouts`.
|
|
|
|
:py:class:`QgsLayoutView` manages the layout interaction tools and
|
|
mouse/key events.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutview.h"
|
|
%End
|
|
%ConvertToSubClassCode
|
|
if ( qobject_cast<QgsLayoutView *>( sipCpp ) )
|
|
sipType = sipType_QgsLayoutView;
|
|
else
|
|
sipType = NULL;
|
|
%End
|
|
public:
|
|
enum ClipboardOperation
|
|
{
|
|
ClipboardCut,
|
|
ClipboardCopy,
|
|
};
|
|
|
|
enum PasteMode
|
|
{
|
|
PasteModeCursor,
|
|
PasteModeCenter,
|
|
PasteModeInPlace,
|
|
};
|
|
|
|
QgsLayoutView( QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsLayoutView.
|
|
%End
|
|
|
|
~QgsLayoutView();
|
|
|
|
QgsLayout *currentLayout();
|
|
%Docstring
|
|
Returns the current layout associated with the view.
|
|
|
|
.. seealso:: :py:func:`setCurrentLayout`
|
|
|
|
.. seealso:: :py:func:`layoutSet`
|
|
%End
|
|
|
|
|
|
void setCurrentLayout( QgsLayout *layout /KeepReference/ );
|
|
%Docstring
|
|
Sets the current ``layout`` to edit in the view.
|
|
|
|
.. seealso:: :py:func:`currentLayout`
|
|
|
|
.. seealso:: :py:func:`layoutSet`
|
|
%End
|
|
|
|
QgsLayoutViewTool *tool();
|
|
%Docstring
|
|
Returns the currently active tool for the view.
|
|
|
|
.. seealso:: :py:func:`setTool`
|
|
%End
|
|
|
|
void setTool( QgsLayoutViewTool *tool );
|
|
%Docstring
|
|
Sets the ``tool`` currently being used in the view.
|
|
|
|
.. seealso:: :py:func:`unsetTool`
|
|
|
|
.. seealso:: :py:func:`tool`
|
|
%End
|
|
|
|
void unsetTool( QgsLayoutViewTool *tool );
|
|
%Docstring
|
|
Unsets the current view tool, if it matches the specified ``tool``.
|
|
|
|
This is called from destructor of view tools to make sure that the tool
|
|
won't be used any more. You don't have to call it manually,
|
|
:py:class:`QgsLayoutViewTool` takes care of it.
|
|
%End
|
|
|
|
void setPreviewModeEnabled( bool enabled );
|
|
%Docstring
|
|
Sets whether a preview effect should be used to alter the view's
|
|
appearance.
|
|
|
|
:param enabled: Set to ``True`` to enable the preview effect on the
|
|
view.
|
|
|
|
.. seealso:: :py:func:`setPreviewMode`
|
|
%End
|
|
|
|
bool previewModeEnabled() const;
|
|
%Docstring
|
|
Returns ``True`` if a preview effect is being used to alter the view's
|
|
appearance.
|
|
|
|
.. seealso:: :py:func:`setPreviewModeEnabled`
|
|
%End
|
|
|
|
void setPreviewMode( QgsPreviewEffect::PreviewMode mode );
|
|
%Docstring
|
|
Sets the preview ``mode`` which should be used to modify the view's
|
|
appearance. Preview modes are only used if
|
|
:py:func:`~QgsLayoutView.previewModeEnabled` is ``True``.
|
|
|
|
.. seealso:: :py:func:`setPreviewModeEnabled`
|
|
|
|
.. seealso:: :py:func:`previewMode`
|
|
%End
|
|
|
|
QgsPreviewEffect::PreviewMode previewMode() const;
|
|
%Docstring
|
|
Returns the preview mode which may be used to modify the view's
|
|
appearance. Preview modes are only used if
|
|
:py:func:`~QgsLayoutView.previewModeEnabled` is ``True``.
|
|
|
|
.. seealso:: :py:func:`setPreviewMode`
|
|
|
|
.. seealso:: :py:func:`previewModeEnabled`
|
|
%End
|
|
|
|
void scaleSafe( double scale );
|
|
%Docstring
|
|
Scales the view in a safe way, by limiting the acceptable range of the
|
|
scale applied. The ``scale`` parameter specifies the zoom factor to
|
|
scale the view by.
|
|
%End
|
|
|
|
void setZoomLevel( double level );
|
|
%Docstring
|
|
Sets the zoom ``level`` for the view, where a zoom level of 1.0
|
|
corresponds to 100%.
|
|
%End
|
|
|
|
void setHorizontalRuler( QgsLayoutRuler *ruler );
|
|
%Docstring
|
|
Sets a horizontal ``ruler`` to synchronize with the view state.
|
|
|
|
.. seealso:: :py:func:`setVerticalRuler`
|
|
%End
|
|
|
|
void setVerticalRuler( QgsLayoutRuler *ruler );
|
|
%Docstring
|
|
Sets a vertical ``ruler`` to synchronize with the view state.
|
|
|
|
.. seealso:: :py:func:`setHorizontalRuler`
|
|
%End
|
|
|
|
void setMenuProvider( QgsLayoutViewMenuProvider *provider /Transfer/ );
|
|
%Docstring
|
|
Sets a ``provider`` for context menus. Ownership of the provider is
|
|
transferred to the view.
|
|
|
|
.. seealso:: :py:func:`menuProvider`
|
|
%End
|
|
|
|
QgsLayoutViewMenuProvider *menuProvider() const;
|
|
%Docstring
|
|
Returns the provider for context menus. Returned value may be ``None``
|
|
if no provider is set.
|
|
|
|
.. seealso:: :py:func:`setMenuProvider`
|
|
%End
|
|
|
|
int currentPage() const;
|
|
%Docstring
|
|
Returns the page visible in the view. This method considers the page at
|
|
the center of the view as the current visible page.
|
|
|
|
.. seealso:: :py:func:`pageChanged`
|
|
%End
|
|
|
|
QList<QgsLayoutItemPage *> visiblePages() const;
|
|
%Docstring
|
|
Returns a list of page items which are currently visible in the view.
|
|
|
|
.. seealso:: :py:func:`visiblePageNumbers`
|
|
%End
|
|
|
|
QList<int> visiblePageNumbers() const;
|
|
%Docstring
|
|
Returns a list of page numbers for pages which are currently visible in
|
|
the view.
|
|
|
|
.. seealso:: :py:func:`visiblePages`
|
|
%End
|
|
|
|
void alignSelectedItems( QgsLayoutAligner::Alignment alignment );
|
|
%Docstring
|
|
Aligns all selected items using the specified ``alignment``.
|
|
|
|
.. seealso:: :py:func:`distributeSelectedItems`
|
|
|
|
.. seealso:: :py:func:`resizeSelectedItems`
|
|
%End
|
|
|
|
void distributeSelectedItems( QgsLayoutAligner::Distribution distribution );
|
|
%Docstring
|
|
Distributes all selected items using the specified ``distribution``.
|
|
|
|
.. seealso:: :py:func:`alignSelectedItems`
|
|
|
|
.. seealso:: :py:func:`resizeSelectedItems`
|
|
%End
|
|
|
|
void resizeSelectedItems( QgsLayoutAligner::Resize resize );
|
|
%Docstring
|
|
Resizes all selected items using the specified ``resize`` mode.
|
|
|
|
.. seealso:: :py:func:`alignSelectedItems`
|
|
|
|
.. seealso:: :py:func:`distributeSelectedItems`
|
|
%End
|
|
|
|
void copySelectedItems( ClipboardOperation operation );
|
|
%Docstring
|
|
Cuts or copies the selected items, respecting the specified
|
|
``operation``.
|
|
|
|
.. 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:: :py:func:`copySelectedItems`
|
|
|
|
.. seealso:: :py:func:`pasteItems`
|
|
%End
|
|
|
|
QList<QgsLayoutItem *> pasteItems( PasteMode mode );
|
|
%Docstring
|
|
Pastes items from clipboard, using the specified ``mode``.
|
|
|
|
A list of pasted items is returned.
|
|
|
|
.. seealso:: :py:func:`copySelectedItems`
|
|
|
|
.. seealso:: :py:func:`hasItemsInClipboard`
|
|
%End
|
|
|
|
QList<QgsLayoutItem *> pasteItems( QPointF layoutPoint );
|
|
%Docstring
|
|
Pastes items from clipboard, at the specified ``layoutPoint``, in layout
|
|
units.
|
|
|
|
A list of pasted items is returned.
|
|
|
|
.. seealso:: :py:func:`copySelectedItems`
|
|
|
|
.. seealso:: :py:func:`hasItemsInClipboard`
|
|
%End
|
|
|
|
bool hasItemsInClipboard() const;
|
|
%Docstring
|
|
Returns ``True`` if the current clipboard contains layout items.
|
|
|
|
.. seealso:: :py:func:`pasteItems`
|
|
%End
|
|
|
|
QPointF deltaForKeyEvent( QKeyEvent *event );
|
|
%Docstring
|
|
Returns the delta (in layout coordinates) by which to move items for the
|
|
given key ``event``.
|
|
%End
|
|
|
|
|
|
void setSectionLabel( const QString &label );
|
|
%Docstring
|
|
Sets a section ``label``, to display above the first page shown in the
|
|
view.
|
|
%End
|
|
|
|
public slots:
|
|
|
|
void zoomFull();
|
|
%Docstring
|
|
Zooms the view to the full extent of the layout.
|
|
|
|
.. seealso:: :py:func:`zoomIn`
|
|
|
|
.. seealso:: :py:func:`zoomOut`
|
|
|
|
.. seealso:: :py:func:`zoomActual`
|
|
%End
|
|
|
|
void zoomWidth();
|
|
%Docstring
|
|
Zooms the view to the full width of the layout.
|
|
|
|
.. seealso:: :py:func:`zoomIn`
|
|
|
|
.. seealso:: :py:func:`zoomOut`
|
|
|
|
.. seealso:: :py:func:`zoomActual`
|
|
%End
|
|
|
|
void zoomIn();
|
|
%Docstring
|
|
Zooms in to the view by a preset amount.
|
|
|
|
.. seealso:: :py:func:`zoomFull`
|
|
|
|
.. seealso:: :py:func:`zoomOut`
|
|
|
|
.. seealso:: :py:func:`zoomActual`
|
|
%End
|
|
|
|
void zoomOut();
|
|
%Docstring
|
|
Zooms out of the view by a preset amount.
|
|
|
|
.. seealso:: :py:func:`zoomFull`
|
|
|
|
.. seealso:: :py:func:`zoomIn`
|
|
|
|
.. seealso:: :py:func:`zoomActual`
|
|
%End
|
|
|
|
void zoomActual();
|
|
%Docstring
|
|
Zooms to the actual size of the layout.
|
|
|
|
.. seealso:: :py:func:`zoomFull`
|
|
|
|
.. seealso:: :py:func:`zoomIn`
|
|
|
|
.. seealso:: :py:func:`zoomOut`
|
|
%End
|
|
|
|
void emitZoomLevelChanged();
|
|
|
|
|
|
void selectAll();
|
|
%Docstring
|
|
Selects all items in the view.
|
|
|
|
.. seealso:: :py:func:`deselectAll`
|
|
|
|
.. seealso:: :py:func:`invertSelection`
|
|
|
|
.. seealso:: :py:func:`selectNextItemAbove`
|
|
|
|
.. seealso:: :py:func:`selectNextItemBelow`
|
|
%End
|
|
|
|
void deselectAll();
|
|
%Docstring
|
|
Deselects all items in the view.
|
|
|
|
.. seealso:: :py:func:`selectAll`
|
|
|
|
.. seealso:: :py:func:`invertSelection`
|
|
%End
|
|
|
|
void invertSelection();
|
|
%Docstring
|
|
Inverts the current selection, selecting deselected items and
|
|
deselecting and selected items.
|
|
|
|
.. seealso:: :py:func:`selectAll`
|
|
|
|
.. seealso:: :py:func:`deselectAll`
|
|
%End
|
|
|
|
void selectNextItemAbove();
|
|
%Docstring
|
|
Selects the next item above the existing selection, by item z order.
|
|
|
|
.. seealso:: :py:func:`selectNextItemBelow`
|
|
|
|
.. seealso:: :py:func:`selectAll`
|
|
|
|
.. seealso:: :py:func:`deselectAll`
|
|
%End
|
|
|
|
void selectNextItemBelow();
|
|
%Docstring
|
|
Selects the next item below the existing selection, by item z order.
|
|
|
|
.. seealso:: :py:func:`selectNextItemAbove`
|
|
|
|
.. seealso:: :py:func:`selectAll`
|
|
|
|
.. seealso:: :py:func:`deselectAll`
|
|
%End
|
|
|
|
void raiseSelectedItems();
|
|
%Docstring
|
|
Raises the selected items up the z-order.
|
|
|
|
.. seealso:: :py:func:`lowerSelectedItems`
|
|
|
|
.. seealso:: :py:func:`moveSelectedItemsToTop`
|
|
|
|
.. seealso:: :py:func:`moveSelectedItemsToBottom`
|
|
%End
|
|
|
|
void lowerSelectedItems();
|
|
%Docstring
|
|
Lowers the selected items down the z-order.
|
|
|
|
.. seealso:: :py:func:`raiseSelectedItems`
|
|
|
|
.. seealso:: :py:func:`moveSelectedItemsToTop`
|
|
|
|
.. seealso:: :py:func:`moveSelectedItemsToBottom`
|
|
%End
|
|
|
|
void moveSelectedItemsToTop();
|
|
%Docstring
|
|
Raises the selected items to the top of the z-order.
|
|
|
|
.. seealso:: :py:func:`raiseSelectedItems`
|
|
|
|
.. seealso:: :py:func:`lowerSelectedItems`
|
|
|
|
.. seealso:: :py:func:`moveSelectedItemsToBottom`
|
|
%End
|
|
|
|
void moveSelectedItemsToBottom();
|
|
%Docstring
|
|
Lowers the selected items to the bottom of the z-order.
|
|
|
|
.. seealso:: :py:func:`raiseSelectedItems`
|
|
|
|
.. seealso:: :py:func:`lowerSelectedItems`
|
|
|
|
.. seealso:: :py:func:`moveSelectedItemsToTop`
|
|
%End
|
|
|
|
void lockSelectedItems();
|
|
%Docstring
|
|
Locks any selected items, preventing them from being interacted with by
|
|
mouse interactions.
|
|
|
|
.. seealso:: :py:func:`unlockAllItems`
|
|
%End
|
|
|
|
void unlockAllItems();
|
|
%Docstring
|
|
Unlocks all locked items in the layout.
|
|
|
|
.. seealso:: :py:func:`lockSelectedItems`
|
|
%End
|
|
|
|
void deleteSelectedItems();
|
|
%Docstring
|
|
Deletes all selected items.
|
|
|
|
.. seealso:: :py:func:`deleteItems`
|
|
%End
|
|
|
|
void deleteItems( const QList<QgsLayoutItem *> &items );
|
|
%Docstring
|
|
Delete the specified ``items``.
|
|
|
|
.. seealso:: :py:func:`deleteSelectedItems`
|
|
%End
|
|
|
|
void groupSelectedItems();
|
|
%Docstring
|
|
Groups all selected items.
|
|
|
|
.. seealso:: :py:func:`ungroupSelectedItems`
|
|
%End
|
|
|
|
void ungroupSelectedItems();
|
|
%Docstring
|
|
Ungroups all selected items.
|
|
|
|
.. seealso:: :py:func:`groupSelectedItems`
|
|
%End
|
|
|
|
void viewChanged();
|
|
%Docstring
|
|
Updates associated rulers and other widgets after view extent or zoom
|
|
has changed. This should be called after calling any of the
|
|
QGraphicsView base class methods which alter the view's zoom level or
|
|
extent, i.e. QGraphicsView.fitInView().
|
|
%End
|
|
|
|
void pushStatusMessage( const QString &message );
|
|
%Docstring
|
|
Pushes a new status bar ``message`` to the view. This causes
|
|
:py:func:`~QgsLayoutView.statusMessage` to be emitted, which should
|
|
cause the message to appear in the status bar for the parent window.
|
|
|
|
.. seealso:: :py:func:`statusMessage`
|
|
%End
|
|
|
|
signals:
|
|
|
|
void layoutSet( QgsLayout *layout );
|
|
%Docstring
|
|
Emitted when a ``layout`` is set for the view.
|
|
|
|
.. seealso:: :py:func:`currentLayout`
|
|
|
|
.. seealso:: :py:func:`setCurrentLayout`
|
|
%End
|
|
|
|
void toolSet( QgsLayoutViewTool *tool );
|
|
%Docstring
|
|
Emitted when the current ``tool`` is changed.
|
|
|
|
.. seealso:: :py:func:`setTool`
|
|
%End
|
|
|
|
void zoomLevelChanged();
|
|
%Docstring
|
|
Emitted whenever the zoom level of the view is changed.
|
|
%End
|
|
|
|
void cursorPosChanged( QPointF layoutPoint );
|
|
%Docstring
|
|
Emitted when the mouse cursor coordinates change within the view. The
|
|
``layoutPoint`` argument indicates the cursor position within the layout
|
|
coordinate system.
|
|
%End
|
|
|
|
void pageChanged( int page );
|
|
%Docstring
|
|
Emitted when the page visible in the view is changed. This signal
|
|
considers the page at the center of the view as the current visible
|
|
page.
|
|
|
|
.. seealso:: :py:func:`currentPage`
|
|
%End
|
|
|
|
void statusMessage( const QString &message );
|
|
%Docstring
|
|
Emitted when the view has a ``message`` for display in a parent window's
|
|
status bar.
|
|
|
|
.. seealso:: :py:func:`pushStatusMessage`
|
|
%End
|
|
|
|
void itemFocused( QgsLayoutItem *item );
|
|
%Docstring
|
|
Emitted when an ``item`` is "focused" in the view, i.e. it becomes the
|
|
active item and should have its properties displayed in any designer
|
|
windows.
|
|
%End
|
|
|
|
void willBeDeleted();
|
|
%Docstring
|
|
Emitted in the destructor when the view is about to be deleted, but is
|
|
still in a perfectly valid state.
|
|
%End
|
|
|
|
protected:
|
|
virtual void mousePressEvent( QMouseEvent *event );
|
|
|
|
virtual void mouseReleaseEvent( QMouseEvent *event );
|
|
|
|
virtual void mouseMoveEvent( QMouseEvent *event );
|
|
|
|
virtual void mouseDoubleClickEvent( QMouseEvent *event );
|
|
|
|
virtual void wheelEvent( QWheelEvent *event );
|
|
|
|
virtual void keyPressEvent( QKeyEvent *event );
|
|
|
|
virtual void keyReleaseEvent( QKeyEvent *event );
|
|
|
|
virtual void resizeEvent( QResizeEvent *event );
|
|
|
|
virtual void scrollContentsBy( int dx, int dy );
|
|
|
|
virtual void dragEnterEvent( QDragEnterEvent *e );
|
|
|
|
virtual void paintEvent( QPaintEvent *event );
|
|
|
|
|
|
};
|
|
|
|
|
|
class QgsLayoutViewMenuProvider
|
|
{
|
|
%Docstring(signature="appended")
|
|
Interface for a :py:class:`QgsLayoutView` context menu.
|
|
|
|
Implementations of this interface can be made to allow
|
|
:py:class:`QgsLayoutView` instances to provide custom context menus
|
|
(opened upon right-click).
|
|
|
|
.. seealso:: :py:class:`QgsLayoutView`
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutview.h"
|
|
%End
|
|
public:
|
|
virtual ~QgsLayoutViewMenuProvider();
|
|
|
|
virtual QMenu *createContextMenu( QWidget *parent /Transfer/, QgsLayout *layout, QPointF layoutPoint ) const = 0 /Factory/;
|
|
%Docstring
|
|
Returns a newly created menu instance (or ``None`` on error)
|
|
%End
|
|
};
|
|
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/layout/qgslayoutview.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|