ifaces/opticaldisc.h

/*
    SPDX-FileCopyrightText: 2006 Kevin Ottens <ervin@kde.org>
 
    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
 
#ifndef SOLID_IFACES_OPTICALDISC_H
#define SOLID_IFACES_OPTICALDISC_H
 
#include <solid/devices/ifaces/storagevolume.h>
#include <solid/opticaldisc.h>
 
namespace Solid
{
namespace Ifaces
{
/**
 * This device interface is available on optical discs.
 *
 * An optical disc is a volume that can be inserted in a cdrom drive.
 */
class OpticalDisc : virtual public StorageVolume
{
public:
    /**
     * Destroys an OpticalDisc object.
     */
    ~OpticalDisc() override;
 
    /**
     * Retrieves the content types this disc contains (audio, video,
     * data...).
     *
     * @return the flag set indicating the available contents
     */
    virtual Solid::OpticalDisc::ContentTypes availableContent() const = 0;
 
    /**
     * Retrieves the disc type (cdr, cdrw...).
     *
     * @return the disc type
     */
    virtual Solid::OpticalDisc::DiscType discType() const = 0;
 
    /**
     * Indicates if it's possible to write additional data to the disc.
     *
     * @return true if the disc is appendable, false otherwise
     */
    virtual bool isAppendable() const = 0;
 
    /**
     * Indicates if the disc is blank.
     *
     * @return true if the disc is blank, false otherwise
     */
    virtual bool isBlank() const = 0;
 
    /**
     * 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
     */
    virtual bool isRewritable() const = 0;
 
    /**
     * 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
     */
    virtual qulonglong capacity() const = 0;
};
}
}
 
Q_DECLARE_INTERFACE(Solid::Ifaces::OpticalDisc, "org.kde.Solid.Ifaces.OpticalDisc/0.1")
 
#endif