1 /*******************************************************************************
3 This file is part of mDictionary.
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.
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.
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/>.
18 Copyright 2010 Comarch S.A.
20 *******************************************************************************/
21 //! \file WordListwidget.h
22 //! \brief Implements word list widget
23 //! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
25 #ifndef WORDLISTWIDGET_H
26 #define WORDLISTWIDGET_H
30 #include <QStringListModel>
31 #include "../backbone/backbone.h"
32 #include "SearchBarWidget.h"
34 //! Displays list of words found in dictionaries
36 It allows user to select word to see its translation or to mark or unmark
37 it as "star" (add/remove from bookmarks). It inherits from QTreeView
38 to allow to display two columns, one with words and second with stars.
39 Star is normal checkable item. To get effect of star we need to set
40 style (WordListProxyStyle) for this widget.
42 class WordListWidget : public QTreeView {
45 explicit WordListWidget(QWidget *parent = 0);
49 //! Requests to show translation which is described by passed translations
51 void showTranslation(QList<Translation*>);
54 //! Requests to add selected word to bookmarks
55 void addBookmark(QList<Translation*>);
57 //! Requests to remove selected word from bookmarks
58 void removeBookmark(QList<Translation*>);
62 //! Shows search results
64 \param hash of found words and its translations objects
66 void showSearchResults(QHash<QString, QList<Translation*> >);
68 //! Locks words list, while backbone is doing something in background
71 //! Unlocks words list
75 //! Reimplemented standard mouseReleaseEvent to check if user clicked on
76 //! word or on its star to emit suitable signal
77 void mouseReleaseEvent(QMouseEvent *event);
79 //! Resizes the size of columns to assure that stars are always on right
80 //! side next to scroll bar
81 void resizeEvent(QResizeEvent *event);
84 //! Emits signal to show translation of clicked item. Signal is emitted
85 //! only when word was clicked.
86 void wordClicked(QModelIndex index);
88 //! Emits signal to show add or remove word from bookmarks.
89 //! Signal is emitted only when star was clicked.
90 void wordChecked(QModelIndex index);
95 //! Adds word to model. Row is row in the model
96 void addWord(QString word, int row);
98 QStandardItemModel* model;
99 //! Describes width of star checkbox in pixels
102 //! Resizes sizes of colums after adding new words or after resize event.
103 void resizeColumns();
105 //! Association between words and their translations
106 QHash<QString, QList<Translation*> > searchResult;
109 #endif // WORDLISTWIDGET_H