ratingsearchutilities.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2008-03-14
 * Description : User interface for searches
 *
 * Copyright (C) 2008-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_RATING_SEARCH_UTILITIES_H
#define DIGIKAM_RATING_SEARCH_UTILITIES_H
 
// Qt includes
 
#include <QAbstractListModel>
#include <QItemDelegate>
#include <QLabel>
#include <QComboBox>
 
// Local includes
 
#include "ratingwidget.h"
#include "comboboxutilities.h"
 
class QTreeView;
class QVBoxLayout;
 
namespace Digikam
{
 
class RatingComboBoxModel;
class RatingComboBoxWidget;
 
class RatingComboBox : public ModelIndexBasedComboBox
{
    Q_OBJECT
 
public:
 
    enum RatingValue
    {
        Null     = -2,
        NoRating = -1,
        Rating0  = 0,
        Rating1  = 1,
        Rating2  = 2,
        Rating3  = 3,
        Rating4  = 4,
        Rating5  = 5
    };
 
public:
 
    explicit RatingComboBox(QWidget* const parent = nullptr);
 
    void setRatingValue(RatingValue value);
    RatingValue ratingValue() const;
 
Q_SIGNALS:
 
    void ratingValueChanged(int value);
 
protected Q_SLOTS:
 
    void currentValueChanged(const QModelIndex& current, const QModelIndex& previous);
    void ratingWidgetChanged(int);
 
protected:
 
    RatingComboBoxModel*  m_model;
    RatingComboBoxWidget* m_ratingWidget;
 
private:
 
    bool                  m_syncing;
};
 
// -- Internal classes ----------------------------------------------------------------
 
class RatingStarDrawer
{
public:
 
    RatingStarDrawer();
 
    QRect drawStarPolygons(QPainter* p, int numberOfStars) const;
 
protected:
 
    QPolygon m_starPolygon;
    QSize    m_starPolygonSize;
};
 
// -------------------------------------------------------------------------
 
class RatingComboBoxWidget : public RatingWidget,
                             public RatingStarDrawer
{
    Q_OBJECT
 
public:
 
    explicit RatingComboBoxWidget(QWidget* const parent = nullptr);
 
    RatingComboBox::RatingValue ratingValue() const;
    void setRatingValue(RatingComboBox::RatingValue value);
 
Q_SIGNALS:
 
    void ratingValueChanged(int value);
 
protected Q_SLOTS:
 
    void slotRatingChanged(int);
 
protected:
 
    void paintEvent(QPaintEvent*) override;
 
protected:
 
    RatingComboBox::RatingValue m_value;
};
 
// -------------------------------------------------------------------------
 
class RatingComboBoxModel : public QAbstractListModel
{
    Q_OBJECT
 
public:
 
    enum CustomRoles
    {
        RatingRole = Qt::UserRole
    };
 
public:
 
    explicit RatingComboBoxModel(QObject* const parent = nullptr);
 
    QModelIndex indexForRatingValue(RatingComboBox::RatingValue value)                    const;
 
    int rowCount(const QModelIndex& parent)                                               const override;
    QVariant data(const QModelIndex& index, int role)                                     const override;
    QModelIndex index(int row, int column = 0, const QModelIndex& parent = QModelIndex()) const override;
 
protected:
 
    QVariant ratingValueToDisplay(RatingComboBox::RatingValue value)                      const;
 
protected:
 
    QList<RatingComboBox::RatingValue> m_entries;
};
 
// -------------------------------------------------------------------------
 
class RatingComboBoxDelegate : public QItemDelegate,
                               public RatingStarDrawer
{
    Q_OBJECT
 
public:
 
    explicit RatingComboBoxDelegate(QObject* const parent = nullptr);
 
    QSize sizeHint(const QStyleOptionViewItem& option, const QModelIndex& index)                const override;
    void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index) const override;
 
protected:
 
    void drawRating(QPainter* painter, const QRect& rect, int rating, bool selectable)          const;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_RATING_SEARCH_UTILITIES_H