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

Solid

  • Solid
  • OpticalDrive
Public Types | Signals | Public Member Functions | Static Public Member Functions | Properties | List of all members
Solid::OpticalDrive Class Reference

#include <opticaldrive.h>

Inheritance diagram for Solid::OpticalDrive:
Inheritance graph
[legend]

Public Types

enum  MediumType {
  Cdr =0x00001, Cdrw =0x00002, Dvd =0x00004, Dvdr =0x00008,
  Dvdrw =0x00010, Dvdram =0x00020, Dvdplusr =0x00040, Dvdplusrw =0x00080,
  Dvdplusdl =0x00100, Dvdplusdlrw =0x00200, Bd =0x00400, Bdr =0x00800,
  Bdre =0x01000, HdDvd =0x02000, HdDvdr =0x04000, HdDvdrw =0x08000
}
 
- Public Types inherited from Solid::StorageDrive
enum  Bus {
  Ide, Usb, Ieee1394, Scsi,
  Sata, Platform
}
 
enum  DriveType {
  HardDisk, CdromDrive, Floppy, Tape,
  CompactFlash, MemoryStick, SmartMedia, SdMmc,
  Xd
}
 
- 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
}
 

Signals

void ejectDone (Solid::ErrorType error, QVariant errorData, const QString &udi)
 
void ejectPressed (const QString &udi)
 
void ejectRequested (const QString &udi)
 

Public Member Functions

virtual ~OpticalDrive ()
 
bool eject ()
 
int readSpeed () const
 
MediumTypes supportedMedia () const
 
int writeSpeed () const
 
QList< int > writeSpeeds () const
 
- Public Member Functions inherited from Solid::StorageDrive
virtual ~StorageDrive ()
 
Bus bus () const
 
DriveType driveType () const
 
bool isHotpluggable () const
 
bool isInUse () const
 
bool isRemovable () const
 
qulonglong size () const
 
- Public Member Functions inherited from Solid::DeviceInterface
virtual ~DeviceInterface ()
 
bool isValid () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Static Public Member Functions

static Type deviceInterfaceType ()
 
- Static Public Member Functions inherited from Solid::StorageDrive
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
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
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)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Properties

int readSpeed
 
MediumTypes supportedMedia
 
int writeSpeed
 
QList< int > writeSpeeds
 
- Properties inherited from Solid::StorageDrive
Bus bus
 
DriveType driveType
 
bool hotpluggable
 
bool inUse
 
bool removable
 
qulonglong size
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Protected Member Functions inherited from Solid::StorageDrive
 StorageDrive (StorageDrivePrivate &dd, QObject *backendObject)
 
- Protected Member Functions inherited from Solid::DeviceInterface
 DeviceInterface (DeviceInterfacePrivate &dd, QObject *backendObject)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Protected Attributes inherited from Solid::DeviceInterface
DeviceInterfacePrivate * d_ptr
 

Detailed Description

This device interface is available on CD-R*,DVD*,Blu-Ray,HD-DVD drives.

An OpticalDrive is a storage that can handle optical discs.

Definition at line 42 of file opticaldrive.h.

Member Enumeration Documentation

enum Solid::OpticalDrive::MediumType

This enum type defines the type of medium an optical drive supports.

  • Cdr : A Recordable Compact Disc (CD-R)
  • Cdrw : A ReWritable Compact Disc (CD-RW)
  • Dvd : A Digital Versatile Disc (DVD)
  • Dvdr : A Recordable Digital Versatile Disc (DVD-R)
  • Dvdrw : A ReWritable Digital Versatile Disc (DVD-RW)
  • Dvdram : A Random Access Memory Digital Versatile Disc (DVD-RAM)
  • Dvdplusr : A Recordable Digital Versatile Disc (DVD+R)
  • Dvdplusrw : A ReWritable Digital Versatile Disc (DVD+RW)
  • Dvdplusdl : A Dual Layer Digital Versatile Disc (DVD+R DL)
  • Dvdplusdlrw : A Dual Layer Digital Versatile Disc (DVD+RW DL)
  • Bd : A Blu-ray Disc (BD)
  • Bdr : A Blu-ray Disc Recordable (BD-R)
  • Bdre : A Blu-ray Disc Recordable and Eraseable (BD-RE)
  • HdDvd : A High Density Digital Versatile Disc (HD DVD)
  • HdDvdr : A High Density Digital Versatile Disc Recordable (HD DVD-R)
  • HdDvdrw : A High Density Digital Versatile Disc ReWritable (HD DVD-RW)
Enumerator
Cdr 
Cdrw 
Dvd 
Dvdr 
Dvdrw 
Dvdram 
Dvdplusr 
Dvdplusrw 
Dvdplusdl 
Dvdplusdlrw 
Bd 
Bdr 
Bdre 
HdDvd 
HdDvdr 
HdDvdrw 

Definition at line 75 of file opticaldrive.h.

Constructor & Destructor Documentation

Solid::OpticalDrive::~OpticalDrive ( )
virtual

Destroys an OpticalDrive object.

Definition at line 38 of file opticaldrive.cpp.

Member Function Documentation

static Type Solid::OpticalDrive::deviceInterfaceType ( )
inlinestatic

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

Returns
the OpticalDrive device interface type
See also
Solid::Ifaces::Enums::DeviceInterface::Type

Definition at line 111 of file opticaldrive.h.

bool Solid::OpticalDrive::eject ( )

Ejects any disc that could be contained in this drive.

If this drive is empty, but has a tray it'll be opened.

Returns
the status of the eject operation

Definition at line 67 of file opticaldrive.cpp.

void Solid::OpticalDrive::ejectDone ( Solid::ErrorType  error,
QVariant  errorData,
const QString &  udi 
)
signal

This signal is emitted when the attempted eject process on this drive is completed.

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

Parameters
errortype of error that occurred, if any
errorDatamore information about the error, if any
udithe UDI of the volume
void Solid::OpticalDrive::ejectPressed ( const QString &  udi)
signal

This signal is emitted when the eject button is pressed on the drive.

Please note that some (broken) drives doesn't report this event.

Parameters
udithe UDI of the drive
void Solid::OpticalDrive::ejectRequested ( const QString &  udi)
signal

This signal is emitted when eject on this drive is requested.

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

Parameters
udithe UDI of the volume
int Solid::OpticalDrive::readSpeed ( ) const

Retrieves the maximum read speed of this drive in kilobytes per second.

Returns
the maximum read speed
MediumTypes Solid::OpticalDrive::supportedMedia ( ) const

Retrieves the medium types this drive supports.

Returns
the flag set indicating the supported medium types
int Solid::OpticalDrive::writeSpeed ( ) const

Retrieves the maximum write speed of this drive in kilobytes per second.

Returns
the maximum write speed
QList<int> Solid::OpticalDrive::writeSpeeds ( ) const

Retrieves the list of supported write speeds of this drive in kilobytes per second.

Returns
the list of supported write speeds

Property Documentation

int Solid::OpticalDrive::readSpeed
read

Definition at line 48 of file opticaldrive.h.

Solid::OpticalDrive::MediumTypes Solid::OpticalDrive::supportedMedia
read

Definition at line 47 of file opticaldrive.h.

int Solid::OpticalDrive::writeSpeed
read

Definition at line 49 of file opticaldrive.h.

QList< int > Solid::OpticalDrive::writeSpeeds
read

Definition at line 50 of file opticaldrive.h.

The documentation for this class was generated from the following files:
  • opticaldrive.h
  • opticaldrive.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:23:26 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Solid

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

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal