Main Page | Alphabetical List | Compound List | File List | Compound Members

Digikam::AlbumInfo Class Reference

#include <albuminfo.h>

List of all members.

Public Member Functions

 AlbumInfo (AlbumManager *parent, const QString &title)
 ~AlbumInfo ()
void openDB ()
void closeDB ()
QString getTitle () const
QString getPath () const
void setComments (const QString &comments)
QString getComments () const
void setCollection (const QString &collection)
QString getCollection () const
void setDate (const QDate &date)
QDate getDate () const
AlbumInfo * nextAlbum ()
AlbumInfo * prevAlbum ()
void setItemComments (const QString &name, const QString &comments)
QString getItemComments (const QString &name)
void deleteItemComments (const QString &name)
QStringList getAllItems ()
QStringList getSelectedItems ()
QStringList getAllItemsPath ()
QStringList getSelectedItemsPath ()
void setViewItem (void *viewItem)
void * getViewItem ()

Detailed Description

AlbumInfo

Represents an album and its properties. Also provides an interface to the album database, so that you can retrieve the properties for the photoitems in this album

Definition at line 43 of file albuminfo.h.

Constructor & Destructor Documentation

Digikam::AlbumInfo::AlbumInfo (  AlbumManager *  parent,
const QString &  title
) 
 

Constructor for this album

Warning:
for internal use only

Digikam::AlbumInfo::~AlbumInfo (   ) 
 

Destructor for this album

Warning:
for internal use only

Member Function Documentation

void Digikam::AlbumInfo::openDB (   ) 
 

Open the database for this album

Note:
If you plan to retrieve/set comments from this album or change the properties of the album, make sure that you open the database first. You don't need to open the database if you are only getting the properties of the album like collection, date...

void Digikam::AlbumInfo::closeDB (   ) 
 

Close the database for this album

Note:
close the database once you have finished with this album if you have opened it.

QString Digikam::AlbumInfo::getTitle (   )  const
 

Returns:
the title of the album

QString Digikam::AlbumInfo::getPath (   )  const
 

return the path of the album

void Digikam::AlbumInfo::setComments (  const QString &  comments  ) 
 

set the comments for this album

QString Digikam::AlbumInfo::getComments (   )  const
 

Returns:
the comments for this album

void Digikam::AlbumInfo::setCollection (  const QString &  collection  ) 
 

set the collection for this album

QString Digikam::AlbumInfo::getCollection (   )  const
 

Returns:
the collection for this album

void Digikam::AlbumInfo::setDate (  const QDate &  date  ) 
 

set the date for this album

QDate Digikam::AlbumInfo::getDate (   )  const
 

Returns:
the date for this album

AlbumInfo* Digikam::AlbumInfo::nextAlbum (   ) 
 

Returns:
a pointer to the next album, or 0 if this is the last album. You can traverse through all the albums like this 
      for(AlbumInfo *album=AlbumManager::instance()->firstAlbum();
          album; album = album->nextAlbum()) {
          doSomething(album);
      }

AlbumInfo* Digikam::AlbumInfo::prevAlbum (   ) 
 

Returns:
a pointer to the previous album, or 0 if this is the first album.

void Digikam::AlbumInfo::setItemComments (  const QString &  name,
const QString &  comments
) 
 

set the comments for an item in this album

QString Digikam::AlbumInfo::getItemComments (  const QString &  name  ) 
 

Returns:
the comments for an item in this album or empty string if not found in database

void Digikam::AlbumInfo::deleteItemComments (  const QString &  name  ) 
 

delete the comments for an item in this album

QStringList Digikam::AlbumInfo::getAllItems (   ) 
 

Get a list of names of all the items in this album if this is the current album. Result is unpredictable if this is not the current album

QStringList Digikam::AlbumInfo::getSelectedItems (   ) 
 

Get a list of names of selected items in this album if this is the current album. Result is unpredictable if this is not the current album

QStringList Digikam::AlbumInfo::getAllItemsPath (   ) 
 

Get a list of paths of all the items in this album if this is the current album. Result is unpredictable if this is not the current album

QStringList Digikam::AlbumInfo::getSelectedItemsPath (   ) 
 

Get a list of paths of selected items in this album if this is the current album. Result is unpredictable if this is not the current album

void Digikam::AlbumInfo::setViewItem (  void *  viewItem  ) 
 

set the viewitem for this album.

Warning:
only for internal use

void* Digikam::AlbumInfo::getViewItem (   ) 
 

Returns:
the viewitem for this album
Warning:
only for internal use

The documentation for this class was generated from the following file:
Generated on Fri Sep 26 16:32:35 2003 for Digikam by doxygen 1.3.2