vcs.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 \hypertarget{classSearchBarWidget_a753561409f73334ad2364bdbf7134eba}{
  26 void \hyperlink{classSearchBarWidget_a753561409f73334ad2364bdbf7134eba}{updateHistoryButtons} (bool prev, bool next, bool list)}
  27 \label{classSearchBarWidget_a753561409f73334ad2364bdbf7134eba}
  28
  29 \begin{DoxyCompactList}\small\item\em Updates state of history buttons. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  30 \subsection*{Signals}
  31 \begin{DoxyCompactItemize}
  32 \item
  33 void \hyperlink{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}{searchForTranslations} (QString)
  34 \item
  35 \hypertarget{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}{
  36 void \hyperlink{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}{stopSearching} ()}
  37 \label{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}
  38
  39 \begin{DoxyCompactList}\small\item\em Request to stop all active searchings. \item\end{DoxyCompactList}\item
  40 \hypertarget{classSearchBarWidget_a78a45ebd4c4af1c3794bf1945bddc1c0}{
  41 void \hyperlink{classSearchBarWidget_a78a45ebd4c4af1c3794bf1945bddc1c0}{historyPrev} ()}
  42 \label{classSearchBarWidget_a78a45ebd4c4af1c3794bf1945bddc1c0}
  43
  44 \begin{DoxyCompactList}\small\item\em Request to show previous translation in history. \item\end{DoxyCompactList}\item
  45 \hypertarget{classSearchBarWidget_a7160d249f973fa021b3ed0034ee6d875}{
  46 void \hyperlink{classSearchBarWidget_a7160d249f973fa021b3ed0034ee6d875}{historyNext} ()}
  47 \label{classSearchBarWidget_a7160d249f973fa021b3ed0034ee6d875}
  48
  49 \begin{DoxyCompactList}\small\item\em Request to show next translation in history. \item\end{DoxyCompactList}\item
  50 \hypertarget{classSearchBarWidget_a6008388c3ca95ea2c432ad7dffd8e544}{
  51 void \hyperlink{classSearchBarWidget_a6008388c3ca95ea2c432ad7dffd8e544}{historyShow} ()}
  52 \label{classSearchBarWidget_a6008388c3ca95ea2c432ad7dffd8e544}
  53
  54 \begin{DoxyCompactList}\small\item\em Request to show history list. \item\end{DoxyCompactList}\item
  55 \hypertarget{classSearchBarWidget_adaa0d9b2abbc4deec48164401316e752}{
  56 void \hyperlink{classSearchBarWidget_adaa0d9b2abbc4deec48164401316e752}{refreshHistoryButtons} ()}
  57 \label{classSearchBarWidget_adaa0d9b2abbc4deec48164401316e752}
  58
  59 \begin{DoxyCompactList}\small\item\em Request to refresh state of history buttons. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  60 \subsection*{Public Member Functions}
  61 \begin{DoxyCompactItemize}
  62 \item
  63 \hypertarget{classSearchBarWidget_a797e54c56b9a819fe97dcd9875d513c6}{
  64 {\bfseries SearchBarWidget} (QWidget $\ast$parent=0)}
  65 \label{classSearchBarWidget_a797e54c56b9a819fe97dcd9875d513c6}
  66
  67 \end{DoxyCompactItemize}
  68
  69
  70 \subsection{Detailed Description}
  71 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
  72
  73 \subsection{Member Function Documentation}
  74 \hypertarget{classSearchBarWidget_ab62c56cffe50613543e05ef58371cf31}{
  75 \index{SearchBarWidget@{SearchBarWidget}!search@{search}}
  76 \index{search@{search}!SearchBarWidget@{SearchBarWidget}}
  77 \subsubsection[{search}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::search (QString {\em word})\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
  78 \label{classSearchBarWidget_ab62c56cffe50613543e05ef58371cf31}
  79
  80
  81 Search for given word.
  82
  83 Sets word as text in search word line edit \hypertarget{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}{
  84 \index{SearchBarWidget@{SearchBarWidget}!searchForTranslations@{searchForTranslations}}
  85 \index{searchForTranslations@{searchForTranslations}!SearchBarWidget@{SearchBarWidget}}
  86 \subsubsection[{searchForTranslations}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::searchForTranslations (QString)\hspace{0.3cm}{\ttfamily  \mbox{[}signal\mbox{]}}}}
  87 \label{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}
  88 Requests to search for list of matching words to word passed as parameter \hypertarget{classSearchBarWidget_a3465a1a8d80d41f36df6f4b79db47521}{
  89 \index{SearchBarWidget@{SearchBarWidget}!setBusy@{setBusy}}
  90 \index{setBusy@{setBusy}!SearchBarWidget@{SearchBarWidget}}
  91 \subsubsection[{setBusy}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setBusy ()\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
  92 \label{classSearchBarWidget_a3465a1a8d80d41f36df6f4b79db47521}
  93
  94
  95 Sets search bar in busy state.
  96
  97 Displays \char`\"{}busy\char`\"{} bar and disables search word text edit and history buttons \hypertarget{classSearchBarWidget_ae1e2875f18de4bf78addf805a3ae896a}{
  98 \index{SearchBarWidget@{SearchBarWidget}!setEnabled@{setEnabled}}
  99 \index{setEnabled@{setEnabled}!SearchBarWidget@{SearchBarWidget}}
 100 \subsubsection[{setEnabled}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setEnabled (bool {\em enabled})\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
 101 \label{classSearchBarWidget_ae1e2875f18de4bf78addf805a3ae896a}
 102
 103
 104 Enable or disable search word line edit and history buttons.
 105
 106 While searching it disables only history button and line edit. Search/Stop button is always enabled \hypertarget{classSearchBarWidget_aa23090a81d12eef86f4078d4f4c7a56e}{
 107 \index{SearchBarWidget@{SearchBarWidget}!setIdle@{setIdle}}
 108 \index{setIdle@{setIdle}!SearchBarWidget@{SearchBarWidget}}
 109 \subsubsection[{setIdle}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setIdle ()\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
 110 \label{classSearchBarWidget_aa23090a81d12eef86f4078d4f4c7a56e}
 111
 112
 113 Sets search bar in idle state.
 114
 115 Hides \char`\"{}busy\char`\"{} bar and enables all widgets, refresh state of history buttons by emmiting refreshHistoryButtons signal
 116
 117 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 118 \item
 119 \hyperlink{SearchBarWidget_8h}{SearchBarWidget.h}\item
 120 SearchBarWidget.cpp\end{DoxyCompactItemize}