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 \subsection*{Public Slots}
  15 \begin{DoxyCompactItemize}
  16 \item
  17 virtual void \hyperlink{classCommonDictInterface_a23e1436f452272cf596e76957fe69796}{search} (QString word, int limit)=0
  18 \begin{DoxyCompactList}\small\item\em performes search in dictionary \item\end{DoxyCompactList}\item
  19 \hypertarget{classCommonDictInterface_a017f37eed4270d37cd5df36e546aacc6}{
  20 virtual void \hyperlink{classCommonDictInterface_a017f37eed4270d37cd5df36e546aacc6}{stop} ()=0}
  21 \label{classCommonDictInterface_a017f37eed4270d37cd5df36e546aacc6}
  22
  23 \begin{DoxyCompactList}\small\item\em stop current operation \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  24 \subsection*{Signals}
  25 \begin{DoxyCompactItemize}
  26 \item
  27 \hypertarget{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}{
  28 void \hyperlink{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}{finalTranslation} (QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$)}
  29 \label{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}
  30
  31 \begin{DoxyCompactList}\small\item\em emit list of finded Translations \item\end{DoxyCompactList}\item
  32 \hypertarget{classCommonDictInterface_abeb1426ae67ac8bc43002756b0cc9308}{
  33 void \hyperlink{classCommonDictInterface_abeb1426ae67ac8bc43002756b0cc9308}{loaded} (\hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$)}
  34 \label{classCommonDictInterface_abeb1426ae67ac8bc43002756b0cc9308}
  35
  36 \begin{DoxyCompactList}\small\item\em emited after dictionary is ready to use afer being loaded \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  37 \subsection*{Public Member Functions}
  38 \begin{DoxyCompactItemize}
  39 \item
  40 \hypertarget{classCommonDictInterface_a7f8b41dbaa0a5bdcb500c048ca501246}{
  41 virtual QString \hyperlink{classCommonDictInterface_a7f8b41dbaa0a5bdcb500c048ca501246}{langFrom} () const =0}
  42 \label{classCommonDictInterface_a7f8b41dbaa0a5bdcb500c048ca501246}
  43
  44 \begin{DoxyCompactList}\small\item\em returns source language code iso 639-\/2 \item\end{DoxyCompactList}\item
  45 \hypertarget{classCommonDictInterface_a9ca51f27e6f4fc159a733849d2434707}{
  46 virtual QString \hyperlink{classCommonDictInterface_a9ca51f27e6f4fc159a733849d2434707}{langTo} () const =0}
  47 \label{classCommonDictInterface_a9ca51f27e6f4fc159a733849d2434707}
  48
  49 \begin{DoxyCompactList}\small\item\em returns destination language code iso 639-\/2 \item\end{DoxyCompactList}\item
  50 \hypertarget{classCommonDictInterface_ab4ee01f92feb9cacb38cb3f326e7944a}{
  51 virtual QString \hyperlink{classCommonDictInterface_ab4ee01f92feb9cacb38cb3f326e7944a}{name} () const =0}
  52 \label{classCommonDictInterface_ab4ee01f92feb9cacb38cb3f326e7944a}
  53
  54 \begin{DoxyCompactList}\small\item\em returns dictionary name (like \char`\"{}old english\char`\"{} or so \item\end{DoxyCompactList}\item
  55 \hypertarget{classCommonDictInterface_af8739606ccb6314b40861f42bf45643d}{
  56 virtual QString \hyperlink{classCommonDictInterface_af8739606ccb6314b40861f42bf45643d}{type} () const =0}
  57 \label{classCommonDictInterface_af8739606ccb6314b40861f42bf45643d}
  58
  59 \begin{DoxyCompactList}\small\item\em returns dictionary type (xdxf, google translate, etc) \item\end{DoxyCompactList}\item
  60 \hypertarget{classCommonDictInterface_aedd525079e04426d5cad9f6b9e117191}{
  61 virtual QString \hyperlink{classCommonDictInterface_aedd525079e04426d5cad9f6b9e117191}{infoNote} () const =0}
  62 \label{classCommonDictInterface_aedd525079e04426d5cad9f6b9e117191}
  63
  64 \begin{DoxyCompactList}\small\item\em returns information about dictionary in html (name, authors, etc) \item\end{DoxyCompactList}\item
  65 virtual QDialog $\ast$ \hyperlink{classCommonDictInterface_a501cea622d6cb2344592bd06dcae0ac0}{loadDialog} ()=0
  66 \item
  67 \hypertarget{classCommonDictInterface_a4771687035b2c4cb02ee37532b621907}{
  68 virtual QDialog $\ast$ \hyperlink{classCommonDictInterface_a4771687035b2c4cb02ee37532b621907}{settingsDialog} ()=0}
  69 \label{classCommonDictInterface_a4771687035b2c4cb02ee37532b621907}
  70
  71 \begin{DoxyCompactList}\small\item\em return dialog with dictionary settings \item\end{DoxyCompactList}\item
  72 \hypertarget{classCommonDictInterface_a319be492dd57d6e2828da2424cb57bb0}{
  73 virtual \hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$ \hyperlink{classCommonDictInterface_a319be492dd57d6e2828da2424cb57bb0}{getNew} (const \hyperlink{classSettings}{Settings} $\ast$) const =0}
  74 \label{classCommonDictInterface_a319be492dd57d6e2828da2424cb57bb0}
  75
  76 \begin{DoxyCompactList}\small\item\em return new, clean copy of plugin with setting set as in Settings$\ast$ \item\end{DoxyCompactList}\item
  77 \hypertarget{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}{
  78 virtual bool \hyperlink{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}{isAvailable} () const =0}
  79 \label{classCommonDictInterface_a72115c2e4a6c6e57d8adfbc240a2e942}
  80
  81 \begin{DoxyCompactList}\small\item\em returns whether plugin can start searching \item\end{DoxyCompactList}\item
  82 virtual uint \hyperlink{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae65a}{hash} () const =0
  83 \end{DoxyCompactItemize}
  84
  85
  86 \subsection{Detailed Description}
  87 Interface for dict engines plugins.
  88
  89 \subsection{Member Function Documentation}
  90 \hypertarget{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae65a}{
  91 \index{CommonDictInterface@{CommonDictInterface}!hash@{hash}}
  92 \index{hash@{hash}!CommonDictInterface@{CommonDictInterface}}
  93 \subsubsection[{hash}]{\setlength{\rightskip}{0pt plus 5cm}virtual uint CommonDictInterface::hash () const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
  94 \label{classCommonDictInterface_a0b58ce9f287e73155b3b4c43e81ae65a}
  95 \begin{DoxyReturn}{Returns}
  96 unique value (unique for every dictionary not plugin
  97 \end{DoxyReturn}
  98 \hypertarget{classCommonDictInterface_a501cea622d6cb2344592bd06dcae0ac0}{
  99 \index{CommonDictInterface@{CommonDictInterface}!loadDialog@{loadDialog}}
 100 \index{loadDialog@{loadDialog}!CommonDictInterface@{CommonDictInterface}}
 101 \subsubsection[{loadDialog}]{\setlength{\rightskip}{0pt plus 5cm}virtual QDialog$\ast$ CommonDictInterface::loadDialog ()\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
 102 \label{classCommonDictInterface_a501cea622d6cb2344592bd06dcae0ac0}
 103 return dialog that creates new dictionary and fills necesary options QDialog should returns Setting$\ast$ object after being showed \hypertarget{classCommonDictInterface_a23e1436f452272cf596e76957fe69796}{
 104 \index{CommonDictInterface@{CommonDictInterface}!search@{search}}
 105 \index{search@{search}!CommonDictInterface@{CommonDictInterface}}
 106 \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{]}}}}
 107 \label{classCommonDictInterface_a23e1436f452272cf596e76957fe69796}
 108
 109
 110 performes search in dictionary
 111
 112
 113 \begin{DoxyParams}{Parameters}
 114 \item[{\em word}]word to search in dictionary \item[{\em limit}]limit on number of results\end{DoxyParams}
 115 After finishing search it have to emit \begin{DoxySeeAlso}{See also}
 116 \hyperlink{classCommonDictInterface}{CommonDictInterface}:\hyperlink{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}{finalTranslation} \hyperlink{classCommonDictInterface_ae66cd415262fa4d3e9bd7bef776c197e}{finalTranslation}
 117 \end{DoxySeeAlso}
 118
 119
 120 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 121 \item
 122 CommonDictInterface.h\item
 123 moc\_\-CommonDictInterface.cpp\end{DoxyCompactItemize}