digiKam
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
Digikam::AlbumRootLocation Class Reference
+ Inheritance diagram for Digikam::AlbumRootLocation:

Public Types

enum  Status {
  LocationNull , LocationAvailable , LocationHidden , LocationUnavailable ,
  LocationDeleted
}
 
enum  Type { TypeVolumeHardWired = AlbumRoot::VolumeHardWired , TypeVolumeRemovable = AlbumRoot::VolumeRemovable , TypeNetwork = AlbumRoot::Network }
 

Public Member Functions

 AlbumRootLocation ()
 
 AlbumRootLocation (const AlbumRootInfo &info)
 
QString albumRootPath () const
 
uint hash () const
 
int id () const
 
bool isAvailable () const
 
bool isNull () const
 
QString label () const
 
void setAbsolutePath (const QString &path)
 
void setId (int id)
 
void setLabel (const QString &label)
 
void setStatus (CollectionLocation::Status s)
 
void setStatusFromFlags ()
 
void setType (Type type)
 
Status status () const
 
Type type () const
 

Public Attributes

bool available
 
bool hidden
 
QString identifier
 
QString specificPath
 

Protected Attributes

int m_id
 
QString m_label
 
QString m_path
 
Status m_status
 
Type m_type
 

Member Enumeration Documentation

◆ Status

enum Digikam::CollectionLocation::Status
inherited
Enumerator
LocationNull 

An invalid status. A location has this status if it is not valid, and it had this status before its creation (for oldStatus information)

LocationAvailable 

The location if available. This is the most common status.

LocationHidden 

The location is explicitly hidden. This gives no information if the location was available were it not hidden.

LocationUnavailable 

The location is currently not available. (Harddisk unplugged, CD not in drive, network fs not mounted etc.) It may become available any time.

LocationDeleted 

An invalid status. A location object acquires this status if it has been deleted. The object then does no longer point to an existing location.

◆ Type

enum Digikam::CollectionLocation::Type
inherited
Enumerator
TypeVolumeHardWired 

The location is located on a storage device that is built-in without frequent removal: Hard-disk inside the machine

TypeVolumeRemovable 

The location is located on a storage device that can be removed from the local machine, and is expected to be removed. USB stick, USB hard-disk, CD, DVD

TypeNetwork 

The location is available via a network file system. The availability depends on the network connection.

Constructor & Destructor Documentation

◆ AlbumRootLocation() [1/2]

Digikam::AlbumRootLocation::AlbumRootLocation ( )
inline

◆ AlbumRootLocation() [2/2]

Digikam::AlbumRootLocation::AlbumRootLocation ( const AlbumRootInfo &  info)
inlineexplicit

References Digikam::AlbumRootInfo::id, Digikam::AlbumRootInfo::identifier, Digikam::AlbumRootInfo::label, Digikam::AlbumRootInfo::specificPath, Digikam::AlbumRootInfo::status, and Digikam::AlbumRootInfo::type.

Member Function Documentation

◆ albumRootPath()

QString Digikam::CollectionLocation::albumRootPath ( ) const
inherited

The current file system path leading to this album root. Only guaranteed to be valid for location with status Available.

References Digikam::CollectionLocation::m_path.

Referenced by Digikam::SetupCollectionModel::data(), Digikam::DatabaseVersionManager::toplevelDirectory(), and Digikam::SetupCollectionModel::updateCollection().

◆ hash()

uint Digikam::CollectionLocation::hash ( ) const
inlineinherited

References qHash().

Referenced by Digikam::qHash().

◆ id()

int Digikam::CollectionLocation::id ( ) const
inherited

The id uniquely identifying this collection

References Digikam::CollectionLocation::m_id.

Referenced by Digikam::CollectionManager::changeType(), Digikam::CollectionManager::Private::checkIfExists(), Digikam::CollectionManager::migrateToVolume(), Digikam::CollectionManager::removeLocation(), and Digikam::CollectionManager::setLabel().

◆ isAvailable()

bool Digikam::CollectionLocation::isAvailable ( ) const
inlineinherited

