Added generated documentation
[mdictionary] / doc / latex / classSearchBarWidget.tex
1 \hypertarget{classSearchBarWidget}{
2 \section{SearchBarWidget Class Reference}
3 \label{classSearchBarWidget}\index{SearchBarWidget@{SearchBarWidget}}
4 }
5
6
7 Displays search bar.  
8
9
10
11
12 {\ttfamily \#include $<$SearchBarWidget.h$>$}
13
14 \subsection*{Public Slots}
15 \begin{DoxyCompactItemize}
16 \item 
17 void \hyperlink{classSearchBarWidget_a2513fe29e47f6f22f79e54cfa7338beb}{setEnabled} (bool enabled=true)
18 \begin{DoxyCompactList}\small\item\em Enable or disable search word line edit and history buttons. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
19 \subsection*{Signals}
20 \begin{DoxyCompactItemize}
21 \item 
22 \hypertarget{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}{
23 void \hyperlink{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}{searchForTranslations} (QString)}
24 \label{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}
25
26 \begin{DoxyCompactList}\small\item\em Requests to search for translation of word passed as parameter. \item\end{DoxyCompactList}\item 
27 \hypertarget{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}{
28 void \hyperlink{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}{stopSearching} ()}
29 \label{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}
30
31 \begin{DoxyCompactList}\small\item\em Request to stop all active searchings. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
32 \subsection*{Public Member Functions}
33 \begin{DoxyCompactItemize}
34 \item 
35 \hypertarget{classSearchBarWidget_a8bb7132063a5fca3cc81673b48189f2f}{
36 {\bfseries SearchBarWidget} (\hyperlink{classBackbone}{Backbone} $\ast$backbone, QWidget $\ast$parent=0)}
37 \label{classSearchBarWidget_a8bb7132063a5fca3cc81673b48189f2f}
38
39 \item 
40 bool \hyperlink{classSearchBarWidget_af586eb0e30d27df6dd91e565199e57d2}{isSearching} () const 
41 \begin{DoxyCompactList}\small\item\em Returns searching status. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
42
43
44 \subsection{Detailed Description}
45 Displays search bar. Contains line edit field to input word which user would like to find and buttons to browse search history. 
46
47 \subsection{Member Function Documentation}
48 \hypertarget{classSearchBarWidget_af586eb0e30d27df6dd91e565199e57d2}{
49 \index{SearchBarWidget@{SearchBarWidget}!isSearching@{isSearching}}
50 \index{isSearching@{isSearching}!SearchBarWidget@{SearchBarWidget}}
51 \subsubsection[{isSearching}]{\setlength{\rightskip}{0pt plus 5cm}bool SearchBarWidget::isSearching () const}}
52 \label{classSearchBarWidget_af586eb0e30d27df6dd91e565199e57d2}
53
54
55 Returns searching status. 
56
57 If backbone is still searching returns true \hypertarget{classSearchBarWidget_a2513fe29e47f6f22f79e54cfa7338beb}{
58 \index{SearchBarWidget@{SearchBarWidget}!setEnabled@{setEnabled}}
59 \index{setEnabled@{setEnabled}!SearchBarWidget@{SearchBarWidget}}
60 \subsubsection[{setEnabled}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setEnabled (bool {\em enabled} = {\ttfamily true})\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
61 \label{classSearchBarWidget_a2513fe29e47f6f22f79e54cfa7338beb}
62
63
64 Enable or disable search word line edit and history buttons. 
65
66 While searching it disables only history button and line edit. Search/Stop button is always enabled 
67
68 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
69 \item 
70 SearchBarWidget.h\item 
71 SearchBarWidget.cpp\item 
72 moc\_\-SearchBarWidget.cpp\end{DoxyCompactItemize}