\section{KIO::Progress\-Base Class Reference}
\label{classKIO_1_1ProgressBase}\index{KIO::ProgressBase@{KIO::ProgressBase}}
This class does all initialization stuff for progress, like connecting signals to slots. Base class for IO progress dialogs.  


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

Inheritance diagram for KIO::Progress\-Base:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=78pt]{classKIO_1_1ProgressBase__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KIO::Progress\-Base:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=277pt]{classKIO_1_1ProgressBase__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Slots}
\begin{CompactItemize}
\item 
void {\bf slot\-Stop} ()
\begin{CompactList}\small\item\em This method should be called for correct cancelation of IO operation Connect this to the progress widgets buttons etc. \item\end{CompactList}\item 
virtual void {\bf slot\-Clean} ()
\begin{CompactList}\small\item\em This method is called when the widget should be cleaned (after job is finished). \item\end{CompactList}\item 
virtual void {\bf slot\-Total\-Size} ({\bf KIO::Job} $\ast$, KIO::filesize\_\-t)\label{classKIO_1_1ProgressBase_i2}

\item 
virtual void {\bf slot\-Total\-Files} ({\bf KIO::Job} $\ast$, unsigned long)\label{classKIO_1_1ProgressBase_i3}

\item 
virtual void {\bf slot\-Total\-Dirs} ({\bf KIO::Job} $\ast$, unsigned long)\label{classKIO_1_1ProgressBase_i4}

\item 
virtual void {\bf slot\-Processed\-Size} ({\bf KIO::Job} $\ast$, KIO::filesize\_\-t)\label{classKIO_1_1ProgressBase_i5}

\item 
virtual void {\bf slot\-Processed\-Files} ({\bf KIO::Job} $\ast$, unsigned long)\label{classKIO_1_1ProgressBase_i6}

\item 
virtual void {\bf slot\-Processed\-Dirs} ({\bf KIO::Job} $\ast$, unsigned long)\label{classKIO_1_1ProgressBase_i7}

\item 
virtual void {\bf slot\-Speed} ({\bf KIO::Job} $\ast$, unsigned long)\label{classKIO_1_1ProgressBase_i8}

\item 
virtual void {\bf slot\-Percent} ({\bf KIO::Job} $\ast$, unsigned long)\label{classKIO_1_1ProgressBase_i9}

\item 
virtual void {\bf slot\-Copying} ({\bf KIO::Job} $\ast$, const  {\bf KURL} \&, const  {\bf KURL} \&)\label{classKIO_1_1ProgressBase_i10}

\item 
virtual void {\bf slot\-Moving} ({\bf KIO::Job} $\ast$, const  {\bf KURL} \&, const  {\bf KURL} \&)\label{classKIO_1_1ProgressBase_i11}

\item 
virtual void {\bf slot\-Deleting} ({\bf KIO::Job} $\ast$, const  {\bf KURL} \&)\label{classKIO_1_1ProgressBase_i12}

\item 
virtual void {\bf slot\-Creating\-Dir} ({\bf KIO::Job} $\ast$, const  {\bf KURL} \&)\label{classKIO_1_1ProgressBase_i13}

\item 
virtual void {\bf slot\-Can\-Resume} ({\bf KIO::Job} $\ast$, KIO::filesize\_\-t)\label{classKIO_1_1ProgressBase_i14}

\end{CompactItemize}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf stopped} ()\label{classKIO_1_1ProgressBase_l0}

\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Progress\-Base} ({\bf QWidget} $\ast$parent)\label{classKIO_1_1ProgressBase_a0}

\item 
void {\bf set\-Job} ({\bf KIO::Job} $\ast$job)\label{classKIO_1_1ProgressBase_a2}

\item 
void {\bf set\-Job} (KIO::Copy\-Job $\ast$job)\label{classKIO_1_1ProgressBase_a3}

\item 
void {\bf set\-Job} ({\bf KIO::Delete\-Job} $\ast$job)\label{classKIO_1_1ProgressBase_a4}

\item 
void {\bf set\-Stop\-On\-Close} (bool stop\-On\-Close)\label{classKIO_1_1ProgressBase_a5}

\item 
bool {\bf stop\-On\-Close} () const \label{classKIO_1_1ProgressBase_a6}

\item 
void {\bf set\-Only\-Clean} (bool only\-Clean)
\begin{CompactList}\small\item\em This controls whether the dialog should be deleted or only cleaned when the {\bf KIO::Job}{\rm (p.\,\pageref{classKIO_1_1Job})} is finished (or canceled). \item\end{CompactList}\item 
bool {\bf only\-Clean} () const \label{classKIO_1_1ProgressBase_a8}

