\section{KNS::Engine Class Reference}
\label{classKNS_1_1Engine}\index{KNS::Engine@{KNS::Engine}}
Central class combining all possible {\bf KNew\-Stuff}{\rm (p.\,\pageref{classKNewStuff})} operations.  


{\tt \#include $<$engine.h$>$}

Inheritance diagram for KNS::Engine:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=54pt]{classKNS_1_1Engine__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KNS::Engine:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=391pt]{classKNS_1_1Engine__coll__graph}
\end{center}
\end{figure}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf upload\-Finished} (bool result)
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Engine} ({\bf KNew\-Stuff} $\ast$new\-Stuff, const {\bf QString} \&type, {\bf QWidget} $\ast$parent\-Widget=0)
\item 
{\bf Engine} ({\bf KNew\-Stuff} $\ast$new\-Stuff, const {\bf QString} \&type, const {\bf QString} \&provider\-List, {\bf QWidget} $\ast$parent\-Widget=0)
\item 
virtual {\bf $\sim$Engine} ()
\item 
{\bf QString} {\bf type} () const 
\item 
{\bf QWidget} $\ast$ {\bf parent\-Widget} () const 
\item 
void {\bf download} ()
\item 
void {\bf upload} (const {\bf QString} \&file\-Name=QString::null, const {\bf QString} \&preview\-Name=QString::null)
\item 
void {\bf download} ({\bf Entry} $\ast$entry)
\item 
void {\bf request\-Meta\-Information} ({\bf Provider} $\ast$provider)
\item 
void {\bf upload} ({\bf Entry} $\ast$entry)
\item 
void {\bf ignore\-Install\-Result} (bool ignore)
\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
void {\bf get\-Meta\-Information} ({\bf Provider::List} $\ast$providers)\label{classKNS_1_1Engine_j0}

\item 
void {\bf select\-Upload\-Provider} ({\bf Provider::List} $\ast$providers)\label{classKNS_1_1Engine_j1}

\item 
void {\bf slot\-New\-Stuff\-Job\-Data} (KIO::Job $\ast$job, const {\bf QByte\-Array} \&data)\label{classKNS_1_1Engine_j2}

\item 
void {\bf slot\-New\-Stuff\-Job\-Result} (KIO::Job $\ast$job)\label{classKNS_1_1Engine_j3}

\item 
void {\bf slot\-Download\-Job\-Result} (KIO::Job $\ast$job)\label{classKNS_1_1Engine_j4}

\item 
void {\bf slot\-Upload\-Payload\-Job\-Result} (KIO::Job $\ast$job)\label{classKNS_1_1Engine_j5}

\item 
void {\bf slot\-Upload\-Preview\-Job\-Result} (KIO::Job $\ast$job)\label{classKNS_1_1Engine_j6}

\item 
void {\bf slot\-Upload\-Meta\-Job\-Result} (KIO::Job $\ast$job)\label{classKNS_1_1Engine_j7}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
bool {\bf create\-Meta\-File} ({\bf Entry} $\ast$)\label{classKNS_1_1Engine_b0}

\end{CompactItemize}


\subsection{Detailed Description}
Central class combining all possible {\bf KNew\-Stuff}{\rm (p.\,\pageref{classKNewStuff})} operations. 

In most cases, {\bf Engine}{\rm (p.\,\pageref{classKNS_1_1Engine})} objects are built and used internally. Using this class explicitely does however give fine-grained control about the upload and download operations.

\begin{Desc}
\item[Author:]Cornelius Schumacher ({\tt schumacher@kde.org}) \end{Desc}
\begin{Desc}
\item[Maintainer:]Josef Spillner ({\tt spillner@kde.org}) \end{Desc}




Definition at line 51 of file engine.h.

\subsection{Constructor \& Destructor Documentation}
\index{KNS::Engine@{KNS::Engine}!Engine@{Engine}}
\index{Engine@{Engine}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KNS::Engine::Engine ({\bf KNew\-Stuff} $\ast$ {\em new\-Stuff}, const {\bf QString} \& {\em type}, {\bf QWidget} $\ast$ {\em parent\-Widget} = {\tt 0})}\label{classKNS_1_1Engine_a0}


Constructor. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em new\-Stuff}]a {\bf KNew\-Stuff}{\rm (p.\,\pageref{classKNewStuff})} object \item[{\em type}]the Hotstuff data type such as \char`\"{}korganizer/calendar\char`\"{} \item[{\em parent\-Widget}]the parent window \end{description}
\end{Desc}
\index{KNS::Engine@{KNS::Engine}!Engine@{Engine}}
\index{Engine@{Engine}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KNS::Engine::Engine ({\bf KNew\-Stuff} $\ast$ {\em new\-Stuff}, const {\bf QString} \& {\em type}, const {\bf QString} \& {\em provider\-List}, {\bf QWidget} $\ast$ {\em parent\-Widget} = {\tt 0})}\label{classKNS_1_1Engine_a1}


