vcs.maemo.org Git - mdictionary/blob - doc/latex/classCommonDictInterface.tex

   1 \hypertarget{classCommonDictInterface}{
   2 \section{CommonDictInterface Class Reference}
   3 \label{classCommonDictInterface}\index{CommonDictInterface@{CommonDictInterface}}
   4 }
   5
   6
   7 Interface for dict engines plugins.
   8
   9
  10
  11
  12 {\ttfamily \#include $<$CommonDictInterface.h$>$}
  13
  14 Inheritance diagram for CommonDictInterface:\begin{figure}[H]
  15 \begin{center}
  16 \leavevmode
  17 \includegraphics[height=2cm]{classCommonDictInterface}
  18 \end{center}
  19 \end{figure}
  20 \subsection*{Public Slots}
  21 \begin{DoxyCompactItemize}
  22 \item
  23 virtual QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classCommonDictInterface_a27594c22d4df398e98af85b40b7407cb}{searchWordList} (QString word, int limit=0)=0
  24 \begin{DoxyCompactList}\small\item\em performs search in dictionary \item\end{DoxyCompactList}\item
  25 \hypertarget{classCommonDictInterface_a017f37eed4270d37cd5df36e546aacc6}{
  26 virtual void \hyperlink{classCommonDictInterface_a017f37eed4270d37cd5df36e546aacc6}{stop} ()=0}
  27 \label{classCommonDictInterface_a017f37eed4270d37cd5df36e546aacc6}
  28
  29 \begin{DoxyCompactList}\small\item\em stops current operation \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  30 \subsection*{Signals}
  31 \begin{DoxyCompactItemize}
  32 \item
  33 \hypertarget{classCommonDictInterface_abeb1426ae67ac8bc43002756b0cc9308}{
  34 void \hyperlink{classCommonDictInterface_abeb1426ae67ac8bc43002756b0cc9308}{loaded} (\hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$)}
  35 \label{classCommonDictInterface_abeb1426ae67ac8bc43002756b0cc9308}
  36
  37 \begin{DoxyCompactList}\small\item\em emited after dictionary is ready to use afer being loaded \item\end{DoxyCompactList}\item
  38 \hypertarget{classCommonDictInterface_aeb500dfe5e18f544a01d5fa5352c3d36}{
  39 void \hyperlink{classCommonDictInterface_aeb500dfe5e18f544a01d5fa5352c3d36}{settingsChanged} ()}
  40 \label{classCommonDictInterface_aeb500dfe5e18f544a01d5fa5352c3d36}
  41
  42 \begin{DoxyCompactList}\small\item\em emited after change dictionary settings \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  43 \subsection*{Public Member Functions}
  44 \begin{DoxyCompactItemize}
  45 \item
  46 \hypertarget{classCommonDictInterface_a8c769e72d6832629d73c987ee9bb5840}{
  47 {\bfseries CommonDictInterface} (QObject $\ast$parent=0)}
  48 \label{classCommonDictInterface_a8c769e72d6832629d73c987ee9bb5840}
  49
  50 \item
  51 \hypertarget{classCommonDictInterface_a7f8b41dbaa0a5bdcb500c048ca501246}{
  52 virtual QString \hyperlink{classCommonDictInterface_a7f8b41dbaa0a5bdcb500c048ca501246}{langFrom} () const =0}
  53 \label{classCommonDictInterface_a7f8b41dbaa0a5bdcb500c048ca501246}
  54
  55 \begin{DoxyCompactList}\small\item\em returns source language code iso 639-\/2 \item\end{DoxyCompactList}\item
  56 \hypertarget{classCommonDictInterface_a9ca51f27e6f4fc159a733849d2434707}{
  57 virtual QString \hyperlink{classCommonDictInterface_a9ca51f27e6f4fc159a733849d2434707}{langTo} () const =0}
  58 \label{classCommonDictInterface_a9ca51f27e6f4fc159a733849d2434707}
  59
  60 \begin{DoxyCompactList}\small\item\em returns destination language code iso 639-\/2 \item\end{DoxyCompactList}\item
  61 \hypertarget{classCommonDictInterface_ab4ee01f92feb9cacb38cb3f326e7944a}{
  62 virtual QString \hyperlink{classCommonDictInterface_ab4ee01f92feb9cacb38cb3f326e7944a}{name} () const =0}
  63 \label{classCommonDictInterface_ab4ee01f92feb9cacb38cb3f326e7944a}
  64
  65 \begin{DoxyCompactList}\small\item\em returns dictionary name (like \char`\"{}old english\char`\"{} or so \item\end{DoxyCompactList}\item
  66 \hypertarget{classCommonDictInterface_af8739606ccb6314b40861f42bf45643d}{
  67 virtual QString \hyperlink{classCommonDictInterface_af8739606ccb6314b40861f42bf45643d}{type} () const =0}
  68 \label{classCommonDictInterface_af8739606ccb6314b40861f42bf45643d}
  69
  70 \begin{DoxyCompactList}\small\item\em returns dictionary type (xdxf, google translate, etc) \item\end{DoxyCompactList}\item
  71 \hypertarget{classCommonDictInterface_aedd525079e04426d5cad9f6b9e117191}{
  72 virtual QString \hyperlink{classCommonDictInterface_aedd525079e04426d5cad9f6b9e117191}{infoNote} () const =0}
  73 \label{classCommonDictInterface_aedd525079e04426d5cad9f6b9e117191}
  74
  75 \begin{DoxyCompactList}\small\item\em returns information about dictionary in html (name, authors, etc) \item\end{DoxyCompactList}\item
  76 \hypertarget{classCommonDictInterface_adbbe216cdb93e0324cf4a6946e8e7af1}{
  77 virtual \hyperlink{classDictDialog}{DictDialog} $\ast$ \hyperlink{classCommonDictInterface_adbbe216cdb93e0324cf4a6946e8e7af1}{dictDialog} ()=0}
  78 \label{classCommonDictInterface_adbbe216cdb93e0324cf4a6946e8e7af1}
  79
  80 \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
  81 \hypertarget{classCommonDictInterface_a319be492dd57d6e2828da2424cb57bb0}{
  82 virtual \hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$ \hyperlink{classCommonDictInterface_a319be492dd57d6e2828da2424cb57bb0}{getNew} (const \hyperlink{classSettings}{Settings} $\ast$) const =0}
  83 \label{classCommonDictInterface_a319be492dd57d6e2828da2424cb57bb0}
  84
  85 \begin{DoxyCompactList}\small\item\em returns new, clean copy of plugin with setting set as in Settings$\ast$ \item\end{DoxyCompactList}\item
  86 \hypertarget{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}{
  87 virtual bool \hyperlink{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}{isAvailable} () const =0}
  88 \label{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}
  89
  90 \begin{DoxyCompactList}\small\item\em returns whether plugin can start searching \item\end{DoxyCompactList}\item
  91 \hypertarget{classCommonDictInterface_af40b38d2c1eafd7f5dd70d29e8333f81}{
  92 virtual QString \hyperlink{classCommonDictInterface_af40b38d2c1eafd7f5dd70d29e8333f81}{search} (QString key)=0}
  93 \label{classCommonDictInterface_af40b38d2c1eafd7f5dd70d29e8333f81}
  94
  95 \begin{DoxyCompactList}\small\item\em returns the actual translation of a word given in key \item\end{DoxyCompactList}\item
  96 virtual uint \hyperlink{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae65a}{hash} () const =0
  97 \item
  98 \hypertarget{classCommonDictInterface_a3ccd6318ae40727de5e66a92cf2fc95e}{
  99 virtual void \hyperlink{classCommonDictInterface_a3ccd6318ae40727de5e66a92cf2fc95e}{setHash} (uint)=0}
 100 \label{classCommonDictInterface_a3ccd6318ae40727de5e66a92cf2fc95e}
 101
 102 \begin{DoxyCompactList}\small\item\em sets unique value (unique for every dictionary not plugin) \item\end{DoxyCompactList}\item
 103 \hypertarget{classCommonDictInterface_a7a20fee14fa5255a1e34e213c93afbe7}{
 104 virtual \hyperlink{classSettings}{Settings} $\ast$ \hyperlink{classCommonDictInterface_a7a20fee14fa5255a1e34e213c93afbe7}{settings} ()=0}
 105 \label{classCommonDictInterface_a7a20fee14fa5255a1e34e213c93afbe7}
 106
 107 \begin{DoxyCompactList}\small\item\em returns current plugin settings \item\end{DoxyCompactList}\item
 108 \hypertarget{classCommonDictInterface_afb5213c49053122f9d8c6d0c1d2c222d}{
 109 virtual QIcon $\ast$ \hyperlink{classCommonDictInterface_afb5213c49053122f9d8c6d0c1d2c222d}{icon} ()=0}
 110 \label{classCommonDictInterface_afb5213c49053122f9d8c6d0c1d2c222d}
 111
 112 \begin{DoxyCompactList}\small\item\em returns plugin icon \item\end{DoxyCompactList}\end{DoxyCompactItemize}
 113
 114
 115 \subsection{Detailed Description}
 116 Interface for dict engines plugins.
 117
 118 \subsection{Member Function Documentation}
 119 \hypertarget{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae65a}{
 120 \index{CommonDictInterface@{CommonDictInterface}!hash@{hash}}
 121 \index{hash@{hash}!CommonDictInterface@{CommonDictInterface}}
 122 \subsubsection[{hash}]{\setlength{\rightskip}{0pt plus 5cm}virtual uint CommonDictInterface::hash () const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
 123 \label{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae65a}
 124 \begin{DoxyReturn}{Returns}
 125 unique value (unique for every dictionary not plugin
 126 \end{DoxyReturn}
 127
 128
 129 Implemented in \hyperlink{classXdxfPlugin_a5e83f29b2eff00598470bb4b82961973}{XdxfPlugin}.
 130
 131 \hypertarget{classCommonDictInterface_a27594c22d4df398e98af85b40b7407cb}{
 132 \index{CommonDictInterface@{CommonDictInterface}!searchWordList@{searchWordList}}
 133 \index{searchWordList@{searchWordList}!CommonDictInterface@{CommonDictInterface}}
 134 \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{]}}}}
 135 \label{classCommonDictInterface_a27594c22d4df398e98af85b40b7407cb}
 136
 137
 138 performs search in dictionary
 139
 140
 141 \begin{DoxyParams}{Parameters}
 142 \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}
 143 After finishing search it have to emit \begin{DoxySeeAlso}{See also}
 144 \hyperlink{classCommonDictInterface}{CommonDictInterface}:finalTranslation finalTranslation
 145 \end{DoxySeeAlso}
 146
 147
 148 Implemented in \hyperlink{classXdxfPlugin_a538581955ba04d1316f1a8befab4d561}{XdxfPlugin}.
 149
 150
 151
 152 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 153 \item
 154 CommonDictInterface.h\item
 155 base/moc\_\-CommonDictInterface.cpp\item
 156 base-\/build-\/desktop/moc\_\-CommonDictInterface.cpp\item
 157 plugins/xdxf/src/moc\_\-CommonDictInterface.cpp\item
 158 plugins/xdxf/tests/moc\_\-CommonDictInterface.cpp\end{DoxyCompactItemize}