\item 
void {\bf finished} ()
\begin{CompactList}\small\item\em \begin{Desc}
\item[Since:]3.1 \end{Desc}
\item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
void {\bf slot\-Finished} ({\bf KIO::Job} $\ast$)\label{classKIO_1_1ProgressBase_j0}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf close\-Event} ({\bf QClose\-Event} $\ast$)\label{classKIO_1_1ProgressBase_b0}

\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKIO_1_1ProgressBase_b1}

\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
{\bf KIO::Job} $\ast$ {\bf m\_\-p\-Job}\label{classKIO_1_1ProgressBase_p0}

\end{CompactItemize}


\subsection{Detailed Description}
This class does all initialization stuff for progress, like connecting signals to slots. Base class for IO progress dialogs. 

All slots are implemented as pure virtual methods.

All custom IO progress dialog should inherit this class. Add your GUI code to the constructor and implemement those virtual methods which you need in order to display progress.

E.g. Statusbar\-Progress only implements slot\-Total\-Size(), slot\-Percent() and slot\-Speed().

Custom progress dialog will be used like this : \small\begin{alltt}
 // create job
 CopyJob* job = {\bf KIO::copy}{\rm (p.\,\pageref{namespaceKIO_a215})}(...);
 // create a dialog
 MyCustomProgress *customProgress;
 customProgress = new MyCustomProgress();
 // connect progress with job
 customProgress-$>$setJob( job );
 ...
 \end{alltt}\normalsize 


There is a special method set\-Stop\-On\-Close() that controls the behavior of the dialog. 

\begin{Desc}
\item[Author:]Matej Koss $<${\tt koss@miesto.sk}$>$ \end{Desc}




Definition at line 70 of file progressbase.h.

\subsection{Member Function Documentation}
\index{KIO::ProgressBase@{KIO::Progress\-Base}!setOnlyClean@{setOnlyClean}}
\index{setOnlyClean@{setOnlyClean}!KIO::ProgressBase@{KIO::Progress\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KIO::Progress\-Base::set\-Only\-Clean (bool {\em only\-Clean})\hspace{0.3cm}{\tt  [inline]}}\label{classKIO_1_1ProgressBase_a7}


This controls whether the dialog should be deleted or only cleaned when the {\bf KIO::Job}{\rm (p.\,\pageref{classKIO_1_1Job})} is finished (or canceled). 

If your dialog is an embedded widget and not a separate window, you should set\-Only\-Clean(true) in the constructor of your custom dialog.

If true - Dialog will only call method {\bf slot\-Clean}{\rm (p.\,\pageref{classKIO_1_1ProgressBase_i1})}. If false - Dialog will be deleted. 

Definition at line 99 of file progressbase.h.\index{KIO::ProgressBase@{KIO::Progress\-Base}!finished@{finished}}
\index{finished@{finished}!KIO::ProgressBase@{KIO::Progress\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KIO::Progress\-Base::finished ()}\label{classKIO_1_1ProgressBase_a9}


\begin{Desc}
\item[Since:]3.1 \end{Desc}




Definition at line 144 of file progressbase.cpp.

References slot\-Clean().\index{KIO::ProgressBase@{KIO::Progress\-Base}!slotStop@{slotStop}}
\index{slotStop@{slotStop}!KIO::ProgressBase@{KIO::Progress\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KIO::Progress\-Base::slot\-Stop ()\hspace{0.3cm}{\tt  [slot]}}\label{classKIO_1_1ProgressBase_i0}


This method should be called for correct cancelation of IO operation Connect this to the progress widgets buttons etc. 



Definition at line 158 of file progressbase.cpp.

References KIO::Job::kill().\index{KIO::ProgressBase@{KIO::Progress\-Base}!slotClean@{slotClean}}
\index{slotClean@{slotClean}!KIO::ProgressBase@{KIO::Progress\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KIO::Progress\-Base::slot\-Clean ()\hspace{0.3cm}{\tt  [virtual, slot]}}\label{classKIO_1_1ProgressBase_i1}


This method is called when the widget should be cleaned (after job is finished). 

redefine this for custom behavior. 

Reimplemented in {\bf KIO::Statusbar\-Progress} {\rm (p.\,\pageref{classKIO_1_1StatusbarProgress_i0})}.

Definition at line 170 of file progressbase.cpp.

References QWidget::hide().

Referenced by finished().

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