\section{KIO::List\-Job Class Reference}
\label{classKIO_1_1ListJob}\index{KIO::ListJob@{KIO::ListJob}}
A {\bf List\-Job}{\rm (p.\,\pageref{classKIO_1_1ListJob})} is allows you to get the get the content of a directory.  


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

Inheritance diagram for KIO::List\-Job:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=60pt]{classKIO_1_1ListJob__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KIO::List\-Job:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=172pt]{classKIO_1_1ListJob__coll__graph}
\end{center}
\end{figure}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf entries} ({\bf KIO::Job} $\ast$job, const {\bf KIO::UDSEntry\-List} \&list)
\item 
void {\bf redirection} ({\bf KIO::Job} $\ast$job, const {\bf KURL} \&url)
\item 
void {\bf permanent\-Redirection} ({\bf KIO::Job} $\ast$job, const {\bf KURL} \&from\-Url, const {\bf KURL} \&to\-Url)
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf List\-Job} (const {\bf KURL} \&url, bool show\-Progress\-Info, bool recursive=false, {\bf QString} prefix=QString::null, bool include\-Hidden=true)
\item 
virtual void {\bf start} (Slave $\ast$slave)\label{classKIO_1_1ListJob_a1}

\item 
const {\bf KURL} \& {\bf redirection\-URL} () const 
\item 
void {\bf set\-Unrestricted} (bool unrestricted)
\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
virtual void {\bf slot\-Finished} ()
\item 
virtual void {\bf slot\-Meta\-Data} (const {\bf KIO::Meta\-Data} \&\_\-meta\-Data)
\item 
virtual void {\bf slot\-Result} ({\bf KIO::Job} $\ast$job)
\item 
void {\bf slot\-List\-Entries} (const {\bf KIO::UDSEntry\-List} \&list)\label{classKIO_1_1ListJob_j3}

\item 
void {\bf slot\-Redirection} (const {\bf KURL} \&url)\label{classKIO_1_1ListJob_j4}

\item 
void {\bf got\-Entries} ({\bf KIO::Job} $\ast$subjob, const {\bf KIO::UDSEntry\-List} \&list)\label{classKIO_1_1ListJob_j5}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKIO_1_1ListJob_b0}

\end{CompactItemize}


\subsection{Detailed Description}
A {\bf List\-Job}{\rm (p.\,\pageref{classKIO_1_1ListJob})} is allows you to get the get the content of a directory. 

Don't create the job directly, but use {\bf KIO::list\-Recursive()}{\rm (p.\,\pageref{namespaceKIO_a228})} or {\bf KIO::list\-Dir()}{\rm (p.\,\pageref{namespaceKIO_a227})} instead. \begin{Desc}
\item[See also:]{\bf KIO::list\-Recursive()}{\rm (p.\,\pageref{namespaceKIO_a228})} 

{\bf KIO::list\-Dir()}{\rm (p.\,\pageref{namespaceKIO_a227})} \end{Desc}




Definition at line 1329 of file jobclasses.h.

\subsection{Constructor \& Destructor Documentation}
\index{KIO::ListJob@{KIO::List\-Job}!ListJob@{ListJob}}
\index{ListJob@{ListJob}!KIO::ListJob@{KIO::List\-Job}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}List\-Job::List\-Job (const {\bf KURL} \& {\em url}, bool {\em show\-Progress\-Info}, bool {\em recursive} = {\tt false}, {\bf QString} {\em prefix} = {\tt QString::null}, bool {\em include\-Hidden} = {\tt true})}\label{classKIO_1_1ListJob_a0}


Do not create a {\bf List\-Job}{\rm (p.\,\pageref{classKIO_1_1ListJob})} directly. 

Use {\bf KIO::list\-Dir()}{\rm (p.\,\pageref{namespaceKIO_a227})} or {\bf KIO::list\-Recursive()}{\rm (p.\,\pageref{namespaceKIO_a228})} instead. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em url}]the url of the directory \item[{\em show\-Progress\-Info}]true to show progress information to the user \item[{\em recursive}]true to get the data recursively from child directories, false to get only the content of the specified dir \item[{\em prefix}]the prefix of the files, or QString::null for no prefix \item[{\em include\-Hidden}]true to include hidden files (those starting with '.')\end{description}
\end{Desc}


Definition at line 1905 of file job.cpp.

\subsection{Member Function Documentation}
\index{KIO::ListJob@{KIO::List\-Job}!redirectionURL@{redirectionURL}}
\index{redirectionURL@{redirectionURL}!KIO::ListJob@{KIO::List\-Job}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf KURL}\& KIO::List\-Job::redirection\-URL () const\hspace{0.3cm}{\tt  [inline]}}\label{classKIO_1_1ListJob_a2}


Returns the List\-Job's redirection URL. 

This will be invalid if there was no redirection. \begin{Desc}
\item[Returns:]the redirection url \end{Desc}
\begin{Desc}
\item[Since:]3.4.1 \end{Desc}


Definition at line 1361 of file jobclasses.h.\index{KIO::ListJob@{KIO::List\-Job}!setUnrestricted@{setUnrestricted}}
\index{setUnrestricted@{setUnrestricted}!KIO::ListJob@{KIO::List\-Job}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List\-Job::set\-Unrestricted (bool {\em unrestricted})}\label{classKIO_1_1ListJob_a3}


