Clean and order documentation in source files. Source ready to beta 2 release
[mdictionary] / src / include / History.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 History.h
23     \brief Object with search history
24
25     \author Mateusz Półrola <mateusz.polrola@comarch.pl>
26 */
27
28 #ifndef HISTORY_H
29 #define HISTORY_H
30
31 #include <QObject>
32 #include <QVector>
33 #include <QStringList>
34
35 class History : public QObject
36 {
37     Q_OBJECT
38 public:
39     explicit History(int maxSize = 5, QObject *parent = 0);
40
41 Q_SIGNALS:
42     void historyChanged(bool prevAvailable,
43                         bool nextAvailable,
44                         bool listAvailable);
45
46 public Q_SLOTS:
47     void refreshStatus();
48
49 public:
50     void add(QString);
51     QString previous();
52     QString next();
53     QStringList list();
54
55     bool prevAvailable();
56     bool nextAvailable();
57     bool listAvailable();
58
59     void setCurrentElement(int element);
60
61     int maxSize();
62
63     void setMaxSize(int size);
64
65 private:
66     QVector<QString> _history;
67     int _maxSize;
68     int currentElement;
69     bool _prevAvailable;
70     bool _nextAvailable;
71     bool _listAvailable;
72 };
73
74 #endif // HISTORY_H