digiKam
Loading...
Searching...
No Matches
Digikam::CollectionLocation Class Reference

#include <collectionlocation.h>

+ Inheritance diagram for Digikam::CollectionLocation:

Public Types

enum  CaseSensitivity { UnknownCaseSensitivity , CaseInsensitive , CaseSensitive }
 
enum  Status {
  LocationNull , LocationAvailable , LocationHidden , LocationUnavailable ,
  LocationDeleted
}
 
enum  Type { Undefined = 0 , VolumeHardWired = 1 , VolumeRemovable = 2 , Network = 3 }
 

Public Member Functions

QString albumRootPath () const
 
Qt::CaseSensitivity asQtCaseSensitivity () const
 
CaseSensitivity caseSensitivity () const
 
 CollectionLocation ()=default
 
size_t hash () const
 
int id () const
 
bool isAvailable () const
 
bool isNull () const
 
QString label () const
 
Status status () const
 
Type type () const
 

Public Attributes

QString identifier
 

Protected Attributes

CaseSensitivity m_caseSensitivity = UnknownCaseSensitivity
 
int m_id = -1
 
QString m_label
 
QString m_path
 
Status m_status = LocationNull
 
Type m_type = VolumeHardWired
 

Member Enumeration Documentation

◆ CaseSensitivity

Enumerator
UnknownCaseSensitivity 

The location has an unknown case sensitivity.

CaseInsensitive 

The location is case insensitive.

CaseSensitive 

The location is case sensitive.

◆ 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
Undefined 

The location is undefined. Keep values constant.

VolumeHardWired 

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

VolumeRemovable 

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

Network 

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

Constructor & Destructor Documentation

◆ CollectionLocation()

Digikam::CollectionLocation::CollectionLocation ( )
default

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::SetupCollectionModel::deleteCollection(), Digikam::SetupCollectionModel::slotAppendPressed(), Digikam::DatabaseVersionManager::toplevelDirectory(), and Digikam::SetupCollectionModel::updateCollection().

◆ asQtCaseSensitivity()

Qt::CaseSensitivity Digikam::CollectionLocation::asQtCaseSensitivity ( ) const

Return as Qt case sensitivity enum of location. For unknown, it is assumed to be Qt::CaseSensitive.

References CaseInsensitive, and m_caseSensitivity.

◆ caseSensitivity()

CollectionLocation::CaseSensitivity Digikam::CollectionLocation::caseSensitivity ( ) const

The case sensitivity of location. See above for possible values.

References m_caseSensitivity.

◆ hash()

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

Referenced by Digikam::qHash().

◆ id()

int Digikam::CollectionLocation::id ( ) const

◆ isAvailable()

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

◆ isNull()

◆ label()

◆ 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::data(), and Digikam::SetupCollectionModel::Item::Item().

Member Data Documentation

◆ identifier

◆ m_caseSensitivity

CaseSensitivity Digikam::CollectionLocation::m_caseSensitivity = UnknownCaseSensitivity
protected

◆ m_id

int Digikam::CollectionLocation::m_id = -1
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 = LocationNull
protected

Referenced by status().

◆ m_type

Type Digikam::CollectionLocation::m_type = VolumeHardWired
protected

Referenced by type().


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