Solid::StorageAccess

#include <Solid/StorageAccess>

Inheritance diagram for Solid::StorageAccess:

[legend]

Properties
bool	accessible

bool	encrypted

QString	filePath

bool	ignored

Properties inherited from QObject
	objectName

Signals
void	accessibilityChanged (bool accessible, const QString &udi)

void	checkDone (Solid::ErrorType error, QVariant errorData, const QString &udi)

void	checkRequested (const QString &udi)

void	repairDone (Solid::ErrorType error, QVariant errorData, const QString &udi)

void	repairRequested (const QString &udi)

void	setupDone (Solid::ErrorType error, QVariant errorData, const QString &udi)

void	setupRequested (const QString &udi)

void	teardownDone (Solid::ErrorType error, QVariant errorData, const QString &udi)

void	teardownRequested (const QString &udi)

Public Member Functions
	~StorageAccess () override

bool	canCheck () const

bool	canRepair () const

bool	check ()

QString	filePath () const

bool	isAccessible () const

bool	isEncrypted () const

bool	isIgnored () const

bool	repair ()

bool	setup ()

bool	teardown ()

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	StorageAccess (StorageAccessPrivate &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 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 }

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 to access them (i.e.

mount or unmount them).

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

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

Property Documentation

◆ accessible

bool Solid::StorageAccess::accessible

read

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

◆ encrypted

bool Solid::StorageAccess::encrypted

read

Definition at line 36 of file frontend/storageaccess.h.

◆ filePath

QString Solid::StorageAccess::filePath

read

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

◆ ignored

bool Solid::StorageAccess::ignored

read

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

Constructor & Destructor Documentation

◆ ~StorageAccess()

Solid::StorageAccess::~StorageAccess ( )

override

Destroys a StorageAccess object.

Definition at line 51 of file frontend/storageaccess.cpp.

◆ StorageAccess()

Solid::StorageAccess::StorageAccess	(	StorageAccessPrivate &	dd,
		QObject *	backendObject )

protected

Definition at line 29 of file frontend/storageaccess.cpp.

Member Function Documentation

◆ accessibilityChanged

void Solid::StorageAccess::accessibilityChanged	(	bool	accessible,
		const QString &	udi )

signal

This signal is emitted when the accessiblity of this device has changed.

Parameters

accessible	true if the volume is accessible, false otherwise
udi	the UDI of the volume

◆ canCheck()

bool Solid::StorageAccess::canCheck ( ) const

Indicates if this volume can check for filesystem errors.

Returns: true if the volume is can be checked

Definition at line 91 of file frontend/storageaccess.cpp.

◆ canRepair()

bool Solid::StorageAccess::canRepair ( ) const

Indicates if the filesystem of this volume supports repair attempts.

It does not indicate if such an attempt will succeed.

Returns: true if the volume is can be repaired

Definition at line 103 of file frontend/storageaccess.cpp.

◆ check()

bool Solid::StorageAccess::check ( )

Checks the filesystem for consistency avoiding any modifications or repairs.

Mounted or unsupported filesystems will result in an error.

Returns: Whether the filesystem is undamaged.

Definition at line 97 of file frontend/storageaccess.cpp.

◆ checkDone

void Solid::StorageAccess::checkDone	(	Solid::ErrorType	error,
		QVariant	errorData,
		const QString &	udi )

signal

This signal is emitted when the attempted check of this device is completed.

The signal might be spontaneous i.e. it can be triggered by another process.

Parameters

error	type of error that occurred, if any
errorData	more information about the error, if any
udi	the UDI of the volume

Since: 6.11

◆ checkRequested

void Solid::StorageAccess::checkRequested ( const QString & udi )

signal

This signal is emitted when a check of this device is requested.

The signal might be spontaneous i.e. it can be triggered by another process.

Parameters

udi	the UDI of the volume

Since: 6.11

◆ deviceInterfaceType()

static Type Solid::StorageAccess::deviceInterfaceType ( )

inlinestatic

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

Returns: the StorageVolume device interface type

See also: Solid::Ifaces::Enums::DeviceInterface::Type

Definition at line 63 of file frontend/storageaccess.h.

◆ filePath()

