kratingwidget.h

Go to the documentation of this file.

/*
 * This file is part of the Nepomuk KDE project.
 * Copyright (C) 2006-2007 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 KRATINGWIDGET_H
#define KRATINGWIDGET_H

#include <QtGui/QFrame>

#include <kdeui_export.h>

class KDEUI_EXPORT KRatingWidget : public QFrame
{
    Q_OBJECT
    Q_PROPERTY( int rating READ rating WRITE setRating )
    Q_PROPERTY( int maxRating READ maxRating WRITE setMaxRating )
    Q_PROPERTY( Qt::Alignment alignment READ alignment WRITE setAlignment )
    Q_PROPERTY( bool halfStepsEnabled READ halfStepsEnabled WRITE setHalfStepsEnabled )
    Q_PROPERTY( int spacing READ spacing WRITE setSpacing )
    Q_PROPERTY( QIcon icon READ icon WRITE setIcon )

 public:
    KRatingWidget( QWidget* parent = 0 );

    ~KRatingWidget();

    unsigned int rating() const;

    int maxRating() const;

    Qt::Alignment alignment() const;

    Qt::LayoutDirection layoutDirection() const;

    int spacing() const;

    QSize sizeHint() const;

    bool halfStepsEnabled() const;

    QIcon icon() const;

 Q_SIGNALS:
    void ratingChanged( unsigned int rating );
    void ratingChanged( int rating );

 public Q_SLOTS:
    void setRating( int rating );

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setRating( unsigned int rating );
#endif

    void setMaxRating( int max );

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setMaxRating( unsigned int max );
#endif

    void setHalfStepsEnabled( bool enabled );

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setOnlyPaintFullSteps( bool );
#endif

    void setSpacing( int );

    void setAlignment( Qt::Alignment align );

    void setLayoutDirection( Qt::LayoutDirection direction );

    void setIcon( const QIcon& icon );

    void setCustomPixmap( const QPixmap& pixmap );

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setPixmap( const QPixmap& );
#endif

    void setPixmapSize( int size );

 protected:
    void mousePressEvent( QMouseEvent* e );
    void mouseMoveEvent( QMouseEvent* e );
    void leaveEvent( QEvent* e );
    void paintEvent( QPaintEvent* e );
    void resizeEvent( QResizeEvent* e );

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

#endif