Referenced by Digikam::ItemInfo::isLocationAvailable(), Digikam::ImportUI::slotDownload(), and Digikam::ItemInfo::thumbnailInfo().

◆ isNull()

bool Digikam::CollectionLocation::isNull ( ) const
inlineinherited

Referenced by Digikam::ToolTipFiller::albumTipContents(), Digikam::SetupCollectionModel::apply(), Digikam::SetupCollectionModel::askForNewCollectionPath(), Digikam::SetupCollectionModel::data(), Digikam::ImportUI::slotDownload(), Digikam::DatabaseVersionManager::toplevelDirectory(), and Digikam::SetupCollectionModel::updateCollection().

◆ label()

QString Digikam::CollectionLocation::label ( ) const
inherited

A user-visible, optional label.

References Digikam::CollectionLocation::m_label.

Referenced by Digikam::ToolTipFiller::albumTipContents(), Digikam::SetupCollectionModel::apply(), Digikam::SetupCollectionModel::data(), and Digikam::AlbumManager::setDatabase().

◆ setAbsolutePath()

void Digikam::AlbumRootLocation::setAbsolutePath ( const QString &  path)
inline

◆ setId()

void Digikam::AlbumRootLocation::setId ( int  id)
inline

◆ setLabel()

void Digikam::AlbumRootLocation::setLabel ( const QString &  label)
inline

Referenced by Digikam::CollectionManager::refreshLocation(), and Digikam::CollectionManager::setLabel().

◆ setStatus()

void Digikam::AlbumRootLocation::setStatus ( CollectionLocation::Status  s)
inline

References Digikam::CollectionLocation::LocationAvailable, and Digikam::CollectionLocation::LocationHidden.

◆ setStatusFromFlags()

void Digikam::AlbumRootLocation::setStatusFromFlags ( )
inline

References Digikam::CollectionLocation::LocationAvailable, Digikam::CollectionLocation::LocationHidden, and Digikam::CollectionLocation::LocationUnavailable.

◆ setType()

void Digikam::AlbumRootLocation::setType ( Type  type)
inline

Referenced by Digikam::CollectionManager::changeType(), and Digikam::CollectionManager::refreshLocation().

◆ status()

CollectionLocation::Status Digikam::CollectionLocation::status ( ) const
inherited

The current status. See above for possible values.

References Digikam::CollectionLocation::m_status.

Referenced by Digikam::SetupCollectionModel::data().

◆ type()

CollectionLocation::Type Digikam::CollectionLocation::type ( ) const
inherited

The type of location. See above for possible values.

References Digikam::CollectionLocation::m_type.

Referenced by Digikam::SetupCollectionModel::Item::Item().

Member Data Documentation

◆ available

bool Digikam::AlbumRootLocation::available

◆ hidden

bool Digikam::AlbumRootLocation::hidden

◆ identifier

QString Digikam::AlbumRootLocation::identifier

Referenced by Digikam::CollectionManager::checkLocation(), Digikam::CollectionManager::Private::findVolumeForLocation(), Digikam::CollectionManager::migrateToVolume(), Digikam::CollectionManager::refreshLocation(), and Digikam::CollectionManager::Private::technicalDescription().

◆ m_id

int Digikam::CollectionLocation::m_id
protectedinherited

Referenced by Digikam::CollectionLocation::id().

◆ m_label

QString Digikam::CollectionLocation::m_label
protectedinherited

Referenced by Digikam::CollectionLocation::label().

◆ m_path

QString Digikam::CollectionLocation::m_path
protectedinherited

Referenced by Digikam::CollectionLocation::albumRootPath().

◆ m_status

Status Digikam::CollectionLocation::m_status
protectedinherited

Referenced by Digikam::CollectionLocation::status().

◆ m_type

Type Digikam::CollectionLocation::m_type
protectedinherited

Referenced by Digikam::CollectionLocation::type().

◆ specificPath

QString Digikam::AlbumRootLocation::specificPath

Referenced by Digikam::CollectionManager::migrationCandidates(), Digikam::CollectionManager::refreshLocation(), and Digikam::CollectionManager::Private::technicalDescription().

The documentation for this class was generated from the following file: