digiKam
Digikam::CollectionLocation Class Reference
+ Inheritance diagram for Digikam::CollectionLocation:

Public Types

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

Public Member Functions

QString albumRootPath () const
 
 CollectionLocation ()
 
uint hash () const
 
int id () const
 
bool isAvailable () const
 
bool isNull () const
 
QString label () const
 
Status status () const
 
Type type () const
 

Protected Attributes

int m_id
 
QString m_label
 
QString m_path
 
Status m_status
 
Type m_type
 

Member Enumeration Documentation

◆ Status

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

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

◆ CollectionLocation()

Digikam::CollectionLocation::CollectionLocation ( )

Member Function Documentation

◆ albumRootPath()

QString Digikam::CollectionLocation::albumRootPath ( ) const

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

References m_path.

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

◆ hash()

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

References qHash().

Referenced by Digikam::qHash().

◆ id()

◆ isAvailable()

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

◆ isNull()

◆ label()

QString Digikam::CollectionLocation::label ( ) const

◆ status()

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

The current status. See above for possible values.

References m_status.

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

◆ type()

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

The type of location. See above for possible values.

References m_type.

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

Member Data Documentation

◆ m_id

int Digikam::CollectionLocation::m_id
protected

Referenced by id().

◆ m_label

QString Digikam::CollectionLocation::m_label
protected

Referenced by label().

◆ m_path

QString Digikam::CollectionLocation::m_path
protected

Referenced by albumRootPath().

◆ m_status

Status Digikam::CollectionLocation::m_status
protected

Referenced by status().

◆ m_type

Type Digikam::CollectionLocation::m_type
protected

Referenced by type().


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