Clean and order documentation in source files. Source ready to beta 2 release
[mdictionary] / src / mdictionary / gui / DBusAdapter.h
1 /*******************************************************************************
2
3     This file is part of mDictionary.
4
5     mDictionary is free software: you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation, either version 3 of the License, or
8     (at your option) any later version.
9
10     mDictionary is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with mDictionary.  If not, see <http://www.gnu.org/licenses/>.
17
18     Copyright 2010 Comarch S.A.
19
20 *******************************************************************************/
21
22 /*! \file DBusAdapter.h
23     \brief Implements dbus adapter which defines dbus interface for an application.
24     Other application can use this interface to call mdictionary methods.
25
26     \author Mateusz Półrola <mateusz.polrola@comarch.pl>
27 */
28
29 #ifndef DBUSADAPTER_H
30 #define DBUSADAPTER_H
31
32 #include <QDBusAbstractAdaptor>
33 #include "MainWindow.h"
34
35 /*!
36     Implements dbus adapter which defines dbus interface for an application.
37     Other application can use this interface to call mdictionary methods.
38 */
39 class DBusAdapter : public QDBusAbstractAdaptor
40 {
41     Q_OBJECT
42     Q_CLASSINFO("D-Bus Interface", "com.comarch.mdictionary")
43 public:
44     explicit DBusAdapter(MainWindow* w);
45
46 public slots:
47     //! Searches for a given word
48     void search(QString word);
49
50     //! Shows application in foreground, can be used to turn on mdictionary
51     //! by another application
52     void showApplication();
53
54 private:
55     MainWindow* mainWindow;
56
57 };
58
59 #endif // DBUSADAPTER_H