QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Types | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsComposerView Class Reference

Widget to display the composer items. More...

#include <qgscomposerview.h>

Inheritance diagram for QgsComposerView:
Inheritance graph
[legend]

Public Types

enum  ClipboardMode { ClipboardModeCut, ClipboardModeCopy }
 
enum  PasteMode { PasteModeCursor, PasteModeCenter, PasteModeInPlace }
 
enum  Tool {
  Select = 0, AddArrow, AddHtml, AddMap,
  AddLegend, AddLabel, AddScalebar, AddPicture,
  AddRectangle, AddEllipse, AddPolygon, AddPolyline,
  AddTriangle, AddTable, AddAttributeTable, MoveItemContent,
  EditNodesItem, Pan, Zoom
}
 Current tool. More...
 
enum  ToolStatus { Inactive, Active, ActiveUntilMouseRelease }
 

Signals

void actionFinished ()
 Current action (e.g. More...
 
void composerViewHide (QgsComposerView *)
 Emitted before composerview is hidden. More...
 
void composerViewShow (QgsComposerView *)
 Emitted before composerview is shown. More...
 
void compositionSet (QgsComposition *)
 Emitted when the composition is set for the view. More...
 
void cursorPosChanged (QPointF)
 Is emitted when mouse cursor coordinates change. More...
 
void itemRemoved (QgsComposerItem *)
 Is emitted when a composer item has been removed from the scene. More...
 
void selectedItemChanged (QgsComposerItem *selected)
 Is emitted when selected item changed. More...
 
void zoomLevelChanged ()
 Is emitted when the view zoom changes. More...
 

Public Member Functions

 QgsComposerView (QWidget *parent=nullptr, const char *name=nullptr, const Qt::WindowFlags &f=nullptr)
 
QMainWindowcomposerWindow ()
 Returns the composer main window. More...
 
QgsCompositioncomposition ()
 Returns the composition or 0 in case of error. More...
 
void copyItems (ClipboardMode mode)
 Cuts or copies the selected items. More...
 
QgsComposerView::Tool currentTool () const
 
void deleteSelectedItems ()
 Deletes selected items. More...
 
void groupItems ()
 Add an item group containing the selected items. More...
 
bool paintingEnabled () const
 
void pasteItems (PasteMode mode)
 Pastes items from clipboard. More...
 
void scaleSafe (double scale)
 Scales the view in a safe way, by limiting the acceptable range of the scale applied. More...
 
void selectAll ()
 Selects all items. More...
 
void selectInvert ()
 Inverts current selection. More...
 
void selectNone ()
 Deselects all items. More...
 
void setComposition (QgsComposition *c)
 Sets the composition for the view. More...
 
void setCurrentTool (QgsComposerView::Tool t)
 
void setHorizontalRuler (QgsComposerRuler *r)
 
void setPaintingEnabled (bool enabled)
 
void setPreviewMode (QgsPreviewEffect::PreviewMode mode)
 Sets the preview mode which should be used to modify the view's appearance. More...
 
void setPreviewModeEnabled (bool enabled)
 Sets whether a preview effect should be used to alter the view's appearance. More...
 
void setVerticalRuler (QgsComposerRuler *r)
 
void setZoomLevel (double zoomLevel)
 Set zoom level, where a zoom level of 1.0 corresponds to 100%. More...
 
void ungroupItems ()
 Ungroups the selected items. More...
 
void updateRulers ()
 Update rulers with current scene rect. More...
 
- Public Member Functions inherited from QGraphicsView
 QGraphicsView (QWidget *parent)
 
 QGraphicsView (QGraphicsScene *scene, QWidget *parent)
 
 ~QGraphicsView ()
 
Qt::Alignment alignment () const
 
QBrush backgroundBrush () const
 
CacheMode cacheMode () const
 
void centerOn (const QPointF &pos)
 
void centerOn (qreal x, qreal y)
 
void centerOn (const QGraphicsItem *item)
 
DragMode dragMode () const
 
void ensureVisible (const QRectF &rect, int xmargin, int ymargin)
 
void ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin, int ymargin)
 
