Updated documentation

[mdictionary] / doc / latex / classCommonDictInterface.tex

diff --git a/doc/latex/classCommonDictInterface.tex b/doc/latex/classCommonDictInterface.tex
index 3bb8d4f..efa0d27 100644 (file)
--- a/doc/latex/classCommonDictInterface.tex
+++ b/doc/latex/classCommonDictInterface.tex
@@ -20,13 +20,13 @@ Inheritance diagram for CommonDictInterface:\begin{figure}[H]
 \subsection*{Public Slots}
 \begin{DoxyCompactItemize}
 \item 
-virtual QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classCommonDictInterface_a3ca9313571e0ecab66ce7a7c5d356f4f}{searchWordList} (QString word, int limit)=0
+virtual QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classCommonDictInterface_a27594c22d4df398e98af85b40b7407cb}{searchWordList} (QString word, int limit=0)=0
 \begin{DoxyCompactList}\small\item\em performs search in dictionary \item\end{DoxyCompactList}\item 
 \hypertarget{classCommonDictInterface_a017f37eed4270d37cd5df36e546aacc6}{
 virtual void \hyperlink{classCommonDictInterface_a017f37eed4270d37cd5df36e546aacc6}{stop} ()=0}
 \label{classCommonDictInterface_a017f37eed4270d37cd5df36e546aacc6}
 
-\begin{DoxyCompactList}\small\item\em stop current operation \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+\begin{DoxyCompactList}\small\item\em stops current operation \item\end{DoxyCompactList}\end{DoxyCompactItemize}
 \subsection*{Signals}
 \begin{DoxyCompactItemize}
 \item 
@@ -34,7 +34,12 @@ virtual void \hyperlink{classCommonDictInterface_a017f37eed4270d37cd5df36e546aac
 void \hyperlink{classCommonDictInterface_abeb1426ae67ac8bc43002756b0cc9308}{loaded} (\hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$)}
 \label{classCommonDictInterface_abeb1426ae67ac8bc43002756b0cc9308}
 
-\begin{DoxyCompactList}\small\item\em emited after dictionary is ready to use afer being loaded \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+\begin{DoxyCompactList}\small\item\em emited after dictionary is ready to use afer being loaded \item\end{DoxyCompactList}\item 
+\hypertarget{classCommonDictInterface_aeb500dfe5e18f544a01d5fa5352c3d36}{
+void \hyperlink{classCommonDictInterface_aeb500dfe5e18f544a01d5fa5352c3d36}{settingsChanged} ()}
+\label{classCommonDictInterface_aeb500dfe5e18f544a01d5fa5352c3d36}
+
+\begin{DoxyCompactList}\small\item\em emited after change dictionary settings \item\end{DoxyCompactList}\end{DoxyCompactItemize}
 \subsection*{Public Member Functions}
 \begin{DoxyCompactItemize}
 \item 
@@ -77,7 +82,7 @@ virtual \hyperlink{classDictDialog}{DictDialog} $\ast$ \hyperlink{classCommonDic
 virtual \hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$ \hyperlink{classCommonDictInterface_a319be492dd57d6e2828da2424cb57bb0}{getNew} (const \hyperlink{classSettings}{Settings} $\ast$) const =0}
 \label{classCommonDictInterface_a319be492dd57d6e2828da2424cb57bb0}
 
-\begin{DoxyCompactList}\small\item\em return new, clean copy of plugin with setting set as in Settings$\ast$ \item\end{DoxyCompactList}\item 
+\begin{DoxyCompactList}\small\item\em returns new, clean copy of plugin with setting set as in Settings$\ast$ \item\end{DoxyCompactList}\item 
 \hypertarget{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}{
 virtual bool \hyperlink{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}{isAvailable} () const =0}
 \label{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}
@@ -94,12 +99,17 @@ virtual uint \hyperlink{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae6
 virtual void \hyperlink{classCommonDictInterface_a3ccd6318ae40727de5e66a92cf2fc95e}{setHash} (uint)=0}
 \label{classCommonDictInterface_a3ccd6318ae40727de5e66a92cf2fc95e}
 
