Solid::StorageDrive

Search for usage in LXR

#include <Solid/StorageDrive>

Inheritance diagram for Solid::StorageDrive:

Public Types

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

Bus bus
 
DriveType driveType
 
bool hotpluggable
 
bool inUse
 
bool removable
 
qulonglong size
 
QDateTime timeDetected
 
QDateTime timeMediaDetected
 
- Properties inherited from QObject
 objectName
 

Public Member Functions

 ~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< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () const 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)
 
- 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)
 

Protected Member Functions

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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Protected Attributes inherited from Solid::DeviceInterface
DeviceInterfacePrivate * d_ptr
 

Detailed Description

This device interface is available on storage devices.

A storage is anything that can contain a set of volumes (card reader, hard disk, cdrom drive...). It's a particular kind of block device.

Member Enumeration Documentation

◆ Bus

This enum type defines the type of bus a storage device is attached to.

  • Ide : An Integrated Drive Electronics (IDE) bus, also known as ATA
  • Usb : An Universal Serial Bus (USB)
  • Ieee1394 : An Ieee1394 bus, also known as Firewire
  • Scsi : A Small Computer System Interface bus
  • Sata : A Serial Advanced Technology Attachment (SATA) bus
  • Platform : A legacy bus that is part of the underlying platform

Definition at line 53 of file frontend/storagedrive.h.

◆ DriveType

This enum type defines the type of drive a storage device can be.

  • HardDisk : A hard disk
  • CdromDrive : An optical drive
  • Floppy : A floppy disk drive
  • Tape : A tape drive
  • CompactFlash : A Compact Flash card reader
  • MemoryStick : A Memory Stick card reader
  • SmartMedia : A Smart Media card reader
  • SdMmc : A SecureDigital/MultiMediaCard card reader
  • Xd : A xD card reader

Definition at line 69 of file frontend/storagedrive.h.

Property Documentation

◆ bus

Bus Solid::StorageDrive::bus
read

Definition at line 30 of file frontend/storagedrive.h.

◆ driveType

DriveType Solid::StorageDrive::driveType
read

Definition at line 31 of file frontend/storagedrive.h.

◆ hotpluggable

bool Solid::StorageDrive::hotpluggable
read

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

◆ inUse

bool Solid::StorageDrive::inUse
read

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

◆ removable

bool Solid::StorageDrive::removable
read

Definition at line 32 of file frontend/storagedrive.h.

◆ size

qulonglong Solid::StorageDrive::size
read

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

◆ timeDetected

QDateTime Solid::StorageDrive::timeDetected
read

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

◆ timeMediaDetected

QDateTime Solid::StorageDrive::timeMediaDetected
read

Definition at line 37 of file frontend/storagedrive.h.

Constructor & Destructor Documentation

◆ ~StorageDrive()

Solid::StorageDrive::~StorageDrive ( )
override

Destroys a StorageDrive object.

Definition at line 27 of file frontend/storagedrive.cpp.

◆ StorageDrive()

Solid::StorageDrive::StorageDrive ( StorageDrivePrivate & dd,
QObject * backendObject )
protected

Definition at line 22 of file frontend/storagedrive.cpp.

Member Function Documentation

◆ bus()

Solid::StorageDrive::Bus Solid::StorageDrive::bus ( ) const

Retrieves the type of physical interface this storage device is connected to.

Returns
the bus type
See also
Solid::StorageDrive::Bus

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

◆ deviceInterfaceType()

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

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

Returns
the StorageDrive device interface type
See also
Solid::DeviceInterface::Type

Definition at line 95 of file frontend/storagedrive.h.

◆ driveType()

Solid::StorageDrive::DriveType Solid::StorageDrive::driveType ( ) const

Retrieves the type of this storage drive.

Returns
the drive type
See also
Solid::StorageDrive::DriveType

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

◆ isHotpluggable()

bool Solid::StorageDrive::isHotpluggable ( ) const

Indicates if this storage device can be plugged or unplugged while the computer is running.

Returns
true if this storage supports hotplug, false otherwise

Definition at line 49 of file frontend/storagedrive.cpp.

◆ isInUse()

bool Solid::StorageDrive::isInUse ( ) const

Indicates if the storage device is currently in use i.e.

if at least one child storage access is mounted

Returns
true if at least one child storage access is mounted

Definition at line 61 of file frontend/storagedrive.cpp.

◆ isRemovable()

bool Solid::StorageDrive::isRemovable ( ) const

Indicates if the media contained by this drive can be removed.

For example memory card can be removed from the drive by the user, while partitions can't be removed from hard disks.

Returns
true if media can be removed, false otherwise.

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

◆ size()

qulonglong Solid::StorageDrive::size ( ) const

Retrieves this drives size in bytes.

Returns
the size of this drive

Definition at line 55 of file frontend/storagedrive.cpp.

◆ timeDetected()

QDateTime Solid::StorageDrive::timeDetected ( ) const

Returns the time the drive was deteced.

Typically this means the time a drive was plugged in, or the computer rebooted

An invalid datetime may be returned if the underlying information is not available

Since
6.0

Definition at line 77 of file frontend/storagedrive.cpp.

◆ timeMediaDetected()

QDateTime Solid::StorageDrive::timeMediaDetected ( ) const

Returns the time media in the drive was deteced.

Typically this means the time a card was inserted into a reader, or the computer rebooted

An invalid datetime may be returned if the underlying information is not available

Since
6.0

Definition at line 83 of file frontend/storagedrive.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 Fri Dec 27 2024 11:46:20 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.