Add documentation, code cleanups
[profile/ivi/ofono-qt.git] / lib / ofonocallbarring.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 OFONOCALLBARRING_H
25 #define OFONOCALLBARRING_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 barring API
33 /*!
34  * This class is used to access oFono call barring API.
35  * The API is documented in
36  * http://git.kernel.org/?p=network/ofono/ofono.git;a=blob_plain;f=doc/call-barring-api.txt
37  */
38 class OFONO_QT_EXPORT OfonoCallBarring : public OfonoModemInterface
39 {
40     Q_OBJECT
41
42 public:
43     OfonoCallBarring(OfonoModem::SelectionSetting modemSetting, const QString &modemPath, QObject *parent=0);
44     ~OfonoCallBarring();
45
46     /* Properties */
47     void requestVoiceIncoming();
48     void setVoiceIncoming(const QString &barrings, const QString &password);
49     void requestVoiceOutgoing();
50     void setVoiceOutgoing(const QString &barrings, const QString &password);
51
52     /* Methods */
53     void requestChangePassword(const QString &old_password, const QString &new_password);
54     void requestDisableAll(const QString &password);
55     void requestDisableAllIncoming(const QString &password);
56     void requestDisableAllOutgoing(const QString &password);
57
58 signals:
59     void incomingBarringInEffect();
60     void outgoingBarringInEffect();
61
62     void voiceIncomingComplete(bool success, const QString &barrings);
63     void voiceOutgoingComplete(bool success, const QString &barrings);
64     void voiceIncomingChanged(const QString &barrings);
65     void voiceOutgoingChanged(const QString &barrings);
66     void setVoiceIncomingFailed();
67     void setVoiceOutgoingFailed();
68
69     void changePasswordComplete(bool success);
70     void disableAllComplete(bool success);
71     void disableAllIncomingComplete(bool success);
72     void disableAllOutgoingComplete(bool success);
73
74 private slots:
75     void propertyChanged(const QString& property, const QVariant& value);
76     void setPropertyFailed(const QString& property);
77     void setPropertyResp();
78     void setPropertyErr(const QDBusError& error);
79     void changePasswordResp();
80     void changePasswordErr(QDBusError error);
81     void disableAllResp();
82     void disableAllErr(QDBusError error);
83     void disableAllIncomingResp();
84     void disableAllIncomingErr(QDBusError error);
85     void disableAllOutgoingResp();
86     void disableAllOutgoingErr(QDBusError error);
87     void requestPropertyComplete(bool success, const QString& property, const QVariant& value);
88
89 private:
90     void setProperty(const QString& name, const QVariant& property,
91                         const QString& password);
92
93    QString m_pendingProperty;
94 };
95
96 #endif  /* !OFONOCALLBARRING_H */