diff options
Diffstat (limited to 'doc/latex/classcUPnPClassMovie.tex')
| -rw-r--r-- | doc/latex/classcUPnPClassMovie.tex | 234 |
1 files changed, 234 insertions, 0 deletions
diff --git a/doc/latex/classcUPnPClassMovie.tex b/doc/latex/classcUPnPClassMovie.tex new file mode 100644 index 0000000..b4fe81a --- /dev/null +++ b/doc/latex/classcUPnPClassMovie.tex @@ -0,0 +1,234 @@ +\hypertarget{classcUPnPClassMovie}{ +\section{cUPnPClassMovie Class Reference} +\label{classcUPnPClassMovie}\index{cUPnPClassMovie@{cUPnPClassMovie}} +} +{\tt \#include $<$object.h$>$} + +Inheritance diagram for cUPnPClassMovie:\nopagebreak +\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=400pt]{classcUPnPClassMovie__inherit__graph} +\end{center} +\end{figure} +Collaboration diagram for cUPnPClassMovie:\nopagebreak +\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=400pt]{classcUPnPClassMovie__coll__graph} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +virtual cStringList $\ast$ \hyperlink{classcUPnPClassMovie_b62e6dac175090b82c47f955e29c146c}{getPropertyList} () +\item +virtual bool \hyperlink{classcUPnPClassMovie_d7f990edda85f2caabe822d2ceeb2b0d}{setProperty} (const char $\ast$Property, const char $\ast$Value) +\item +virtual bool \hyperlink{classcUPnPClassMovie_b4c1d5a973856469b93d2033b65d7ba2}{getProperty} (const char $\ast$Property, char $\ast$$\ast$Value) const +\item +int \hyperlink{classcUPnPClassMovie_3df7d1a4d798fddde1b379a2302a128c}{setDVDRegionCode} (int RegionCode) +\item +int \hyperlink{classcUPnPClassMovie_136a1daa4c14c2d7397624eb288c463e}{setStorageMedium} (const char $\ast$StorageMedium) +\item +int \hyperlink{classcUPnPClassMovie_80a41ba769974e80635b80aa3c41f66d}{getDVDRegionCode} () const +\item +const char $\ast$ \hyperlink{classcUPnPClassMovie_9fc36c7e0a1a465ec720b219a1710cc6}{getStorageMedium} () const +\end{CompactItemize} +\subsection*{Protected Member Functions} +\begin{CompactItemize} +\item +\hyperlink{classcUPnPClassMovie_7343932df4e5bfd9821e16026cb7c66d}{cUPnPClassMovie} () +\end{CompactItemize} +\subsection*{Protected Attributes} +\begin{CompactItemize} +\item +\hypertarget{classcUPnPClassMovie_90cc86f3eb248bbea4b3bf845862455f}{ +int \hyperlink{classcUPnPClassMovie_90cc86f3eb248bbea4b3bf845862455f}{mDVDRegionCode}} +\label{classcUPnPClassMovie_90cc86f3eb248bbea4b3bf845862455f} + +\begin{CompactList}\small\item\em The Region code of the movie (0 - 8). \item\end{CompactList}\item +\hypertarget{classcUPnPClassMovie_a9bcda545b8ce19e3b613757b3759127}{ +cString \hyperlink{classcUPnPClassMovie_a9bcda545b8ce19e3b613757b3759127}{mStorageMedium}} +\label{classcUPnPClassMovie_a9bcda545b8ce19e3b613757b3759127} + +\begin{CompactList}\small\item\em The storage medium where the movie is stored. \item\end{CompactList}\end{CompactItemize} +\subsection*{Friends} +\begin{CompactItemize} +\item +\hypertarget{classcUPnPClassMovie_3d0d0aedce8b1c661ea360b9a6d616f6}{ +class \hyperlink{classcUPnPClassMovie_3d0d0aedce8b1c661ea360b9a6d616f6}{cMediaDatabase}} +\label{classcUPnPClassMovie_3d0d0aedce8b1c661ea360b9a6d616f6} + +\item +\hypertarget{classcUPnPClassMovie_aefab39434a832c545ac75a79fa81d23}{ +class \hyperlink{classcUPnPClassMovie_aefab39434a832c545ac75a79fa81d23}{cUPnPObjectMediator}} +\label{classcUPnPClassMovie_aefab39434a832c545ac75a79fa81d23} + +\item +\hypertarget{classcUPnPClassMovie_d1fb2eb621f67f9aa7abf2e67e1a5305}{ +class \hyperlink{classcUPnPClassMovie_d1fb2eb621f67f9aa7abf2e67e1a5305}{cUPnPMovieMediator}} +\label{classcUPnPClassMovie_d1fb2eb621f67f9aa7abf2e67e1a5305} + +\end{CompactItemize} + + +\subsection{Detailed Description} +The UPnP class Movie + +This is a UPnP class Movie representation with all its properties. + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{classcUPnPClassMovie_7343932df4e5bfd9821e16026cb7c66d}{ +\index{cUPnPClassMovie@{cUPnPClassMovie}!cUPnPClassMovie@{cUPnPClassMovie}} +\index{cUPnPClassMovie@{cUPnPClassMovie}!cUPnPClassMovie@{cUPnPClassMovie}} +\subsubsection[{cUPnPClassMovie}]{\setlength{\rightskip}{0pt plus 5cm}cUPnPClassMovie::cUPnPClassMovie ()\hspace{0.3cm}{\tt \mbox{[}protected\mbox{]}}}} +\label{classcUPnPClassMovie_7343932df4e5bfd9821e16026cb7c66d} + + +Constructor of a movie + +This creates a new instance of a movie + +\subsection{Member Function Documentation} +\hypertarget{classcUPnPClassMovie_80a41ba769974e80635b80aa3c41f66d}{ +\index{cUPnPClassMovie@{cUPnPClassMovie}!getDVDRegionCode@{getDVDRegionCode}} +\index{getDVDRegionCode@{getDVDRegionCode}!cUPnPClassMovie@{cUPnPClassMovie}} +\subsubsection[{getDVDRegionCode}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassMovie::getDVDRegionCode () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassMovie_80a41ba769974e80635b80aa3c41f66d} + + +Get the DVD region code + +This returns the DVD region code. For more information, see \href{http://en.wikipedia.org/wiki/DVD_region_code}{\tt http://en.wikipedia.org/wiki/DVD\_\-region\_\-code} + +The integer representation for {\em ALL\/} is 9. + +\begin{Desc} +\item[See also:]\href{http://en.wikipedia.org/wiki/DVD_region_code}{\tt http://en.wikipedia.org/wiki/DVD\_\-region\_\-code} \end{Desc} +\begin{Desc} +\item[Returns:]the DVD region code \end{Desc} +\hypertarget{classcUPnPClassMovie_b4c1d5a973856469b93d2033b65d7ba2}{ +\index{cUPnPClassMovie@{cUPnPClassMovie}!getProperty@{getProperty}} +\index{getProperty@{getProperty}!cUPnPClassMovie@{cUPnPClassMovie}} +\subsubsection[{getProperty}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPClassMovie::getProperty (const char $\ast$ {\em Property}, \/ char $\ast$$\ast$ {\em Value}) const\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} +\label{classcUPnPClassMovie_b4c1d5a973856469b93d2033b65d7ba2} + + +Gets a property + +Returns the value of a specified property. The value is converted into a string. + +\begin{Desc} +\item[Returns:]returns\begin{itemize} +\item {\bf {\tt true},} if the property exists\item {\bf {\tt false},} otherwise \end{itemize} +\end{Desc} +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em Property}]the property which should be returned \item[{\em Value}]the value of that property \end{description} +\end{Desc} + + +Reimplemented from \hyperlink{classcUPnPClassVideoItem_94ab2ffcbe14abb63c680e6748e70ef1}{cUPnPClassVideoItem}.\hypertarget{classcUPnPClassMovie_b62e6dac175090b82c47f955e29c146c}{ +\index{cUPnPClassMovie@{cUPnPClassMovie}!getPropertyList@{getPropertyList}} +\index{getPropertyList@{getPropertyList}!cUPnPClassMovie@{cUPnPClassMovie}} +\subsubsection[{getPropertyList}]{\setlength{\rightskip}{0pt plus 5cm}cStringList $\ast$ cUPnPClassMovie::getPropertyList ()\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} +\label{classcUPnPClassMovie_b62e6dac175090b82c47f955e29c146c} + + +Get the properties of the object + +This returns a property list with all the properties which can be obtained or set with {\tt getProperty} or {\tt setProperty}. + +\begin{Desc} +\item[Returns:]a stringlist with the properties \end{Desc} + + +Reimplemented from \hyperlink{classcUPnPClassVideoItem_9dc397419b45535a3e6a676667b619a4}{cUPnPClassVideoItem}.\hypertarget{classcUPnPClassMovie_9fc36c7e0a1a465ec720b219a1710cc6}{ +\index{cUPnPClassMovie@{cUPnPClassMovie}!getStorageMedium@{getStorageMedium}} +\index{getStorageMedium@{getStorageMedium}!cUPnPClassMovie@{cUPnPClassMovie}} +\subsubsection[{getStorageMedium}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ cUPnPClassMovie::getStorageMedium () const\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} +\label{classcUPnPClassMovie_9fc36c7e0a1a465ec720b219a1710cc6} + + +Get the storage medium + +This returns the storage medium, where the movie resides. + +\begin{Desc} +\item[Returns:]the storage medium \end{Desc} +\hypertarget{classcUPnPClassMovie_3df7d1a4d798fddde1b379a2302a128c}{ +\index{cUPnPClassMovie@{cUPnPClassMovie}!setDVDRegionCode@{setDVDRegionCode}} +\index{setDVDRegionCode@{setDVDRegionCode}!cUPnPClassMovie@{cUPnPClassMovie}} +\subsubsection[{setDVDRegionCode}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassMovie::setDVDRegionCode (int {\em RegionCode})}} +\label{classcUPnPClassMovie_3df7d1a4d798fddde1b379a2302a128c} + + +Sets the DVD region code + +For more information on this, see \href{http://en.wikipedia.org/wiki/DVD_region_code}{\tt http://en.wikipedia.org/wiki/DVD\_\-region\_\-code} + +The integer representation for {\em ALL\/} is 9. + +\begin{Desc} +\item[See also:]\href{http://en.wikipedia.org/wiki/DVD_region_code}{\tt http://en.wikipedia.org/wiki/DVD\_\-region\_\-code} \end{Desc} +\begin{Desc} +\item[Returns:]returns\begin{itemize} +\item {\bf {\tt 0},} if setting was successful\item {\bf {\tt $<$0},} otherwise \end{itemize} +\end{Desc} +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em RegionCode}]the region code of this movie \end{description} +\end{Desc} +\hypertarget{classcUPnPClassMovie_d7f990edda85f2caabe822d2ceeb2b0d}{ +\index{cUPnPClassMovie@{cUPnPClassMovie}!setProperty@{setProperty}} +\index{setProperty@{setProperty}!cUPnPClassMovie@{cUPnPClassMovie}} +\subsubsection[{setProperty}]{\setlength{\rightskip}{0pt plus 5cm}bool cUPnPClassMovie::setProperty (const char $\ast$ {\em Property}, \/ const char $\ast$ {\em Value})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} +\label{classcUPnPClassMovie_d7f990edda85f2caabe822d2ceeb2b0d} + + +Sets a property + +Sets the value of a specified property. The value is converted from string into the propper data type + +\begin{Desc} +\item[Returns:]returns\begin{itemize} +\item {\bf {\tt true},} if the property exists\item {\bf {\tt false},} otherwise \end{itemize} +\end{Desc} +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em Property}]the property which should be set \item[{\em Value}]the value of that property \end{description} +\end{Desc} + + +Reimplemented from \hyperlink{classcUPnPClassVideoItem_3cbda6d87f5a9ff0475a75e76ba19924}{cUPnPClassVideoItem}.\hypertarget{classcUPnPClassMovie_136a1daa4c14c2d7397624eb288c463e}{ +\index{cUPnPClassMovie@{cUPnPClassMovie}!setStorageMedium@{setStorageMedium}} +\index{setStorageMedium@{setStorageMedium}!cUPnPClassMovie@{cUPnPClassMovie}} +\subsubsection[{setStorageMedium}]{\setlength{\rightskip}{0pt plus 5cm}int cUPnPClassMovie::setStorageMedium (const char $\ast$ {\em StorageMedium})}} +\label{classcUPnPClassMovie_136a1daa4c14c2d7397624eb288c463e} + + +Sets the storage medium + +This will set the storage medium, where the movie resides. Valid media are defined in \hyperlink{common_8h-source}{common.h} + +\begin{Desc} +\item[See also:]\hyperlink{common_8h-source}{common.h} \end{Desc} +\begin{Desc} +\item[Returns:]returns\begin{itemize} +\item {\bf {\tt 0},} if setting was successful\item {\bf {\tt $<$0},} otherwise \end{itemize} +\end{Desc} +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em StorageMedium}]the medium where the movie is located \end{description} +\end{Desc} + + +The documentation for this class was generated from the following files:\begin{CompactItemize} +\item +database/object.h\item +database/object.cpp\end{CompactItemize} |