Add sorting of dictionary list
[mdictionary] / src / mdictionary / gui / DictManagerWidget.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 DictManagerWidget.h
23 //! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
24
25 #ifndef DICTMANAGERWIDGET_H
26 #define DICTMANAGERWIDGET_H
27
28 #include <QWidget>
29 #include <QtGui>
30 #include "../../include/GUIInterface.h"
31 #include "MenuWidget.h"
32
33
34 //! Implements dictionaries management widget
35 /*!
36   Shows list of loaded dictionaries and their states (active/inactive).
37   It allows to change dicts states, add new dict, remove selected one or
38   change settings of selected dict. All changes are saved automatically after
39   hiding of this widget.
40 */
41 class DictManagerWidget : public QDialog {
42     Q_OBJECT
43 public:
44     //! Constructor
45     /*!
46       \param parent parent of this widget, which must be subclass of
47       GUIInterface, because it will use it to get info about loaded plugins
48       and dicts.
49     */
50     explicit DictManagerWidget(GUIInterface *parent = 0);
51
52 protected:
53     void showEvent(QShowEvent *e);
54     void hideEvent(QHideEvent *e);
55
56 Q_SIGNALS:
57     //! Emitted when hiding widget, it will save states of dictionaries
58     /*!
59         \param list of only active dictionaries
60     */
61     void selectedDictionaries(QList<CommonDictInterface*>);
62
63     //! Emitted when user wants to add new dictionary
64     /*!
65         \param new dictionary returned by specific plugin dialog
66     */
67     void addDictionary(CommonDictInterface*);
68
69     //! Emitted when user wants to remove dictionary
70     /*!
71         \param dictionary which will be removed
72     */
73     void removeDictionary(CommonDictInterface*);
74
75
76 public Q_SLOTS:
77
78     #ifndef Q_WS_MAEMO_5
79         void save();
80     #endif
81
82 private Q_SLOTS:
83     /*! Shows "plugin select" dialog and then plugin specific "add new dictionary
84         dialog", which will return new CommonDictInterface* object, which is
85         later passed as parameter of addDictionary signal*/
86     void addNewDictButtonClicked();
87
88     /*! Passes dictionary selected from list as parameter of removeDictionary
89         signal */
90     void removeButtonClicked();
91
92     //! user select one of items
93     void itemSelected(QListWidgetItem*);
94
95     //! Shows plugin's settings dialog
96     void settingsButtonClicked();
97
98     //! Each change of state (that needs to be saved) should call this to
99     //! indicate state change
100     void changed();
101
102     //! saves changes
103     void saveChanges();
104
105 private:
106     void initalizeUI();
107     QPushButton* addNewDictButton;
108     QPushButton* removeDictButton;
109     QPushButton* settingsButton;
110
111     QVBoxLayout* verticalLayout;
112     QHBoxLayout* buttonGroup;
113     QListWidget* dictList;
114
115     //holds association between items on list and CommonDictInterface objects
116     QHash<QListWidgetItem*, CommonDictInterface*> dictsHash;
117     GUIInterface* guiInterface;
118
119     bool _changed;
120
121     void refreshDictsList();
122
123     #ifndef Q_WS_MAEMO_5
124         QPushButton* closeButton;
125         bool _save;
126     #endif
127 };
128
129 #endif // DICTMANAGERWIDGET_H