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 Displays list of words found in dictionaries
24 \author Mateusz Półrola <mateusz.polrola@comarch.pl>
27 #ifndef WORDLISTWIDGET_H
28 #define WORDLISTWIDGET_H
31 #include <QStringListModel>
32 #include "../backbone/backbone.h"
33 #include "WordListProxyStyle.h"
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);
50 //! Requests to show translation which is described by passed translations
52 void showTranslation(QList<Translation*>);
55 //! Requests to add selected word to bookmarks
56 void addBookmark(QList<Translation*>);
58 //! Requests to remove selected word from bookmarks
59 void removeBookmark(QList<Translation*>);
63 //! Shows search results
65 \param hash of found words and its translations objects
67 void showSearchResults(QHash<QString, QList<Translation*> >);
69 //! Locks words list, while backbone is doing something in background
72 //! Unlocks words list
79 //! Reimplemented standard mouseReleaseEvent to check if user clicked on
80 //! a word or on its star to emit suitable signal
81 void mouseReleaseEvent(QMouseEvent *event);
83 //! Resizes the size of columns to assure that stars are always on right
84 //! side next to scroll bar
85 void resizeEvent(QResizeEvent *event);
87 //! Checks if user press return and if so displays translation of selected word
88 void keyPressEvent( QKeyEvent * event);
91 //! Emits signal to show translation of clicked item. Signal is emitted
92 //! only when a word was clicked.
93 void wordClicked(QModelIndex index);
95 //! Emits signal to show add or remove word from bookmarks.
96 //! Signal is emitted only when a star was clicked.
97 void wordChecked(QModelIndex index);
102 //! Adds word to model. Row is row in the model
103 void addWord(QString word, int row);
105 QStandardItemModel* model;
107 //! Describes width of a star checkbox in pixels
110 //! Resizes sizes of colums after adding new words or after resize event.
111 void resizeColumns();
113 //! Association between words and their translations
114 QHash<QString, QList<Translation*> > searchResult;
115 WordListProxyStyle* proxyStyle;
118 #endif // WORDLISTWIDGET_H