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

   1 \hypertarget{classTranslation}{
   2 \section{Translation Class Reference}
   3 \label{classTranslation}\index{Translation@{Translation}}
   4 }
   5
   6
   7 /file \hyperlink{translation_8h_source}{translation.h}
   8
   9
  10
  11
  12 {\ttfamily \#include $<$translation.h$>$}
  13
  14 Inheritance diagram for Translation:\begin{figure}[H]
  15 \begin{center}
  16 \leavevmode
  17 \includegraphics[height=2cm]{classTranslation}
  18 \end{center}
  19 \end{figure}
  20 \subsection*{Public Member Functions}
  21 \begin{DoxyCompactItemize}
  22 \item
  23 virtual QString \hyperlink{classTranslation_ad79cf5dcb94a31865ec3c31ed2eb5c55}{key} () const =0
  24 \item
  25 \hypertarget{classTranslation_a3f0cdfb6b44f44c7eecfd716b6163eb5}{
  26 bool {\bfseries operator==} (\hyperlink{classTranslation}{Translation} $\ast$translation)}
  27 \label{classTranslation_a3f0cdfb6b44f44c7eecfd716b6163eb5}
  28
  29 \item
  30 virtual QString \hyperlink{classTranslation_a8d61ceaea454b600964299d58dac8ad7}{dictionaryInfo} () const =0
  31 \item
  32 virtual QString \hyperlink{classTranslation_acee3b3c3cdd8d1055f6d2e2c23c9bea0}{toHtml} () const =0
  33 \item
  34 \hypertarget{classTranslation_a58a3168e903ad58cc0c86ebe4ba8e6e2}{
  35 bool \hyperlink{classTranslation_a58a3168e903ad58cc0c86ebe4ba8e6e2}{isBookmark} () const }
  36 \label{classTranslation_a58a3168e903ad58cc0c86ebe4ba8e6e2}
  37
  38 \begin{DoxyCompactList}\small\item\em whether given translation is taken from bookmarks \item\end{DoxyCompactList}\item
  39 void \hyperlink{classTranslation_a7e0c987ec4b10543084e26dbd9dd964d}{setBookmark} (bool b)
  40 \end{DoxyCompactItemize}
  41 \subsection*{Protected Attributes}
  42 \begin{DoxyCompactItemize}
  43 \item
  44 \hypertarget{classTranslation_aeddbbf7ea4d3cc4e96a2965a9acb7b90}{
  45 bool {\bfseries \_\-bookmark}}
  46 \label{classTranslation_aeddbbf7ea4d3cc4e96a2965a9acb7b90}
  47
  48 \end{DoxyCompactItemize}
  49
  50
  51 \subsection{Detailed Description}
  52 /file \hyperlink{translation_8h_source}{translation.h} Interface for translation instances\begin{DoxySeeAlso}{See also}
  53 \hyperlink{classTranslation}{Translation}
  54 \end{DoxySeeAlso}
  55 \begin{DoxyAuthor}{Author}
  56 Bartosz Szatkowski $<$\href{mailto:bulislaw@linux.com}{\tt bulislaw@linux.com}$>$
  57 \end{DoxyAuthor}
  58 \hyperlink{classTranslation}{Translation} is kind of GoF proxy, it stores key:translation pair and provide it in lazy way -\/$>$ key is available always, but translation is fetched as late as possible
  59
  60 \subsection{Member Function Documentation}
  61 \hypertarget{classTranslation_a8d61ceaea454b600964299d58dac8ad7}{
  62 \index{Translation@{Translation}!dictionaryInfo@{dictionaryInfo}}
  63 \index{dictionaryInfo@{dictionaryInfo}!Translation@{Translation}}
  64 \subsubsection[{dictionaryInfo}]{\setlength{\rightskip}{0pt plus 5cm}virtual QString Translation::dictionaryInfo () const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
  65 \label{classTranslation_a8d61ceaea454b600964299d58dac8ad7}
  66 \begin{DoxyReturn}{Returns}
  67 dictionary information (plugin name, languages, $<$logo$>$ etc)$\backslash$ to be displayed in translation table header
  68 \end{DoxyReturn}
  69
  70
  71 Implemented in \hyperlink{classBookmarkTranslation_ab8bf0620bcdff42499f370c5914ec988}{BookmarkTranslation}, and \hyperlink{classTranslationXdxf_a6ed8752805971610dc7c6cfc28366e9d}{TranslationXdxf}.
  72
  73 \hypertarget{classTranslation_ad79cf5dcb94a31865ec3c31ed2eb5c55}{
  74 \index{Translation@{Translation}!key@{key}}
  75 \index{key@{key}!Translation@{Translation}}
  76 \subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}virtual QString Translation::key () const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
  77 \label{classTranslation_ad79cf5dcb94a31865ec3c31ed2eb5c55}
  78 \begin{DoxyReturn}{Returns}
  79 word to be translated
  80 \end{DoxyReturn}
  81
  82
  83 Implemented in \hyperlink{classBookmarkTranslation_a36a26169f2013b2baa8921803be8f583}{BookmarkTranslation}, and \hyperlink{classTranslationXdxf_a66eb82634b0128ca003aaa2caa81555a}{TranslationXdxf}.
  84
  85 \hypertarget{classTranslation_a7e0c987ec4b10543084e26dbd9dd964d}{
  86 \index{Translation@{Translation}!setBookmark@{setBookmark}}
  87 \index{setBookmark@{setBookmark}!Translation@{Translation}}
  88 \subsubsection[{setBookmark}]{\setlength{\rightskip}{0pt plus 5cm}void Translation::setBookmark (bool {\em b})\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
  89 \label{classTranslation_a7e0c987ec4b10543084e26dbd9dd964d}
  90
  91 \begin{DoxyParams}{Parameters}
  92 \item[{\em b}]if true then translation is from bookmarks \end{DoxyParams}
  93 \hypertarget{classTranslation_acee3b3c3cdd8d1055f6d2e2c23c9bea0}{
  94 \index{Translation@{Translation}!toHtml@{toHtml}}
  95 \index{toHtml@{toHtml}!Translation@{Translation}}
  96 \subsubsection[{toHtml}]{\setlength{\rightskip}{0pt plus 5cm}virtual QString Translation::toHtml () const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
  97 \label{classTranslation_acee3b3c3cdd8d1055f6d2e2c23c9bea0}
  98 \begin{DoxyReturn}{Returns}
  99 parsed raw format into html
 100 \end{DoxyReturn}
 101
 102
 103 Implemented in \hyperlink{classBookmarkTranslation_a2f610661252e7f7569fd95a2b1e73e40}{BookmarkTranslation}, and \hyperlink{classTranslationXdxf_a136ccd2e4996a0463349333eb1fa9a92}{TranslationXdxf}.
 104
 105
 106
 107 The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
 108 \item
 109 translation.h\end{DoxyCompactItemize}