QString Solid::StorageAccess::filePath ( ) const

Retrieves the absolute path of this volume mountpoint.

Returns: the absolute path to the mount point if the volume is mounted, QString() otherwise

Definition at line 61 of file frontend/storageaccess.cpp.

◆ isAccessible()

bool Solid::StorageAccess::isAccessible ( ) const

Indicates if this volume is mounted.

Returns: true if the volume is mounted

Definition at line 55 of file frontend/storageaccess.cpp.

◆ isEncrypted()

bool Solid::StorageAccess::isEncrypted ( ) const

Checks if source of the storage is encrypted.

Returns: true if storage is encrypted one

Since: 5.80

Definition at line 85 of file frontend/storageaccess.cpp.

◆ isIgnored()

bool Solid::StorageAccess::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 79 of file frontend/storageaccess.cpp.

◆ repair()

bool Solid::StorageAccess::repair ( )

Tries to repair the filesystem.

Mounted or unsupported filesystems will result in an error.

Returns: Whether the filesystem could be successfully repaired

Definition at line 109 of file frontend/storageaccess.cpp.

◆ repairDone

void Solid::StorageAccess::repairDone	(	Solid::ErrorType	error,
		QVariant	errorData,
		const QString &	udi )

signal

This signal is emitted when the attempted repaired of this device is completed.

The signal might be spontaneous i.e. it can be triggered by another process.

Parameters

error	type of error that occurred, if any
errorData	more information about the error, if any
udi	the UDI of the volume

◆ repairRequested

void Solid::StorageAccess::repairRequested ( const QString & udi )

signal

This signal is emitted when a repair of this device is requested.

The signal might be spontaneous i.e. it can be triggered by another process.

Parameters

udi	the UDI of the volume

◆ setup()

bool Solid::StorageAccess::setup ( )

Mounts the volume.

Returns: false if the operation is not supported, true if the operation is attempted

Definition at line 67 of file frontend/storageaccess.cpp.

◆ setupDone

void Solid::StorageAccess::setupDone	(	Solid::ErrorType	error,
		QVariant	errorData,
		const QString &	udi )

signal

This signal is emitted when the attempted setting up of this device is completed.

The signal might be spontaneous i.e. it can be triggered by another process.

Parameters

error	type of error that occurred, if any
errorData	more information about the error, if any
udi	the UDI of the volume

◆ setupRequested

void Solid::StorageAccess::setupRequested ( const QString & udi )

signal

This signal is emitted when a setup of this device is requested.

The signal might be spontaneous i.e. it can be triggered by another process.

Parameters

udi	the UDI of the volume

◆ teardown()

bool Solid::StorageAccess::teardown ( )

Unmounts the volume.

Returns: false if the operation is not supported, true if the operation is attempted

Definition at line 73 of file frontend/storageaccess.cpp.

◆ teardownDone

void Solid::StorageAccess::teardownDone	(	Solid::ErrorType	error,
		QVariant	errorData,
		const QString &	udi )

signal

This signal is emitted when the attempted tearing down of this device is completed.

The signal might be spontaneous i.e. it can be triggered by another process.

Parameters

error	type of error that occurred, if any
errorData	more information about the error, if any
udi	the UDI of the volume

◆ teardownRequested

void Solid::StorageAccess::teardownRequested ( const QString & udi )

signal

This signal is emitted when a teardown of this device is requested.

The signal might be spontaneous i.e. it can be triggered by another process

Parameters

udi	the UDI of the volume

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Solid

Solid::StorageAccess

Properties

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ accessible

◆ encrypted

◆ filePath

◆ ignored

Constructor & Destructor Documentation

◆ ~StorageAccess()

◆ StorageAccess()

Member Function Documentation

◆ accessibilityChanged

◆ canCheck()

◆ canRepair()

◆ check()

◆ checkDone

◆ checkRequested

◆ deviceInterfaceType()

◆ filePath()

◆ isAccessible()

◆ isEncrypted()

◆ isIgnored()

◆ repair()

◆ repairDone

◆ repairRequested

◆ setup()

◆ setupDone

◆ setupRequested

◆ teardown()

◆ teardownDone

◆ teardownRequested