Solid::StorageAccess Class Reference

#include <storageaccess.h>

Inheritance diagram for Solid::StorageAccess:

Signals
void	accessibilityChanged (bool accessible, 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
virtual	~StorageAccess ()
QString	filePath () const
bool	isAccessible () const
bool	isIgnored () const
bool	setup ()
bool	teardown ()
Public Member Functions inherited from Solid::DeviceInterface
virtual	~DeviceInterface ()
bool	isValid () 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)

Protected Member Functions
	StorageAccess (StorageAccessPrivate &dd, QObject *backendObject)
Protected Member Functions inherited from Solid::DeviceInterface
	DeviceInterface (DeviceInterfacePrivate &dd, QObject *backendObject)

Properties
bool	accessible
QString	filePath
bool	ignored

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, NetworkInterface = 11,   AcAdapter = 12, Battery = 13, Button = 14, AudioInterface = 15,   DvbInterface = 16, Video = 17, SerialInterface = 18, SmartCardReader = 19,   InternetGateway = 20, NetworkShare = 21, Last = 0xffff }
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 42 of file storageaccess.h.

Constructor & Destructor Documentation

Solid::StorageAccess::~StorageAccess ( )

virtual

Destroys a StorageAccess object.

Definition at line 60 of file storageaccess.cpp.

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

protected

Definition at line 43 of file storageaccess.cpp.

Member Function Documentation

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

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 75 of file storageaccess.h.

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

bool Solid::StorageAccess::isAccessible

(

)

const

Indicates if this volume is mounted.

Returns

true if the volume is mounted

Definition at line 65 of file storageaccess.cpp.

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 89 of file storageaccess.cpp.

bool Solid::StorageAccess::setup

(

)

Mounts the volume.

Returns

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

Definition at line 77 of file storageaccess.cpp.

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

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

bool Solid::StorageAccess::teardown

(

)

Unmounts the volume.

Returns

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

Definition at line 83 of file storageaccess.cpp.

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

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

Property Documentation

bool Solid::StorageAccess::accessible

read

Definition at line 45 of file storageaccess.h.

QString Solid::StorageAccess::filePath

read

Definition at line 46 of file storageaccess.h.

bool Solid::StorageAccess::ignored

read

Definition at line 47 of file storageaccess.h.

---

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

• storageaccess.h
• storageaccess.cpp