Solid::OpticalDrive

Search for usage in LXR

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

#include <Solid/OpticalDrive>

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

Public Types

enum  MediumType {
  UnknownMediumType = 0x00000 , 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
}
 
typedef QFlags< MediumType > MediumTypes
 
- 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 , Battery = 12 ,
  NetworkShare = 14 , Last = 0xffff
}
 
- Public Types inherited from QObject
typedef  QObjectList
 

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
 
QDateTime timeDetected
 
QDateTime timeMediaDetected
 
- Properties inherited from QObject
 objectName
 

Signals

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

Public Member Functions

 ~OpticalDrive () override
 
bool eject ()
 
int readSpeed () const
 
MediumTypes supportedMedia () const
 
int writeSpeed () const
 
QList< int > writeSpeeds () const
 
- Public Member Functions inherited from Solid::StorageDrive
 ~StorageDrive () override
 
Bus bus () const
 
DriveType driveType () const
 
bool isHotpluggable () const
 
bool isInUse () const
 
bool isRemovable () const
 
qulonglong size () const
 
QDateTime timeDetected () const
 
QDateTime timeMediaDetected () const
 
- 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::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
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)
 

Additional Inherited Members

- Protected Member Functions inherited from Solid::StorageDrive
SOLID_NO_EXPORT StorageDrive (StorageDrivePrivate &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)
 
- 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.

Member Typedef Documentation

◆ MediumTypes

QFlags< MediumType > Solid::OpticalDrive::MediumTypes

Stores a combination of MediumType values.

Definition at line 87 of file frontend/opticaldrive.h.

Member Enumeration Documentation

◆ MediumType

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)
See also
MediumTypes

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

Property Documentation

◆ readSpeed

int Solid::OpticalDrive::readSpeed
read

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

◆ supportedMedia

MediumTypes Solid::OpticalDrive::supportedMedia
read

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

◆ writeSpeed

int Solid::OpticalDrive::writeSpeed
read

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

◆ writeSpeeds

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

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

Constructor & Destructor Documentation

◆ ~OpticalDrive()

Solid::OpticalDrive::~OpticalDrive ( )
override

Destroys an OpticalDrive object.

Definition at line 21 of file frontend/opticaldrive.cpp.

Member Function Documentation

◆ deviceInterfaceType()

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 113 of file frontend/opticaldrive.h.

◆ eject()

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 49 of file frontend/opticaldrive.cpp.

◆ ejectDone

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

◆ ejectPressed

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

◆ ejectRequested

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

◆ readSpeed()

int Solid::OpticalDrive::readSpeed ( ) const

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

Returns
the maximum read speed

Definition at line 31 of file frontend/opticaldrive.cpp.

◆ supportedMedia()

Solid::OpticalDrive::MediumTypes Solid::OpticalDrive::supportedMedia ( ) const

Retrieves the medium types this drive supports.

Returns
the flag set indicating the supported medium types

Definition at line 25 of file frontend/opticaldrive.cpp.

◆ writeSpeed()

int Solid::OpticalDrive::writeSpeed ( ) const

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

Returns
the maximum write speed

Definition at line 37 of file frontend/opticaldrive.cpp.

◆ writeSpeeds()

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

Definition at line 43 of file frontend/opticaldrive.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:14:22 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.