X-Git-Url: http://vcs.maemo.org/git/?a=blobdiff_plain;f=doc%2Flatex%2FclassSearchBarWidget.tex;h=9397b3d8e7f828f8ed88b249c301509566d6eee3;hb=bd708a52aa508816a137b7c73778b7f99d1d2f9e;hp=fcf2117d5c33d1216ba2646ee7bd7d87cce7f746;hpb=cdd29888c9d65e469deb8747c836bb75e875bde3;p=mdictionary diff --git a/doc/latex/classSearchBarWidget.tex b/doc/latex/classSearchBarWidget.tex index fcf2117..9397b3d 100644 --- a/doc/latex/classSearchBarWidget.tex +++ b/doc/latex/classSearchBarWidget.tex @@ -14,59 +14,120 @@ Displays search bar. \subsection*{Public Slots} \begin{DoxyCompactItemize} \item -void \hyperlink{classSearchBarWidget_a2513fe29e47f6f22f79e54cfa7338beb}{setEnabled} (bool enabled=true) -\begin{DoxyCompactList}\small\item\em Enable or disable search word line edit and history buttons. \item\end{DoxyCompactList}\end{DoxyCompactItemize} +void \hyperlink{classSearchBarWidget_ae1e2875f18de4bf78addf805a3ae896a}{setEnabled} (bool) +\begin{DoxyCompactList}\small\item\em Enable or disable search word line edit and history buttons. \item\end{DoxyCompactList}\item +void \hyperlink{classSearchBarWidget_a3465a1a8d80d41f36df6f4b79db47521}{setBusy} () +\begin{DoxyCompactList}\small\item\em Sets search bar in busy state. \item\end{DoxyCompactList}\item +void \hyperlink{classSearchBarWidget_aa23090a81d12eef86f4078d4f4c7a56e}{setIdle} () +\begin{DoxyCompactList}\small\item\em Sets search bar in idle state. \item\end{DoxyCompactList}\item +void \hyperlink{classSearchBarWidget_ab62c56cffe50613543e05ef58371cf31}{search} (QString word) +\begin{DoxyCompactList}\small\item\em Search for given word. \item\end{DoxyCompactList}\item +void \hyperlink{classSearchBarWidget_a967b78d6ec64459d2e68eb3367af3da2}{searchDelay} (QString word) +\begin{DoxyCompactList}\small\item\em Start to search for given word after 500 ms. \item\end{DoxyCompactList}\item +\hypertarget{classSearchBarWidget_a753561409f73334ad2364bdbf7134eba}{ +void \hyperlink{classSearchBarWidget_a753561409f73334ad2364bdbf7134eba}{updateHistoryButtons} (bool prev, bool next, bool list)} +\label{classSearchBarWidget_a753561409f73334ad2364bdbf7134eba} + +\begin{DoxyCompactList}\small\item\em Updates state of history buttons. \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection*{Signals} \begin{DoxyCompactItemize} \item -\hypertarget{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}{ -void \hyperlink{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}{searchForTranslations} (QString)} -\label{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b} - -\begin{DoxyCompactList}\small\item\em Requests to search for translation of word passed as parameter. \item\end{DoxyCompactList}\item +void \hyperlink{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b}{searchForTranslations} (QString) +\item \hypertarget{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}{ void \hyperlink{classSearchBarWidget_a126dc7f997386fce833d879f643a077b}{stopSearching} ()} \label{classSearchBarWidget_a126dc7f997386fce833d879f643a077b} -\begin{DoxyCompactList}\small\item\em Request to stop all active searchings. \item\end{DoxyCompactList}\end{DoxyCompactItemize} +\begin{DoxyCompactList}\small\item\em Request to stop all active searchings. \item\end{DoxyCompactList}\item +\hypertarget{classSearchBarWidget_a78a45ebd4c4af1c3794bf1945bddc1c0}{ +void \hyperlink{classSearchBarWidget_a78a45ebd4c4af1c3794bf1945bddc1c0}{historyPrev} ()} +\label{classSearchBarWidget_a78a45ebd4c4af1c3794bf1945bddc1c0} + +\begin{DoxyCompactList}\small\item\em Request to show previous translation in history. \item\end{DoxyCompactList}\item +\hypertarget{classSearchBarWidget_a7160d249f973fa021b3ed0034ee6d875}{ +void \hyperlink{classSearchBarWidget_a7160d249f973fa021b3ed0034ee6d875}{historyNext} ()} +\label{classSearchBarWidget_a7160d249f973fa021b3ed0034ee6d875} + +\begin{DoxyCompactList}\small\item\em Request to show next translation in history. \item\end{DoxyCompactList}\item +\hypertarget{classSearchBarWidget_a6008388c3ca95ea2c432ad7dffd8e544}{ +void \hyperlink{classSearchBarWidget_a6008388c3ca95ea2c432ad7dffd8e544}{historyShow} ()} +\label{classSearchBarWidget_a6008388c3ca95ea2c432ad7dffd8e544} + +\begin{DoxyCompactList}\small\item\em Request to show history list. \item\end{DoxyCompactList}\item +\hypertarget{classSearchBarWidget_adaa0d9b2abbc4deec48164401316e752}{ +void \hyperlink{classSearchBarWidget_adaa0d9b2abbc4deec48164401316e752}{refreshHistoryButtons} ()} +\label{classSearchBarWidget_adaa0d9b2abbc4deec48164401316e752} + +\begin{DoxyCompactList}\small\item\em Request to refresh state of history buttons. \item\end{DoxyCompactList}\end{DoxyCompactItemize} \subsection*{Public Member Functions} \begin{DoxyCompactItemize} \item -\hypertarget{classSearchBarWidget_a8bb7132063a5fca3cc81673b48189f2f}{ -{\bfseries SearchBarWidget} (\hyperlink{classBackbone}{Backbone} $\ast$backbone, QWidget $\ast$parent=0)} -\label{classSearchBarWidget_a8bb7132063a5fca3cc81673b48189f2f} +\hypertarget{classSearchBarWidget_a797e54c56b9a819fe97dcd9875d513c6}{ +{\bfseries SearchBarWidget} (QWidget $\ast$parent=0)} +\label{classSearchBarWidget_a797e54c56b9a819fe97dcd9875d513c6} -\item -bool \hyperlink{classSearchBarWidget_af586eb0e30d27df6dd91e565199e57d2}{isSearching} () const -\begin{DoxyCompactList}\small\item\em Returns searching status. \item\end{DoxyCompactList}\end{DoxyCompactItemize} +\end{DoxyCompactItemize} \subsection{Detailed Description} -Displays search bar. Contains line edit field to input word which user would like to find and buttons to browse search history. +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 \subsection{Member Function Documentation} -\hypertarget{classSearchBarWidget_af586eb0e30d27df6dd91e565199e57d2}{ -\index{SearchBarWidget@{SearchBarWidget}!isSearching@{isSearching}} -\index{isSearching@{isSearching}!SearchBarWidget@{SearchBarWidget}} -\subsubsection[{isSearching}]{\setlength{\rightskip}{0pt plus 5cm}bool SearchBarWidget::isSearching () const}} -\label{classSearchBarWidget_af586eb0e30d27df6dd91e565199e57d2} +\hypertarget{classSearchBarWidget_ab62c56cffe50613543e05ef58371cf31}{ +\index{SearchBarWidget@{SearchBarWidget}!search@{search}} +\index{search@{search}!SearchBarWidget@{SearchBarWidget}} +\subsubsection[{search}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::search (QString {\em word})\hspace{0.3cm}{\ttfamily \mbox{[}slot\mbox{]}}}} +\label{classSearchBarWidget_ab62c56cffe50613543e05ef58371cf31} + +Search for given word. -Returns searching status. +Sets word as text in search word line edit \hypertarget{classSearchBarWidget_a967b78d6ec64459d2e68eb3367af3da2}{ +\index{SearchBarWidget@{SearchBarWidget}!searchDelay@{searchDelay}} +\index{searchDelay@{searchDelay}!SearchBarWidget@{SearchBarWidget}} +\subsubsection[{searchDelay}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::searchDelay (QString {\em word})\hspace{0.3cm}{\ttfamily \mbox{[}slot\mbox{]}}}} +\label{classSearchBarWidget_a967b78d6ec64459d2e68eb3367af3da2} -If backbone is still searching returns true \hypertarget{classSearchBarWidget_a2513fe29e47f6f22f79e54cfa7338beb}{ + +Start to search for given word after 500 ms. + +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}{ +\index{SearchBarWidget@{SearchBarWidget}!searchForTranslations@{searchForTranslations}} +\index{searchForTranslations@{searchForTranslations}!SearchBarWidget@{SearchBarWidget}} +\subsubsection[{searchForTranslations}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::searchForTranslations (QString {\em \_\-t1})\hspace{0.3cm}{\ttfamily \mbox{[}signal\mbox{]}}}} +\label{classSearchBarWidget_a72e7ffc17c918cc8839f892d0161521b} +Requests to search for list of matching words to word passed as parameter \hypertarget{classSearchBarWidget_a3465a1a8d80d41f36df6f4b79db47521}{ +\index{SearchBarWidget@{SearchBarWidget}!setBusy@{setBusy}} +\index{setBusy@{setBusy}!SearchBarWidget@{SearchBarWidget}} +\subsubsection[{setBusy}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setBusy ()\hspace{0.3cm}{\ttfamily \mbox{[}slot\mbox{]}}}} +\label{classSearchBarWidget_a3465a1a8d80d41f36df6f4b79db47521} + + +Sets search bar in busy state. + +Displays \char`\"{}busy\char`\"{} bar and disables search word text edit and history buttons \hypertarget{classSearchBarWidget_ae1e2875f18de4bf78addf805a3ae896a}{ \index{SearchBarWidget@{SearchBarWidget}!setEnabled@{setEnabled}} \index{setEnabled@{setEnabled}!SearchBarWidget@{SearchBarWidget}} -\subsubsection[{setEnabled}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setEnabled (bool {\em enabled} = {\ttfamily true})\hspace{0.3cm}{\ttfamily \mbox{[}slot\mbox{]}}}} -\label{classSearchBarWidget_a2513fe29e47f6f22f79e54cfa7338beb} +\subsubsection[{setEnabled}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setEnabled (bool {\em enabled})\hspace{0.3cm}{\ttfamily \mbox{[}slot\mbox{]}}}} +\label{classSearchBarWidget_ae1e2875f18de4bf78addf805a3ae896a} Enable or disable search word line edit and history buttons. -While searching it disables only history button and line edit. Search/Stop button is always enabled +While searching it disables only history button and line edit. Search/Stop button is always enabled \hypertarget{classSearchBarWidget_aa23090a81d12eef86f4078d4f4c7a56e}{ +\index{SearchBarWidget@{SearchBarWidget}!setIdle@{setIdle}} +\index{setIdle@{setIdle}!SearchBarWidget@{SearchBarWidget}} +\subsubsection[{setIdle}]{\setlength{\rightskip}{0pt plus 5cm}void SearchBarWidget::setIdle ()\hspace{0.3cm}{\ttfamily \mbox{[}slot\mbox{]}}}} +\label{classSearchBarWidget_aa23090a81d12eef86f4078d4f4c7a56e} + + +Sets search bar in idle state. + +Hides \char`\"{}busy\char`\"{} bar and enables all widgets, refresh state of history buttons by emmiting refreshHistoryButtons signal The documentation for this class was generated from the following files:\begin{DoxyCompactItemize} \item -SearchBarWidget.h\item +\hyperlink{SearchBarWidget_8h}{SearchBarWidget.h}\item SearchBarWidget.cpp\item -moc\_\-SearchBarWidget.cpp\end{DoxyCompactItemize} +moc\_\-SearchBarWidget.cpp\item +build-\/desktop/moc\_\-SearchBarWidget.cpp\end{DoxyCompactItemize}