Do not apply any KIOSK restrictions to this job. 

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


Definition at line 2085 of file job.cpp.

Referenced by KIO::Delete\-Job::slot\-Result().\index{KIO::ListJob@{KIO::List\-Job}!entries@{entries}}
\index{entries@{entries}!KIO::ListJob@{KIO::List\-Job}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KIO::List\-Job::entries ({\bf KIO::Job} $\ast$ {\em job}, const {\bf KIO::UDSEntry\-List} \& {\em list})\hspace{0.3cm}{\tt  [signal]}}\label{classKIO_1_1ListJob_l0}


This signal emits the entry found by the job while listing. 

The progress signals aren't specific to {\bf List\-Job}{\rm (p.\,\pageref{classKIO_1_1ListJob})}. It simply uses Simple\-Job's processed\-Size (number of entries listed) and total\-Size (total number of entries, if known), as well as percent. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em job}]the job that emitted this signal \item[{\em list}]the list of UDSEntries \end{description}
\end{Desc}
\index{KIO::ListJob@{KIO::List\-Job}!redirection@{redirection}}
\index{redirection@{redirection}!KIO::ListJob@{KIO::List\-Job}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KIO::List\-Job::redirection ({\bf KIO::Job} $\ast$ {\em job}, const {\bf KURL} \& {\em url})\hspace{0.3cm}{\tt  [signal]}}\label{classKIO_1_1ListJob_l1}


Signals a redirection. 

Use to update the URL shown to the user. The redirection itself is handled internally. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em job}]the job that is redirected \item[{\em url}]the new url \end{description}
\end{Desc}


Referenced by slot\-Finished().\index{KIO::ListJob@{KIO::List\-Job}!permanentRedirection@{permanentRedirection}}
\index{permanentRedirection@{permanentRedirection}!KIO::ListJob@{KIO::List\-Job}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KIO::List\-Job::permanent\-Redirection ({\bf KIO::Job} $\ast$ {\em job}, const {\bf KURL} \& {\em from\-Url}, const {\bf KURL} \& {\em to\-Url})\hspace{0.3cm}{\tt  [signal]}}\label{classKIO_1_1ListJob_l2}


Signals a permanent redirection. 

The redirection itself is handled internally. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em job}]the job that emitted this signal \item[{\em from\-Url}]the original URL \item[{\em to\-Url}]the new URL \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Referenced by slot\-Finished().\index{KIO::ListJob@{KIO::List\-Job}!slotFinished@{slotFinished}}
\index{slotFinished@{slotFinished}!KIO::ListJob@{KIO::List\-Job}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List\-Job::slot\-Finished ()\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKIO_1_1ListJob_j0}


Called when the slave marks the job as finished. 



Reimplemented from {\bf KIO::Simple\-Job} {\rm (p.\,\pageref{classKIO_1_1SimpleJob_j0})}.

Definition at line 2033 of file job.cpp.

References KIO::Scheduler::do\-Job(), KMime\-Type::find\-By\-URL(), KURL::is\-Empty(), QString::is\-Empty(), KURL::is\-Local\-File(), KURL::is\-Valid(), permanent\-Redirection(), KIO::Job::query\-Meta\-Data(), redirection(), KURL::set\-Protocol(), and KIO::Simple\-Job::slot\-Finished().\index{KIO::ListJob@{KIO::List\-Job}!slotMetaData@{slotMetaData}}
\index{slotMetaData@{slotMetaData}!KIO::ListJob@{KIO::List\-Job}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List\-Job::slot\-Meta\-Data (const {\bf KIO::Meta\-Data} \& {\em \_\-meta\-Data})\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKIO_1_1ListJob_j1}


{\bf Meta\-Data}{\rm (p.\,\pageref{classKIO_1_1MetaData})} from the slave is received. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-meta\-Data}]the meta data \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf meta\-Data()}{\rm (p.\,\pageref{classKIO_1_1Job_a21})} \end{Desc}


Reimplemented from {\bf KIO::Simple\-Job} {\rm (p.\,\pageref{classKIO_1_1SimpleJob_j6})}.

Definition at line 2068 of file job.cpp.

References KIO::Simple\-Job::slot\-Meta\-Data().\index{KIO::ListJob@{KIO::List\-Job}!slotResult@{slotResult}}
\index{slotResult@{slotResult}!KIO::ListJob@{KIO::List\-Job}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List\-Job::slot\-Result ({\bf KIO::Job} $\ast$ {\em job})\hspace{0.3cm}{\tt  [protected, virtual, slot]}}\label{classKIO_1_1ListJob_j2}


Called whenever a subjob finishes. 

Default implementation checks for errors and propagates to parent job, then calls remove\-Subjob. Override if you don't want subjobs errors to be propagated. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em job}]the subjob \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf result()}{\rm (p.\,\pageref{classKIO_1_1Job_l0})} \end{Desc}


Reimplemented from {\bf KIO::Job} {\rm (p.\,\pageref{classKIO_1_1Job_j0})}.

Definition at line 2013 of file job.cpp.

References KIO::Job::remove\-Subjob().

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