digikam

Digikam::CollectionLocation

Digikam::CollectionLocation Class Reference

#include <collectionlocation.h>

Inherited by Digikam::AlbumRootLocation.

Detailed Description

Definition at line 40 of file collectionlocation.h.


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

enum Digikam::CollectionLocation::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.

Definition at line 45 of file collectionlocation.h.

enum Digikam::CollectionLocation::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.

Definition at line 63 of file collectionlocation.h.

Constructor & Destructor Documentation

Digikam::CollectionLocation::CollectionLocation ( )

Definition at line 31 of file collectionlocation.cpp.

Member Function Documentation

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.

Definition at line 51 of file collectionlocation.cpp.

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

Definition at line 94 of file collectionlocation.h.

int Digikam::CollectionLocation::id ( ) const

The id uniquely identifying this collection.

Definition at line 36 of file collectionlocation.cpp.

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

Definition at line 91 of file collectionlocation.h.

bool Digikam::CollectionLocation::isNull ( ) const [inline]

Definition at line 92 of file collectionlocation.h.

QString Digikam::CollectionLocation::label ( ) const

A user-visible, optional label.

Definition at line 56 of file collectionlocation.cpp.

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

The current status.

See above for possible values.

Definition at line 41 of file collectionlocation.cpp.

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

The type of location.

See above for possible values.

Definition at line 46 of file collectionlocation.cpp.

Member Data Documentation

int Digikam::CollectionLocation::m_id [protected]

Definition at line 99 of file collectionlocation.h.

QString Digikam::CollectionLocation::m_label [protected]

Definition at line 103 of file collectionlocation.h.

QString Digikam::CollectionLocation::m_path [protected]

Definition at line 100 of file collectionlocation.h.

Status Digikam::CollectionLocation::m_status [protected]

Definition at line 101 of file collectionlocation.h.

Type Digikam::CollectionLocation::m_type [protected]

Definition at line 102 of file collectionlocation.h.

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

digikam

Digikam::CollectionLocation Class Reference

Detailed Description

Public Types

Public Member Functions

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

digikam

API Reference