• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Solid

Solid::StorageVolume

Solid::StorageVolume Class Reference

This device interface is available on volume devices. More...

#include <storagevolume.h>

Inheritance diagram for Solid::StorageVolume:
Solid::DeviceInterface QObject Solid::OpticalDisc

List of all members.

Public Types

enum  UsageType {
  Other = 0, Unused = 1, FileSystem = 2, PartitionTable = 3,
  Raid = 4, Encrypted = 5
}

Public Member Functions

Device encryptedContainer () const
QString fsType () const
bool isIgnored () const
QString label () const
qulonglong size () const
UsageType usage () const
QString uuid () const
virtual ~StorageVolume ()

Static Public Member Functions

static Type deviceInterfaceType ()

Protected Member Functions

 StorageVolume (StorageVolumePrivate &dd, QObject *backendObject)

Properties

QString fsType
bool ignored
QString label
qulonglong size
UsageType usage
QString uuid

Detailed Description

This device interface is available on volume devices.

A volume is anything that can contain data (partition, optical disc, memory card). It's a particular kind of block device.

Definition at line 38 of file storagevolume.h.


Member Enumeration Documentation

enum Solid::StorageVolume::UsageType

This enum type defines the how a volume is used.

  • FileSystem : A mountable filesystem volume
  • PartitionTable : A volume containing a partition table
  • Raid : A volume member of a raid set (not mountable)
  • Other : A not mountable volume (like a swap partition)
  • Unused : An unused or free volume
Enumerator:
Other 
Unused 
FileSystem 
PartitionTable 
Raid 
Encrypted 

Definition at line 61 of file storagevolume.h.


Constructor & Destructor Documentation

Solid::StorageVolume::~StorageVolume (  )  [virtual]

Destroys a StorageVolume object.

Definition at line 37 of file storagevolume.cpp.

Solid::StorageVolume::StorageVolume ( StorageVolumePrivate &  dd,
QObject *  backendObject 
) [protected]

For internal use only.

Definition at line 32 of file storagevolume.cpp.


Member Function Documentation

static Type Solid::StorageVolume::deviceInterfaceType (  )  [inline, static]

Get the Solid::DeviceInterface::Type of the StorageVolume device interface.

Returns:
the StorageVolume device interface type
See also:
Solid::Ifaces::Enums::DeviceInterface::Type

Reimplemented in Solid::OpticalDisc.

Definition at line 88 of file storagevolume.h.

Solid::Device Solid::StorageVolume::encryptedContainer (  )  const

Retrieves the crypto container of this volume.

Returns:
the encrypted volume containing the current volume if appliable, an invalid device otherwise

Definition at line 78 of file storagevolume.cpp.

QString Solid::StorageVolume::fsType (  )  const

Retrieves the filesystem type of this volume.

FIXME: It's a platform dependent string, maybe we should switch to an enum?

Returns:
the filesystem type if applicable, QString() otherwise
bool Solid::StorageVolume::isIgnored (  )  const

Indicates if this volume should be ignored by applications.

If it should be ignored, it generally means that it should be invisible to the user. It's useful for firmware partitions or OS reinstall partitions on some systems.

Returns:
true if the volume should be ignored

Definition at line 42 of file storagevolume.cpp.

QString Solid::StorageVolume::label (  )  const

Retrieves this volume label.

Returns:
the volume label if available, QString() otherwise
qulonglong Solid::StorageVolume::size (  )  const

Retrieves this volume size in bytes.

Returns:
the size of this volume
UsageType Solid::StorageVolume::usage (  )  const

Retrieves the type of use for this volume (for example filesystem).

Returns:
the usage type
See also:
Solid::Ifaces::Enums::StorageVolume::UsageType
QString Solid::StorageVolume::uuid (  )  const

Retrieves this volume Universal Unique IDentifier (UUID).

You can generally assume that this identifier is unique with reasonable confidence. Except if the volume UUID has been forged to intentionally provoke a collision, the probability to have two volumes having the same UUID is low.

Returns:
the Universal Unique IDentifier if available, QString() otherwise

Property Documentation

QString Solid::StorageVolume::fsType [read]

Definition at line 44 of file storagevolume.h.

bool Solid::StorageVolume::ignored [read]

Definition at line 42 of file storagevolume.h.

QString Solid::StorageVolume::label [read]

Definition at line 45 of file storagevolume.h.

qulonglong Solid::StorageVolume::size [read]

Definition at line 47 of file storagevolume.h.

Solid::StorageVolume::UsageType Solid::StorageVolume::usage [read]

Definition at line 43 of file storagevolume.h.

QString Solid::StorageVolume::uuid [read]

Definition at line 46 of file storagevolume.h.


The documentation for this class was generated from the following files:
  • storagevolume.h
  • storagevolume.cpp

Solid

Skip menu "Solid"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal