coredbchangesets.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-12-01
 * Description : Core database recording changes.
 *
 * Copyright (C) 2007-2008 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_CORE_DB_CHANGESETS_H
#define DIGIKAM_CORE_DB_CHANGESETS_H
 
#include "digikam_config.h"
 
// Qt includes
 
#include <QList>
#include <QMetaType>
 
#ifdef HAVE_DBUS
#   include <QDBusArgument>
#   include "dbenginedbusutils.h"
#endif
 
// Local includes
 
#include "digikam_export.h"
#include "coredbfields.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT ImageChangeset
{
public:
 
    ImageChangeset();
    ImageChangeset(const QList<qlonglong>& ids, const DatabaseFields::Set& changes);
    ImageChangeset(qlonglong id, const DatabaseFields::Set& changes);
 
    QList<qlonglong> ids()                                      const;
    bool containsImage(qlonglong id)                            const;
    DatabaseFields::Set changes()                               const;
 
#ifdef HAVE_DBUS
 
    ImageChangeset& operator<<(const QDBusArgument& argument);
    const ImageChangeset& operator>>(QDBusArgument& argument)   const;
 
#endif // HAVE_DBUS
 
private:
 
    QList<qlonglong>    m_ids;
    DatabaseFields::Set m_changes;
};
 
// ----------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT ImageTagChangeset
{
public:
 
    enum Operation
    {
        Unknown,
        Added,
        Moved,
        Removed,
        RemovedAll,
        PropertiesChanged
    };
 
public:
 
    ImageTagChangeset();
    ImageTagChangeset(const QList<qlonglong>& ids, const QList<int>& tags, Operation operation);
    ImageTagChangeset(qlonglong id, const QList<int>& tags, Operation operation);
    ImageTagChangeset(qlonglong id, int tag, Operation operation);
 
    ImageTagChangeset& operator<<(const ImageTagChangeset& other);
 
#ifdef HAVE_DBUS
 
    ImageTagChangeset& operator<<(const QDBusArgument& argument);
    const ImageTagChangeset& operator>>(QDBusArgument& argument) const;
 
#endif // HAVE_DBUS
 
    QList<qlonglong> ids()           const;
    bool containsImage(qlonglong id) const;
    QList<int> tags()                const;
    bool containsTag(int id)         const;
    Operation operation()            const;
 
    bool tagsWereAdded() const
    {
        return (operation() == Added);
    }
 
    bool tagsWereRemoved() const
    {
        return ((operation() == Removed) || (operation() == RemovedAll));
    }
 
    bool propertiesWereChanged() const
    {
        return (operation() == PropertiesChanged);
    }
 
private:
 
    QList<qlonglong>    m_ids;
    QList<int>          m_tags;
    Operation           m_operation;
};
 
// ----------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT CollectionImageChangeset
{
public:
 
    enum Operation
    {
        Unknown,
 
        Added,
 
        Removed,
 
        RemovedAll,
 
        Deleted,
 
        RemovedDeleted,
 
        Moved,
 
        Copied
    };
 
public:
 
    CollectionImageChangeset();
    CollectionImageChangeset(const QList<qlonglong>& ids, const QList<int>& albums, Operation operation);
    CollectionImageChangeset(const QList<qlonglong>& ids, int album, Operation operation);
    CollectionImageChangeset(qlonglong id, int album, Operation operation);
 
    CollectionImageChangeset& operator<<(const CollectionImageChangeset& other);
 
#ifdef HAVE_DBUS
 
    CollectionImageChangeset& operator<<(const QDBusArgument& argument);
    const CollectionImageChangeset& operator>>(QDBusArgument& argument) const;
 
#endif // HAVE_DBUS
 
    QList<qlonglong> ids()           const;
    bool containsImage(qlonglong id) const;
    QList<int> albums()              const;
    bool containsAlbum(int id)       const;
    Operation operation()            const;
 
private:
 
    QList<qlonglong>    m_ids;
    QList<int>          m_albums;
    Operation           m_operation;
};
 
// ----------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT AlbumChangeset
{
public:
 
    enum Operation
    {
        Unknown,
        Added,
        Deleted,
        Renamed,
        PropertiesChanged
    };
 
public:
 
    AlbumChangeset();
    AlbumChangeset(int albumId, Operation operation);
 
    int albumId()                                             const;
    Operation operation()                                     const;
 
#ifdef HAVE_DBUS
 
    AlbumChangeset& operator<<(const QDBusArgument& argument);
    const AlbumChangeset& operator>>(QDBusArgument& argument) const;
 
#endif // HAVE_DBUS
 
private:
 
    int       m_id;
    Operation m_operation;
};
 
// ----------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT TagChangeset
{
public:
 
    enum Operation
    {
        Unknown,
        Added,
        Moved,
        Deleted,
        Renamed,
        Reparented,
        IconChanged,
        PropertiesChanged 
    };
 
public:
 
    TagChangeset();
    TagChangeset(int tagId, Operation operation);
 
    int tagId()                                             const;
    Operation operation()                                   const;
 
#ifdef HAVE_DBUS
 
    TagChangeset& operator<<(const QDBusArgument& argument);
    const TagChangeset& operator>>(QDBusArgument& argument) const;
 
#endif // HAVE_DBUS
 
private:
 
    int       m_id;
    Operation m_operation;
};
 
// ----------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT AlbumRootChangeset
{
public:
 
    enum Operation
    {
        Unknown,
        Added,
        Deleted,
        PropertiesChanged
    };
 
public:
 
    AlbumRootChangeset();
    AlbumRootChangeset(int albumRootId, Operation operation);
 
    int albumRootId()                                             const;
    Operation operation()                                         const;
 
#ifdef HAVE_DBUS
 
    AlbumRootChangeset& operator<<(const QDBusArgument& argument);
    const AlbumRootChangeset& operator>>(QDBusArgument& argument) const;
 
#endif // HAVE_DBUS
 
private:
 
    int       m_id;
    Operation m_operation;
};
 
// ----------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT SearchChangeset
{
public:
 
    enum Operation
    {
        Unknown,
        Added,
        Deleted,
        Changed
    };
 
public:
 
    SearchChangeset();
    SearchChangeset(int searchId, Operation operation);
 
    int searchId()                                             const;
    Operation operation()                                      const;
 
#ifdef HAVE_DBUS
 
    SearchChangeset& operator<<(const QDBusArgument& argument);
    const SearchChangeset& operator>>(QDBusArgument& argument) const;
 
#endif // HAVE_DBUS
 
private:
 
    int       m_id;
    Operation m_operation;
};
 
} // namespace Digikam
 
#ifdef HAVE_DBUS
 
// custom macro from our dbusutilities.h
DECLARE_METATYPE_FOR_DBUS(Digikam::ImageChangeset)
DECLARE_METATYPE_FOR_DBUS(Digikam::ImageTagChangeset)
DECLARE_METATYPE_FOR_DBUS(Digikam::CollectionImageChangeset)
DECLARE_METATYPE_FOR_DBUS(Digikam::AlbumChangeset)
DECLARE_METATYPE_FOR_DBUS(Digikam::TagChangeset)
DECLARE_METATYPE_FOR_DBUS(Digikam::SearchChangeset)
DECLARE_METATYPE_FOR_DBUS(Digikam::AlbumRootChangeset)
DECLARE_METATYPE_FOR_DBUS(Digikam::DatabaseFields::Set)
 
#endif // HAVE_DBUS
 
#endif // DIGIKAM_CORE_DB_CHANGESETS_H