Added documentation
[mdictionary] / doc / latex / classWordListWidget.tex
1 \hypertarget{classWordListWidget}{
2 \section{WordListWidget Class Reference}
3 \label{classWordListWidget}\index{WordListWidget@{WordListWidget}}
4 }
5
6
7 Displays list of words found in dictionaries.  
8
9
10
11
12 {\ttfamily \#include $<$WordListWidget.h$>$}
13
14 \subsection*{Public Slots}
15 \begin{DoxyCompactItemize}
16 \item 
17 void \hyperlink{classWordListWidget_ae4ac47bc19b239de121fd72455215479}{showSearchResults} (QHash$<$ QString, QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ $>$)
18 \begin{DoxyCompactList}\small\item\em Shows search results. \item\end{DoxyCompactList}\item 
19 \hypertarget{classWordListWidget_a84984352531dfc2489f662f3cf30d9bd}{
20 void \hyperlink{classWordListWidget_a84984352531dfc2489f662f3cf30d9bd}{lockList} ()}
21 \label{classWordListWidget_a84984352531dfc2489f662f3cf30d9bd}
22
23 \begin{DoxyCompactList}\small\item\em Lock words list, while backbone is doing somethig in background. \item\end{DoxyCompactList}\item 
24 \hypertarget{classWordListWidget_a9c08e4e72879ae1015566474f88fde81}{
25 void \hyperlink{classWordListWidget_a9c08e4e72879ae1015566474f88fde81}{unlockList} ()}
26 \label{classWordListWidget_a9c08e4e72879ae1015566474f88fde81}
27
28 \begin{DoxyCompactList}\small\item\em Unlocks words list. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
29 \subsection*{Signals}
30 \begin{DoxyCompactItemize}
31 \item 
32 void \hyperlink{classWordListWidget_a8bd328a9229e63b99769041aa0dd3e06}{showTranslation} (QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$)
33 \item 
34 \hypertarget{classWordListWidget_a60a458e4bdaa3b918603efd5748d0a17}{
35 void \hyperlink{classWordListWidget_a60a458e4bdaa3b918603efd5748d0a17}{addBookmark} (QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$)}
36 \label{classWordListWidget_a60a458e4bdaa3b918603efd5748d0a17}
37
38 \begin{DoxyCompactList}\small\item\em Request to add selected word to bookmarks. \item\end{DoxyCompactList}\item 
39 \hypertarget{classWordListWidget_a7ef184b35ebf94babb882405c80cb2c8}{
40 void \hyperlink{classWordListWidget_a7ef184b35ebf94babb882405c80cb2c8}{removeBookmark} (QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$)}
41 \label{classWordListWidget_a7ef184b35ebf94babb882405c80cb2c8}
42
43 \begin{DoxyCompactList}\small\item\em Request to remove selected word from bookmarks. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
44 \subsection*{Public Member Functions}
45 \begin{DoxyCompactItemize}
46 \item 
47 \hypertarget{classWordListWidget_a5f84179019ee766bdb8c46f111da95ce}{
48 {\bfseries WordListWidget} (QWidget $\ast$parent=0)}
49 \label{classWordListWidget_a5f84179019ee766bdb8c46f111da95ce}
50
51 \end{DoxyCompactItemize}
52 \subsection*{Protected Member Functions}
53 \begin{DoxyCompactItemize}
54 \item 
55 \hypertarget{classWordListWidget_a6550ace51b030ad657cc4d11a22e003f}{
56 void {\bfseries mouseReleaseEvent} (QMouseEvent $\ast$event)}
57 \label{classWordListWidget_a6550ace51b030ad657cc4d11a22e003f}
58
59 \item 
60 \hypertarget{classWordListWidget_af5d4dc1b72daeca1c03ac9b0498efc7a}{
61 void {\bfseries resizeEvent} (QResizeEvent $\ast$event)}
62 \label{classWordListWidget_af5d4dc1b72daeca1c03ac9b0498efc7a}
63
64 \end{DoxyCompactItemize}
65
66
67 \subsection{Detailed Description}
68 Displays list of words found in dictionaries. It allow user to select word to see it's translation or to mark it as \char`\"{}star\char`\"{} 
69
70 \subsection{Member Function Documentation}
71 \hypertarget{classWordListWidget_ae4ac47bc19b239de121fd72455215479}{
72 \index{WordListWidget@{WordListWidget}!showSearchResults@{showSearchResults}}
73 \index{showSearchResults@{showSearchResults}!WordListWidget@{WordListWidget}}
74 \subsubsection[{showSearchResults}]{\setlength{\rightskip}{0pt plus 5cm}void WordListWidget::showSearchResults (QHash$<$ QString, QList$<$ {\bf Translation} $\ast$ $>$ $>$ {\em result})\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
75 \label{classWordListWidget_ae4ac47bc19b239de121fd72455215479}
76
77
78 Shows search results. 
79
80
81 \begin{DoxyParams}{Parameters}
82 \item[{\em hash}]of found words and it's translations objects \end{DoxyParams}
83 \hypertarget{classWordListWidget_a8bd328a9229e63b99769041aa0dd3e06}{
84 \index{WordListWidget@{WordListWidget}!showTranslation@{showTranslation}}
85 \index{showTranslation@{showTranslation}!WordListWidget@{WordListWidget}}
86 \subsubsection[{showTranslation}]{\setlength{\rightskip}{0pt plus 5cm}void WordListWidget::showTranslation (QList$<$ {\bf Translation} $\ast$ $>$ {\em \_\-t1})\hspace{0.3cm}{\ttfamily  \mbox{[}signal\mbox{]}}}}
87 \label{classWordListWidget_a8bd328a9229e63b99769041aa0dd3e06}
88 Request to show translation which is described by passed translations objects 
89
90 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
91 \item 
92 WordListWidget.h\item 
93 WordListWidget.cpp\item 
94 moc\_\-WordListWidget.cpp\end{DoxyCompactItemize}