FrameGraphicsItem.h

Go to the documentation of this file.

//
// This file is part of the Marble Virtual Globe.
//
// This program is free software licensed under the GNU LGPL. You can
// find a copy of this license in LICENSE.txt in the top directory of
// the source code.
//
// Copyright 2009      Bastian Holst <bastianholst@gmx.de>
//

#ifndef MARBLE_FRAMEGRAPHICSITEM_H
#define MARBLE_FRAMEGRAPHICSITEM_H

// Marble
#include "marble_export.h"
#include "ScreenGraphicsItem.h"
#include <QPainterPath>
class QBrush;

namespace Marble
{

class FrameGraphicsItemPrivate;

class MARBLE_EXPORT FrameGraphicsItem : public ScreenGraphicsItem
{
 public:
    enum FrameType {
        NoFrame,
        RectFrame,
        RoundedRectFrame,
        ShadowFrame
    };

    explicit FrameGraphicsItem( MarbleGraphicsItem *parent = 0 );

    virtual ~FrameGraphicsItem();

    FrameType frame() const;

    void setFrame( FrameType type );

    qreal margin() const;

    void setMargin( qreal margin );

    qreal marginTop() const;

    void setMarginTop( qreal marginTop );

    qreal marginBottom() const;

    void setMarginBottom( qreal marginBottom );

    qreal marginLeft() const;

    void setMarginLeft( qreal marginLeft );

    qreal marginRight() const;

    void setMarginRight( qreal marginRight );

    qreal borderWidth() const;

    void setBorderWidth( qreal width );

    qreal padding() const;

    void setPadding( qreal width );

    QBrush borderBrush() const;

    void setBorderBrush( const QBrush &brush );

    Qt::PenStyle borderStyle () const;

    void setBorderStyle( Qt::PenStyle style );

    QBrush background() const;

    void setBackground( const QBrush &background );

    QRectF paintedRect() const;

    QRectF contentRect() const;
    QSizeF contentSize() const;

    void setContentSize( const QSizeF& size );

 protected:
    virtual QPainterPath backgroundShape() const;

    virtual void paint( QPainter *painter );

    virtual void paintContent( QPainter *painter );

    virtual void paintBackground( QPainter *painter );

 private:
    Q_DISABLE_COPY( FrameGraphicsItem )

    FrameGraphicsItemPrivate * const d;
};

} // namespace Marble

#endif