void ensureVisible (const QGraphicsItem *item, int xmargin, int ymargin)
 
void fitInView (const QRectF &rect, Qt::AspectRatioMode aspectRatioMode)
 
void fitInView (qreal x, qreal y, qreal w, qreal h, Qt::AspectRatioMode aspectRatioMode)
 
void fitInView (const QGraphicsItem *item, Qt::AspectRatioMode aspectRatioMode)
 
QBrush foregroundBrush () const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const
 
void invalidateScene (const QRectF &rect, QFlags< QGraphicsScene::SceneLayer > layers)
 
bool isInteractive () const
 
bool isTransformed () const
 
QGraphicsItemitemAt (const QPoint &pos) const
 
QGraphicsItemitemAt (int x, int y) const
 
QList< QGraphicsItem * > items () const
 
QList< QGraphicsItem * > items (const QPolygon &polygon, Qt::ItemSelectionMode mode) const
 
QList< QGraphicsItem * > items (int x, int y) const
 
QList< QGraphicsItem * > items (const QRect &rect, Qt::ItemSelectionMode mode) const
 
QList< QGraphicsItem * > items (int x, int y, int w, int h, Qt::ItemSelectionMode mode) const
 
QList< QGraphicsItem * > items (const QPainterPath &path, Qt::ItemSelectionMode mode) const
 
QList< QGraphicsItem * > items (const QPoint &pos) const
 
QPoint mapFromScene (const QPointF &point) const
 
QPolygon mapFromScene (const QRectF &rect) const
 
QPolygon mapFromScene (const QPolygonF &polygon) const
 
QPoint mapFromScene (qreal x, qreal y) const
 
QPolygon mapFromScene (qreal x, qreal y, qreal w, qreal h) const
 
QPainterPath mapFromScene (const QPainterPath &path) const
 
QPolygonF mapToScene (const QRect &rect) const
 
QPolygonF mapToScene (const QPolygon &polygon) const
 
QPointF mapToScene (const QPoint &point) const
 
QPolygonF mapToScene (int x, int y, int w, int h) const
 
QPointF mapToScene (int x, int y) const
 
QPainterPath mapToScene (const QPainterPath &path) const
 
QMatrix matrix () const
 
OptimizationFlags optimizationFlags () const
 
void render (QPainter *painter, const QRectF &target, const QRect &source, Qt::AspectRatioMode aspectRatioMode)
 
QPainter::RenderHints renderHints () const
 
void resetCachedContent ()
 
void resetMatrix ()
 
void resetTransform ()
 
ViewportAnchor resizeAnchor () const
 
void rotate (qreal angle)
 
Qt::ItemSelectionMode rubberBandSelectionMode () const
 
void scale (qreal sx, qreal sy)
 
QGraphicsScenescene () const
 
QRectF sceneRect () const
 
void setAlignment (QFlags< Qt::AlignmentFlag > alignment)
 
void setBackgroundBrush (const QBrush &brush)
 
void setCacheMode (QFlags< QGraphicsView::CacheModeFlag > mode)
 
void setDragMode (DragMode mode)
 
void setForegroundBrush (const QBrush &brush)
 
void setInteractive (bool allowed)
 
void setMatrix (const QMatrix &matrix, bool combine)
 
void setOptimizationFlag (OptimizationFlag flag, bool enabled)
 
void setOptimizationFlags (QFlags< QGraphicsView::OptimizationFlag > flags)
 
void setRenderHint (QPainter::RenderHint hint, bool enabled)
 
void setRenderHints (QFlags< QPainter::RenderHint > hints)
 
void setResizeAnchor (ViewportAnchor anchor)
 
void setRubberBandSelectionMode (Qt::ItemSelectionMode mode)
 
void setScene (QGraphicsScene *scene)
 
void setSceneRect (qreal x, qreal y, qreal w, qreal h)
 
void setSceneRect (const QRectF &rect)
 
void setTransform (const QTransform &matrix, bool combine)
 
void setTransformationAnchor (ViewportAnchor anchor)
 
void setViewportUpdateMode (ViewportUpdateMode mode)
 
