File indexing completed on 2024-05-12 04:01:51

 /*
     SPDX-FileCopyrightText: 2006-2007 Kevin Ottens <ervin@kde.org>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #ifndef SOLID_OPTICALDISC_H
 #define SOLID_OPTICALDISC_H
 
 #include <solid/solid_export.h>
 
 #include <solid/storagevolume.h>
 
 namespace Solid
 {
 class OpticalDiscPrivate;
 class Device;
 
 /**
  * @class Solid::OpticalDisc opticaldisc.h <Solid/OpticalDisc>
  *
  * This device interface is available on optical discs.
  *
  * An optical disc is a volume that can be inserted in CD-R*,DVD*,Blu-Ray,HD-DVD drives.
  */
 class SOLID_EXPORT OpticalDisc : public StorageVolume
 {
     Q_OBJECT
     Q_PROPERTY(ContentTypes availableContent READ availableContent)
     Q_PROPERTY(DiscType discType READ discType)
     Q_PROPERTY(bool appendable READ isAppendable)
     Q_PROPERTY(bool blank READ isBlank)
     Q_PROPERTY(bool rewritable READ isRewritable)
     Q_PROPERTY(qulonglong capacity READ capacity)
     Q_DECLARE_PRIVATE(OpticalDisc)
     friend class Device;
 
 public:
     /**
      * This enum type defines the type of content available in an optical disc.
      *
      * - Audio : A disc containing audio
      * - Data : A disc containing data
      * - VideoCd : A Video Compact Disc (VCD)
      * - SuperVideoCd : A Super Video Compact Disc (SVCD)
      * - VideoDvd : A Video Digital Versatile Disc (DVD-Video)
      *
      * @see ContentTypes
      */
     enum ContentType {
         NoContent = 0x00,
         Audio = 0x01,
         Data = 0x02,
         VideoCd = 0x04,
         SuperVideoCd = 0x08,
         VideoDvd = 0x10,
         VideoBluRay = 0x20,
     };
     Q_ENUM(ContentType)
 
     /**
      * Stores a combination of #ContentType values.
      */
     Q_DECLARE_FLAGS(ContentTypes, ContentType)
     Q_FLAG(ContentTypes)
 
     /**
      * This enum type defines the type of optical disc it can be.
      *
      * - UnknownDiscType : An undetermined disc type
      * - CdRom : A Compact Disc Read-Only Memory (CD-ROM)
      * - CdRecordable : A Compact Disc Recordable (CD-R)
      * - CdRewritable : A Compact Disc ReWritable (CD-RW)
      * - DvdRom : A Digital Versatile Disc Read-Only Memory (DVD-ROM)
      * - DvdRam : A Digital Versatile Disc Random Access Memory (DVD-RAM)
      * - DvdRecordable : A Digital Versatile Disc Recordable (DVD-R)
      * - DvdRewritable : A Digital Versatile Disc ReWritable (DVD-RW)
      * - DvdPlusRecordable : A Digital Versatile Disc Recordable (DVD+R)
      * - DvdPlusRewritable : A Digital Versatile Disc ReWritable (DVD+RW)
      * - DvdPlusRecordableDuallayer : A Digital Versatile Disc Recordable Dual-Layer (DVD+R DL)
      * - DvdPlusRewritableDuallayer : A Digital Versatile Disc ReWritable Dual-Layer (DVD+RW DL)
      * - BluRayRom : A Blu-ray Disc (BD)
      * - BluRayRecordable : A Blu-ray Disc Recordable (BD-R)
      * - BluRayRewritable : A Blu-ray Disc (BD-RE)
      * - HdDvdRom: A High Density Digital Versatile Disc (HD DVD)
      * - HdDvdRecordable : A High Density Digital Versatile Disc Recordable (HD DVD-R)
      * - HdDvdRewritable : A High Density Digital Versatile Disc ReWritable (HD DVD-RW)
      */
     enum DiscType {
         UnknownDiscType = -1,
         CdRom,
         CdRecordable,
         CdRewritable,
         DvdRom,
         DvdRam,
         DvdRecordable,
         DvdRewritable,
         DvdPlusRecordable,
         DvdPlusRewritable,
         DvdPlusRecordableDuallayer,
         DvdPlusRewritableDuallayer,
         BluRayRom,
         BluRayRecordable,
         BluRayRewritable,
         HdDvdRom,
         HdDvdRecordable,
         HdDvdRewritable,
     };
     Q_ENUM(DiscType)
 
 private:
     /**
      * Creates a new OpticalDisc object.
      * You generally won't need this. It's created when necessary using
      * Device::as().
      *
      * @param backendObject the device interface object provided by the backend
      * @see Solid::Device::as()
      */
     SOLID_NO_EXPORT explicit OpticalDisc(QObject *backendObject);
 
 public:
     /**
      * Destroys an OpticalDisc object.
      */
     ~OpticalDisc() override;
 
     /**
      * Get the Solid::DeviceInterface::Type of the OpticalDisc device interface.
      *
      * @return the OpticalDisc device interface type
      * @see Solid::Ifaces::Enums::DeviceInterface::Type
      */
     static Type deviceInterfaceType()
     {
         return DeviceInterface::OpticalDisc;
     }
 
     /**
      * Retrieves the content types this disc contains (audio, video,
      * data...).
      *
      * @return the flag set indicating the available contents
      * @see Solid::OpticalDisc::ContentType
      */
     ContentTypes availableContent() const;
 
     /**
      * Retrieves the disc type (cdr, cdrw...).
      *
      * @return the disc type
      */
     DiscType discType() const;
 
     /**
      * Indicates if it's possible to write additional data to the disc.
      *
      * @return true if the disc is appendable, false otherwise
      */
     bool isAppendable() const;
 
     /**
      * Indicates if the disc is blank.
      *
      * @return true if the disc is blank, false otherwise
      */
     bool isBlank() const;
 
     /**
      * Indicates if the disc is rewritable.
      *
      * A disc is rewritable if you can write on it several times.
      *
      * @return true if the disc is rewritable, false otherwise
      */
     bool isRewritable() const;
 
     /**
      * Retrieves the disc capacity (that is the maximum size of a
      * volume could have on this disc).
      *
      * @return the capacity of the disc in bytes
      */
     qulonglong capacity() const;
 };
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(OpticalDisc::ContentTypes)
 
 }
 
 #endif