Documentation fixups
[profile/ivi/ofono-qt.git] / lib / ofonomodemmanager.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 OFONOMODEMMANAGER_H
25 #define OFONOMODEMMANAGER_H
26
27 #include <QtCore/QObject>
28 #include <QVariant>
29 #include <QDBusObjectPath>
30 #include <QStringList>
31 #include "libofono-qt_global.h"
32
33 //! Provides access to the list of available modems and changes in that list.
34 class OFONO_QT_EXPORT OfonoModemManager : public QObject {
35
36 Q_OBJECT
37
38 public:
39
40     OfonoModemManager(QObject *parent=0);
41
42     ~OfonoModemManager();
43
44     //! Returns a list of d-bus object paths that represent available modems
45     QStringList modems() const;
46
47 signals:
48     //! Issued when a modem has been added
49     void modemAdded(const QString &modemPath);
50     
51     //! Issued when a modem has been removed
52     void modemRemoved(const QString &modemPath);
53
54 private slots:
55     void onModemAdded(const QDBusObjectPath &path, const QVariantMap &map);
56     void onModemRemoved(const QDBusObjectPath &path);
57
58 private:
59     QStringList m_modems;
60 };
61
62 #endif