Constructor. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em new\-Stuff}]a {\bf KNew\-Stuff}{\rm (p.\,\pageref{classKNewStuff})} object \item[{\em type}]the Hotstuff data type such as \char`\"{}korganizer/calendar\char`\"{} \item[{\em provider\-List}]the URL of the provider list \item[{\em parent\-Widget}]the parent window \end{description}
\end{Desc}
\index{KNS::Engine@{KNS::Engine}!~Engine@{$\sim$Engine}}
\index{~Engine@{$\sim$Engine}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual KNS::Engine::$\sim${\bf Engine} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKNS_1_1Engine_a2}


Destructor. 



\subsection{Member Function Documentation}
\index{KNS::Engine@{KNS::Engine}!type@{type}}
\index{type@{type}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KNS::Engine::type () const\hspace{0.3cm}{\tt  [inline]}}\label{classKNS_1_1Engine_a3}


Returns the previously set data type. 

\begin{Desc}
\item[Returns:]the Hotstuff data type \end{Desc}


Definition at line 84 of file engine.h.

Referenced by KNew\-Stuff::type().\index{KNS::Engine@{KNS::Engine}!parentWidget@{parentWidget}}
\index{parentWidget@{parentWidget}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QWidget}$\ast$ KNS::Engine::parent\-Widget () const\hspace{0.3cm}{\tt  [inline]}}\label{classKNS_1_1Engine_a4}


Returns the previously set parent widget. 

\begin{Desc}
\item[Returns:]parent widget \end{Desc}


Definition at line 91 of file engine.h.

Referenced by KNew\-Stuff::parent\-Widget().\index{KNS::Engine@{KNS::Engine}!download@{download}}
\index{download@{download}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KNS::Engine::download ()}\label{classKNS_1_1Engine_a5}


Initiates the download process, retrieving provider lists and invoking the download dialog. 



Referenced by KNew\-Stuff::download().\index{KNS::Engine@{KNS::Engine}!upload@{upload}}
\index{upload@{upload}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KNS::Engine::upload (const {\bf QString} \& {\em file\-Name} = {\tt QString::null}, const {\bf QString} \& {\em preview\-Name} = {\tt QString::null})}\label{classKNS_1_1Engine_a6}


Initiates the upload process, invoking the provider selection dialog and the file upload dialog. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em file\-Name}]name of the payload data file \item[{\em preview\-Name}]name of the preview image file \end{description}
\end{Desc}


Referenced by KNew\-Stuff::upload().\index{KNS::Engine@{KNS::Engine}!download@{download}}
\index{download@{download}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KNS::Engine::download ({\bf Entry} $\ast$ {\em entry})}\label{classKNS_1_1Engine_a7}


Downloads the specified data file. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em entry}]the Hotstuff data object to be downloaded \end{description}
\end{Desc}
\index{KNS::Engine@{KNS::Engine}!requestMetaInformation@{requestMetaInformation}}
\index{requestMetaInformation@{requestMetaInformation}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KNS::Engine::request\-Meta\-Information ({\bf Provider} $\ast$ {\em provider})}\label{classKNS_1_1Engine_a8}


Asynchronous lookup of provider information such as upload and download locations, icon etc. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em provider}]the Hotstuff provider to request information from \end{description}
\end{Desc}
\index{KNS::Engine@{KNS::Engine}!upload@{upload}}
\index{upload@{upload}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KNS::Engine::upload ({\bf Entry} $\ast$ {\em entry})}\label{classKNS_1_1Engine_a9}


Uploads the specified data file to the provider-dependent location. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em entry}]the Hotstuff data object to be uploaded \end{description}
\end{Desc}
\index{KNS::Engine@{KNS::Engine}!ignoreInstallResult@{ignoreInstallResult}}
\index{ignoreInstallResult@{ignoreInstallResult}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KNS::Engine::ignore\-Install\-Result (bool {\em ignore})}\label{classKNS_1_1Engine_a10}


Ignores the return value of the install method. 

Used internally to avoid showing of the success/failure dialog when installation is done in another place, like in {\bf KNew\-Stuff\-Secure}{\rm (p.\,\pageref{classKNewStuffSecure})} 

Referenced by KNew\-Stuff\-Secure::download\-Resource().\index{KNS::Engine@{KNS::Engine}!uploadFinished@{uploadFinished}}
\index{uploadFinished@{uploadFinished}!KNS::Engine@{KNS::Engine}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KNS::Engine::upload\-Finished (bool {\em result})\hspace{0.3cm}{\tt  [signal]}}\label{classKNS_1_1Engine_l0}


Emitted when the upload has finished. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em result}]indicates the success/failure of the upload \end{description}
\end{Desc}


The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
engine.h\end{CompactItemize}
