digiKam Developer Documentation
Professional Photo Management with the Power of Open Source
Loading...
Searching...
No Matches
Digikam::PAlbum Class Reference

A Physical Album representation.

+ Inheritance diagram for Digikam::PAlbum:

Public Member Functions

 PAlbum (const QString &parentPath, int albumRoot)
 Constructor for Trash album.
 
 PAlbum (const QString &title)
 Constructor for root album.
 
 PAlbum (int albumRoot, const QString &label)
 Constructor for album root albums.
 
 PAlbum (int albumRoot, const QString &parentPath, const QString &title, int id)
 Constructor for normal albums.
 
QString albumPath () const
 
int albumRootId () const
 
QString albumRootLabel () const
 
QString albumRootPath () const
 
QString caption () const
 
QString category () const
 
CoreDbUrl databaseUrl () const override
 
QDate date () const
 
QUrl fileUrl () const
 
QString folderPath () const
 
qlonglong iconId () const
 
bool isAlbumRoot () const
 
QString prettyUrl () const
 
void setCaption (const QString &caption)
 
void setCategory (const QString &category)
 
void setDate (const QDate &date)
 
- Public Member Functions inherited from Digikam::Album
QList< int > childAlbumIds (bool recursive=false)
 
AlbumList childAlbums (bool recursive=false)
 
AlbumchildAtRow (int row) const
 
int childCount () const
 
void * extraData (const void *const key) const
 Retrieve the associated extra data associated with key.
 
AlbumfirstChild () const
 
int globalID () const
 An album ID is only unique among the set of all Albums of its Type.
 
int id () const
 Each album has a ID uniquely identifying it in the set of Albums of a Type.
 
bool isAncestorOf (Album *const album) const
 
bool isRoot () const
 
bool isTrashAlbum () const
 
bool isUsedByLabelsTree () const
 
AlbumlastChild () const
 
Albumnext () const
 
Albumparent () const
 
void prepareForDeletion ()
 For secure deletion in an album model, call this function beforehand.
 
Albumprev () const
 
void removeExtraData (const void *const key)
 Remove the associated extra data associated with key.
 
int rowFromAlbum () const
 
void setExtraData (const void *const key, void *const value)
 This allows to associate some "extra" data to a Album.
 
void setUsedByLabelsTree (bool isUsed)
 Sets the property m_usedByLabelsTree to true if the search album was created using the Colors and labels tree view.
 
QString title () const
 
Type type () const
 

Friends

class AlbumManager
 

Additional Inherited Members

- Public Types inherited from Digikam::Album
enum  Type {
  PHYSICAL = 0 , TAG , DATE , SEARCH ,
  FACE
}
 
- Static Public Member Functions inherited from Digikam::Album
static int globalID (Type type, int id)
 Produces the global id.
 
- Protected Member Functions inherited from Digikam::Album
 Album (Album::Type type, int id, bool root)
 Constructor.
 
virtual ~Album ()
 Destructor.
 
void clear ()
 Delete all child albums and also remove any associated extra data.
 
void insertChild (Album *const child)
 
void removeChild (Album *const child)
 
void setParent (Album *const parent)
 
void setTitle (const QString &title)
 

Member Function Documentation

◆ databaseUrl()

CoreDbUrl Digikam::PAlbum::databaseUrl ( ) const
overridevirtual
Returns
the kde url of the album

Implements Digikam::Album.