git.maemo.org Git - mdictionary/blob - doc/latex/classXdxfPlugin.tex

   1 \hypertarget{classXdxfPlugin}{
   2 \section{XdxfPlugin Class Reference}
   3 \label{classXdxfPlugin}\index{XdxfPlugin@{XdxfPlugin}}
   4 }
   5 Inheritance diagram for XdxfPlugin:\begin{figure}[H]
   6 \begin{center}
   7 \leavevmode
   8 \includegraphics[height=2cm]{classXdxfPlugin}
   9 \end{center}
  10 \end{figure}
  11 \subsection*{Public Slots}
  12 \begin{DoxyCompactItemize}
  13 \item
  14 QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classXdxfPlugin_a538581955ba04d1316f1a8befab4d561}{searchWordList} (QString word, int limit=0)
  15 \begin{DoxyCompactList}\small\item\em performs search in dictionary \item\end{DoxyCompactList}\item
  16 \hypertarget{classXdxfPlugin_a93d9ca6bbd8cc5b5cbda418f6499025b}{
  17 void \hyperlink{classXdxfPlugin_a93d9ca6bbd8cc5b5cbda418f6499025b}{stop} ()}
  18 \label{classXdxfPlugin_a93d9ca6bbd8cc5b5cbda418f6499025b}
  19
  20 \begin{DoxyCompactList}\small\item\em stop current operation \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  21 \subsection*{Signals}
  22 \begin{DoxyCompactItemize}
  23 \item
  24 void \hyperlink{classXdxfPlugin_a7f3d10e661ecd0180a0e7f27c4254033}{updateCachingProgress} (int, int)
  25 \end{DoxyCompactItemize}
  26 \subsection*{Public Member Functions}
  27 \begin{DoxyCompactItemize}
  28 \item
  29 \hypertarget{classXdxfPlugin_a6cb6059f34448ba265aa57b3c995d2d6}{
  30 {\bfseries XdxfPlugin} (QObject $\ast$parent=0)}
  31 \label{classXdxfPlugin_a6cb6059f34448ba265aa57b3c995d2d6}
  32
  33 \item
  34 \hypertarget{classXdxfPlugin_a512b66dd3e147cc86a2bc3e9418104fc}{
  35 QString \hyperlink{classXdxfPlugin_a512b66dd3e147cc86a2bc3e9418104fc}{langFrom} () const }
  36 \label{classXdxfPlugin_a512b66dd3e147cc86a2bc3e9418104fc}
  37
  38 \begin{DoxyCompactList}\small\item\em returns source language code iso 639-\/2 \item\end{DoxyCompactList}\item
  39 \hypertarget{classXdxfPlugin_a6969b031c270fd556fcecf0e423c0895}{
  40 QString \hyperlink{classXdxfPlugin_a6969b031c270fd556fcecf0e423c0895}{langTo} () const }
  41 \label{classXdxfPlugin_a6969b031c270fd556fcecf0e423c0895}
  42
  43 \begin{DoxyCompactList}\small\item\em returns destination language code iso 639-\/2 \item\end{DoxyCompactList}\item
  44 \hypertarget{classXdxfPlugin_a860f2e7375797c80ed4a7eb8bdf1831b}{
  45 QString \hyperlink{classXdxfPlugin_a860f2e7375797c80ed4a7eb8bdf1831b}{name} () const }
  46 \label{classXdxfPlugin_a860f2e7375797c80ed4a7eb8bdf1831b}
  47
  48 \begin{DoxyCompactList}\small\item\em returns dictionary name (like \char`\"{}old english\char`\"{} or so) \item\end{DoxyCompactList}\item
  49 \hypertarget{classXdxfPlugin_a1ef22204eed844d74f90b7222a122c5d}{
  50 QString \hyperlink{classXdxfPlugin_a1ef22204eed844d74f90b7222a122c5d}{type} () const }
  51 \label{classXdxfPlugin_a1ef22204eed844d74f90b7222a122c5d}
  52
  53 \begin{DoxyCompactList}\small\item\em returns dictionary type (xdxf, google translate, etc) \item\end{DoxyCompactList}\item
  54 \hypertarget{classXdxfPlugin_ab3af2811d200d1901629e5fba8e64eb7}{
  55 QString \hyperlink{classXdxfPlugin_ab3af2811d200d1901629e5fba8e64eb7}{infoNote} () const }
  56 \label{classXdxfPlugin_ab3af2811d200d1901629e5fba8e64eb7}
  57
  58 \begin{DoxyCompactList}\small\item\em returns information about dictionary in html (name, authors, etc) \item\end{DoxyCompactList}\item
  59 \hypertarget{classXdxfPlugin_ac6cbb0ef522b93927de69e5bfe3f7600}{
  60 \hyperlink{classDictDialog}{DictDialog} $\ast$ \hyperlink{classXdxfPlugin_ac6cbb0ef522b93927de69e5bfe3f7600}{dictDialog} ()}
  61 \label{classXdxfPlugin_ac6cbb0ef522b93927de69e5bfe3f7600}
  62
  63 \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
  64 \hypertarget{classXdxfPlugin_a1c1fabf4653655f4f654e0ea31c14539}{
  65 \hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$ \hyperlink{classXdxfPlugin_a1c1fabf4653655f4f654e0ea31c14539}{getNew} (const \hyperlink{classSettings}{Settings} $\ast$) const }
  66 \label{classXdxfPlugin_a1c1fabf4653655f4f654e0ea31c14539}
  67
  68 \begin{DoxyCompactList}\small\item\em returns new, clean copy of plugin with setting set as in Settings$\ast$ \item\end{DoxyCompactList}\item
  69 \hypertarget{classXdxfPlugin_a0a57cddf8db03190a2a49492cc7f43f4}{
  70 bool \hyperlink{classXdxfPlugin_a0a57cddf8db03190a2a49492cc7f43f4}{isAvailable} () const }
  71 \label{classXdxfPlugin_a0a57cddf8db03190a2a49492cc7f43f4}
  72
  73 \begin{DoxyCompactList}\small\item\em returns whether plugin can start searching \item\end{DoxyCompactList}\item
  74 \hypertarget{classXdxfPlugin_a3439332c8624e64456c0b7b62c99bf42}{
  75 QString \hyperlink{classXdxfPlugin_a3439332c8624e64456c0b7b62c99bf42}{search} (QString key)}
  76 \label{classXdxfPlugin_a3439332c8624e64456c0b7b62c99bf42}
  77
  78 \begin{DoxyCompactList}\small\item\em returns a description of a word given by a QString \item\end{DoxyCompactList}\item
  79 \hypertarget{classXdxfPlugin_a5e83f29b2eff00598470bb4b82961973}{
  80 uint \hyperlink{classXdxfPlugin_a5e83f29b2eff00598470bb4b82961973}{hash} () const }
  81 \label{classXdxfPlugin_a5e83f29b2eff00598470bb4b82961973}
  82
  83 \begin{DoxyCompactList}\small\item\em returns a unique hash for a dictionary \item\end{DoxyCompactList}\item
  84 \hypertarget{classXdxfPlugin_a74b5d40e3fa217a10c6ba790a9433086}{
  85 void \hyperlink{classXdxfPlugin_a74b5d40e3fa217a10c6ba790a9433086}{setHash} (uint)}
  86 \label{classXdxfPlugin_a74b5d40e3fa217a10c6ba790a9433086}
  87
  88 \begin{DoxyCompactList}\small\item\em set unique value (unique for every dictionary not plugin) \item\end{DoxyCompactList}\item
  89 \hypertarget{classXdxfPlugin_a115e0b340b8f9a5099b8f2a4f755dbfc}{
  90 \hyperlink{classSettings}{Settings} $\ast$ \hyperlink{classXdxfPlugin_a115e0b340b8f9a5099b8f2a4f755dbfc}{settings} ()}
  91 \label{classXdxfPlugin_a115e0b340b8f9a5099b8f2a4f755dbfc}
  92
  93 \begin{DoxyCompactList}\small\item\em returns current plugin settings \item\end{DoxyCompactList}\item
  94 \hypertarget{classXdxfPlugin_aa52537c4bc22c3ea10ba53a716e9f8b0}{
  95 long \hyperlink{classXdxfPlugin_aa52537c4bc22c3ea10ba53a716e9f8b0}{wordsCount} ()}
  96 \label{classXdxfPlugin_aa52537c4bc22c3ea10ba53a716e9f8b0}
  97
  98 \begin{DoxyCompactList}\small\item\em returns words count in dictionary \item\end{DoxyCompactList}\item
  99 \hypertarget{classXdxfPlugin_a35802d08aadf5a070a7497008099ea47}{
 100 void \hyperlink{classXdxfPlugin_a35802d08aadf5a070a7497008099ea47}{setSettings} (\hyperlink{classSettings}{Settings} $\ast$)}
 101 \label{classXdxfPlugin_a35802d08aadf5a070a7497008099ea47}
 102
 103 \begin{DoxyCompactList}\small\item\em Sets new settings. \item\end{DoxyCompactList}\item
 104 \hypertarget{classXdxfPlugin_a7de7c4707ae4cd34f39c8f305c7cf348}{
 105 virtual QIcon $\ast$ \hyperlink{classXdxfPlugin_a7de7c4707ae4cd34f39c8f305c7cf348}{icon} ()}
 106 \label{classXdxfPlugin_a7de7c4707ae4cd34f39c8f305c7cf348}
 107
 108 \begin{DoxyCompactList}\small\item\em returns plugin icon \item\end{DoxyCompactList}\end{DoxyCompactItemize}
 109 \subsection*{Protected Member Functions}
 110 \begin{DoxyCompactItemize}
 111 \item
 112 \hypertarget{classXdxfPlugin_a7c13565b60ea9f1850b7de05961a3cec}{
 113 QString {\bfseries removeAccents} (QString)}
 114 \label{classXdxfPlugin_a7c13565b60ea9f1850b7de05961a3cec}
 115
 116 \end{DoxyCompactItemize}
 117
 118
 119 \subsection{Member Function Documentation}
 120 \hypertarget{classXdxfPlugin_a538581955ba04d1316f1a8befab4d561}{
 121 \index{XdxfPlugin@{XdxfPlugin}!searchWordList@{searchWordList}}
 122 \index{searchWordList@{searchWordList}!XdxfPlugin@{XdxfPlugin}}
 123 \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{]}}}}
 124 \label{classXdxfPlugin_a538581955ba04d1316f1a8befab4d561}
 125
 126
 127 performs search in dictionary
 128
 129
 130 \begin{DoxyParams}{Parameters}
 131 \item[{\em word}]word to search in dictionary \item[{\em limit}]limit on number of results\end{DoxyParams}
 132 After finishing search it has to emit \begin{DoxySeeAlso}{See also}
 133 \hyperlink{classCommonDictInterface}{CommonDictInterface}:finalTranslation finalTranslation
 134 \end{DoxySeeAlso}
 135
 136
 137 Implements \hyperlink{classCommonDictInterface_a27594c22d4df398e98af85b40b7407cb}{CommonDictInterface}.
 138
 139 \hypertarget{classXdxfPlugin_a7f3d10e661ecd0180a0e7f27c4254033}{
 140 \index{XdxfPlugin@{XdxfPlugin}!updateCachingProgress@{updateCachingProgress}}
 141 \index{updateCachingProgress@{updateCachingProgress}!XdxfPlugin@{XdxfPlugin}}
 142 \subsubsection[{updateCachingProgress}]{\setlength{\rightskip}{0pt plus 5cm}void XdxfPlugin::updateCachingProgress (int {\em \_\-t1}, \/  int {\em \_\-t2})\hspace{0.3cm}{\ttfamily  \mbox{[}signal\mbox{]}}}}
 143 \label{classXdxfPlugin_a7f3d10e661ecd0180a0e7f27c4254033}
 144 emited with percent count of caching progress, and time elapsed from last signal emit
 145
 146 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 147 \item
 148 xdxfplugin.h\item
 149 src/moc\_\-xdxfplugin.cpp\item
 150 xdxfplugin.cpp\item
 151 tests/moc\_\-xdxfplugin.cpp\end{DoxyCompactItemize}