qgscomposerview.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposerview.h
                             -------------------
    begin                : January 2005
    copyright            : (C) 2005 by Radim Blazek
    email                : blazek@itc.it
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSCOMPOSERVIEW_H
#define QGSCOMPOSERVIEW_H

#include <QGraphicsView>
#include "qgsaddremoveitemcommand.h"
#include "qgsprevieweffect.h" // for QgsPreviewEffect::PreviewMode

class QDomDocument;
class QDomElement;
class QKeyEvent;
class QMainWindow;
class QMouseEvent;
class QgsComposition;
class QgsComposerArrow;
class QgsComposerItem;
class QgsComposerLabel;
class QgsComposerLegend;
class QgsComposerMap;
class QgsComposerPicture;
class QgsComposerRuler;
class QgsComposerScaleBar;
class QgsComposerShape;
class QgsComposerAttributeTableV2;

class GUI_EXPORT QgsComposerView: public QGraphicsView
{
    Q_OBJECT

  public:

    enum Tool
    {
      Select = 0,      // Select/Move item
      AddArrow,        // add arrow
      AddHtml,
      AddMap,          // add new map
      AddLegend,       // add vector legend
      AddLabel,        // add label
      AddScalebar,     // add scalebar
      AddPicture,      // add raster/vector picture
      AddRectangle,
      AddEllipse,
      AddTriangle,
      AddTable,        // add attribute table
      AddAttributeTable,
      MoveItemContent, // move content of item (e.g. content of map)
      Pan,
      Zoom
    };

    enum ClipboardMode
    {
      ClipboardModeCut,
      ClipboardModeCopy
    };

    enum PasteMode
    {
      PasteModeCursor,
      PasteModeCenter,
      PasteModeInPlace
    };

    enum ToolStatus
    {
      Inactive,
      Active,
      ActiveUntilMouseRelease
    };

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

    void groupItems();

    void ungroupItems();

    void copyItems( ClipboardMode mode );

    void pasteItems( PasteMode mode );

    void deleteSelectedItems();

    void selectAll();

    void selectNone();

    void selectInvert();

    QgsComposerView::Tool currentTool() const {return mCurrentTool;}
    void setCurrentTool( QgsComposerView::Tool t );

    void setComposition( QgsComposition* c );

    QgsComposition* composition();

    QMainWindow* composerWindow();

    void setPaintingEnabled( bool enabled ) { mPaintingEnabled = enabled; }
    bool paintingEnabled() const { return mPaintingEnabled; }

    void updateRulers();

    void setHorizontalRuler( QgsComposerRuler* r ) { mHorizontalRuler = r; }
    void setVerticalRuler( QgsComposerRuler* r ) { mVerticalRuler = r; }

    void setZoomLevel( double zoomLevel );

    void scaleSafe( double scale );

    void setPreviewModeEnabled( bool enabled );
    void setPreviewMode( QgsPreviewEffect::PreviewMode mode );

  protected:
    void mousePressEvent( QMouseEvent* ) override;
    void mouseReleaseEvent( QMouseEvent* ) override;
    void mouseMoveEvent( QMouseEvent* ) override;
    void mouseDoubleClickEvent( QMouseEvent* e ) override;

    void keyPressEvent( QKeyEvent * e ) override;
    void keyReleaseEvent( QKeyEvent * e ) override;

    void wheelEvent( QWheelEvent* event ) override;

    void paintEvent( QPaintEvent* event ) override;

    void hideEvent( QHideEvent* e ) override;
    void showEvent( QShowEvent* e ) override;

    void resizeEvent( QResizeEvent* event ) override;
    void scrollContentsBy( int dx, int dy ) override;

  private:
    QgsComposerView::Tool mCurrentTool;
    QgsComposerView::Tool mPreviousTool;

    QGraphicsRectItem* mRubberBandItem;
    QGraphicsLineItem* mRubberBandLineItem;
    QgsComposerItem* mMoveContentItem;
    QPointF mMoveContentStartPos;
    QPointF mRubberBandStartPos;

    bool mMarqueeSelect;
    bool mMarqueeZoom;
    QgsComposerView::ToolStatus mTemporaryZoomStatus;

    bool mPaintingEnabled;

    QgsComposerRuler* mHorizontalRuler;
    QgsComposerRuler* mVerticalRuler;

    void addShape( Tool currentTool );

    bool mToolPanning;
    bool mMousePanning;
    bool mKeyPanning;

    bool mMovingItemContent;

    QPoint mMouseLastXY;
    QPoint mMouseCurrentXY;
    QPoint mMousePressStartPos;

    QgsPreviewEffect* mPreviewEffect;

    QCursor defaultCursorForTool( Tool currentTool );

    void wheelZoom( QWheelEvent * event );
    void updateRubberBandRect( QPointF & pos, const bool constrainSquare = false, const bool fromCenter = false );
    void updateRubberBandLine( QPointF pos, const bool constrainAngles = false );
    void removeRubberBand();

    void startMarqueeSelect( QPointF & scenePoint );
    void endMarqueeSelect( QMouseEvent* e );
    void startMarqueeZoom( QPointF & scenePoint );
    void endMarqueeZoom( QMouseEvent* e );

    //void connectAddRemoveCommandSignals( QgsAddRemoveItemCommand* c );

  signals:
    void selectedItemChanged( QgsComposerItem* selected );
    void itemRemoved( QgsComposerItem* );
    void actionFinished();
    void cursorPosChanged( QPointF );
    void zoomLevelChanged();

    void composerViewShow( QgsComposerView* );
    void composerViewHide( QgsComposerView* );

    void compositionSet( QgsComposition* );
};

#endif