← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/kde4libs/gutsy

« back to all changes in this revision

Viewing changes to solid/solid/ifaces/opticaldisc.h

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2007-02-21 11:00:12 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20070221110012-6kw8khr9knv6lmg1
Tags: 3.80.3-0ubuntu1
New upstream unstable release

Show diffs side-by-side

added added

removed removed

Lines of Context:
solid/solid/ifaces/opticaldisc.h
 
1
/*  This file is part of the KDE project
 
2
    Copyright (C) 2006 Kevin Ottens <ervin@kde.org>
 
3
 
 
4
    This library is free software; you can redistribute it and/or
 
5
    modify it under the terms of the GNU Library General Public
 
6
    License version 2 as published by the Free Software Foundation.
 
7
 
 
8
    This library is distributed in the hope that it will be useful,
 
9
    but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
11
    Library General Public License for more details.
 
12
 
 
13
    You should have received a copy of the GNU Library General Public License
 
14
    along with this library; see the file COPYING.LIB.  If not, write to
 
15
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 
16
    Boston, MA 02110-1301, USA.
 
17
 
 
18
*/
 
19
 
 
20
#ifndef SOLID_IFACES_OPTICALDISC_H
 
21
#define SOLID_IFACES_OPTICALDISC_H
 
22
 
 
23
#include <kdelibs_export.h>
 
24
 
 
25
#include <solid/ifaces/volume.h>
 
26
#include <solid/opticaldisc.h>
 
27
 
 
28
namespace Solid
 
29
{
 
30
namespace Ifaces
 
31
{
 
32
    /**
 
33
     * This capability is available on optical discs.
 
34
     *
 
35
     * An optical disc is a volume that can be inserted in a cdrom drive.
 
36
     */
 
37
    class SOLIDIFACES_EXPORT OpticalDisc : virtual public Volume
 
38
    {
 
39
    public:
 
40
        /**
 
41
         * Destroys an OpticalDisc object.
 
42
         */
 
43
        virtual ~OpticalDisc();
 
44
 
 
45
 
 
46
        /**
 
47
         * Retrieves the content types this disc contains (audio, video,
 
48
         * data...).
 
49
         *
 
50
         * @return the flag set indicating the available contents
 
51
         */
 
52
        virtual Solid::OpticalDisc::ContentTypes availableContent() const = 0;
 
53
 
 
54
        /**
 
55
         * Retrieves the disc type (cdr, cdrw...).
 
56
         *
 
57
         * @return the disc type
 
58
         */
 
59
        virtual Solid::OpticalDisc::DiscType discType() const = 0;
 
60
 
 
61
        /**
 
62
         * Indicates if it's possible to write additional data to the disc.
 
63
         *
 
64
         * @return true if the disc is appendable, false otherwise
 
65
         */
 
66
        virtual bool isAppendable() const = 0;
 
67
 
 
68
        /**
 
69
         * Indicates if the disc is blank.
 
70
         *
 
71
         * @return true if the disc is blank, false otherwise
 
72
         */
 
73
        virtual bool isBlank() const = 0;
 
74
 
 
75
        /**
 
76
         * Indicates if the disc is rewritable.
 
77
         *
 
78
         * A disc is rewritable if you can write on it several times.
 
79
         *
 
80
         * @return true if the disc is rewritable, false otherwise
 
81
         */
 
82
        virtual bool isRewritable() const = 0;
 
83
 
 
84
        /**
 
85
         * Retrieves the disc capacity (that is the maximum size of a
 
86
         * volume could have on this disc).
 
87
         *
 
88
         * @return the capacity of the disc in bytes
 
89
         */
 
90
        virtual qulonglong capacity() const = 0;
 
91
    };
 
92
}
 
93
}
 
94
 
 
95
Q_DECLARE_INTERFACE( Solid::Ifaces::OpticalDisc, "org.kde.Solid.Ifaces.OpticalDisc/0.1" )
 
96
 
 
97
#endif