summaryrefslogtreecommitdiff
path: root/doc/latex/classcMenuSetupUPnP.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/latex/classcMenuSetupUPnP.tex')
-rw-r--r--doc/latex/classcMenuSetupUPnP.tex88
1 files changed, 88 insertions, 0 deletions
diff --git a/doc/latex/classcMenuSetupUPnP.tex b/doc/latex/classcMenuSetupUPnP.tex
new file mode 100644
index 0000000..858d8ad
--- /dev/null
+++ b/doc/latex/classcMenuSetupUPnP.tex
@@ -0,0 +1,88 @@
+\hypertarget{classcMenuSetupUPnP}{
+\section{cMenuSetupUPnP Class Reference}
+\label{classcMenuSetupUPnP}\index{cMenuSetupUPnP@{cMenuSetupUPnP}}
+}
+{\tt \#include $<$menusetup.h$>$}
+
+Collaboration diagram for cMenuSetupUPnP:\nopagebreak
+\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[width=400pt]{classcMenuSetupUPnP__coll__graph}
+\end{center}
+\end{figure}
+\subsection*{Public Member Functions}
+\begin{CompactItemize}
+\item
+virtual eOSState \hyperlink{classcMenuSetupUPnP_5a6d78afea79d330e710d09b808d5240}{ProcessKey} (eKeys Key)
+\end{CompactItemize}
+\subsection*{Protected Member Functions}
+\begin{CompactItemize}
+\item
+virtual void \hyperlink{classcMenuSetupUPnP_e90738a7757dcc01e64e8ccad2f8a0e6}{Store} (void)
+\item
+void \hyperlink{classcMenuSetupUPnP_ed45944671b8974f7639aefee11e8f50}{Update} (void)
+\item
+void \hyperlink{classcMenuSetupUPnP_6f3e5ab68db53ce74ec81af07671d00e}{Load} (void)
+\end{CompactItemize}
+
+
+\subsection{Detailed Description}
+The VDR setup page
+
+This class shows and manages the settings within the VDR setup OSD
+
+\subsection{Member Function Documentation}
+\hypertarget{classcMenuSetupUPnP_6f3e5ab68db53ce74ec81af07671d00e}{
+\index{cMenuSetupUPnP@{cMenuSetupUPnP}!Load@{Load}}
+\index{Load@{Load}!cMenuSetupUPnP@{cMenuSetupUPnP}}
+\subsubsection[{Load}]{\setlength{\rightskip}{0pt plus 5cm}void cMenuSetupUPnP::Load (void)\hspace{0.3cm}{\tt \mbox{[}protected\mbox{]}}}}
+\label{classcMenuSetupUPnP_6f3e5ab68db53ce74ec81af07671d00e}
+
+
+Loads the setup information
+
+This loads the setup information from the configuration file \hypertarget{classcMenuSetupUPnP_5a6d78afea79d330e710d09b808d5240}{
+\index{cMenuSetupUPnP@{cMenuSetupUPnP}!ProcessKey@{ProcessKey}}
+\index{ProcessKey@{ProcessKey}!cMenuSetupUPnP@{cMenuSetupUPnP}}
+\subsubsection[{ProcessKey}]{\setlength{\rightskip}{0pt plus 5cm}eOSState cMenuSetupUPnP::ProcessKey (eKeys {\em Key})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
+\label{classcMenuSetupUPnP_5a6d78afea79d330e710d09b808d5240}
+
+
+Processes a keystroke
+
+This processes a keystroke which is done by the user and updates the menu accordingly
+
+It returns the current state of the VDR after pressing a key
+
+\begin{Desc}
+\item[Returns:]The current state of the VDR \end{Desc}
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em Key}]Key, pressed by the user \end{description}
+\end{Desc}
+\hypertarget{classcMenuSetupUPnP_e90738a7757dcc01e64e8ccad2f8a0e6}{
+\index{cMenuSetupUPnP@{cMenuSetupUPnP}!Store@{Store}}
+\index{Store@{Store}!cMenuSetupUPnP@{cMenuSetupUPnP}}
+\subsubsection[{Store}]{\setlength{\rightskip}{0pt plus 5cm}void cMenuSetupUPnP::Store (void)\hspace{0.3cm}{\tt \mbox{[}protected, virtual\mbox{]}}}}
+\label{classcMenuSetupUPnP_e90738a7757dcc01e64e8ccad2f8a0e6}
+
+
+Stores the setup information
+
+This stores the setup information in the configuration file \hypertarget{classcMenuSetupUPnP_ed45944671b8974f7639aefee11e8f50}{
+\index{cMenuSetupUPnP@{cMenuSetupUPnP}!Update@{Update}}
+\index{Update@{Update}!cMenuSetupUPnP@{cMenuSetupUPnP}}
+\subsubsection[{Update}]{\setlength{\rightskip}{0pt plus 5cm}void cMenuSetupUPnP::Update (void)\hspace{0.3cm}{\tt \mbox{[}protected\mbox{]}}}}
+\label{classcMenuSetupUPnP_ed45944671b8974f7639aefee11e8f50}
+
+
+Update the menu
+
+This updates the menu osd and refreshes the screen.
+
+The documentation for this class was generated from the following files:\begin{CompactItemize}
+\item
+misc/menusetup.h\item
+misc/menusetup.cpp\end{CompactItemize}