qwt_symbol.h

Go to the documentation of this file.

/* -*- mode: C++ ; c-file-style: "stroustrup" -*- *****************************
 * Qwt Widget Library
 * Copyright (C) 1997   Josef Wilgen
 * Copyright (C) 2002   Uwe Rathmann
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the Qwt License, Version 1.0
 *****************************************************************************/

#ifndef QWT_SYMBOL_H
#define QWT_SYMBOL_H

#include "qwt_global.h"

#include <qpolygon.h>
#include <qpen.h>
#include <qbrush.h>

class QPainter;
class QSize;
class QBrush;
class QPen;
class QColor;
class QPointF;
class QPainterPath;
class QPixmap;
class QByteArray;
class QwtGraphic;

class QWT_EXPORT QwtSymbol
{
public:
    enum Style
    {
        NoSymbol = -1,

        Ellipse,

        Rect,

        Diamond,

        Triangle,

        DTriangle,

        UTriangle,

        LTriangle,

        RTriangle,

        Cross,

        XCross,

        HLine,

        VLine,

        Star1,

        Star2,

        Hexagon,

        Path,

        Pixmap,

        Graphic,

        SvgDocument,

        UserStyle = 1000
    };

    enum CachePolicy
    {
        NoCache,

        Cache,

        AutoCache
    };

public:
    explicit QwtSymbol( Style = NoSymbol );
    QwtSymbol( Style, const QBrush &, const QPen &, const QSize & );
    QwtSymbol( const QPainterPath &, const QBrush &, const QPen & );

    virtual ~QwtSymbol();

    void setCachePolicy( CachePolicy );
    CachePolicy cachePolicy() const;

    void setSize( const QSize & );
    void setSize( int width, int height = -1 );
    const QSize &size() const;

    void setPinPoint( const QPointF &pos, bool enable = true );
    QPointF pinPoint() const;

    void setPinPointEnabled( bool );
    bool isPinPointEnabled() const;

    virtual void setColor( const QColor & );

    void setBrush( const QBrush & );
    const QBrush &brush() const;

    void setPen( const QColor &, qreal width = 0.0, Qt::PenStyle = Qt::SolidLine );
    void setPen( const QPen & );
    const QPen &pen() const;

    void setStyle( Style );
    Style style() const;

    void setPath( const QPainterPath & );
    const QPainterPath &path() const;

    void setPixmap( const QPixmap & );
    const QPixmap &pixmap() const;

    void setGraphic( const QwtGraphic & );
    const QwtGraphic &graphic() const;

#ifndef QWT_NO_SVG
    void setSvgDocument( const QByteArray & );
#endif

    void drawSymbol( QPainter *, const QRectF & ) const;
    void drawSymbol( QPainter *, const QPointF & ) const;
    void drawSymbols( QPainter *, const QPolygonF & ) const;
    void drawSymbols( QPainter *,
        const QPointF *, int numPoints ) const;

    virtual QRect boundingRect() const;
    void invalidateCache();

protected:
    virtual void renderSymbols( QPainter *,
        const QPointF *, int numPoints ) const;

private:
    Q_DISABLE_COPY(QwtSymbol)

    class PrivateData;
    PrivateData *d_data;
};

inline void QwtSymbol::drawSymbol(
    QPainter *painter, const QPointF &pos ) const
{
    drawSymbols( painter, &pos, 1 );
}

inline void QwtSymbol::drawSymbols(
    QPainter *painter, const QPolygonF &points ) const
{
    drawSymbols( painter, points.data(), points.size() );
}

#endif