Solid::Ifaces::StorageVolume

Solid::Ifaces::StorageVolume Class Referenceabstract

#include <storagevolume.h>

Inheritance diagram for Solid::Ifaces::StorageVolume:

Public Member Functions

virtual ~StorageVolume ()
 
virtual QString encryptedContainerUdi () const =0
 
virtual QString fsType () const =0
 
virtual bool isIgnored () const =0
 
virtual QString label () const =0
 
virtual qulonglong size () const =0
 
virtual Solid::StorageVolume::UsageType usage () const =0
 
virtual QString uuid () const =0
 
- Public Member Functions inherited from Solid::Ifaces::Block
virtual ~Block ()
 
virtual QString device () const =0
 
virtual int deviceMajor () const =0
 
virtual int deviceMinor () const =0
 
- Public Member Functions inherited from Solid::Ifaces::DeviceInterface
virtual ~DeviceInterface ()
 

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 23 of file ifaces/storagevolume.h.

Constructor & Destructor Documentation

Solid::Ifaces::StorageVolume::~StorageVolume ( )
virtual

Destroys a StorageVolume object.

Definition at line 9 of file ifaces/storagevolume.cpp.

Member Function Documentation

virtual QString Solid::Ifaces::StorageVolume::encryptedContainerUdi ( ) const
pure virtual

Retrieves the crypto container UDI of this volume.

Returns
the encrypted volume UDI containing the current volume if appliable, an empty string otherwise
virtual QString Solid::Ifaces::StorageVolume::fsType ( ) const
pure virtual

Retrieves the filesystem type of this volume.

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

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
virtual QString Solid::Ifaces::StorageVolume::label ( ) const
pure virtual

Retrieves this volume label.

Returns
the volume lavel if available, QString() otherwise
virtual qulonglong Solid::Ifaces::StorageVolume::size ( ) const
pure virtual

Retrieves this volume size in bytes.

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

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

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

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

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Aug 10 2020 22:53:13 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.