Add documentation, code cleanups
[profile/ivi/ofono-qt.git] / lib / ofonocallmeter.h
1 /*
2  * This file is part of ofono-qt
3  *
4  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
5  *
6  * Contact: Alexander Kanavin <alexander.kanavin@nokia.com>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public License
10  * version 2.1 as published by the Free Software Foundation.
11  *
12  * This library is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA
21  *
22  */
23
24 #ifndef OFONOCALLMETER_H
25 #define OFONOCALLMETER_H
26
27 #include <QtCore/QObject>
28 #include <QtDBus/QtDBus>
29 #include "ofonomodeminterface.h"
30 #include "libofono-qt_global.h"
31
32 //! This class is used to access oFono call meter API
33 /*!
34  * This class is used to access oFono call meter API.
35  * The API is documented in
36  * http://git.kernel.org/?p=network/ofono/ofono.git;a=blob_plain;f=doc/call-meter-api.txt
37  */
38 class OFONO_QT_EXPORT OfonoCallMeter : public OfonoModemInterface
39 {
40     Q_OBJECT
41
42 public:
43     OfonoCallMeter(OfonoModem::SelectionSetting modemSetting, const QString &modemPath, QObject *parent=0);
44     ~OfonoCallMeter();
45
46     /* Properties */
47     void requestCallMeter();
48     
49 signals:
50     void callMeterComplete(bool success, uint value);
51
52     void callMeterChanged(uint value);
53
54 private slots:
55     void propertyChanged(const QString& property, const QVariant& value);
56     void requestPropertyComplete(bool success, const QString& property, const QVariant& value);
57 };
58
59 #endif  /* !OFONOCALLMETER_H */