Changed repo structure
[mdictionary] / doc / latex / classBookmarks.tex
diff --git a/doc/latex/classBookmarks.tex b/doc/latex/classBookmarks.tex
deleted file mode 100644 (file)
index 1648bbb..0000000
+++ /dev/null
@@ -1,118 +0,0 @@
-\hypertarget{classBookmarks}{
-\section{Bookmarks Class Reference}
-\label{classBookmarks}\index{Bookmarks@{Bookmarks}}
-}
-
-
-\hyperlink{classBookmarks}{Bookmarks} are way to store words that You think You will need to search for often.  
-
-
-
-
-{\ttfamily \#include $<$Bookmarks.h$>$}
-
-\subsection*{Public Member Functions}
-\begin{DoxyCompactItemize}
-\item 
-void \hyperlink{classBookmarks_a9683f8d17fe512b8db231c65e50a0849}{add} (\hyperlink{classTranslation}{Translation} $\ast$translation)
-\begin{DoxyCompactList}\small\item\em Adds new word and translation to bookmarks. \item\end{DoxyCompactList}\item 
-void \hyperlink{classBookmarks_a39e88874e5f250386e82340c954d71f8}{remove} (\hyperlink{classTranslation}{Translation} $\ast$translation)
-\begin{DoxyCompactList}\small\item\em Removes word and coresponding translation cache from bookmark list. \item\end{DoxyCompactList}\item 
-QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classBookmarks_a3c4e248e8d2f669d6f9095d84db78dda}{list} ()
-\item 
-QList$<$ \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classBookmarks_ae77e1a6e54a1a100f31b91cf419875be}{searchWordList} (QString word)
-\begin{DoxyCompactList}\small\item\em search in bookmarks for given word (wildcards may apply '$\ast$' and '?') \item\end{DoxyCompactList}\item 
-QStringList \hyperlink{classBookmarks_af8860f39cc06e8848d2f0eca07573148}{search} (QString word, QString dbname)
-\begin{DoxyCompactList}\small\item\em Search for final translation of given word. \item\end{DoxyCompactList}\item 
-\hypertarget{classBookmarks_ae92c866a7711e2e10c6ad42ae2ced0ad}{
-void \hyperlink{classBookmarks_ae92c866a7711e2e10c6ad42ae2ced0ad}{clear} ()}
-\label{classBookmarks_ae92c866a7711e2e10c6ad42ae2ced0ad}
-
-\begin{DoxyCompactList}\small\item\em clars bookmarks database \item\end{DoxyCompactList}\item 
-bool \hyperlink{classBookmarks_aea5612609b4a4ac0e56de73dcb38625e}{inBookmarks} (QString word)
-\end{DoxyCompactItemize}
-
-
-\subsection{Detailed Description}
-\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. 
-
-\subsection{Member Function Documentation}
-\hypertarget{classBookmarks_a9683f8d17fe512b8db231c65e50a0849}{
-\index{Bookmarks@{Bookmarks}!add@{add}}
-\index{add@{add}!Bookmarks@{Bookmarks}}
-\subsubsection[{add}]{\setlength{\rightskip}{0pt plus 5cm}void Bookmarks::add ({\bf Translation} $\ast$ {\em translation})}}
-\label{classBookmarks_a9683f8d17fe512b8db231c65e50a0849}
-
-
-Adds new word and translation to bookmarks. 
-
-
-\begin{DoxyParams}{Parameters}
-\item[{\em translation}]new translation to be saved and cached as a bookmark \end{DoxyParams}
-\hypertarget{classBookmarks_aea5612609b4a4ac0e56de73dcb38625e}{
-\index{Bookmarks@{Bookmarks}!inBookmarks@{inBookmarks}}
-\index{inBookmarks@{inBookmarks}!Bookmarks@{Bookmarks}}
-\subsubsection[{inBookmarks}]{\setlength{\rightskip}{0pt plus 5cm}bool Bookmarks::inBookmarks (QString {\em word})}}
-\label{classBookmarks_aea5612609b4a4ac0e56de73dcb38625e}
-\begin{DoxyReturn}{Returns}
-true if given word is already in bookmarks 
-\end{DoxyReturn}
-
-\begin{DoxyParams}{Parameters}
-\item[{\em word}]to check \end{DoxyParams}
-\hypertarget{classBookmarks_a3c4e248e8d2f669d6f9095d84db78dda}{
-\index{Bookmarks@{Bookmarks}!list@{list}}
-\index{list@{list}!Bookmarks@{Bookmarks}}
-\subsubsection[{list}]{\setlength{\rightskip}{0pt plus 5cm}QList$<$ {\bf Translation} $\ast$ $>$ Bookmarks::list ()}}
-\label{classBookmarks_a3c4e248e8d2f669d6f9095d84db78dda}
-\begin{DoxyReturn}{Returns}
-all bookmarks (word and translation as a translation object as a list 
-\end{DoxyReturn}
-\hypertarget{classBookmarks_a39e88874e5f250386e82340c954d71f8}{
-\index{Bookmarks@{Bookmarks}!remove@{remove}}
-\index{remove@{remove}!Bookmarks@{Bookmarks}}
-\subsubsection[{remove}]{\setlength{\rightskip}{0pt plus 5cm}void Bookmarks::remove ({\bf Translation} $\ast$ {\em translation})}}
-\label{classBookmarks_a39e88874e5f250386e82340c954d71f8}
-
-
-Removes word and coresponding translation cache from bookmark list. 
-
-
-\begin{DoxyParams}{Parameters}
-\item[{\em translation}]translation to be removed \end{DoxyParams}
-\hypertarget{classBookmarks_af8860f39cc06e8848d2f0eca07573148}{
-\index{Bookmarks@{Bookmarks}!search@{search}}
-\index{search@{search}!Bookmarks@{Bookmarks}}
-\subsubsection[{search}]{\setlength{\rightskip}{0pt plus 5cm}QStringList Bookmarks::search (QString {\em word}, \/  QString {\em dbname})}}
-\label{classBookmarks_af8860f39cc06e8848d2f0eca07573148}
-
-
-Search for final translation of given word. 
-
-\begin{DoxyReturn}{Returns}
-word translation list in text format xml or html to be formated and displayed 
-\end{DoxyReturn}
-
-\begin{DoxyParams}{Parameters}
-\item[{\em word}]word to search for \end{DoxyParams}
-\hypertarget{classBookmarks_ae77e1a6e54a1a100f31b91cf419875be}{
-\index{Bookmarks@{Bookmarks}!searchWordList@{searchWordList}}
-\index{searchWordList@{searchWordList}!Bookmarks@{Bookmarks}}
-\subsubsection[{searchWordList}]{\setlength{\rightskip}{0pt plus 5cm}QList$<$ {\bf Translation} $\ast$ $>$ Bookmarks::searchWordList (QString {\em word})}}
-\label{classBookmarks_ae77e1a6e54a1a100f31b91cf419875be}
-
-
-search in bookmarks for given word (wildcards may apply '$\ast$' and '?') 
-
-
-\begin{DoxyParams}{Parameters}
-\item[{\em word}]to search for \end{DoxyParams}
-\begin{DoxyReturn}{Returns}
-list of matching \hyperlink{classTranslation}{Translation} objects 
-\end{DoxyReturn}
-
-
-The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
-\item 
-Bookmarks.h\item 
-Bookmarks.cpp\end{DoxyCompactItemize}