\hypertarget{class_ogre_1_1_param_dictionary}{}\doxysection{Ogre\+::Param\+Dictionary Class Reference}
\label{class_ogre_1_1_param_dictionary}\index{Ogre::ParamDictionary@{Ogre::ParamDictionary}}


Class to hold a dictionary of parameters for a single class.  




{\ttfamily \#include $<$Ogre\+String\+Interface.\+h$>$}

\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_param_dictionary_af3f46fdeacdb40c4dc234cd3540cd701}{Param\+Dictionary}} ()
\item 
void \mbox{\hyperlink{class_ogre_1_1_param_dictionary_a411fa9cc6ca47ea388307fdd7841f547}{add\+Parameter}} (const \mbox{\hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def}} \&param\+Def, \mbox{\hyperlink{class_ogre_1_1_param_command}{Param\+Command}} $\ast$param\+Cmd)
\begin{DoxyCompactList}\small\item\em Method for adding a parameter definition for this class. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List}} \& \mbox{\hyperlink{class_ogre_1_1_param_dictionary_a8daf849b675d97176b60034630fcd445}{get\+Parameters}} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a list of parameters valid for this object. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Friends}
\begin{DoxyCompactItemize}
\item 
class \mbox{\hyperlink{class_ogre_1_1_param_dictionary_af1037345f6c7a90f967a44cb1eb6dadc}{String\+Interface}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Class to hold a dictionary of parameters for a single class. 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_param_dictionary_af3f46fdeacdb40c4dc234cd3540cd701}\label{class_ogre_1_1_param_dictionary_af3f46fdeacdb40c4dc234cd3540cd701}} 
\index{Ogre::ParamDictionary@{Ogre::ParamDictionary}!ParamDictionary@{ParamDictionary}}
\index{ParamDictionary@{ParamDictionary}!Ogre::ParamDictionary@{Ogre::ParamDictionary}}
\doxysubsubsection{\texorpdfstring{ParamDictionary()}{ParamDictionary()}}
{\footnotesize\ttfamily Ogre\+::\+Param\+Dictionary\+::\+Param\+Dictionary (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_param_dictionary_a411fa9cc6ca47ea388307fdd7841f547}\label{class_ogre_1_1_param_dictionary_a411fa9cc6ca47ea388307fdd7841f547}} 
\index{Ogre::ParamDictionary@{Ogre::ParamDictionary}!addParameter@{addParameter}}
\index{addParameter@{addParameter}!Ogre::ParamDictionary@{Ogre::ParamDictionary}}
\doxysubsubsection{\texorpdfstring{addParameter()}{addParameter()}}
{\footnotesize\ttfamily void Ogre\+::\+Param\+Dictionary\+::add\+Parameter (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def}} \&}]{param\+Def,  }\item[{\mbox{\hyperlink{class_ogre_1_1_param_command}{Param\+Command}} $\ast$}]{param\+Cmd }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Method for adding a parameter definition for this class. 


\begin{DoxyParams}{Parameters}
{\em param\+Def} & A \mbox{\hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def}} object defining the parameter \\
\hline
{\em param\+Cmd} & Pointer to a \mbox{\hyperlink{class_ogre_1_1_param_command}{Param\+Command}} subclass to handle the getting / setting of this parameter. NB this class will not destroy this on shutdown, please ensure you do \\
\hline
\end{DoxyParams}


References Ogre\+::\+Parameter\+Def\+::name.

\mbox{\Hypertarget{class_ogre_1_1_param_dictionary_a8daf849b675d97176b60034630fcd445}\label{class_ogre_1_1_param_dictionary_a8daf849b675d97176b60034630fcd445}} 
\index{Ogre::ParamDictionary@{Ogre::ParamDictionary}!getParameters@{getParameters}}
\index{getParameters@{getParameters}!Ogre::ParamDictionary@{Ogre::ParamDictionary}}
\doxysubsubsection{\texorpdfstring{getParameters()}{getParameters()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List}}\& Ogre\+::\+Param\+Dictionary\+::get\+Parameters (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Retrieves a list of parameters valid for this object. 

\begin{DoxyReturn}{Returns}
A reference to a static list of \mbox{\hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def}} objects. 
\end{DoxyReturn}


\doxysubsection{Friends And Related Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_param_dictionary_af1037345f6c7a90f967a44cb1eb6dadc}\label{class_ogre_1_1_param_dictionary_af1037345f6c7a90f967a44cb1eb6dadc}} 
\index{Ogre::ParamDictionary@{Ogre::ParamDictionary}!StringInterface@{StringInterface}}
\index{StringInterface@{StringInterface}!Ogre::ParamDictionary@{Ogre::ParamDictionary}}
\doxysubsubsection{\texorpdfstring{StringInterface}{StringInterface}}
{\footnotesize\ttfamily friend class \mbox{\hyperlink{class_ogre_1_1_string_interface}{String\+Interface}}\hspace{0.3cm}{\ttfamily [friend]}}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_string_interface_8h}{Ogre\+String\+Interface.\+h}}\end{DoxyCompactItemize}
