Updated 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 \end{DoxyCompactItemize}
34 \subsection*{Public Member Functions}
35 \begin{DoxyCompactItemize}
36 \item 
37 \hypertarget{classWordListWidget_a5f84179019ee766bdb8c46f111da95ce}{
38 {\bfseries WordListWidget} (QWidget $\ast$parent=0)}
39 \label{classWordListWidget_a5f84179019ee766bdb8c46f111da95ce}
40
41 \end{DoxyCompactItemize}
42
43
44 \subsection{Detailed Description}
45 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`\"{} 
46
47 \subsection{Member Function Documentation}
48 \hypertarget{classWordListWidget_ae4ac47bc19b239de121fd72455215479}{
49 \index{WordListWidget@{WordListWidget}!showSearchResults@{showSearchResults}}
50 \index{showSearchResults@{showSearchResults}!WordListWidget@{WordListWidget}}
51 \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{]}}}}
52 \label{classWordListWidget_ae4ac47bc19b239de121fd72455215479}
53
54
55 Shows search results. 
56
57
58 \begin{DoxyParams}{Parameters}
59 \item[{\em hash}]of found words and it's translations objects \end{DoxyParams}
60 \hypertarget{classWordListWidget_a8bd328a9229e63b99769041aa0dd3e06}{
61 \index{WordListWidget@{WordListWidget}!showTranslation@{showTranslation}}
62 \index{showTranslation@{showTranslation}!WordListWidget@{WordListWidget}}
63 \subsubsection[{showTranslation}]{\setlength{\rightskip}{0pt plus 5cm}void WordListWidget::showTranslation (QList$<$ {\bf Translation} $\ast$ $>$)\hspace{0.3cm}{\ttfamily  \mbox{[}signal\mbox{]}}}}
64 \label{classWordListWidget_a8bd328a9229e63b99769041aa0dd3e06}
65 Request to show translation which is described by passed translations objects 
66
67 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
68 \item 
69 WordListWidget.h\item 
70 WordListWidget.cpp\end{DoxyCompactItemize}