kratingpainter.h

Go to the documentation of this file.

/*
   This file is part of the Nepomuk KDE project.
   Copyright (C) 2007-2008 Sebastian Trueg <trueg@kde.org>

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

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
 */

#ifndef _NEPOMUK_RATING_PAINTER_H_
#define _NEPOMUK_RATING_PAINTER_H_

#include <kdeui_export.h>

#include <QtCore/Qt>

class QIcon;
class QPixmap;
class QPainter;
class QPoint;
class QRect;


class KDEUI_EXPORT KRatingPainter
{
public:
    KRatingPainter();

    ~KRatingPainter();

    int maxRating() const;

    bool halfStepsEnabled() const;

    Qt::Alignment alignment() const;

    Qt::LayoutDirection layoutDirection() const;

    QIcon icon() const;

    bool isEnabled() const;

    QPixmap customPixmap() const;

    int spacing() const;

    void setMaxRating( int max );

    void setHalfStepsEnabled( bool enabled );

    void setAlignment( Qt::Alignment align );

    void setLayoutDirection( Qt::LayoutDirection direction );

    void setIcon( const QIcon& icon );

    void setEnabled( bool enabled );

    void setCustomPixmap( const QPixmap& pixmap );

    void setSpacing( int spacing );

    void paint( QPainter* painter, const QRect& rect, int rating, int hoverRating = -1 ) const;

    int ratingFromPosition( const QRect& rect, const QPoint& pos ) const;

    static void paintRating( QPainter* p, const QRect& rect, Qt::Alignment align, int rating, int hoverRating = -1 );

    static int getRatingFromPosition( const QRect& rect, Qt::Alignment align, Qt::LayoutDirection direction, const QPoint& pos );

private:
    class Private;
    Private* const d;
};

#endif