git.maemo.org Git - mdictionary/blob - 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_ae1e2875f18de4bf78addf805a3ae896a}{setEnabled} (bool)
  18 \begin{DoxyCompactList}\small\item\em Enable or disable search word line edit and history buttons. \item\end{DoxyCompactList}\item
  19 void \hyperlink{classSearchBarWidget_a3465a1a8d80d41f36df6f4b79db47521}{setBusy} ()
  20 \begin{DoxyCompactList}\small\item\em Sets search bar in busy state. \item\end{DoxyCompactList}\item
  21 void \hyperlink{classSearchBarWidget_aa23090a81d12eef86f4078d4f4c7a56e}{setIdle} ()
  22 \begin{DoxyCompactList}\small\item\em Sets search bar in idle state. \item\end{DoxyCompactList}\item
  23 void \hyperlink{classSearchBarWidget_ab62c56cffe50613543e05ef58371cf31}{search} (QString word)
  24 \begin{DoxyCompactList}\small\item\em Search for given word. \item\end{DoxyCompactList}\item
  25 void \hyperlink{classSearchBarWidget_a967b78d6ec64459d2e68eb3367af3da2}{searchDelay} (QString word)
  26 \begin{DoxyCompactList}\small\item\em Start to search for given word after 500 ms. \item\end{DoxyCompactList}\item
  27 \hypertarget{classSearchBarWidget_a753561409f73334ad2364bdbf7134eba}{
  28 void \hyperlink{classSearchBarWidget_a753561409f73334ad2364bdbf7134eba}{updateHistoryButtons} (bool prev, bool next, bool list)}
  29 \label{classSearchBarWidget_a753561409f73334ad2364bdbf7134eba}
  30
  31 \begin{DoxyCompactList}\small\item\em Updates state of history buttons. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  32 \subsection*{Signals}
  33 \begin{DoxyCompactItemize}
  34 \item
  35 void \hyperlink{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}{searchForTranslations} (QString)
  36 \item
  37 \hypertarget{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}{
  38 void \hyperlink{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}{stopSearching} ()}
  39 \label{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}
  40
  41 \begin{DoxyCompactList}\small\item\em Request to stop all active searchings. \item\end{DoxyCompactList}\item
  42 \hypertarget{classSearchBarWidget_a78a45ebd4c4af1c3794bf1945bddc1c0}{
  43 void \hyperlink{classSearchBarWidget_a78a45ebd4c4af1c3794bf1945bddc1c0}{historyPrev} ()}
  44 \label{classSearchBarWidget_a78a45ebd4c4af1c3794bf1945bddc1c0}
  45
  46 \begin{DoxyCompactList}\small\item\em Request to show previous translation in history. \item\end{DoxyCompactList}\item
  47 \hypertarget{classSearchBarWidget_a7160d249f973fa021b3ed0034ee6d875}{
  48 void \hyperlink{classSearchBarWidget_a7160d249f973fa021b3ed0034ee6d875}{historyNext} ()}
  49 \label{classSearchBarWidget_a7160d249f973fa021b3ed0034ee6d875}
  50
  51 \begin{DoxyCompactList}\small\item\em Request to show next translation in history. \item\end{DoxyCompactList}\item
  52 \hypertarget{classSearchBarWidget_a6008388c3ca95ea2c432ad7dffd8e544}{
  53 void \hyperlink{classSearchBarWidget_a6008388c3ca95ea2c432ad7dffd8e544}{historyShow} ()}
  54 \label{classSearchBarWidget_a6008388c3ca95ea2c432ad7dffd8e544}
  55
  56 \begin{DoxyCompactList}\small\item\em Request to show history list. \item\end{DoxyCompactList}\item
  57 \hypertarget{classSearchBarWidget_adaa0d9b2abbc4deec48164401316e752}{
  58 void \hyperlink{classSearchBarWidget_adaa0d9b2abbc4deec48164401316e752}{refreshHistoryButtons} ()}
  59 \label{classSearchBarWidget_adaa0d9b2abbc4deec48164401316e752}
  60
  61 \begin{DoxyCompactList}\small\item\em Request to refresh state of history buttons. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  62 \subsection*{Public Member Functions}
  63 \begin{DoxyCompactItemize}
  64 \item
  65 \hypertarget{classSearchBarWidget_a797e54c56b9a819fe97dcd9875d513c6}{
  66 {\bfseries SearchBarWidget} (QWidget $\ast$parent=0)}
  67 \label{classSearchBarWidget_a797e54c56b9a819fe97dcd9875d513c6}
  68
  69 \end{DoxyCompactItemize}
  70
  71
  72 \subsection{Detailed Description}
  73 Displays search bar. Contains line edit field to input word which user would like to find and buttons to start/stop search and browse search history. Line edit and history buttons are disabled when search is ongoing, only start/stop button stays active. When searching it also displays progress bar
  74
  75 \subsection{Member Function Documentation}
  76 \hypertarget{classSearchBarWidget_ab62c56cffe50613543e05ef58371cf31}{
  77 \index{SearchBarWidget@{SearchBarWidget}!search@{search}}
  78 \index{search@{search}!SearchBarWidget@{SearchBarWidget}}
  79 \subsubsection[{search}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::search (QString {\em word})\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
  80 \label{classSearchBarWidget_ab62c56cffe50613543e05ef58371cf31}
  81
  82
  83 Search for given word.
  84
  85 Sets word as text in search word line edit \hypertarget{classSearchBarWidget_a967b78d6ec64459d2e68eb3367af3da2}{
  86 \index{SearchBarWidget@{SearchBarWidget}!searchDelay@{searchDelay}}
  87 \index{searchDelay@{searchDelay}!SearchBarWidget@{SearchBarWidget}}
  88 \subsubsection[{searchDelay}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::searchDelay (QString {\em word})\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
  89 \label{classSearchBarWidget_a967b78d6ec64459d2e68eb3367af3da2}
  90
  91
  92 Start to search for given word after 500 ms.
  93
  94 Sets word as text in search word line edit, and wait 500 ms to start search. If in meanwhile this slot is called again it will stop previous timers. \hypertarget{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}{
  95 \index{SearchBarWidget@{SearchBarWidget}!searchForTranslations@{searchForTranslations}}
  96 \index{searchForTranslations@{searchForTranslations}!SearchBarWidget@{SearchBarWidget}}
  97 \subsubsection[{searchForTranslations}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::searchForTranslations (QString {\em \_\-t1})\hspace{0.3cm}{\ttfamily  \mbox{[}signal\mbox{]}}}}
  98 \label{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}
  99 Requests to search for list of matching words to word passed as parameter \hypertarget{classSearchBarWidget_a3465a1a8d80d41f36df6f4b79db47521}{
 100 \index{SearchBarWidget@{SearchBarWidget}!setBusy@{setBusy}}
 101 \index{setBusy@{setBusy}!SearchBarWidget@{SearchBarWidget}}
 102 \subsubsection[{setBusy}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setBusy ()\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
 103 \label{classSearchBarWidget_a3465a1a8d80d41f36df6f4b79db47521}
 104
 105
 106 Sets search bar in busy state.
 107
 108 Displays \char`\"{}busy\char`\"{} bar and disables search word text edit and history buttons \hypertarget{classSearchBarWidget_ae1e2875f18de4bf78addf805a3ae896a}{
 109 \index{SearchBarWidget@{SearchBarWidget}!setEnabled@{setEnabled}}
 110 \index{setEnabled@{setEnabled}!SearchBarWidget@{SearchBarWidget}}
 111 \subsubsection[{setEnabled}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setEnabled (bool {\em enabled})\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
 112 \label{classSearchBarWidget_ae1e2875f18de4bf78addf805a3ae896a}
 113
 114
 115 Enable or disable search word line edit and history buttons.
 116
 117 While searching it disables only history button and line edit. Search/Stop button is always enabled \hypertarget{classSearchBarWidget_aa23090a81d12eef86f4078d4f4c7a56e}{
 118 \index{SearchBarWidget@{SearchBarWidget}!setIdle@{setIdle}}
 119 \index{setIdle@{setIdle}!SearchBarWidget@{SearchBarWidget}}
 120 \subsubsection[{setIdle}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setIdle ()\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
 121 \label{classSearchBarWidget_aa23090a81d12eef86f4078d4f4c7a56e}
 122
 123
 124 Sets search bar in idle state.
 125
 126 Hides \char`\"{}busy\char`\"{} bar and enables all widgets, refresh state of history buttons by emmiting refreshHistoryButtons signal
 127
 128 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 129 \item
 130 \hyperlink{SearchBarWidget_8h}{SearchBarWidget.h}\item
 131 SearchBarWidget.cpp\item
 132 moc\_\-SearchBarWidget.cpp\item
 133 build-\/desktop/moc\_\-SearchBarWidget.cpp\end{DoxyCompactItemize}