/** An annotation item can be either placed either on screen coordinates or on map coordinates.
  It may reference a feature and displays that association with a balloon like appearance*/

%ModuleCode
#include "qgsformannotationitem.h"
#include "qgshtmlannotationitem.h"
#include "qgssvgannotationitem.h"
#include "qgstextannotationitem.h"
%End

class QgsAnnotationItem: QgsMapCanvasItem, QgsAnnotation
{
%TypeHeaderCode
#include <qgsannotationitem.h>
%End

%ConvertToSubClassCode
  if (dynamic_cast<QgsFormAnnotationItem*>(sipCpp) )
    sipType = sipType_QgsFormAnnotationItem;
  else if (dynamic_cast<QgsHtmlAnnotationItem*>(sipCpp) )
    sipType = sipType_QgsHtmlAnnotationItem;
  else if (dynamic_cast<QgsSvgAnnotationItem*>(sipCpp) )
    sipType = sipType_QgsSvgAnnotationItem;
  else if (dynamic_cast<QgsTextAnnotationItem*>(sipCpp) )
    sipType = sipType_QgsTextAnnotationItem;
  else
    sipType = 0;
%End


  public:
    enum MouseMoveAction
    {
      NoAction,
      MoveMapPosition,
      MoveFramePosition,
      ResizeFrameUp,
      ResizeFrameDown,
      ResizeFrameLeft,
      ResizeFrameRight,
      ResizeFrameLeftUp,
      ResizeFrameRightUp,
      ResizeFrameLeftDown,
      ResizeFrameRightDown
    };

    QgsAnnotationItem( QgsMapCanvas* mapCanvas );
    virtual ~QgsAnnotationItem();

    void updatePosition();

    QRectF boundingRect() const;

    virtual QSizeF minimumFrameSize() const;

    /** Returns the mouse move behaviour for a given position
      @param pos the position in scene coordinates*/
    QgsAnnotationItem::MouseMoveAction moveActionForPosition( QPointF pos ) const;
    /** Returns suitable cursor shape for mouse move action*/
    Qt::CursorShape cursorShapeForAction( MouseMoveAction moveAction ) const;

    //setters and getters
    void setMapPositionFixed( bool fixed );
    bool mapPositionFixed() const;

    virtual void setMapPosition( const QgsPoint& pos );
    QgsPoint mapPosition() const;

    virtual QPointF relativePosition() const;

    virtual double scaleFactor() const;

    virtual bool showItem() const;

    /** Sets the CRS of the map position.
      @param crs the CRS to set */
    virtual void setMapPositionCrs( const QgsCoordinateReferenceSystem& crs );
    /** Returns the CRS of the map position.*/
    QgsCoordinateReferenceSystem mapPositionCrs() const;

    void setFrameSize( QSizeF size );
    QSizeF frameSize() const;

    void setOffsetFromReferencePoint( QPointF offset );
    QPointF offsetFromReferencePoint() const;

    /** Set symbol that is drawn on map position. Takes ownership*/
    void setMarkerSymbol( QgsMarkerSymbolV2* symbol /Transfer/ );
    const QgsMarkerSymbolV2* markerSymbol() const;

    void setFrameBorderWidth( double w );
    double frameBorderWidth() const;

    void setFrameColor( const QColor& c );
    QColor frameColor() const;

    void setFrameBackgroundColor( const QColor& c );
    QColor frameBackgroundColor() const;

    virtual void writeXml( QDomDocument& doc ) const = 0;
    virtual void readXml( const QDomDocument& doc, const QDomElement& itemElem ) = 0;

    void _writeXml( QDomDocument& doc, QDomElement& itemElem ) const;
    void _readXml( const QDomDocument& doc, const QDomElement& annotationElem );

    virtual void setItemData( int role, const QVariant& value );
    virtual void paint( QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget = nullptr );
    void paint( QPainter* painter );

  protected:
    void updateBoundingRect();
    /** Check where to attach the balloon connection between frame and map point*/
    void updateBalloon();

    //! Draws the annotation frame to a destination painter
    void drawFrame( QPainter* p ) const;

    //! Draws the map position marker symbol to a destination painter
    void drawMarkerSymbol( QPainter* p ) const;

    //! Draws selection handles around the item
    void drawSelectionBoxes( QPainter* p ) const;

    /** Returns frame width in painter units*/
    //double scaledFrameWidth( QPainter* p) const;
    /** Gets the frame line (0 is the top line, 1 right, 2 bottom, 3 left)*/
    QLineF segment( int index ) const;
    /** Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point*/
    QPointF pointOnLineWithDistance( QPointF startPoint, QPointF directionPoint, double distance ) const;
    /** Returns the symbol size scaled in (mapcanvas) pixels. Used for the counding rect calculation*/
    double scaledSymbolSize() const;
};