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

   1 \hypertarget{classBookmarks}{
   2 \section{Bookmarks Class Reference}
   3 \label{classBookmarks}\index{Bookmarks@{Bookmarks}}
   4 }
   5
   6
   7 \hyperlink{classBookmarks}{Bookmarks} are way to store words that You think You will need to search for often.
   8
   9
  10
  11
  12 {\ttfamily \#include $<$Bookmarks.h$>$}
  13
  14 \subsection*{Public Member Functions}
  15 \begin{DoxyCompactItemize}
  16 \item
  17 void \hyperlink{classBookmarks_a9683f8d17fe512b8db231c65e50a0849}{add} (\hyperlink{classTranslation}{Translation} $\ast$translation)
  18 \begin{DoxyCompactList}\small\item\em Adds new word and translation to bookmarks. \item\end{DoxyCompactList}\item
  19 void \hyperlink{classBookmarks_a39e88874e5f250386e82340c954d71f8}{remove} (\hyperlink{classTranslation}{Translation} $\ast$translation)
  20 \begin{DoxyCompactList}\small\item\em Removes word and coresponding translation cache from bookmark list. \item\end{DoxyCompactList}\item
  21 QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classBookmarks_a3c4e248e8d2f669d6f9095d84db78dda}{list} ()
  22 \item
  23 QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classBookmarks_ae77e1a6e54a1a100f31b91cf419875be}{searchWordList} (QString word)
  24 \begin{DoxyCompactList}\small\item\em search in bookmarks for given word (wildcards may apply '$\ast$' and '?') \item\end{DoxyCompactList}\item
  25 QStringList \hyperlink{classBookmarks_af8860f39cc06e8848d2f0eca07573148}{search} (QString word, QString dbname)
  26 \begin{DoxyCompactList}\small\item\em Search for final translation of given word. \item\end{DoxyCompactList}\item
  27 \hypertarget{classBookmarks_ae92c866a7711e2e10c6ad42ae2ced0ad}{
  28 void \hyperlink{classBookmarks_ae92c866a7711e2e10c6ad42ae2ced0ad}{clear} ()}
  29 \label{classBookmarks_ae92c866a7711e2e10c6ad42ae2ced0ad}
  30
  31 \begin{DoxyCompactList}\small\item\em clars bookmarks database \item\end{DoxyCompactList}\item
  32 bool \hyperlink{classBookmarks_aea5612609b4a4ac0e56de73dcb38625e}{inBookmarks} (QString word)
  33 \end{DoxyCompactItemize}
  34
  35
  36 \subsection{Detailed Description}
  37 \hyperlink{classBookmarks}{Bookmarks} are way to store words that You think You will need to search for often. When You add bookmark (by clickin on \char`\"{}star\char`\"{} in words list) You adds it to special list with cached translations from all available dictionaries so You can search for them quickly even when You delete coresponding dict.
  38
  39 \subsection{Member Function Documentation}
  40 \hypertarget{classBookmarks_a9683f8d17fe512b8db231c65e50a0849}{
  41 \index{Bookmarks@{Bookmarks}!add@{add}}
  42 \index{add@{add}!Bookmarks@{Bookmarks}}
  43 \subsubsection[{add}]{\setlength{\rightskip}{0pt plus 5cm}void Bookmarks::add ({\bf Translation} $\ast$ {\em translation})}}
  44 \label{classBookmarks_a9683f8d17fe512b8db231c65e50a0849}
  45
  46
  47 Adds new word and translation to bookmarks.
  48
  49
  50 \begin{DoxyParams}{Parameters}
  51 \item[{\em translation}]new translation to be saved and cached as a bookmark \end{DoxyParams}
  52 \hypertarget{classBookmarks_aea5612609b4a4ac0e56de73dcb38625e}{
  53 \index{Bookmarks@{Bookmarks}!inBookmarks@{inBookmarks}}
  54 \index{inBookmarks@{inBookmarks}!Bookmarks@{Bookmarks}}
  55 \subsubsection[{inBookmarks}]{\setlength{\rightskip}{0pt plus 5cm}bool Bookmarks::inBookmarks (QString {\em word})}}
  56 \label{classBookmarks_aea5612609b4a4ac0e56de73dcb38625e}
  57 \begin{DoxyReturn}{Returns}
  58 true if given word is already in bookmarks
  59 \end{DoxyReturn}
  60
  61 \begin{DoxyParams}{Parameters}
  62 \item[{\em word}]to check \end{DoxyParams}
  63 \hypertarget{classBookmarks_a3c4e248e8d2f669d6f9095d84db78dda}{
  64 \index{Bookmarks@{Bookmarks}!list@{list}}
  65 \index{list@{list}!Bookmarks@{Bookmarks}}
  66 \subsubsection[{list}]{\setlength{\rightskip}{0pt plus 5cm}QList$<$ {\bf Translation} $\ast$ $>$ Bookmarks::list ()}}
  67 \label{classBookmarks_a3c4e248e8d2f669d6f9095d84db78dda}
  68 \begin{DoxyReturn}{Returns}
  69 all bookmarks (word and translation as a translation object as a list
  70 \end{DoxyReturn}
  71 \hypertarget{classBookmarks_a39e88874e5f250386e82340c954d71f8}{
  72 \index{Bookmarks@{Bookmarks}!remove@{remove}}
  73 \index{remove@{remove}!Bookmarks@{Bookmarks}}
  74 \subsubsection[{remove}]{\setlength{\rightskip}{0pt plus 5cm}void Bookmarks::remove ({\bf Translation} $\ast$ {\em translation})}}
  75 \label{classBookmarks_a39e88874e5f250386e82340c954d71f8}
  76
  77
  78 Removes word and coresponding translation cache from bookmark list.
  79
  80
  81 \begin{DoxyParams}{Parameters}
  82 \item[{\em translation}]translation to be removed \end{DoxyParams}
  83 \hypertarget{classBookmarks_af8860f39cc06e8848d2f0eca07573148}{
  84 \index{Bookmarks@{Bookmarks}!search@{search}}
  85 \index{search@{search}!Bookmarks@{Bookmarks}}
  86 \subsubsection[{search}]{\setlength{\rightskip}{0pt plus 5cm}QStringList Bookmarks::search (QString {\em word}, \/  QString {\em dbname})}}
  87 \label{classBookmarks_af8860f39cc06e8848d2f0eca07573148}
  88
  89
  90 Search for final translation of given word.
  91
  92 \begin{DoxyReturn}{Returns}
  93 word translation list in text format xml or html to be formated and displayed
  94 \end{DoxyReturn}
  95
  96 \begin{DoxyParams}{Parameters}
  97 \item[{\em word}]word to search for \end{DoxyParams}
  98 \hypertarget{classBookmarks_ae77e1a6e54a1a100f31b91cf419875be}{
  99 \index{Bookmarks@{Bookmarks}!searchWordList@{searchWordList}}
 100 \index{searchWordList@{searchWordList}!Bookmarks@{Bookmarks}}
 101 \subsubsection[{searchWordList}]{\setlength{\rightskip}{0pt plus 5cm}QList$<$ {\bf Translation} $\ast$ $>$ Bookmarks::searchWordList (QString {\em word})}}
 102 \label{classBookmarks_ae77e1a6e54a1a100f31b91cf419875be}
 103
 104
 105 search in bookmarks for given word (wildcards may apply '$\ast$' and '?')
 106
 107
 108 \begin{DoxyParams}{Parameters}
 109 \item[{\em word}]to search for \end{DoxyParams}
 110 \begin{DoxyReturn}{Returns}
 111 list of matching \hyperlink{classTranslation}{Translation} objects
 112 \end{DoxyReturn}
 113
 114
 115 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 116 \item
 117 Bookmarks.h\item
 118 Bookmarks.cpp\end{DoxyCompactItemize}