itemcomments.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-09-19
 * Description : Access to comments of an item in the database
 *
 * Copyright (C) 2007-2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2009-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2008      by Patrick Spendrin <ps_ml 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_ITEM_COMMENTS_H
#define DIGIKAM_ITEM_COMMENTS_H
 
// Qt includes
 
#include <QString>
#include <QDateTime>
#include <QSharedDataPointer>
#include <QSharedData>
#include <QSet>
 
// Local includes
 
#include "digikam_export.h"
#include "coredbalbuminfo.h"
#include "captionvalues.h"
#include "coredbaccess.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT ItemComments
{
public:
 
    enum LanguageChoiceBehavior
    {
        ReturnMatchingLanguageOnly,
 
        ReturnMatchingOrDefaultLanguage,
 
        ReturnMatchingDefaultOrFirstLanguage
    };
 
    enum UniqueBehavior
    {
        UniquePerLanguage,
 
        UniquePerLanguageAndAuthor
    };
 
public:
 
    ItemComments();
 
    explicit ItemComments(qlonglong imageid);
 
    ItemComments(const CoreDbAccess& access, qlonglong imageid);
 
    ItemComments(const ItemComments& other);
    ~ItemComments();
 
    ItemComments& operator=(const ItemComments& other);
 
    bool isNull()                                                                                               const;
 
    void setUniqueBehavior(UniqueBehavior behavior);
 
    QString defaultComment(DatabaseComment::Type type = DatabaseComment::Comment)                               const;
 
    QString defaultComment(int* const index, Digikam::DatabaseComment::Type type = DatabaseComment::Comment)    const;
 
    QString commentForLanguage(const QString& languageCode, int* const index = nullptr,
                               LanguageChoiceBehavior behavior = ReturnMatchingDefaultOrFirstLanguage)          const;
 
    int numberOfComments()                                                                                      const;
 
    DatabaseComment::Type type(int index)                                                                       const;
 
    QString language(int index)                                                                                 const;
 
    QString author(int index)                                                                                   const;
    QDateTime date(int index)                                                                                   const;
    QString comment(int index)                                                                                  const;
 
    void addComment(const QString& comment,
                    const QString& language = QString(),
                    const QString& author = QString(),
                    const QDateTime& date = QDateTime(),
                    DatabaseComment::Type type = DatabaseComment::Comment);
 
    void addHeadline(const QString& headline,
                     const QString& language = QString(),
                     const QString& author = QString(),
                     const QDateTime& date = QDateTime());
 
    void addTitle(const QString& title,
                  const QString& language = QString(),
                  const QString& author = QString(),
                  const QDateTime& date = QDateTime());
 
    void replaceComments(const CaptionsMap& comments,
                         DatabaseComment::Type type = DatabaseComment::Comment);
 
    void remove(int index);
 
    void removeAll(DatabaseComment::Type type);
 
    void removeAllComments();
 
    void removeAll();
 
    void changeComment(int index, const QString& comment);
    void changeLanguage(int index, const QString& language);
    void changeAuthor(int index, const QString& author);
    void changeDate(int index, const QDateTime& date);
    void changeType(int index, DatabaseComment::Type type);
 
    void apply();
    void apply(CoreDbAccess& access);
 
    CaptionsMap toCaptionsMap(DatabaseComment::Type = DatabaseComment::Comment)                                 const;
 
    void replaceFrom(const ItemComments& source);
 
protected:
 
    void addCommentDirectly(const QString& comment,
                            const QString& language,
                            const QString& author,
                            DatabaseComment::Type type,
                            const QDateTime& date);
public:
 
    class Private;
 
protected:
 
    QSharedDataPointer<Private> d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ITEM_COMMENTS_H