galleryconfig.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2006-04-04
 * Description : a tool to generate HTML image galleries
 *
 * 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_GALLERY_CONFIG_H
#define DIGIKAM_GALLERY_CONFIG_H
 
// Qt includes
 
#include <QUrl>
#include <QString>
 
// KDE includes
 
#include <kconfigskeleton.h>
 
namespace DigikamGenericHtmlGalleryPlugin
{
 
class GalleryConfig : public KConfigSkeleton
{
    Q_OBJECT
 
public:
 
    class EnumFullFormat
    {
    public:
 
        enum type
        {
            JPEG,
            PNG,
            COUNT
        };
    };
 
    class EnumThumbnailFormat
    {
    public:
 
        enum type
        {
            JPEG,
            PNG,
            COUNT
        };
    };
 
    // Web Browser to use
    enum EnumWebBrowser
    {
        NOBROWSER = 0,
        INTERNAL,
        DESKTOP,
        COUNT
    };
 
public:
 
    explicit GalleryConfig(QObject* const parent = nullptr);
    ~GalleryConfig() override;
 
    void setTheme(const QString&);
    QString theme() const;
 
    void setUseOriginalImageAsFullImage(bool);
    bool useOriginalImageAsFullImage() const;
 
    void setFullResize(bool);
    bool fullResize() const;
 
    void setFullSize(int);
    int fullSize() const;
 
    void setFullFormat(int);
    int fullFormat() const;
 
    void setFullQuality(int);
    int fullQuality() const;
 
    void setCopyOriginalImage(bool);
    bool copyOriginalImage() const;
 
    void setThumbnailSize(int);
    int thumbnailSize() const;
 
    void setThumbnailFormat(int);
    int thumbnailFormat() const;
 
    void setThumbnailQuality(int);
    int thumbnailQuality() const;
 
    void setThumbnailSquare(bool);
    bool thumbnailSquare() const;
 
    void setDestUrl(const QUrl&);
    QUrl destUrl() const;
 
    void setOpenInBrowser(int);
    int openInBrowser() const;
 
    void setImageSelectionTitle(const QString&);
    QString imageSelectionTitle() const;
 
protected:
 
    QString    m_theme;
    bool       m_useOriginalImageAsFullImage;
    bool       m_fullResize;
    int        m_fullSize;
    int        m_fullFormat;
    int        m_fullQuality;
    bool       m_copyOriginalImage;
    int        m_thumbnailSize;
    int        m_thumbnailFormat;
    int        m_thumbnailQuality;
    bool       m_thumbnailSquare;
    QUrl       m_destUrl;
    int        m_openInBrowser;
    QString    m_imageSelectionTitle; // Gallery title to use for GalleryInfo::ImageGetOption::IMAGES selection.
};
 
} // namespace DigikamGenericHtmlGalleryPlugin
 
#endif // DIGIKAM_GALLERY_CONFIG_H