void shear (qreal sh, qreal sv)
 
virtual QSize sizeHint () const
 
QTransform transform () const
 
ViewportAnchor transformationAnchor () const
 
void translate (qreal dx, qreal dy)
 
void updateScene (const QList< QRectF > &rects)
 
void updateSceneRect (const QRectF &rect)
 
QTransform viewportTransform () const
 
ViewportUpdateMode viewportUpdateMode () const
 
- Public Member Functions inherited from QAbstractScrollArea
 QAbstractScrollArea (QWidget *parent)
 
 ~QAbstractScrollArea ()
 
void addScrollBarWidget (QWidget *widget, QFlags< Qt::AlignmentFlag > alignment)
 
QWidgetcornerWidget () const
 
QScrollBarhorizontalScrollBar () const
 
Qt::ScrollBarPolicy horizontalScrollBarPolicy () const
 
QSize maximumViewportSize () const
 
virtual QSize minimumSizeHint () const
 
QWidgetList scrollBarWidgets (QFlags< Qt::AlignmentFlag > alignment)
 
void setCornerWidget (QWidget *widget)
 
void setHorizontalScrollBar (QScrollBar *scrollBar)
 
void setHorizontalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setVerticalScrollBar (QScrollBar *scrollBar)
 
void setVerticalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setViewport (QWidget *widget)
 
QScrollBarverticalScrollBar () const
 
Qt::ScrollBarPolicy verticalScrollBarPolicy () const
 
QWidgetviewport () const
 
- Public Member Functions inherited from QFrame
 QFrame (QWidget *parent, QFlags< Qt::WindowType > f)
 
 QFrame (QWidget *parent, const char *name, QFlags< Qt::WindowType > f)
 
 ~QFrame ()
 
QRect frameRect () const
 
Shadow frameShadow () const
 
Shape frameShape () const
 
int frameStyle () const
 
int frameWidth () const
 
int lineWidth () const
 
int midLineWidth () const
 
void setFrameRect (const QRect &)
 
void setFrameShadow (Shadow)
 
void setFrameShape (Shape)
 
void setFrameStyle (int style)
 
void setLineWidth (int)
 
void setMidLineWidth (int)
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, QFlags< Qt::WindowType > f)
 
 QWidget (QWidget *parent, const char *name, QFlags< Qt::WindowType > f)
 
 ~QWidget ()
 
bool acceptDrops () const
 
QString accessibleDescription () const
 
QString accessibleName () const
 
QList< QAction * > actions () const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const
 
Qt::BackgroundMode backgroundMode () const
 
QPoint backgroundOffset () const
 
BackgroundOrigin backgroundOrigin () const
 
QPalette::ColorRole backgroundRole () const
 
QSize baseSize () const
 
QString caption () const
 
QWidgetchildAt (int x, int y, bool includeThis) const
 
QWidgetchildAt (const QPoint &p, bool includeThis) const
 
QWidgetchildAt (int x, int y) const
 
QWidgetchildAt (const QPoint &p) const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
void clearFocus ()
 
void clearMask ()
 
bool close (bool alsoDelete)
 
bool close ()
 
QColorGroup colorGroup () const
 
void constPolish () const
 
QMargins contentsMargins () const
 
QRect contentsRect () const
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
QCursor cursor () const
 
void customContextMenuRequested (const QPoint &pos)
 
void drawText (const QPoint &p, const QString &s)
 
void drawText (int x, int y, const QString &s)
 
WId effectiveWinId () const
 
void ensurePolished () const
 
void erase ()
 
void erase (const QRect &rect)
 
void erase (const QRegion &rgn)
 
void erase (int x, int y, int w, int h)
 
Qt::FocusPolicy focusPolicy () const
 
QWidgetfocusProxy () const
 
QWidgetfocusWidget () const
 
const QFontfont () const
 
QFontInfo fontInfo () const
 
QFontMetrics fontMetrics () const
 
QPalette::ColorRole foregroundRole () const
 
QRect frameGeometry () const
 
QSize frameSize () const
 
const QRectgeometry () const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
 
