Added documentation
[mdictionary] / doc / latex / classSettings.tex
1 \hypertarget{classSettings}{
2 \section{Settings Class Reference}
3 \label{classSettings}\index{Settings@{Settings}}
4 }
5
6
7 Plugins or dictionaries may need to keep some of configuration between sessions, moreover \hyperlink{classBackbone}{Backbone} or GUI may want store some additional info in plugin \hyperlink{classSettings}{Settings}.  
8
9
10
11
12 {\ttfamily \#include $<$settings.h$>$}
13
14 \subsection*{Public Member Functions}
15 \begin{DoxyCompactItemize}
16 \item 
17 \hypertarget{classSettings_a12d2ccfdcd22802b6802e8273d33dc4f}{
18 {\bfseries Settings} (const \hyperlink{classSettings}{Settings} $\ast$set)}
19 \label{classSettings_a12d2ccfdcd22802b6802e8273d33dc4f}
20
21 \item 
22 QString \hyperlink{classSettings_ad20672a43255a3bec46b1bc085f2f6eb}{value} (const QString key) const 
23 \item 
24 \hypertarget{classSettings_ab7388c1a9a18e3afd79de5393ca9803a}{
25 void \hyperlink{classSettings_ab7388c1a9a18e3afd79de5393ca9803a}{setValue} (const QString key, const QString value)}
26 \label{classSettings_ab7388c1a9a18e3afd79de5393ca9803a}
27
28 \begin{DoxyCompactList}\small\item\em sets key to value \item\end{DoxyCompactList}\item 
29 \hypertarget{classSettings_a44ff7168f01375fa6ac0dff5d4d4a5f4}{
30 QList$<$ QString $>$ {\bfseries keys} () const }
31 \label{classSettings_a44ff7168f01375fa6ac0dff5d4d4a5f4}
32
33 \end{DoxyCompactItemize}
34
35
36 \subsection{Detailed Description}
37 Plugins or dictionaries may need to keep some of configuration between sessions, moreover \hyperlink{classBackbone}{Backbone} or GUI may want store some additional info in plugin \hyperlink{classSettings}{Settings}. Its important for plugin to store all information given it in \hyperlink{classSettings}{Settings}. 
38
39 \subsection{Member Function Documentation}
40 \hypertarget{classSettings_ad20672a43255a3bec46b1bc085f2f6eb}{
41 \index{Settings@{Settings}!value@{value}}
42 \index{value@{value}!Settings@{Settings}}
43 \subsubsection[{value}]{\setlength{\rightskip}{0pt plus 5cm}QString Settings::value (const QString {\em key}) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
44 \label{classSettings_ad20672a43255a3bec46b1bc085f2f6eb}
45 \begin{DoxyReturn}{Returns}
46 value fo given key 
47 \end{DoxyReturn}
48
49 \begin{DoxyParams}{Parameters}
50 \item[{\em key}]\end{DoxyParams}
51
52
53 The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
54 \item 
55 settings.h\end{DoxyCompactItemize}