• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Solid

Solid::StorageAccess

Solid::StorageAccess Class Reference

#include <storageaccess.h>

Inheritance diagram for Solid::StorageAccess:

Inheritance graph
[legend]

List of all members.


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


Signals

void accessibilityChanged (bool accessible, const QString &udi)
void setupDone (Solid::ErrorType error, QVariant errorData, const QString &udi)
void teardownDone (Solid::ErrorType error, QVariant errorData, const QString &udi)

Public Member Functions

QString filePath () const
bool isAccessible () const
bool setup ()
bool teardown ()
virtual ~StorageAccess ()

Static Public Member Functions

static Type deviceInterfaceType ()

Protected Member Functions

 StorageAccess (StorageAccessPrivate &dd, QObject *backendObject)

Properties

bool accessible
QString filePath

Constructor & Destructor Documentation

Solid::StorageAccess::~StorageAccess (  )  [virtual]

Destroys a StorageAccess object.

Definition at line 48 of file storageaccess.cpp.

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

Definition at line 37 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 (  )  [inline, static]

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 72 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 53 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 65 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.

Parameters:
error type of error that occurred, if any
errorData more information about the error, if any
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 71 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.

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


Property Documentation

bool Solid::StorageAccess::accessible [read]

Definition at line 43 of file storageaccess.h.

QString Solid::StorageAccess::filePath [read]

Definition at line 44 of file storageaccess.h.


The documentation for this class was generated from the following files:
  • storageaccess.h
  • storageaccess.cpp

Solid

Skip menu "Solid"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal