collectionlocation.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-04-09
 * Description : Collection location abstraction
 *
 * Copyright (C) 2007-2011 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_COLLECTION_LOCATION_H
#define DIGIKAM_COLLECTION_LOCATION_H
 
// Qt includes
 
#include <QString>
#include <QHash>
 
// Local includes
 
#include "digikam_export.h"
#include "coredbalbuminfo.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT CollectionLocation
{
 
public:
 
    enum Status
    {
        LocationNull,
 
        LocationAvailable,
 
        LocationHidden,
 
        LocationUnavailable,
 
        LocationDeleted
    };
 
public:
 
    enum Type
    {
        TypeVolumeHardWired = AlbumRoot::VolumeHardWired,
 
        TypeVolumeRemovable = AlbumRoot::VolumeRemovable,
 
        TypeNetwork         = AlbumRoot::Network
    };
 
public:
 
    CollectionLocation();
 
    int     id() const;
 
    Status  status() const;
 
    Type    type() const;
 
    QString albumRootPath() const;
 
    QString label() const;
 
    bool isAvailable() const
    {
        return (m_status == LocationAvailable);
    }
 
    bool isNull() const
    {
        return (m_status == LocationNull);
    }
 
    uint hash() const
    {
        return ::qHash(m_id);
    }
 
protected:
 
    int     m_id;
    QString m_path;
    Status  m_status;
    Type    m_type;
    QString m_label;
};
 
inline uint qHash(const CollectionLocation& loc)
{
    return loc.hash();
}
 
} // namespace Digikam
 
#endif // DIGIKAM_COLLECTION_LOCATION_H