virtual HDC getDC () const
 
void grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const
 
bool hasEditFocus () const
 
bool hasFocus () const
 
bool hasMouse () const
 
bool hasMouseTracking () const
 
int height () const
 
virtual int heightForWidth (int w) const
 
void hide ()
 
const QPixmapicon () const
 
void iconify ()
 
QString iconText () const
 
QInputContextinputContext ()
 
Qt::InputMethodHints inputMethodHints () const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const
 
bool isAncestorOf (const QWidget *child) const
 
bool isDesktop () const
 
bool isDialog () const
 
bool isEnabled () const
 
bool isEnabledTo (QWidget *ancestor) const
 
bool isEnabledToTLW () const
 
bool isFullScreen () const
 
bool isHidden () const
 
bool isInputMethodEnabled () const
 
bool isMaximized () const
 
bool isMinimized () const
 
bool isModal () const
 
bool isPopup () const
 
bool isShown () const
 
bool isTopLevel () const
 
bool isUpdatesEnabled () const
 
bool isVisible () const
 
bool isVisibleTo (QWidget *ancestor) const
 
bool isVisibleToTLW () const
 
bool isWindow () const
 
bool isWindowModified () const
 
QLayoutlayout () const
 
Qt::LayoutDirection layoutDirection () const
 
QLocale locale () const
 
void lower ()
 
Qt::HANDLE macCGHandle () const
 
Qt::HANDLE macQDHandle () const
 
QPoint mapFrom (QWidget *parent, const QPoint &pos) const
 
QPoint mapFromGlobal (const QPoint &pos) const
 
QPoint mapFromParent (const QPoint &pos) const
 
QPoint mapTo (QWidget *parent, const QPoint &pos) const
 
QPoint mapToGlobal (const QPoint &pos) const
 
QPoint mapToParent (const QPoint &pos) const
 
QRegion mask () const
 
int maximumHeight () const
 
QSize maximumSize () const
 
int maximumWidth () const
 
int minimumHeight () const
 
QSize minimumSize () const
 
int minimumWidth () const
 
void move (int x, int y)
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const
 
QWidgetnextInFocusChain () const
 
QRect normalGeometry () const
 
void overrideWindowFlags (QFlags< Qt::WindowType > flags)
 
bool ownCursor () const
 
bool ownFont () const
 
bool ownPalette () const
 
virtual QPaintEnginepaintEngine () const
 
const QPalettepalette () const
 
QWidgetparentWidget (bool sameWindow) const
 
QWidgetparentWidget () const
 
QPlatformWindow * platformWindow () const
 
QPlatformWindowFormat platformWindowFormat () const
 
void polish ()
 
QPoint pos () const
 
QWidgetpreviousInFocusChain () const
 
void raise ()
 
void recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)
 
QRect rect () const
 
virtual void releaseDC (HDC hdc) const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)
 
void repaint (int x, int y, int w, int h, bool b)
 
void repaint (const QRegion &rgn, bool b)
 
void repaint ()
 
void repaint (int x, int y, int w, int h)
 
void repaint (const QRegion &rgn)
 
void repaint (bool b)
 
void repaint (const QRect &rect)
 
void repaint (const QRect &r, bool b)
 
void reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)
 
void reparent (QWidget *parent, const QPoint &p, bool showIt)
 
void resize (int w, int h)
 
void resize (const QSize &)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &r)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setActiveWindow ()
 
void setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundColor (const QColor &color)
 
void setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)
 
void setBackgroundOrigin (BackgroundOrigin background)
 
void setBackgroundPixmap (const QPixmap &pixmap)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 
void setCaption (const QString &c)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContentsMargins (const QMargins &margins)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
void setEraseColor (const QColor &color)
 
void setErasePixmap (const QPixmap &pixmap)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &s)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus (Qt::FocusReason reason)
 
void setFocus ()
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *w)
 
void setFont (const QFont &)
 
void setFont (const QFont &f, bool b)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (int x, int y, int w, int h)
 
void setGeometry (const QRect &)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setIcon (const QPixmap &i)
 
void setIconText (const QString &it)
 
