• Skip to content
• Skip to link menu

KDE 4.2 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

digikam

album.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * http://www.digikam.org
 *
 * Date        : 2004-06-15
 * Description : digiKam album types
 *
 * Copyright (C) 2004-2005 by Renchi Raju <renchi@pooh.tam.uiuc.edu>
 * Copyright (C) 2006-2008 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 ALBUM_H
#define ALBUM_H

// Qt includes.

#include <QList>
#include <QString>
#include <QDateTime>
#include <QMap>

// KDE includes.

#include <kurl.h>

// Local includes.

#include "albuminfo.h"
#include "databaseurl.h"

namespace Digikam
{

class Album
{
public:

    enum Type
    {
        PHYSICAL=0, 
        TAG,        
        DATE,       
        SEARCH      
    };

    Album*  parent() const;

    Album*  firstChild() const;

    Album*  lastChild() const;

    Album*  next() const;

    Album*  prev() const;

    Type    type() const;

    int     id() const;

    int     globalID() const;

    QString title() const;

    virtual DatabaseUrl databaseUrl() const = 0;

    bool    isRoot() const;

    bool    isAncestorOf(Album* album) const;

    void    setExtraData(const void* key, void *value);

    void    removeExtraData(const void* key);

    void*   extraData(const void* key) const;

protected:

    Album(Album::Type type, int id, bool root);

    virtual ~Album();

    void    clear();

    void setTitle(const QString& title);

    void setParent(Album* parent);

    void insertChild(Album* child);

    void removeChild(Album* child);

private:

    Album();
    Album(const Album&);
    Album& operator==(const Album&);

private:

    bool                     m_root;
    bool                     m_clearing;

    int                      m_id;

    QString                  m_title;
    QMap<const void*, void*> m_extraMap;

    Type                     m_type;

    Album*                   m_parent;
    Album*                   m_firstChild;
    Album*                   m_lastChild;
    Album*                   m_next;
    Album*                   m_prev;

    friend class AlbumManager;
};

class PAlbum : public Album
{
public:

    PAlbum(const QString& title);
    PAlbum(int albumRoot, const QString &label);
    PAlbum(int albumRoot, const QString &parentPath, const QString& title, int id);
    ~PAlbum();

    void setCaption(const QString& caption);
    void setCollection(const QString& collection);
    void setDate(const QDate& date);

    QString     albumRootPath() const;
    int         albumRootId() const;
    QString     caption() const;
    QString     collection() const;
    QDate       date() const;
    QString     albumPath() const;
    QString     prettyUrl() const;
    QString     folderPath() const;
    DatabaseUrl databaseUrl() const;
    KUrl        fileUrl() const;
    QString     icon() const;
    KUrl        iconKURL() const;

    bool        isAlbumRoot() const;

private:

    int        m_albumRootId;

    QString    m_path;
    QString    m_parentPath;
    QString    m_collection;
    QString    m_caption;
    QString    m_icon;

    bool       m_isAlbumRootAlbum;

    QDate      m_date;

    friend class AlbumManager;
};

class TAlbum : public Album
{
public:

    TAlbum(const QString& title, int id, bool root=false);
    ~TAlbum();

    QString     tagPath(bool leadingSlash = true) const;
    DatabaseUrl databaseUrl() const;
    QString     prettyUrl() const;
    QString     icon() const;
    QList<int>  tagIDs() const;

private:

    int     m_pid;

    QString m_icon;

    friend class AlbumManager;
};

class DAlbum : public Album
{
public:

    enum Range
    {
        Month = 0,
        Year
    };

    DAlbum(const QDate& date, bool root=false, Range range=Month);
    ~DAlbum();

    QDate date() const;
    Range range() const;
    DatabaseUrl databaseUrl() const;

private:

    static int  m_uniqueID;

    QDate       m_date;

    Range       m_range;

    friend class AlbumManager;
};

class SAlbum : public Album
{
public:

    SAlbum(const QString &title, int id, bool root=false);
    ~SAlbum();

    DatabaseUrl          databaseUrl() const;
    QString              query() const;
    DatabaseSearch::Type type() const;
    bool                 isNormalSearch() const;
    bool                 isAdvancedSearch() const;
    bool                 isKeywordSearch() const;
    bool                 isTimelineSearch() const;
    bool                 isHaarSearch() const;
    bool                 isMapSearch() const;
    bool                 isDuplicatesSearch() const;

private:

    void setSearch(DatabaseSearch::Type type, const QString &query);

private:

    QString              m_query;
    DatabaseSearch::Type m_type;

    friend class AlbumManager;
};

class AlbumIterator
{
public:

    AlbumIterator(Album *album);
    ~AlbumIterator();

    AlbumIterator& operator++();
    Album*         operator*();
    Album*         current() const;

private:

    AlbumIterator() {}
    AlbumIterator(const AlbumIterator&) {}
    AlbumIterator& operator=(const AlbumIterator&){ return *this; }

private:

    Album* m_current;
    Album* m_root;
};

}  // namespace Digikam

#endif /* ALBUM_H */

digikam

Skip menu "digikam"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members

API Reference

Skip menu "API Reference"

• digikam

Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal