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

   1 \hypertarget{classBackbone}{
   2 \section{Backbone Class Reference}
   3 \label{classBackbone}\index{Backbone@{Backbone}}
   4 }
   5
   6
   7 Inner part of dictionary -\/ glues together GUI and plugins.
   8
   9
  10
  11
  12 {\ttfamily \#include $<$backbone.h$>$}
  13
  14 \subsection*{Public Slots}
  15 \begin{DoxyCompactItemize}
  16 \item
  17 \hypertarget{classBackbone_a1ede318bd5d226a8fa566f13452fb07d}{
  18 void \hyperlink{classBackbone_a1ede318bd5d226a8fa566f13452fb07d}{stopSearching} ()}
  19 \label{classBackbone_a1ede318bd5d226a8fa566f13452fb07d}
  20
  21 \begin{DoxyCompactList}\small\item\em stops all current searches \item\end{DoxyCompactList}\item
  22 \hypertarget{classBackbone_a3b1f2cf8de594cbd18bef4ca854337e2}{
  23 void \hyperlink{classBackbone_a3b1f2cf8de594cbd18bef4ca854337e2}{search} (QString word)}
  24 \label{classBackbone_a3b1f2cf8de594cbd18bef4ca854337e2}
  25
  26 \begin{DoxyCompactList}\small\item\em search for a word translation \item\end{DoxyCompactList}\item
  27 \hypertarget{classBackbone_ac23b486119652095d956413a6e68afec}{
  28 void \hyperlink{classBackbone_ac23b486119652095d956413a6e68afec}{selectedDictionaries} (QList$<$ \hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$ $>$)}
  29 \label{classBackbone_ac23b486119652095d956413a6e68afec}
  30
  31 \begin{DoxyCompactList}\small\item\em sets active dictionaries \item\end{DoxyCompactList}\item
  32 \hypertarget{classBackbone_af1f9ed9ee7f8b9e869092f2f9cd8cd3f}{
  33 void \hyperlink{classBackbone_af1f9ed9ee7f8b9e869092f2f9cd8cd3f}{addDictionary} (\hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$dict)}
  34 \label{classBackbone_af1f9ed9ee7f8b9e869092f2f9cd8cd3f}
  35
  36 \begin{DoxyCompactList}\small\item\em adds new dictionary \item\end{DoxyCompactList}\item
  37 \hypertarget{classBackbone_aa61afbf8ef2e05c0c2a9634fbdccad19}{
  38 void \hyperlink{classBackbone_aa61afbf8ef2e05c0c2a9634fbdccad19}{quit} ()}
  39 \label{classBackbone_aa61afbf8ef2e05c0c2a9634fbdccad19}
  40
  41 \begin{DoxyCompactList}\small\item\em stops all current activity and kill plugins -\/ be ready to exit \item\end{DoxyCompactList}\item
  42 \hypertarget{classBackbone_a1e78cb315afc4aefb1accae4fd2c865b}{
  43 void \hyperlink{classBackbone_a1e78cb315afc4aefb1accae4fd2c865b}{translation} ()}
  44 \label{classBackbone_a1e78cb315afc4aefb1accae4fd2c865b}
  45
  46 \begin{DoxyCompactList}\small\item\em Fired when dictionary call finalTranslation(..) with translation ready. \item\end{DoxyCompactList}\item
  47 \hypertarget{classBackbone_a056fc494ed689f253d83fc2366c07931}{
  48 void \hyperlink{classBackbone_a056fc494ed689f253d83fc2366c07931}{removeDictionary} (\hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$dict)}
  49 \label{classBackbone_a056fc494ed689f253d83fc2366c07931}
  50
  51 \begin{DoxyCompactList}\small\item\em Removes given dictionary. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  52 \subsection*{Signals}
  53 \begin{DoxyCompactItemize}
  54 \item
  55 void \hyperlink{classBackbone_afef04921ba89c424eb882cc14153de39}{closeOk} ()
  56 \item
  57 \hypertarget{classBackbone_ae50cec4f0c49149a46e913b31bcef92c}{
  58 void \hyperlink{classBackbone_ae50cec4f0c49149a46e913b31bcef92c}{ready} ()}
  59 \label{classBackbone_ae50cec4f0c49149a46e913b31bcef92c}
  60
  61 \begin{DoxyCompactList}\small\item\em emitted when there are search result ready to fetch \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  62 \subsection*{Public Member Functions}
  63 \begin{DoxyCompactItemize}
  64 \item
  65 \hypertarget{classBackbone_a738dad7741d990f8f51a1ffbbc4610c4}{
  66 {\bfseries Backbone} (QObject $\ast$parent=0)}
  67 \label{classBackbone_a738dad7741d990f8f51a1ffbbc4610c4}
  68
  69 \item
  70 \hypertarget{classBackbone_a6edbf4e5819dbc551ab54dad66f474f2}{
  71 {\bfseries Backbone} (const \hyperlink{classBackbone}{Backbone} \&b)}
  72 \label{classBackbone_a6edbf4e5819dbc551ab54dad66f474f2}
  73
  74 \item
  75 QHash$<$ \hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$, bool $>$ \hyperlink{classBackbone_a4b027f51bb4cc3803f6be85bc25d6a4b}{getDictionaries} ()
  76 \item
  77 QList$<$ \hyperlink{classCommonDictInterface}{CommonDictInterface} $\ast$ $>$ \hyperlink{classBackbone_a2fdfa0cf73fda5304635b61455b48db9}{getPlugins} ()
  78 \item
  79 QList$<$ QString $>$ \hyperlink{classBackbone_aad6c6a42de0c933f056354a5c6528f85}{getHistory} ()
  80 \item
  81 QMultiHash$<$ QString, \hyperlink{classTranslation}{Translation} $\ast$ $>$ \hyperlink{classBackbone_adeaabfee86975f65b8e728b8582caa35}{result} ()
  82 \item
  83 int \hyperlink{classBackbone_addad48903943006b6a4661169f80ee5a}{searchLimit} () const
  84 \item
  85 int \hyperlink{classBackbone_ad0ddecf22c51867e984cb4e6a745d67c}{activeSearches} () const
  86 \end{DoxyCompactItemize}
  87
  88
  89 \subsection{Detailed Description}
  90 Inner part of dictionary -\/ glues together GUI and plugins.
  91
  92 \subsection{Member Function Documentation}
  93 \hypertarget{classBackbone_ad0ddecf22c51867e984cb4e6a745d67c}{
  94 \index{Backbone@{Backbone}!activeSearches@{activeSearches}}
  95 \index{activeSearches@{activeSearches}!Backbone@{Backbone}}
  96 \subsubsection[{activeSearches}]{\setlength{\rightskip}{0pt plus 5cm}int Backbone::activeSearches () const}}
  97 \label{classBackbone_ad0ddecf22c51867e984cb4e6a745d67c}
  98 \begin{DoxyReturn}{Returns}
  99 number of active searches
 100 \end{DoxyReturn}
 101 \hypertarget{classBackbone_afef04921ba89c424eb882cc14153de39}{
 102 \index{Backbone@{Backbone}!closeOk@{closeOk}}
 103 \index{closeOk@{closeOk}!Backbone@{Backbone}}
 104 \subsubsection[{closeOk}]{\setlength{\rightskip}{0pt plus 5cm}void Backbone::closeOk ()\hspace{0.3cm}{\ttfamily  \mbox{[}signal\mbox{]}}}}
 105 \label{classBackbone_afef04921ba89c424eb882cc14153de39}
 106 emmited when backbone is ready to close -\/ after getting stop signal it should kill all threads and so on \hypertarget{classBackbone_a4b027f51bb4cc3803f6be85bc25d6a4b}{
 107 \index{Backbone@{Backbone}!getDictionaries@{getDictionaries}}
 108 \index{getDictionaries@{getDictionaries}!Backbone@{Backbone}}
 109 \subsubsection[{getDictionaries}]{\setlength{\rightskip}{0pt plus 5cm}QHash$<$ {\bf CommonDictInterface} $\ast$, bool $>$ Backbone::getDictionaries ()}}
 110 \label{classBackbone_a4b027f51bb4cc3803f6be85bc25d6a4b}
 111 \begin{DoxyReturn}{Returns}
 112 all loadded dictionaries with activity state flag
 113 \end{DoxyReturn}
 114 \hypertarget{classBackbone_aad6c6a42de0c933f056354a5c6528f85}{
 115 \index{Backbone@{Backbone}!getHistory@{getHistory}}
 116 \index{getHistory@{getHistory}!Backbone@{Backbone}}
 117 \subsubsection[{getHistory}]{\setlength{\rightskip}{0pt plus 5cm}QList$<$ QString $>$ Backbone::getHistory ()}}
 118 \label{classBackbone_aad6c6a42de0c933f056354a5c6528f85}
 119 \begin{DoxyReturn}{Returns}
 120 history of performed searches
 121 \end{DoxyReturn}
 122 \hypertarget{classBackbone_a2fdfa0cf73fda5304635b61455b48db9}{
 123 \index{Backbone@{Backbone}!getPlugins@{getPlugins}}
 124 \index{getPlugins@{getPlugins}!Backbone@{Backbone}}
 125 \subsubsection[{getPlugins}]{\setlength{\rightskip}{0pt plus 5cm}QList$<$ {\bf CommonDictInterface} $\ast$ $>$ Backbone::getPlugins ()}}
 126 \label{classBackbone_a2fdfa0cf73fda5304635b61455b48db9}
 127 \begin{DoxyReturn}{Returns}
 128 all loadded plugins
 129 \end{DoxyReturn}
 130 \hypertarget{classBackbone_adeaabfee86975f65b8e728b8582caa35}{
 131 \index{Backbone@{Backbone}!result@{result}}
 132 \index{result@{result}!Backbone@{Backbone}}
 133 \subsubsection[{result}]{\setlength{\rightskip}{0pt plus 5cm}QMultiHash$<$ QString, {\bf Translation} $\ast$ $>$ Backbone::result ()}}
 134 \label{classBackbone_adeaabfee86975f65b8e728b8582caa35}
 135 \begin{DoxyReturn}{Returns}
 136 return search fesult
 137 \end{DoxyReturn}
 138 \hypertarget{classBackbone_addad48903943006b6a4661169f80ee5a}{
 139 \index{Backbone@{Backbone}!searchLimit@{searchLimit}}
 140 \index{searchLimit@{searchLimit}!Backbone@{Backbone}}
 141 \subsubsection[{searchLimit}]{\setlength{\rightskip}{0pt plus 5cm}int Backbone::searchLimit () const}}
 142 \label{classBackbone_addad48903943006b6a4661169f80ee5a}
 143 \begin{DoxyReturn}{Returns}
 144 maximum number of word that plugin could find
 145 \end{DoxyReturn}
 146
 147
 148 The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
 149 \item
 150 backbone.h\item
 151 backbone.cpp\end{DoxyCompactItemize}