void setInputContext (QInputContext *context)
 
void setInputMethodEnabled (bool enabled)
 
void setInputMethodHints (QFlags< Qt::InputMethodHint > hints)
 
void setKeyCompression (bool b)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setPalette (const QPalette &p, bool b)
 
void setPaletteBackgroundColor (const QColor &color)
 
void setPaletteBackgroundPixmap (const QPixmap &pixmap)
 
void setPaletteForegroundColor (const QColor &color)
 
void setParent (QWidget *parent)
 
void setParent (QWidget *parent, QFlags< Qt::WindowType > f)
 
void setPlatformWindow (QPlatformWindow *window)
 
void setPlatformWindowFormat (const QPlatformWindowFormat &format)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setShown (bool shown)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setSizePolicy (QSizePolicy)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
QStylesetStyle (const QString &style)
 
void setStyleSheet (const QString &styleSheet)
 
void setToolTip (const QString &)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
virtual void setVisible (bool visible)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlags (QFlags< Qt::WindowType > type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowModified (bool)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (QFlags< Qt::WindowState > windowState)
 
void setWindowSurface (QWindowSurface *surface)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const
 
QSize sizeIncrement () const
 
QSizePolicy sizePolicy () const
 
void stackUnder (QWidget *w)
 
QString statusTip () const
 
QStylestyle () const
 
QString styleSheet () const
 
bool testAttribute (Qt::WidgetAttribute attribute) const
 
QString toolTip () const
 
QWidgettopLevelWidget () const
 
bool underMouse () const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetFont ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void unsetPalette ()
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update (int x, int y, int w, int h)
 
void update ()
 
void updateGeometry ()
 
bool updatesEnabled () const
 
QRect visibleRect () const
 
QRegion visibleRegion () const
 
QString whatsThis () const
 
int width () const
 
QWidgetwindow () const
 
QString windowFilePath () const
 
Qt::WindowFlags windowFlags () const
 
QIcon windowIcon () const
 
QString windowIconText () const
 
Qt::WindowModality windowModality () const
 
qreal windowOpacity () const
 
QString windowRole () const
 
Qt::WindowStates windowState () const
 
QWindowSurface * windowSurface () const
 
QString windowTitle () const
 
Qt::WindowType windowType () const
 
WId winId () const
 
int x () const
 
const QX11Infox11Info () const
 
Qt::HANDLE x11PictureHandle () const
 
int y () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 
- Public Member Functions inherited from QPaintDevice
virtual ~QPaintDevice ()
 
int colorCount () const
 
int depth () const
 
int height () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
int numColors () const
 
virtual QPaintEnginepaintEngine () const=0
 
bool paintingActive () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
int width () const
 
int widthMM () const
 
int x11Cells () const
 
Qt::HANDLE x11Colormap () const
 
bool x11DefaultColormap () const
 
bool x11DefaultVisual () const
 
int x11Depth () const
 
Display * x11Display () const
 
int x11Screen () const
 
void * x11Visual () const
 

Protected Member Functions

void hideEvent (QHideEvent *e) override
 
void keyPressEvent (QKeyEvent *e) override
 
void keyReleaseEvent (QKeyEvent *e) override
 
void mouseDoubleClickEvent (QMouseEvent *e) override
 
void mouseMoveEvent (QMouseEvent *) override
 
void mousePressEvent (QMouseEvent *) override
 
void mouseReleaseEvent (QMouseEvent *) override
 
void paintEvent (QPaintEvent *event) override
 
void resizeEvent (QResizeEvent *event) override
 
void scrollContentsBy (int dx, int dy) override
 
void showEvent (QShowEvent *e) override
 
void wheelEvent (QWheelEvent *event) override
 
- Protected Member Functions inherited from QGraphicsView
virtual void contextMenuEvent (QContextMenuEvent *event)
 
virtual void dragEnterEvent (QDragEnterEvent *event)
 
virtual void dragLeaveEvent (QDragLeaveEvent *event)
 
virtual void dragMoveEvent (QDragMoveEvent *event)
 
virtual void drawBackground (QPainter *painter, const QRectF &rect)
 
virtual void drawForeground (QPainter *painter, const QRectF &rect)
 
virtual void drawItems (QPainter *painter, int numItems, QGraphicsItem *[] items, const QStyleOptionGraphicsItem[] options)
 
virtual void dropEvent (QDropEvent *event)
 
virtual bool event (QEvent *event)
 
virtual void focusInEvent (QFocusEvent *event)
 
virtual bool focusNextPrevChild (bool next)
 
virtual void focusOutEvent (QFocusEvent *event)
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
void setupViewport (QWidget *widget)
 
virtual bool viewportEvent (QEvent *event)
 
- Protected Member Functions inherited from QAbstractScrollArea
void setupViewport (QWidget *viewport)
 
void setViewportMargins (const QMargins &margins)
 
void setViewportMargins (int left, int top, int right, int bottom)
 
- Protected Member Functions inherited from QFrame
virtual void changeEvent (QEvent *ev)
 
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void closeEvent (QCloseEvent *event)
 
void create (WId window, bool initializeWindow, bool destroyOldWindow)
 
void destroy (bool destroyWindow, bool destroySubWindows)
 
virtual void enterEvent (QEvent *event)
 
bool focusNextChild ()
 
bool focusPreviousChild ()
 
virtual void languageChange ()
 
virtual void leaveEvent (QEvent *event)
 
virtual bool macEvent (EventHandlerCallRef caller, EventRef event)
 
virtual int metric (PaintDeviceMetric m) const
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool qwsEvent (QWSEvent *event)
 
void resetInputContext ()
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
virtual bool winEvent (MSG *message, long *result)
 
virtual bool x11Event (XEvent *event)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Member Functions inherited from QPaintDevice
 QPaintDevice ()
 

Additional Inherited Members

- Static Public Member Functions inherited from QWidget
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
QWidgetMapper * wmapper ()
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Public Member Functions inherited from QPaintDevice
int x11AppCells (int screen)
 
Qt::HANDLE x11AppColormap (int screen)
 
bool x11AppDefaultColormap (int screen)
 
bool x11AppDefaultVisual (int screen)
 
int x11AppDepth (int screen)
 
Display * x11AppDisplay ()
 
int x11AppDpiX (int screen)
 
int x11AppDpiY (int screen)
 
Qt::HANDLE x11AppRootWindow (int screen)
 
int x11AppScreen ()
 
void * x11AppVisual (int screen)
 
void x11SetAppDpiX (int dpi, int screen)
 
void x11SetAppDpiY (int dpi, int screen)
 
- Public Attributes inherited from QGraphicsView
typedef CacheMode
 
typedef OptimizationFlags
 
- Public Attributes inherited from QWidget
typedef RenderFlags
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QGraphicsView
 alignment
 
 backgroundBrush
 
 cacheMode
 
 dragMode
 
 foregroundBrush
 
 interactive
 
 optimizationFlags
 
 renderHints
 
 resizeAnchor
 
 rubberBandSelectionMode
 
 sceneRect
 
 transformationAnchor
 
 viewportUpdateMode
 
- Properties inherited from QAbstractScrollArea
 horizontalScrollBarPolicy
 
 verticalScrollBarPolicy
 
- Properties inherited from QFrame
 frameRect
 
 frameShadow
 
 frameShape
 
 frameWidth
 
 lineWidth
 
 midLineWidth
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 toolTip
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Widget to display the composer items.

Manages the composer tools and the mouse/key events. Creates the composer items according to the current map tools and keeps track of the rubber band item.

Definition at line 49 of file qgscomposerview.h.

Member Enumeration Documentation

◆ ClipboardMode

Enumerator
ClipboardModeCut 
ClipboardModeCopy 

Definition at line 79 of file qgscomposerview.h.

◆ PasteMode

Enumerator
PasteModeCursor 
PasteModeCenter 
PasteModeInPlace 

Definition at line 85 of file qgscomposerview.h.

◆ Tool

Current tool.

Enumerator
Select 
AddArrow 
AddHtml 
AddMap 
AddLegend 
AddLabel 
AddScalebar 
AddPicture 
AddRectangle 
AddEllipse 
AddPolygon 
AddPolyline 
AddTriangle 
AddTable 
AddAttributeTable 
MoveItemContent 
EditNodesItem 
Pan 
Zoom 

Definition at line 56 of file qgscomposerview.h.

◆ ToolStatus

Enumerator
Inactive 
Active 
ActiveUntilMouseRelease 

Definition at line 92 of file qgscomposerview.h.

Constructor & Destructor Documentation

◆ QgsComposerView()

QgsComposerView::QgsComposerView ( QWidget parent = nullptr,
const char *  name = nullptr,
const Qt::WindowFlags f = nullptr 
)

Definition at line 54 of file qgscomposerview.cpp.

Member Function Documentation

◆ actionFinished

void QgsComposerView::actionFinished ( )
signal

Current action (e.g.

adding composer map) has been finished. The purpose of this signal is that QgsComposer may set the selection tool again

◆ composerViewHide

void QgsComposerView::composerViewHide ( QgsComposerView )
signal

Emitted before composerview is hidden.

◆ composerViewShow

void QgsComposerView::composerViewShow ( QgsComposerView )
signal

Emitted before composerview is shown.

◆ composerWindow()

QMainWindow * QgsComposerView::composerWindow ( )

Returns the composer main window.

Definition at line 2242 of file qgscomposerview.cpp.

◆ composition()

QgsComposition * QgsComposerView::composition ( )

Returns the composition or 0 in case of error.

Definition at line 2188 of file qgscomposerview.cpp.

◆ compositionSet

void QgsComposerView::compositionSet ( QgsComposition )
signal

Emitted when the composition is set for the view.

◆ copyItems()

void QgsComposerView::copyItems ( ClipboardMode  mode)

Cuts or copies the selected items.

Definition at line 1485 of file qgscomposerview.cpp.

◆ currentTool()

QgsComposerView::Tool QgsComposerView::currentTool ( ) const
inline

Definition at line 125 of file qgscomposerview.h.

◆ cursorPosChanged

void QgsComposerView::cursorPosChanged ( QPointF  )
signal

Is emitted when mouse cursor coordinates change.

◆ deleteSelectedItems()

void QgsComposerView::deleteSelectedItems ( )

Deletes selected items.

Definition at line 1576 of file qgscomposerview.cpp.

◆ groupItems()

void QgsComposerView::groupItems ( )

Add an item group containing the selected items.

Definition at line 2201 of file qgscomposerview.cpp.

◆ hideEvent()

void QgsComposerView::hideEvent ( QHideEvent e)
overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 2147 of file qgscomposerview.cpp.

◆ itemRemoved

void QgsComposerView::itemRemoved ( QgsComposerItem )
signal

Is emitted when a composer item has been removed from the scene.

◆ keyPressEvent()

void QgsComposerView::keyPressEvent ( QKeyEvent e)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 1696 of file qgscomposerview.cpp.

◆ keyReleaseEvent()

void QgsComposerView::keyReleaseEvent ( QKeyEvent e)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 1930 of file qgscomposerview.cpp.

◆ mouseDoubleClickEvent()

void QgsComposerView::mouseDoubleClickEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 1417 of file qgscomposerview.cpp.

◆ mouseMoveEvent()

void QgsComposerView::mouseMoveEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 1184 of file qgscomposerview.cpp.

◆ mousePressEvent()

void QgsComposerView::mousePressEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 163 of file qgscomposerview.cpp.

◆ mouseReleaseEvent()

void QgsComposerView::mouseReleaseEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 735 of file qgscomposerview.cpp.

◆ paintEvent()

void QgsComposerView::paintEvent ( QPaintEvent event)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 2134 of file qgscomposerview.cpp.

◆ paintingEnabled()

bool QgsComposerView::paintingEnabled ( ) const
inline

Definition at line 140 of file qgscomposerview.h.

◆ pasteItems()

void QgsComposerView::pasteItems ( PasteMode  mode)

Pastes items from clipboard.

Definition at line 1539 of file qgscomposerview.cpp.

◆ resizeEvent()

void QgsComposerView::resizeEvent ( QResizeEvent event)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 2159 of file qgscomposerview.cpp.

◆ scaleSafe()

void QgsComposerView::scaleSafe ( double  scale)

Scales the view in a safe way, by limiting the acceptable range of the scale applied.

Parameters
scalefactor to scale view by
Note
added in QGIS 2.16

Definition at line 2106 of file qgscomposerview.cpp.

◆ scrollContentsBy()

void QgsComposerView::scrollContentsBy ( int  dx,
int  dy 
)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 2166 of file qgscomposerview.cpp.

◆ selectAll()

void QgsComposerView::selectAll ( )

Selects all items.

Definition at line 1625 of file qgscomposerview.cpp.

◆ selectedItemChanged

void QgsComposerView::selectedItemChanged ( QgsComposerItem selected)
signal

Is emitted when selected item changed.

If 0, no item is selected

◆ selectInvert()

void QgsComposerView::selectInvert ( )

Inverts current selection.

Definition at line 1665 of file qgscomposerview.cpp.

◆ selectNone()

void QgsComposerView::selectNone ( )

Deselects all items.

Definition at line 1655 of file qgscomposerview.cpp.

◆ setComposition()

void QgsComposerView::setComposition ( QgsComposition c)

Sets the composition for the view.

If the composition is being set manually and not by a QgsComposer, then this must be set BEFORE adding any items to the composition.

Definition at line 2172 of file qgscomposerview.cpp.

◆ setCurrentTool()

void QgsComposerView::setCurrentTool ( QgsComposerView::Tool  t)

Definition at line 88 of file qgscomposerview.cpp.

◆ setHorizontalRuler()

void QgsComposerView::setHorizontalRuler ( QgsComposerRuler r)
inline

Definition at line 145 of file qgscomposerview.h.

◆ setPaintingEnabled()

void QgsComposerView::setPaintingEnabled ( bool  enabled)
inline

Definition at line 139 of file qgscomposerview.h.

◆ setPreviewMode()

void QgsComposerView::setPreviewMode ( QgsPreviewEffect::PreviewMode  mode)

Sets the preview mode which should be used to modify the view's appearance.

Preview modes are only used if setPreviewMode is set to true.

Parameters
modePreviewMode to be used to draw the view
Note
added in 2.3
See also
setPreviewModeEnabled

Definition at line 2124 of file qgscomposerview.cpp.

◆ setPreviewModeEnabled()

void QgsComposerView::setPreviewModeEnabled ( bool  enabled)

Sets whether a preview effect should be used to alter the view's appearance.

Parameters
enabledSet to true to enable the preview effect on the view
Note
added in 2.3
See also
setPreviewMode

Definition at line 2114 of file qgscomposerview.cpp.

◆ setVerticalRuler()

void QgsComposerView::setVerticalRuler ( QgsComposerRuler r)
inline

Definition at line 146 of file qgscomposerview.h.

◆ setZoomLevel()

void QgsComposerView::setZoomLevel ( double  zoomLevel)

Set zoom level, where a zoom level of 1.0 corresponds to 100%.

Definition at line 2090 of file qgscomposerview.cpp.

◆ showEvent()

void QgsComposerView::showEvent ( QShowEvent e)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 2153 of file qgscomposerview.cpp.

◆ ungroupItems()

void QgsComposerView::ungroupItems ( )

Ungroups the selected items.

Definition at line 2222 of file qgscomposerview.cpp.

◆ updateRulers()

void QgsComposerView::updateRulers ( )

Update rulers with current scene rect.

Definition at line 570 of file qgscomposerview.cpp.

◆ wheelEvent()

void QgsComposerView::wheelEvent ( QWheelEvent event)
overrideprotectedvirtual

Reimplemented from QGraphicsView.

Definition at line 1978 of file qgscomposerview.cpp.

◆ zoomLevelChanged

void QgsComposerView::zoomLevelChanged ( )
signal

Is emitted when the view zoom changes.


The documentation for this class was generated from the following files: