Merge branch 'master' of ssh://drop.maemo.org/git/mdictionary into xdxf

[mdictionary] / doc / latex / classXdxfPlugin.tex

diff --git a/doc/latex/classXdxfPlugin.tex b/doc/latex/classXdxfPlugin.tex
new file mode 100644 (file)
index 0000000..d572191
--- /dev/null
+++ b/doc/latex/classXdxfPlugin.tex
@@ -0,0 +1,116 @@
+\hypertarget{classXdxfPlugin}{
+\section{XdxfPlugin Class Reference}
+\label{classXdxfPlugin}\index{XdxfPlugin@{XdxfPlugin}}
+}
+Inheritance diagram for XdxfPlugin:\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[height=2cm]{classXdxfPlugin}
+\end{center}
+\end{figure}
+\subsection*{Public Slots}
+\begin{DoxyCompactItemize}
+\item 
+QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classXdxfPlugin_a538581955ba04d1316f1a8befab4d561}{searchWordList} (QString word, int limit=0)
+\begin{DoxyCompactList}\small\item\em performs search in dictionary \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a93d9ca6bbd8cc5b5cbda418f6499025b}{
+void \hyperlink{classXdxfPlugin_a93d9ca6bbd8cc5b5cbda418f6499025b}{stop} ()}
+\label{classXdxfPlugin_a93d9ca6bbd8cc5b5cbda418f6499025b}
+
+\begin{DoxyCompactList}\small\item\em stop current operation \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+\subsection*{Public Member Functions}
+\begin{DoxyCompactItemize}
+\item 
+\hypertarget{classXdxfPlugin_a6cb6059f34448ba265aa57b3c995d2d6}{
+{\bfseries XdxfPlugin} (QObject $\ast$parent=0)}
+\label{classXdxfPlugin_a6cb6059f34448ba265aa57b3c995d2d6}
+
+\item 
+\hypertarget{classXdxfPlugin_a512b66dd3e147cc86a2bc3e9418104fc}{
+QString \hyperlink{classXdxfPlugin_a512b66dd3e147cc86a2bc3e9418104fc}{langFrom} () const }
+\label{classXdxfPlugin_a512b66dd3e147cc86a2bc3e9418104fc}
+
+\begin{DoxyCompactList}\small\item\em returns source language code iso 639-\/2 \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a6969b031c270fd556fcecf0e423c0895}{
+QString \hyperlink{classXdxfPlugin_a6969b031c270fd556fcecf0e423c0895}{langTo} () const }
+\label{classXdxfPlugin_a6969b031c270fd556fcecf0e423c0895}
+
+\begin{DoxyCompactList}\small\item\em returns destination language code iso 639-\/2 \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a860f2e7375797c80ed4a7eb8bdf1831b}{
+QString \hyperlink{classXdxfPlugin_a860f2e7375797c80ed4a7eb8bdf1831b}{name} () const }
+\label{classXdxfPlugin_a860f2e7375797c80ed4a7eb8bdf1831b}
+
+\begin{DoxyCompactList}\small\item\em returns dictionary name (like \char`\"{}old english\char`\"{} or so) \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a1ef22204eed844d74f90b7222a122c5d}{
+QString \hyperlink{classXdxfPlugin_a1ef22204eed844d74f90b7222a122c5d}{type} () const }
+\label{classXdxfPlugin_a1ef22204eed844d74f90b7222a122c5d}
+
+\begin{DoxyCompactList}\small\item\em returns dictionary type (xdxf, google translate, etc) \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_ab3af2811d200d1901629e5fba8e64eb7}{
+QString \hyperlink{classXdxfPlugin_ab3af2811d200d1901629e5fba8e64eb7}{infoNote} () const }
+\label{classXdxfPlugin_ab3af2811d200d1901629e5fba8e64eb7}
+
+\begin{DoxyCompactList}\small\item\em returns information about dictionary in html (name, authors, etc) \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_ac6cbb0ef522b93927de69e5bfe3f7600}{
+\hyperlink{classDictDialog}{DictDialog} $\ast$ \hyperlink{classXdxfPlugin_ac6cbb0ef522b93927de69e5bfe3f7600}{dictDialog} ()}
+\label{classXdxfPlugin_ac6cbb0ef522b93927de69e5bfe3f7600}
+
+\begin{DoxyCompactList}\small\item\em returns \hyperlink{classDictDialog}{DictDialog} object that creates dialogs for adding new dictionary and change plugin settings \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a1c1fabf4653655f4f654e0ea31c14539}{
+\hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$ \hyperlink{classXdxfPlugin_a1c1fabf4653655f4f654e0ea31c14539}{getNew} (const \hyperlink{classSettings}{Settings} $\ast$) const }
+\label{classXdxfPlugin_a1c1fabf4653655f4f654e0ea31c14539}
+
+\begin{DoxyCompactList}\small\item\em returns new, clean copy of plugin with setting set as in Settings$\ast$ \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a0a57cddf8db03190a2a49492cc7f43f4}{
+bool \hyperlink{classXdxfPlugin_a0a57cddf8db03190a2a49492cc7f43f4}{isAvailable} () const }
+\label{classXdxfPlugin_a0a57cddf8db03190a2a49492cc7f43f4}
+
+\begin{DoxyCompactList}\small\item\em returns whether plugin can start searching \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a3439332c8624e64456c0b7b62c99bf42}{
+QString \hyperlink{classXdxfPlugin_a3439332c8624e64456c0b7b62c99bf42}{search} (QString key)}
+\label{classXdxfPlugin_a3439332c8624e64456c0b7b62c99bf42}
+
+\begin{DoxyCompactList}\small\item\em returns a description of a word given by a QString \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a5e83f29b2eff00598470bb4b82961973}{
+uint \hyperlink{classXdxfPlugin_a5e83f29b2eff00598470bb4b82961973}{hash} () const }
+\label{classXdxfPlugin_a5e83f29b2eff00598470bb4b82961973}
+
+\begin{DoxyCompactList}\small\item\em returns a unique hash for a dictionary \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a74b5d40e3fa217a10c6ba790a9433086}{
+void \hyperlink{classXdxfPlugin_a74b5d40e3fa217a10c6ba790a9433086}{setHash} (uint)}
+\label{classXdxfPlugin_a74b5d40e3fa217a10c6ba790a9433086}
+
+\begin{DoxyCompactList}\small\item\em set unique value (unique for every dictionary not plugin) \item\end{DoxyCompactList}\item 
+\hypertarget{classXdxfPlugin_a115e0b340b8f9a5099b8f2a4f755dbfc}{
+\hyperlink{classSettings}{Settings} $\ast$ \hyperlink{classXdxfPlugin_a115e0b340b8f9a5099b8f2a4f755dbfc}{settings} ()}
+\label{classXdxfPlugin_a115e0b340b8f9a5099b8f2a4f755dbfc}
+
+\begin{DoxyCompactList}\small\item\em returns current plugin settings \item\end{DoxyCompactList}\end{DoxyCompactItemize}
+
+
+\subsection{Member Function Documentation}
+\hypertarget{classXdxfPlugin_a538581955ba04d1316f1a8befab4d561}{
+\index{XdxfPlugin@{XdxfPlugin}!searchWordList@{searchWordList}}
+\index{searchWordList@{searchWordList}!XdxfPlugin@{XdxfPlugin}}
+\subsubsection[{searchWordList}]{\setlength{\rightskip}{0pt plus 5cm}QList$<$ {\bf Translation} $\ast$ $>$ XdxfPlugin::searchWordList (QString {\em word}, \/  int {\em limit} = {\ttfamily 0})\hspace{0.3cm}{\ttfamily  \mbox{[}virtual, slot\mbox{]}}}}
+\label{classXdxfPlugin_a538581955ba04d1316f1a8befab4d561}
+
+
+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}
+After finishing search it has to emit \begin{DoxySeeAlso}{See also}
+\hyperlink{classCommonDictInterface}{CommonDictInterface}:finalTranslation finalTranslation 
+\end{DoxySeeAlso}
+
+
+Implements \hyperlink{classCommonDictInterface_a3ca9313571e0ecab66ce7a7c5d356f4f}{CommonDictInterface}.
+
+
+
+The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
+\item 
+xdxfplugin.h\item 
+xdxfplugin.cpp\end{DoxyCompactItemize}