-\begin{DoxyCompactList}\small\item\em set unique value (unique for every dictionary not plugin) \item\end{DoxyCompactList}\item 
+\begin{DoxyCompactList}\small\item\em sets unique value (unique for every dictionary not plugin) \item\end{DoxyCompactList}\item 
 \hypertarget{classCommonDictInterface_a7a20fee14fa5255a1e34e213c93afbe7}{
 virtual \hyperlink{classSettings}{Settings} $\ast$ \hyperlink{classCommonDictInterface_a7a20fee14fa5255a1e34e213c93afbe7}{settings} ()=0}
 \label{classCommonDictInterface_a7a20fee14fa5255a1e34e213c93afbe7}
 
-\begin{DoxyCompactList}\small\item\em returns current plugin settings \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+\begin{DoxyCompactList}\small\item\em returns current plugin settings \item\end{DoxyCompactList}\item 
+\hypertarget{classCommonDictInterface_ac29057a9001f4acf6fcd6eec883cea62}{
+virtual QIcon \hyperlink{classCommonDictInterface_ac29057a9001f4acf6fcd6eec883cea62}{icon} ()=0}
+\label{classCommonDictInterface_ac29057a9001f4acf6fcd6eec883cea62}
+
+\begin{DoxyCompactList}\small\item\em returns plugin icon \item\end{DoxyCompactList}\end{DoxyCompactItemize}
 
 
 \subsection{Detailed Description}
@@ -118,18 +128,18 @@ unique value (unique for every dictionary not plugin
 
 Implemented in \hyperlink{classXdxfPlugin_a5e83f29b2eff00598470bb4b82961973}{XdxfPlugin}.
 
-\hypertarget{classCommonDictInterface_a3ca9313571e0ecab66ce7a7c5d356f4f}{
+\hypertarget{classCommonDictInterface_a27594c22d4df398e98af85b40b7407cb}{
 \index{CommonDictInterface@{CommonDictInterface}!searchWordList@{searchWordList}}
 \index{searchWordList@{searchWordList}!CommonDictInterface@{CommonDictInterface}}
-\subsubsection[{searchWordList}]{\setlength{\rightskip}{0pt plus 5cm}virtual QList$<${\bf Translation}$\ast$$>$ CommonDictInterface::searchWordList (QString {\em word}, \/  int {\em limit})\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual, slot\mbox{]}}}}
-\label{classCommonDictInterface_a3ca9313571e0ecab66ce7a7c5d356f4f}
+\subsubsection[{searchWordList}]{\setlength{\rightskip}{0pt plus 5cm}virtual QList$<${\bf Translation}$\ast$$>$ CommonDictInterface::searchWordList (QString {\em word}, \/  int {\em limit} = {\ttfamily 0})\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual, slot\mbox{]}}}}
+\label{classCommonDictInterface_a27594c22d4df398e98af85b40b7407cb}
 
 
 performs search in dictionary 
 
 
 \begin{DoxyParams}{Parameters}
-\item[{\em word}]word to search in dictionary \item[{\em limit}]limit on number of results\end{DoxyParams}
+\item[{\em word}]word to search in dictionary \item[{\em limit}]limit on number of results, if limit=0 all matching words are returned\end{DoxyParams}
 After finishing search it have to emit \begin{DoxySeeAlso}{See also}
 \hyperlink{classCommonDictInterface}{CommonDictInterface}:finalTranslation finalTranslation 
 \end{DoxySeeAlso}
@@ -139,6 +149,7 @@ Implemented in \hyperlink{classXdxfPlugin_a538581955ba04d1316f1a8befab4d561}{Xdx
 
 
 
-The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
+The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 \item 
-CommonDictInterface.h\end{DoxyCompactItemize}
+CommonDictInterface.h\item 
+moc\_\-CommonDictInterface.cpp\end{DoxyCompactItemize}