Merge branch 'master' into cache
[mdictionary] / doc / latex / classWordListWidget.tex
index 3e6cde2..d3646b9 100644 (file)
@@ -14,17 +14,52 @@ Displays list of words found in dictionaries.
 \subsection*{Public Slots}
 \begin{DoxyCompactItemize}
 \item 
-\hypertarget{classWordListWidget_a43d54da6c79020025fe919fb1f781ccd}{
-void \hyperlink{classWordListWidget_a43d54da6c79020025fe919fb1f781ccd}{showSearchResults} ()}
-\label{classWordListWidget_a43d54da6c79020025fe919fb1f781ccd}
+void \hyperlink{classWordListWidget_ae4ac47bc19b239de121fd72455215479}{showSearchResults} (QHash$<$ QString, QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ $>$)
+\begin{DoxyCompactList}\small\item\em Shows search results. \item\end{DoxyCompactList}\item 
+\hypertarget{classWordListWidget_a84984352531dfc2489f662f3cf30d9bd}{
+void \hyperlink{classWordListWidget_a84984352531dfc2489f662f3cf30d9bd}{lockList} ()}
+\label{classWordListWidget_a84984352531dfc2489f662f3cf30d9bd}
 
-\begin{DoxyCompactList}\small\item\em Request to show search results, requested by backbone when it finished search. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+\begin{DoxyCompactList}\small\item\em Lock words list, while backbone is doing somethig in background. \item\end{DoxyCompactList}\item 
+\hypertarget{classWordListWidget_a9c08e4e72879ae1015566474f88fde81}{
+void \hyperlink{classWordListWidget_a9c08e4e72879ae1015566474f88fde81}{unlockList} ()}
+\label{classWordListWidget_a9c08e4e72879ae1015566474f88fde81}
+
+\begin{DoxyCompactList}\small\item\em Unlocks words list. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{Signals}
+\begin{DoxyCompactItemize}
+\item 
+void \hyperlink{classWordListWidget_a8bd328a9229e63b99769041aa0dd3e06}{showTranslation} (QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$)
+\item 
+\hypertarget{classWordListWidget_a60a458e4bdaa3b918603efd5748d0a17}{
+void \hyperlink{classWordListWidget_a60a458e4bdaa3b918603efd5748d0a17}{addBookmark} (QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$)}
+\label{classWordListWidget_a60a458e4bdaa3b918603efd5748d0a17}
+
+\begin{DoxyCompactList}\small\item\em Request to add selected word to bookmarks. \item\end{DoxyCompactList}\item 
+\hypertarget{classWordListWidget_a7ef184b35ebf94babb882405c80cb2c8}{
+void \hyperlink{classWordListWidget_a7ef184b35ebf94babb882405c80cb2c8}{removeBookmark} (QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$)}
+\label{classWordListWidget_a7ef184b35ebf94babb882405c80cb2c8}
+
+\begin{DoxyCompactList}\small\item\em Request to remove selected word from bookmarks. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
 \subsection*{Public Member Functions}
 \begin{DoxyCompactItemize}
 \item 
-\hypertarget{classWordListWidget_ae9150096f497718fbc9eeae3dcaf3b3f}{
-{\bfseries WordListWidget} (\hyperlink{classBackbone}{Backbone} $\ast$backbone, QWidget $\ast$parent=0)}
-\label{classWordListWidget_ae9150096f497718fbc9eeae3dcaf3b3f}
+\hypertarget{classWordListWidget_a5f84179019ee766bdb8c46f111da95ce}{
+{\bfseries WordListWidget} (QWidget $\ast$parent=0)}
+\label{classWordListWidget_a5f84179019ee766bdb8c46f111da95ce}
+
+\end{DoxyCompactItemize}
+\subsection*{Protected Member Functions}
+\begin{DoxyCompactItemize}
+\item 
+\hypertarget{classWordListWidget_a6550ace51b030ad657cc4d11a22e003f}{
+void {\bfseries mouseReleaseEvent} (QMouseEvent $\ast$event)}
+\label{classWordListWidget_a6550ace51b030ad657cc4d11a22e003f}
+
+\item 
+\hypertarget{classWordListWidget_af5d4dc1b72daeca1c03ac9b0498efc7a}{
+void {\bfseries resizeEvent} (QResizeEvent $\ast$event)}
+\label{classWordListWidget_af5d4dc1b72daeca1c03ac9b0498efc7a}
 
 \end{DoxyCompactItemize}
 
@@ -32,7 +67,28 @@ void \hyperlink{classWordListWidget_a43d54da6c79020025fe919fb1f781ccd}{showSearc
 \subsection{Detailed Description}
 Displays list of words found in dictionaries. It allow user to select word to see it's translation or to mark it as \char`\"{}star\char`\"{} 
 
+\subsection{Member Function Documentation}
+\hypertarget{classWordListWidget_ae4ac47bc19b239de121fd72455215479}{
+\index{WordListWidget@{WordListWidget}!showSearchResults@{showSearchResults}}
+\index{showSearchResults@{showSearchResults}!WordListWidget@{WordListWidget}}
+\subsubsection[{showSearchResults}]{\setlength{\rightskip}{0pt plus 5cm}void WordListWidget::showSearchResults (QHash$<$ QString, QList$<$ {\bf Translation} $\ast$ $>$ $>$ {\em result})\hspace{0.3cm}{\ttfamily  \mbox{[}slot\mbox{]}}}}
+\label{classWordListWidget_ae4ac47bc19b239de121fd72455215479}
+
+
+Shows search results. 
+
+
+\begin{DoxyParams}{Parameters}
+\item[{\em hash}]of found words and it's translations objects \end{DoxyParams}
+\hypertarget{classWordListWidget_a8bd328a9229e63b99769041aa0dd3e06}{
+\index{WordListWidget@{WordListWidget}!showTranslation@{showTranslation}}
+\index{showTranslation@{showTranslation}!WordListWidget@{WordListWidget}}
+\subsubsection[{showTranslation}]{\setlength{\rightskip}{0pt plus 5cm}void WordListWidget::showTranslation (QList$<$ {\bf Translation} $\ast$ $>$ {\em \_\-t1})\hspace{0.3cm}{\ttfamily  \mbox{[}signal\mbox{]}}}}
+\label{classWordListWidget_a8bd328a9229e63b99769041aa0dd3e06}
+Request to show translation which is described by passed translations objects 
+
 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 \item 
 WordListWidget.h\item 
-WordListWidget.cpp\end{DoxyCompactItemize}
+WordListWidget.cpp\item 
+moc\_\-WordListWidget.cpp\end{DoxyCompactItemize}