Added doxygen config file and first documentation

[mdictionary] / doc / latex / classSearchBarWidget.tex

diff --git a/doc/latex/classSearchBarWidget.tex b/doc/latex/classSearchBarWidget.tex
new file mode 100644 (file)
index 0000000..65808f0
--- /dev/null
+++ b/doc/latex/classSearchBarWidget.tex
@@ -0,0 +1,71 @@
+\hypertarget{classSearchBarWidget}{
+\section{SearchBarWidget Class Reference}
+\label{classSearchBarWidget}\index{SearchBarWidget@{SearchBarWidget}}
+}
+
+
+Displays search bar.  
+
+
+
+
+{\ttfamily \#include $<$SearchBarWidget.h$>$}
+
+\subsection*{Public Slots}
+\begin{DoxyCompactItemize}
+\item 
+void \hyperlink{classSearchBarWidget_ae1e2875f18de4bf78addf805a3ae896a}{setEnabled} (bool)
+\begin{DoxyCompactList}\small\item\em Enable or disable search word line edit and 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 
+\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}
+\subsection*{Public Member Functions}
+\begin{DoxyCompactItemize}
+\item 
+\hypertarget{classSearchBarWidget_a797e54c56b9a819fe97dcd9875d513c6}{
+{\bfseries SearchBarWidget} (QWidget $\ast$parent=0)}
+\label{classSearchBarWidget_a797e54c56b9a819fe97dcd9875d513c6}
+
+\item 
+bool \hyperlink{classSearchBarWidget_a23605776418ae474a358b66f210e7726}{isSearching} ()
+\begin{DoxyCompactList}\small\item\em Returns searching status. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
+Displays search bar. Contains line edit field to input word which user would to find, and buttons to browse search history. 
+
+\subsection{Member Function Documentation}
+\hypertarget{classSearchBarWidget_a23605776418ae474a358b66f210e7726}{
+\index{SearchBarWidget@{SearchBarWidget}!isSearching@{isSearching}}
+\index{isSearching@{isSearching}!SearchBarWidget@{SearchBarWidget}}
+\subsubsection[{isSearching}]{\setlength{\rightskip}{0pt plus 5cm}bool SearchBarWidget::isSearching ()}}
+\label{classSearchBarWidget_a23605776418ae474a358b66f210e7726}
+
+
+Returns searching status. 
+
+If backbone is still searching returns true \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})\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 
+
+The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
+\item 
+SearchBarWidget.h\item 
+SearchBarWidget.cpp\end{DoxyCompactItemize}