albumselectors.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-10-09
 * Description : A widget to select Physical or virtual albums with combo-box
 *
 * Copyright (C) 2010-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2012-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * 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_ALBUM_SELECTORS_H
#define DIGIKAM_ALBUM_SELECTORS_H
 
// Qt includes
 
#include <QWidget>
 
namespace Digikam
{
 
class Album;
typedef QList<Album*> AlbumList;
 
class AlbumSelectors : public QWidget
{
    Q_OBJECT
 
public:
 
    enum AlbumType
    {
        PhysAlbum = 0,
        TagsAlbum,
        All
    };
 
    enum SelectionType
    {
        SingleSelection = 0,
        MultipleSelection
    };
 
public:
 
    explicit AlbumSelectors(const QString& label,
                            const QString& configName,
                            QWidget* const parent = nullptr,
                            AlbumType albumType = All);
    ~AlbumSelectors()                         override;
 
    AlbumList selectedAlbums()          const;
 
    QList<int> selectedAlbumIds()       const;
 
    AlbumList selectedTags()            const;
 
    QList<int> selectedTagIds()         const;
 
    AlbumList selectedAlbumsAndTags()   const;
 
    void resetPAlbumSelection();
 
    void resetTAlbumSelection();
 
    void resetSelection();
 
    void setAlbumSelected(Album* const album, SelectionType type);
 
    void setTagSelected(Album* const album, SelectionType type);
 
    void setTypeSelection(int albumType);
 
    int typeSelection()                 const;
 
    bool wholeAlbumsChecked()           const;
 
    bool wholeTagsChecked()             const;
 
public Q_SLOTS:
 
    void loadState();
 
    void saveState();
 
Q_SIGNALS:
 
    void signalSelectionChanged();
 
private Q_SLOTS:
 
    void slotUpdateClearButtons();
    void slotWholeAlbums(bool);
    void slotWholeTags(bool);
 
private:
 
    void initAlbumWidget();
    void initTagWidget();
    void updateTabText();
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ALBUM_SELECTORS_H