Solid::Ifaces::StorageAccess

Solid::Ifaces::StorageAccess Class Referenceabstract

#include <storageaccess.h>

Inheritance diagram for Solid::Ifaces::StorageAccess:

Public Member Functions

virtual ~StorageAccess ()
 
virtual QString filePath () const =0
 
virtual bool isAccessible () const =0
 
virtual bool isIgnored () const =0
 
virtual bool setup ()=0
 
virtual bool teardown ()=0
 
- Public Member Functions inherited from Solid::Ifaces::DeviceInterface
virtual ~DeviceInterface ()
 

Protected Member Functions

virtual void accessibilityChanged (bool accessible, const QString &udi)=0
 
virtual void setupDone (Solid::ErrorType error, QVariant resultData, const QString &udi)=0
 
virtual void setupRequested (const QString &udi)=0
 
virtual void teardownDone (Solid::ErrorType error, QVariant resultData, const QString &udi)=0
 
virtual void teardownRequested (const QString &udi)=0
 

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/storageaccess.h.

Constructor & Destructor Documentation

Solid::Ifaces::StorageAccess::~StorageAccess ( )
virtual

Destroys a StorageVolume object.

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

Member Function Documentation

virtual void Solid::Ifaces::StorageAccess::accessibilityChanged ( bool  accessible,
const QString udi 
)
protectedpure virtual

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

Parameters
newStatetrue if the volume is mounted, false otherwise
udithe UDI of the volume
virtual QString Solid::Ifaces::StorageAccess::filePath ( ) const
pure virtual

Retrieves the absolute path of this volume mountpoint.

Returns
the absolute path to the mount point if the volume is mounted, QString() otherwise
virtual bool Solid::Ifaces::StorageAccess::isAccessible ( ) const
pure virtual

Indicates if this volume is mounted.

Returns
true if the volume is mounted
virtual bool Solid::Ifaces::StorageAccess::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 bool Solid::Ifaces::StorageAccess::setup ( )
pure virtual

Mounts the volume.

Returns
the job handling the operation
virtual void Solid::Ifaces::StorageAccess::setupDone ( Solid::ErrorType  error,
QVariant  resultData,
const QString udi 
)
protectedpure virtual

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

Parameters
newStatetrue if the volume is mounted, false otherwise
udithe UDI of the volume
virtual void Solid::Ifaces::StorageAccess::setupRequested ( const QString udi)
protectedpure virtual

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
udithe UDI of the volume
virtual bool Solid::Ifaces::StorageAccess::teardown ( )
pure virtual

Unmounts the volume.

Returns
the job handling the operation
virtual void Solid::Ifaces::StorageAccess::teardownDone ( Solid::ErrorType  error,
QVariant  resultData,
const QString udi 
)
protectedpure virtual

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

Parameters
newStatetrue if the volume is mounted, false otherwise
udithe UDI of the volume
virtual void Solid::Ifaces::StorageAccess::teardownRequested ( const QString udi)
protectedpure virtual

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
udithe UDI of the volume

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.