Updated the README file with some contributor tips.
[basket4.git] / src / filter.h
blob5d4e93402cb7bbeebb61c80fd18bc49dcd9e2f46
1 /***************************************************************************
2 * Copyright (C) 2003 by Sébastien Laoût *
3 * slaout@linux62.org *
4 * *
5 * This program 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 2 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * This program 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 this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
21 #ifndef FILTER_H
22 #define FILTER_H
24 #include <qwidget.h>
25 #include <qmap.h>
27 #include "focusedwidgets.h"
29 class QToolButton;
31 class Tag;
32 class State;
34 /** The structure that contain all filter terms
35 * @author Sébastien Laoût
37 class FilterData
39 public:
40 // Useful Enum for tagFilterType:
41 enum TagFilterType { DontCareTagsFilter = 0, NotTaggedFilter, TaggedFilter, TagFilter, StateFilter };
42 // Constructor and Destructor:
43 FilterData() { isFiltering = false; tagFilterType = DontCareTagsFilter; tag = 0; state = 0; }
44 ~FilterData() {}
45 // Filter data:
46 QString string;
47 int tagFilterType;
48 Tag *tag;
49 State *state;
50 bool isFiltering;
53 /** A QWidget that allow user to enter terms to filter in a Basket.
54 * @author Sébastien Laoût
56 class FilterBar : public QWidget
58 Q_OBJECT
59 public:
60 FilterBar(QWidget *parent = 0, const char *name = 0);
61 ~FilterBar();
62 const FilterData& filterData();
63 signals:
64 void newFilter(const FilterData &data);
65 void escapePressed();
66 void returnPressed();
67 public slots:
68 void repopulateTagsComnbo();
69 void reset();
70 void inAllBaskets();
71 void setEditFocus();
72 void filterTag(Tag *tag);
73 void filterState(State *state);
74 void setFilterAll(bool filterAll);
75 void setFilterData(const FilterData &data);
76 public:
77 bool hasEditFocus();
78 KLineEdit* lineEdit() { return m_lineEdit; }
79 private slots:
80 void textChanged(const QString &text);
81 void tagChanged(int index);
82 private:
83 FilterData *m_data;
84 FocusedLineEdit *m_lineEdit;
85 QToolButton *m_resetButton;
86 FocusedComboBox *m_tagsBox;
87 QToolButton *m_inAllBasketsButton;
89 QMap<int, Tag*> m_tagsMap;
90 QMap<int, State*> m_statesMap;
93 #endif // FILTER_H