Solid::StorageVolume Class Reference

#include <Solid/StorageVolume>

Inheritance diagram for Solid::StorageVolume:

Public Types
enum	UsageType {   Other = 0 , Unused = 1 , FileSystem = 2 , PartitionTable = 3 ,   Raid = 4 , Encrypted = 5 }
Public Types inherited from Solid::DeviceInterface
enum	Type {   Unknown = 0 , GenericInterface = 1 , Processor = 2 , Block = 3 ,   StorageAccess = 4 , StorageDrive = 5 , OpticalDrive = 6 , StorageVolume = 7 ,   OpticalDisc = 8 , Camera = 9 , PortableMediaPlayer = 10 , Battery = 12 ,   NetworkShare = 14 , Last = 0xffff }

Properties
QString	fsType
bool	ignored
QString	label
qulonglong	size
UsageType	usage
QString	uuid
Properties inherited from QObject
	objectName

Public Member Functions
	~StorageVolume () override
Device	encryptedContainer () const
QString	fsType () const
bool	isIgnored () const
QString	label () const
qulonglong	size () const
UsageType	usage () const
QString	uuid () const
Public Member Functions inherited from Solid::DeviceInterface
	~DeviceInterface () override
bool	isValid () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static Type	deviceInterfaceType ()
Static Public Member Functions inherited from Solid::DeviceInterface
static Type	stringToType (const QString &type)
static QString	typeDescription (Type type)
static QString	typeToString (Type type)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
SOLID_NO_EXPORT	StorageVolume (StorageVolumePrivate &dd, QObject *backendObject)
Protected Member Functions inherited from Solid::DeviceInterface
SOLID_NO_EXPORT	DeviceInterface (DeviceInterfacePrivate &dd, QObject *backendObject)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Attributes inherited from QObject
typedef	QObjectList
Protected Attributes inherited from Solid::DeviceInterface
DeviceInterfacePrivate *	d_ptr

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 27 of file frontend/storagevolume.h.

Member Enumeration Documentation

UsageType

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

Definition at line 49 of file frontend/storagevolume.h.

Property Documentation

fsType

QString Solid::StorageVolume::fsType

read

Definition at line 32 of file frontend/storagevolume.h.

ignored

bool Solid::StorageVolume::ignored

read

Definition at line 30 of file frontend/storagevolume.h.

label

QString Solid::StorageVolume::label

read

Definition at line 33 of file frontend/storagevolume.h.

size

qulonglong Solid::StorageVolume::size

read

Definition at line 35 of file frontend/storagevolume.h.

usage

UsageType Solid::StorageVolume::usage

read

Definition at line 31 of file frontend/storagevolume.h.

uuid

QString Solid::StorageVolume::uuid

read

Definition at line 34 of file frontend/storagevolume.h.

Constructor & Destructor Documentation

~StorageVolume()

Solid::StorageVolume::~StorageVolume ( )

override

Destroys a StorageVolume object.

Definition at line 24 of file frontend/storagevolume.cpp.

StorageVolume()

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

protected

Definition at line 19 of file frontend/storagevolume.cpp.

Member Function Documentation

deviceInterfaceType()

static Type Solid::StorageVolume::deviceInterfaceType ( )

inlinestatic

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

Returns

the StorageVolume device interface type

See also

Solid::DeviceInterface::Type

Definition at line 75 of file frontend/storagevolume.h.

encryptedContainer()

Solid::Device Solid::StorageVolume::encryptedContainer

(

)

const

Retrieves the crypto container of this volume.

Returns

the encrypted volume containing the current volume if applicable, an invalid device otherwise

Definition at line 64 of file frontend/storagevolume.cpp.

fsType()

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

Definition at line 40 of file frontend/storagevolume.cpp.

isIgnored()

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 28 of file frontend/storagevolume.cpp.

label()

QString Solid::StorageVolume::label

(

)

const

Retrieves this volume label.

Returns

the volume label if available, QString() otherwise

Definition at line 46 of file frontend/storagevolume.cpp.

size()

qulonglong Solid::StorageVolume::size

(

)

const

Retrieves this volume size in bytes.

Returns

the size of this volume

Definition at line 58 of file frontend/storagevolume.cpp.

usage()

Solid::StorageVolume::UsageType Solid::StorageVolume::usage

(

)

const

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

Returns

the usage type

See also

Solid::StorageVolume::UsageType

Definition at line 34 of file frontend/storagevolume.cpp.

uuid()

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

Definition at line 52 of file frontend/storagevolume.cpp.

---

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

• frontend/storagevolume.h
• frontend/storagevolume.cpp