choicesearchutilities.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2008-04-18
 * 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_CHOICE_SEARCH_UTILITIES_H
#define DIGIKAM_CHOICE_SEARCH_UTILITIES_H
 
// Qt includes
 
#include <QAbstractListModel>
#include <QList>
#include <QVariant>
 
// Local includes
 
#include "dexpanderbox.h"
#include "coredbsearchxml.h"
#include "comboboxutilities.h"
 
namespace Digikam
{
 
class ChoiceSearchModel : public QAbstractListModel
{
    Q_OBJECT
 
public:
 
    enum CustomRoles
    {
        IdRole = Qt::UserRole
    };
 
public:
 
    explicit ChoiceSearchModel(QObject* const parent = nullptr);
 
    void setChoice(const QMap<int, QString>& data);
 
    void setChoice(const QVariantList& data);
 
    void setChoice(const QStringList& data);
 
    QVariantList checkedKeys() const;
 
    template <typename T> QList<T> checkedKeys() const;
 
    QStringList checkedDisplayTexts() const;
 
    template <typename T> void setChecked(const T& key, bool checked = true);
 
    template <typename T> void setChecked(const QList<T>& keys, bool checked = true);
 
    template <typename T> void setChecked(const T& value, SearchXml::Relation relation);
 
    void resetChecked();
 
    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;
    Qt::ItemFlags flags(const QModelIndex& index) const override;
    bool          setData(const QModelIndex& index, const QVariant& value, int role) override;
 
Q_SIGNALS:
 
    void checkStateChanged(const QVariant& key, bool isChecked);
 
protected:
 
    void setChecked(int index, bool checked);
 
protected:
 
    class Entry
    {
    public:
 
        Entry();
        Entry(const QVariant& key, const QString& userDisplay);
 
        bool operator==(const Entry& other) const;
 
        bool operator==(const QVariant& other) const;
 
    public:
 
        QVariant m_key;
        QString  m_display;
        bool     m_checkState;
    };
 
protected:
 
    QList<Entry> m_entries;
};
 
template <typename T> void ChoiceSearchModel::setChecked(const T& key, bool checked)
{
    QVariant variantKey(key);
 
    for (int i = 0 ; i < m_entries.size() ; ++i)
    {
        if (m_entries[i].m_key == variantKey)
        {
            setChecked(i, checked);
        }
    }
}
 
template <typename T> void ChoiceSearchModel::setChecked(const T& value, SearchXml::Relation relation)
{
    for (int i = 0 ; i < m_entries.size() ; ++i)
    {
        setChecked(i, SearchXml::testRelation(m_entries.at(i).m_key.value<T>(), value, relation));
    }
}
 
template <typename T> void ChoiceSearchModel::setChecked(const QList<T>& keys, bool checked)
{
    foreach (T key, keys)
    {
        setChecked(key, checked);
    }
}
 
template <typename T> QList<T> ChoiceSearchModel::checkedKeys() const
{
    QList<T> list;
 
    for (QList<Entry>::const_iterator it = m_entries.begin() ; it != m_entries.end() ; ++it)
    {
        if ((*it).m_checkState)
        {
            list << (*it).m_key.value<T>();
        }
    }
 
    return list;
}
 
// -------------------------------------------------------------------------------------
 
class ChoiceSearchComboBox : public ListViewComboBox
{
    Q_OBJECT
 
public:
 
    explicit ChoiceSearchComboBox(QWidget* const parent = nullptr);
 
    void setSearchModel(ChoiceSearchModel* model);
 
    void setLabelText(const QString& text);
 
    ChoiceSearchModel*   model() const;
    DSqueezedClickLabel* label() const;
 
Q_SIGNALS:
 
    void checkStateChanged();
 
protected Q_SLOTS:
 
    void labelClicked();
 
protected:
 
    void installView(QAbstractItemView* view = nullptr) override;
 
protected:
 
    DSqueezedClickLabel* m_label;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_CHOICE_SEARCH_UTILITIES_H