Added doxygen config file and first documentation
[mdictionary] / doc / latex / classCommonDictInterface.tex
diff --git a/doc/latex/classCommonDictInterface.tex b/doc/latex/classCommonDictInterface.tex
new file mode 100644 (file)
index 0000000..ba99a9b
--- /dev/null
@@ -0,0 +1,127 @@
+\hypertarget{classCommonDictInterface}{
+\section{CommonDictInterface Class Reference}
+\label{classCommonDictInterface}\index{CommonDictInterface@{CommonDictInterface}}
+}
+
+
+Interface for dict engines plugins.  
+
+
+
+
+{\ttfamily \#include $<$CommonDictInterface.h$>$}
+
+\subsection*{Public Slots}
+\begin{DoxyCompactItemize}
+\item 
+virtual void \hyperlink{classCommonDictInterface_a23e1436f452272cf596e76957fe69796}{search} (QString word, int limit)=0
+\begin{DoxyCompactList}\small\item\em performes 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}
+\subsection*{Signals}
+\begin{DoxyCompactItemize}
+\item 
+\hypertarget{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}{
+void \hyperlink{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}{finalTranslation} (QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$)}
+\label{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}
+
+\begin{DoxyCompactList}\small\item\em emit list of finded Translations \item\end{DoxyCompactList}\item 
+\hypertarget{classCommonDictInterface_abeb1426ae67ac8bc43002756b0cc9308}{
+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}
+\subsection*{Public Member Functions}
+\begin{DoxyCompactItemize}
+\item 
+\hypertarget{classCommonDictInterface_aebb1bc49eb8a37dfaac1319dc6738568}{
+{\bfseries CommonDictInterface} (const QObject $\ast$parent=0)=0}
+\label{classCommonDictInterface_aebb1bc49eb8a37dfaac1319dc6738568}
+
+\item 
+\hypertarget{classCommonDictInterface_a7f8b41dbaa0a5bdcb500c048ca501246}{
+virtual QString \hyperlink{classCommonDictInterface_a7f8b41dbaa0a5bdcb500c048ca501246}{langFrom} () const =0}
+\label{classCommonDictInterface_a7f8b41dbaa0a5bdcb500c048ca501246}
+
+\begin{DoxyCompactList}\small\item\em returns source language code iso 639-\/2 \item\end{DoxyCompactList}\item 
+\hypertarget{classCommonDictInterface_a9ca51f27e6f4fc159a733849d2434707}{
+virtual QString \hyperlink{classCommonDictInterface_a9ca51f27e6f4fc159a733849d2434707}{langTo} () const =0}
+\label{classCommonDictInterface_a9ca51f27e6f4fc159a733849d2434707}
+
+\begin{DoxyCompactList}\small\item\em returns destination language code iso 639-\/2 \item\end{DoxyCompactList}\item 
+\hypertarget{classCommonDictInterface_ab4ee01f92feb9cacb38cb3f326e7944a}{
+virtual QString \hyperlink{classCommonDictInterface_ab4ee01f92feb9cacb38cb3f326e7944a}{name} () const =0}
+\label{classCommonDictInterface_ab4ee01f92feb9cacb38cb3f326e7944a}
+
+\begin{DoxyCompactList}\small\item\em returns dictionary name (like \char`\"{}old english\char`\"{} or so \item\end{DoxyCompactList}\item 
+\hypertarget{classCommonDictInterface_af8739606ccb6314b40861f42bf45643d}{
+virtual QString \hyperlink{classCommonDictInterface_af8739606ccb6314b40861f42bf45643d}{type} () const =0}
+\label{classCommonDictInterface_af8739606ccb6314b40861f42bf45643d}
+
+\begin{DoxyCompactList}\small\item\em returns dictionary type (xdxf, google translate, etc) \item\end{DoxyCompactList}\item 
+\hypertarget{classCommonDictInterface_aedd525079e04426d5cad9f6b9e117191}{
+virtual QString \hyperlink{classCommonDictInterface_aedd525079e04426d5cad9f6b9e117191}{infoNote} () const =0}
+\label{classCommonDictInterface_aedd525079e04426d5cad9f6b9e117191}
+
+\begin{DoxyCompactList}\small\item\em returns information about dictionary in html (name, authors, etc) \item\end{DoxyCompactList}\item 
+virtual QDialog $\ast$ \hyperlink{classCommonDictInterface_a501cea622d6cb2344592bd06dcae0ac0}{loadDialog} ()=0
+\item 
+\hypertarget{classCommonDictInterface_a4771687035b2c4cb02ee37532b621907}{
+virtual QDialog $\ast$ \hyperlink{classCommonDictInterface_a4771687035b2c4cb02ee37532b621907}{settingsDialog} ()=0}
+\label{classCommonDictInterface_a4771687035b2c4cb02ee37532b621907}
+
+\begin{DoxyCompactList}\small\item\em return dialog with dictionary settings \item\end{DoxyCompactList}\item 
+\hypertarget{classCommonDictInterface_a319be492dd57d6e2828da2424cb57bb0}{
+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 
+\hypertarget{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}{
+virtual bool \hyperlink{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}{isAvailable} () const =0}
+\label{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}
+
+\begin{DoxyCompactList}\small\item\em returns whether plugin can start searching \item\end{DoxyCompactList}\item 
+virtual uint \hyperlink{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae65a}{hash} () const =0
+\end{DoxyCompactItemize}
+
+
+\subsection{Detailed Description}
+Interface for dict engines plugins. 
+
+\subsection{Member Function Documentation}
+\hypertarget{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae65a}{
+\index{CommonDictInterface@{CommonDictInterface}!hash@{hash}}
+\index{hash@{hash}!CommonDictInterface@{CommonDictInterface}}
+\subsubsection[{hash}]{\setlength{\rightskip}{0pt plus 5cm}virtual uint CommonDictInterface::hash () const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
+\label{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae65a}
+\begin{DoxyReturn}{Returns}
+unique value (unique for every dictionary not plugin 
+\end{DoxyReturn}
+\hypertarget{classCommonDictInterface_a501cea622d6cb2344592bd06dcae0ac0}{
+\index{CommonDictInterface@{CommonDictInterface}!loadDialog@{loadDialog}}
+\index{loadDialog@{loadDialog}!CommonDictInterface@{CommonDictInterface}}
+\subsubsection[{loadDialog}]{\setlength{\rightskip}{0pt plus 5cm}virtual QDialog$\ast$ CommonDictInterface::loadDialog ()\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
+\label{classCommonDictInterface_a501cea622d6cb2344592bd06dcae0ac0}
+return dialog that creates new dictionary and fills necesary options QDialog should returns Setting$\ast$ object after being showed \hypertarget{classCommonDictInterface_a23e1436f452272cf596e76957fe69796}{
+\index{CommonDictInterface@{CommonDictInterface}!search@{search}}
+\index{search@{search}!CommonDictInterface@{CommonDictInterface}}
+\subsubsection[{search}]{\setlength{\rightskip}{0pt plus 5cm}virtual void CommonDictInterface::search (QString {\em word}, \/  int {\em limit})\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual, slot\mbox{]}}}}
+\label{classCommonDictInterface_a23e1436f452272cf596e76957fe69796}
+
+
+performes search in dictionary 
+
+
+\begin{DoxyParams}{Parameters}
+\item[{\em word}]word to search in dictionary \item[{\em limit}]limit on number of results\end{DoxyParams}
+After finishing search it have to emit \begin{DoxySeeAlso}{See also}
+\hyperlink{classCommonDictInterface}{CommonDictInterface}:\hyperlink{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}{finalTranslation} \hyperlink{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}{finalTranslation} 
+\end{DoxySeeAlso}
+
+
+The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
+\item 
+CommonDictInterface.h\end{DoxyCompactItemize}