summaryrefslogtreecommitdiff
path: root/doc/latex/classcSortCriteria.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/latex/classcSortCriteria.tex')
-rw-r--r--doc/latex/classcSortCriteria.tex52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/latex/classcSortCriteria.tex b/doc/latex/classcSortCriteria.tex
new file mode 100644
index 0000000..8f6e461
--- /dev/null
+++ b/doc/latex/classcSortCriteria.tex
@@ -0,0 +1,52 @@
+\hypertarget{classcSortCriteria}{
+\section{cSortCriteria Class Reference}
+\label{classcSortCriteria}\index{cSortCriteria@{cSortCriteria}}
+}
+{\tt \#include $<$search.h$>$}
+
+Collaboration diagram for cSortCriteria:\nopagebreak
+\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[width=145pt]{classcSortCriteria__coll__graph}
+\end{center}
+\end{figure}
+\subsection*{Static Public Member Functions}
+\begin{CompactItemize}
+\item
+static cList$<$ \hyperlink{structcSortCrit}{cSortCrit} $>$ $\ast$ \hyperlink{classcSortCriteria_818579ec634d8b6f670a55545970b9e7}{parse} (const char $\ast$Sort)
+\end{CompactItemize}
+
+
+\subsection{Detailed Description}
+Creates a list with sort criteria
+
+This parser creates a list of sort criteria. It parses the sort criteria string from a {\em Browse\/} or {\em Search\/} request and stores the information in a {\tt \hyperlink{structcSortCrit}{cSortCrit}} structure.
+
+\subsection{Member Function Documentation}
+\hypertarget{classcSortCriteria_818579ec634d8b6f670a55545970b9e7}{
+\index{cSortCriteria@{cSortCriteria}!parse@{parse}}
+\index{parse@{parse}!cSortCriteria@{cSortCriteria}}
+\subsubsection[{parse}]{\setlength{\rightskip}{0pt plus 5cm}cList$<$ {\bf cSortCrit} $>$ $\ast$ cSortCriteria::parse (const char $\ast$ {\em Sort})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}}
+\label{classcSortCriteria_818579ec634d8b6f670a55545970b9e7}
+
+
+Parses the sort criteria
+
+This parses the sort criteria and returns a list with valid criterias
+
+\begin{Desc}
+\item[Returns:]returns\begin{itemize}
+\item a list with valid sort criterias\item {\bf {\tt null},} otherwise \end{itemize}
+\end{Desc}
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em Sort}]the string container the sort criteria \end{description}
+\end{Desc}
+
+
+The documentation for this class was generated from the following files:\begin{CompactItemize}
+\item
+misc/search.h\item
+misc/search.cpp\end{CompactItemize}