Added documentation
[mdictionary] / doc / latex / classBookmarkTranslation.tex
1 \hypertarget{classBookmarkTranslation}{
2 \section{BookmarkTranslation Class Reference}
3 \label{classBookmarkTranslation}\index{BookmarkTranslation@{BookmarkTranslation}}
4 }
5
6
7 /file BookmarkTranslation.h  
8
9
10
11
12 {\ttfamily \#include $<$BookmarkTranslations.h$>$}
13
14 Inheritance diagram for BookmarkTranslation:\begin{figure}[H]
15 \begin{center}
16 \leavevmode
17 \includegraphics[height=2cm]{classBookmarkTranslation}
18 \end{center}
19 \end{figure}
20 \subsection*{Public Member Functions}
21 \begin{DoxyCompactItemize}
22 \item 
23 \hypertarget{classBookmarkTranslation_a17da49fbac39171fe41effdd6a627c8c}{
24 {\bfseries BookmarkTranslation} (QString key, \hyperlink{classBookmarks}{Bookmarks} $\ast$bookmarks, QString dbName)}
25 \label{classBookmarkTranslation_a17da49fbac39171fe41effdd6a627c8c}
26
27 \item 
28 QString \hyperlink{classBookmarkTranslation_a36a26169f2013b2baa8921803be8f583}{key} () const 
29 \item 
30 QString \hyperlink{classBookmarkTranslation_ab8bf0620bcdff42499f370c5914ec988}{dictionaryInfo} () const 
31 \item 
32 QString \hyperlink{classBookmarkTranslation_a2f610661252e7f7569fd95a2b1e73e40}{toHtml} () const 
33 \item 
34 void \hyperlink{classBookmarkTranslation_a617e4019609c0433746906281273cb24}{setKey} (QString key)
35 \begin{DoxyCompactList}\small\item\em sets the word for which we want to find a translation \item\end{DoxyCompactList}\item 
36 \hypertarget{classBookmarkTranslation_afcee088877e7a6df26512a9b1ddb62cf}{
37 void \hyperlink{classBookmarkTranslation_afcee088877e7a6df26512a9b1ddb62cf}{setDictionaryInfo} (QString dictionaryInfo)}
38 \label{classBookmarkTranslation_afcee088877e7a6df26512a9b1ddb62cf}
39
40 \begin{DoxyCompactList}\small\item\em sets information about dictionary \item\end{DoxyCompactList}\end{DoxyCompactItemize}
41
42
43 \subsection{Detailed Description}
44 /file BookmarkTranslation.h \hyperlink{classBookmarks}{Bookmarks} functionality needs its own translation object -\/ becouse \hyperlink{classTranslation}{Translation} object should use slighty different api of \hyperlink{classBookmarks}{Bookmarks} objects\begin{DoxyAuthor}{Author}
45 Bartosz Szatkowski $<$\href{mailto:bulislaw@linux.com}{\tt bulislaw@linux.com}$>$ 
46 \end{DoxyAuthor}
47
48
49 \subsection{Member Function Documentation}
50 \hypertarget{classBookmarkTranslation_ab8bf0620bcdff42499f370c5914ec988}{
51 \index{BookmarkTranslation@{BookmarkTranslation}!dictionaryInfo@{dictionaryInfo}}
52 \index{dictionaryInfo@{dictionaryInfo}!BookmarkTranslation@{BookmarkTranslation}}
53 \subsubsection[{dictionaryInfo}]{\setlength{\rightskip}{0pt plus 5cm}QString BookmarkTranslation::dictionaryInfo () const\hspace{0.3cm}{\ttfamily  \mbox{[}inline, virtual\mbox{]}}}}
54 \label{classBookmarkTranslation_ab8bf0620bcdff42499f370c5914ec988}
55 \begin{DoxyReturn}{Returns}
56 dictionary information (plugin name, languages, $<$logo$>$ etc)$\backslash$ to be displayed in translation table header 
57 \end{DoxyReturn}
58
59
60 Implements \hyperlink{classTranslation_a8d61ceaea454b600964299d58dac8ad7}{Translation}.
61
62 \hypertarget{classBookmarkTranslation_a36a26169f2013b2baa8921803be8f583}{
63 \index{BookmarkTranslation@{BookmarkTranslation}!key@{key}}
64 \index{key@{key}!BookmarkTranslation@{BookmarkTranslation}}
65 \subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}QString BookmarkTranslation::key () const\hspace{0.3cm}{\ttfamily  \mbox{[}inline, virtual\mbox{]}}}}
66 \label{classBookmarkTranslation_a36a26169f2013b2baa8921803be8f583}
67 \begin{DoxyReturn}{Returns}
68 word to be translated 
69 \end{DoxyReturn}
70
71
72 Implements \hyperlink{classTranslation_ad79cf5dcb94a31865ec3c31ed2eb5c55}{Translation}.
73
74 \hypertarget{classBookmarkTranslation_a617e4019609c0433746906281273cb24}{
75 \index{BookmarkTranslation@{BookmarkTranslation}!setKey@{setKey}}
76 \index{setKey@{setKey}!BookmarkTranslation@{BookmarkTranslation}}
77 \subsubsection[{setKey}]{\setlength{\rightskip}{0pt plus 5cm}void BookmarkTranslation::setKey (QString {\em key})\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
78 \label{classBookmarkTranslation_a617e4019609c0433746906281273cb24}
79
80
81 sets the word for which we want to find a translation 
82
83
84 \begin{DoxyParams}{Parameters}
85 \item[{\em word}]for which we want to find a translation \end{DoxyParams}
86 \hypertarget{classBookmarkTranslation_a2f610661252e7f7569fd95a2b1e73e40}{
87 \index{BookmarkTranslation@{BookmarkTranslation}!toHtml@{toHtml}}
88 \index{toHtml@{toHtml}!BookmarkTranslation@{BookmarkTranslation}}
89 \subsubsection[{toHtml}]{\setlength{\rightskip}{0pt plus 5cm}QString BookmarkTranslation::toHtml () const\hspace{0.3cm}{\ttfamily  \mbox{[}inline, virtual\mbox{]}}}}
90 \label{classBookmarkTranslation_a2f610661252e7f7569fd95a2b1e73e40}
91 \begin{DoxyReturn}{Returns}
92 parsed raw format into html 
93 \end{DoxyReturn}
94
95
96 Implements \hyperlink{classTranslation_acee3b3c3cdd8d1055f6d2e2c23c9bea0}{Translation}.
97
98
99
100 The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
101 \item 
102 BookmarkTranslations.h\end{DoxyCompactItemize}