\section{KDir\-Lister Class Reference}
\label{classKDirLister}\index{KDirLister@{KDirLister}}
The dir lister deals with the kiojob used to list and update a directory and has signals for the user of this class (e.g. Helper class for the kiojob used to list and update a directory.  


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

Inheritance diagram for KDir\-Lister:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=65pt]{classKDirLister__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KDir\-Lister:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=49pt]{classKDirLister__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Which\-Items} \{ {\bf All\-Items} =  0, 
{\bf Filtered\-Items} =  1
 \}
\begin{CompactList}\small\item\em Used by {\bf items}{\rm (p.\,\pageref{classKDirLister_a31})}() and {\bf items\-For\-Dir}{\rm (p.\,\pageref{classKDirLister_a32})}() to specify whether you want all items for a directory or just the filtered ones. \item\end{CompactList}\end{CompactItemize}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf started} (const  {\bf KURL} \&\_\-url)
\begin{CompactList}\small\item\em Tell the view that we started to list {\tt \_\-url}. \item\end{CompactList}\item 
void {\bf completed} ()
\begin{CompactList}\small\item\em Tell the view that listing is finished. \item\end{CompactList}\item 
void {\bf completed} (const  {\bf KURL} \&\_\-url)
\begin{CompactList}\small\item\em Tell the view that the listing of the directory {\tt \_\-url} is finished. \item\end{CompactList}\item 
void {\bf canceled} ()
\begin{CompactList}\small\item\em Tell the view that the user canceled the listing. \item\end{CompactList}\item 
void {\bf canceled} (const  {\bf KURL} \&\_\-url)
\begin{CompactList}\small\item\em Tell the view that the listing of the directory {\tt \_\-url} was canceled. \item\end{CompactList}\item 
void {\bf redirection} (const  {\bf KURL} \&\_\-url)
\begin{CompactList}\small\item\em Signal a redirection. \item\end{CompactList}\item 
void {\bf redirection} (const  {\bf KURL} \&old\-Url, const  {\bf KURL} \&new\-Url)
\begin{CompactList}\small\item\em Signal a redirection. \item\end{CompactList}\item 
void {\bf clear} ()
\begin{CompactList}\small\item\em Signal to clear all items. \item\end{CompactList}\item 
void {\bf clear} (const  {\bf KURL} \&\_\-url)
\begin{CompactList}\small\item\em Signal to empty the directory {\tt \_\-url}. \item\end{CompactList}\item 
void {\bf new\-Items} (const  {\bf KFile\-Item\-List} \&items)
\begin{CompactList}\small\item\em Signal new items. \item\end{CompactList}\item 
void {\bf items\-Filtered\-By\-Mime} (const  {\bf KFile\-Item\-List} \&items)
\begin{CompactList}\small\item\em Send a list of items filtered-out by mime-type. \item\end{CompactList}\item 
void {\bf delete\-Item} ({\bf KFile\-Item} $\ast$\_\-file\-Item)
\begin{CompactList}\small\item\em Signal an item to remove. \item\end{CompactList}\item 
void {\bf refresh\-Items} (const  {\bf KFile\-Item\-List} \&items)
\begin{CompactList}\small\item\em Signal an item to refresh (its mimetype/icon/name has changed). \item\end{CompactList}\item 
void {\bf info\-Message} (const  {\bf QString} \&msg)
\begin{CompactList}\small\item\em Emitted to display information about running jobs. \item\end{CompactList}\item 
void {\bf percent} (int percent)
\begin{CompactList}\small\item\em Progress signal showing the overall progress of the KDir\-Lister. \item\end{CompactList}\item 
void {\bf total\-Size} (KIO::filesize\_\-t size)
\begin{CompactList}\small\item\em Emitted when we know the size of the jobs. \item\end{CompactList}\item 
void {\bf processed\-Size} (KIO::filesize\_\-t size)
\begin{CompactList}\small\item\em Regularly emitted to show the progress of this KDir\-Lister. \item\end{CompactList}\item 
void {\bf speed} (int bytes\_\-per\_\-second)
\begin{CompactList}\small\item\em Emitted to display information about the speed of the jobs. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KDir\-Lister} (bool \_\-delayed\-Mime\-Types=false)
\begin{CompactList}\small\item\em Create a directory lister. \item\end{CompactList}\item 
virtual {\bf $\sim$KDir\-Lister} ()
\begin{CompactList}\small\item\em Destroy the directory lister. \item\end{CompactList}\item 
virtual bool {\bf open\-URL} (const  {\bf KURL} \&\_\-url, bool \_\-keep=false, bool \_\-reload=false)
\begin{CompactList}\small\item\em Run the directory lister on the given url. \item\end{CompactList}\item 
virtual void {\bf stop} ()
\begin{CompactList}\small\item\em Stop listing all directories currently being listed. \item\end{CompactList}\item 
virtual void {\bf stop} (const  {\bf KURL} \&\_\-url)
\begin{CompactList}\small\item\em Stop listing the given directory. \item\end{CompactList}\item 
bool {\bf auto\-Update} () const 
\begin{CompactList}\small\item\em Checks whether {\bf KDir\-Watch}{\rm (p.\,\pageref{classKDirWatch})} will automatically update directories. \item\end{CompactList}\item 
virtual void {\bf set\-Auto\-Update} (bool enable)
\begin{CompactList}\small\item\em Enable/disable automatic directory updating, when a directory changes (using {\bf KDir\-Watch}{\rm (p.\,\pageref{classKDirWatch})}). \item\end{CompactList}\item 
bool {\bf auto\-Error\-Handling\-Enabled} () const 
\begin{CompactList}\small\item\em Check whether auto error handling is enabled. \item\end{CompactList}\item 
void {\bf set\-Auto\-Error\-Handling\-Enabled} (bool enable, {\bf QWidget} $\ast${\bf parent})
\begin{CompactList}\small\item\em Enable or disable auto error handling is enabled. \item\end{CompactList}\item 
bool {\bf showing\-Dot\-Files} () const 
\begin{CompactList}\small\item\em Checks whether hidden files (files beginning with a dot) will be shown. \item\end{CompactList}\item 
virtual void {\bf set\-Showing\-Dot\-Files} (bool \_\-show\-Dot\-Files)
\begin{CompactList}\small\item\em Changes the \char`\"{}is viewing dot files\char`\"{} setting. \item\end{CompactList}\item 
bool {\bf dir\-Only\-Mode} () const 
\begin{CompactList}\small\item\em Checks whether the KDir\-Lister only lists directories or all files. \item\end{CompactList}\item 
virtual void {\bf set\-Dir\-Only\-Mode} (bool dirs\-Only)
\begin{CompactList}\small\item\em Call this to list only directories. \item\end{CompactList}\item 
const  {\bf KURL} \& {\bf url} () const 
\begin{CompactList}\small\item\em Returns the URL that is listed by this KDir\-Lister. \item\end{CompactList}\item 
virtual void {\bf emit\-Changes} ()
\begin{CompactList}\small\item\em Actually emit the changes made with set\-Showing\-Dot\-Files, set\-Dir\-Only\-Mode, set\-Name\-Filter and set\-Mime\-Filter. \item\end{CompactList}\item 
virtual void {\bf update\-Directory} (const  {\bf KURL} \&\_\-dir)
\begin{CompactList}\small\item\em Update the directory {\tt \_\-dir}. \item\end{CompactList}\item 
bool {\bf is\-Finished} () const 
\begin{CompactList}\small\item\em Returns true if no io operation is currently in progress. \item\end{CompactList}\item 
{\bf KFile\-Item} $\ast$ {\bf root\-Item} () const 
\begin{CompactList}\small\item\em Returns the file item of the URL. \item\end{CompactList}\item 
virtual {\bf KFile\-Item} $\ast$ {\bf find\-By\-URL} (const  {\bf KURL} \&\_\-url) const 
\begin{CompactList}\small\item\em Find an item by its URL. \item\end{CompactList}\item 
{\bf KFile\-Item} $\ast$ {\bf find} (const  {\bf KURL} \&\_\-url) const \label{classKDirLister_a19}

\item 
virtual {\bf KFile\-Item} $\ast$ {\bf find\-By\-Name} (const  {\bf QString} \&{\bf name}) const 
\begin{CompactList}\small\item\em Find an item by its name. \item\end{CompactList}\item 
virtual void {\bf set\-Name\-Filter} (const  {\bf QString} \&filter)
\begin{CompactList}\small\item\em Set a name filter to only list items matching this name, e.g. \item\end{CompactList}\item 
const  {\bf QString} \& {\bf name\-Filter} () const 
\begin{CompactList}\small\item\em Returns the current name filter, as set via {\bf set\-Name\-Filter}{\rm (p.\,\pageref{classKDirLister_a21})}(). \item\end{CompactList}\item 
virtual void {\bf set\-Mime\-Filter} (const  {\bf QString\-List} \&mime\-List)
\begin{CompactList}\small\item\em Set mime-based filter to only list items matching the given mimetypes. \item\end{CompactList}\item 
void {\bf set\-Mime\-Exclude\-Filter} (const  {\bf QString\-List} \&mime\-List)
\begin{CompactList}\small\item\em Filtering should be done with KFile\-Filter. \item\end{CompactList}\item 
virtual void {\bf clear\-Mime\-Filter} ()
\begin{CompactList}\small\item\em Clears the mime based filter. \item\end{CompactList}\item 
const  {\bf QString\-List} \& {\bf mime\-Filters} () const 
\begin{CompactList}\small\item\em Returns the list of mime based filters, as set via {\bf set\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a23})}(). \item\end{CompactList}\item 
bool {\bf matches\-Filter} (const  {\bf QString} \&{\bf name}) const 
\begin{CompactList}\small\item\em Checks whether {\tt name} matches a filter in the list of name filters. \item\end{CompactList}\item 
bool {\bf matches\-Mime\-Filter} (const  {\bf QString} \&mime) const 
\begin{CompactList}\small\item\em Checks whether {\tt mime} matches a filter in the list of mime types. \item\end{CompactList}\item 
void {\bf set\-Main\-Window} ({\bf QWidget} $\ast$window)
\begin{CompactList}\small\item\em Pass the main window this object is associated with this is used for caching authentication data. \item\end{CompactList}\item 
{\bf QWidget} $\ast$ {\bf main\-Window} ()
\begin{CompactList}\small\item\em Returns the main window associated with this object. \item\end{CompactList}\item 
{\bf KFile\-Item\-List} {\bf items} ({\bf Which\-Items} which=Filtered\-Items) const 
\begin{CompactList}\small\item\em Returns the items listed for the current {\bf url}{\rm (p.\,\pageref{classKDirLister_a13})}(). \item\end{CompactList}\item 
{\bf KFile\-Item\-List} {\bf items\-For\-Dir} (const  {\bf KURL} \&dir, {\bf Which\-Items} which=Filtered\-Items) const 
\begin{CompactList}\small\item\em Returns the items listed for the given {\tt dir}. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Types}
\begin{CompactItemize}
\item 
enum {\bf Changes} \{ \par
{\bf NONE} = 0, 
{\bf NAME\_\-FILTER} = 1, 
{\bf MIME\_\-FILTER} = 2, 
{\bf DOT\_\-FILES} = 4, 
\par
{\bf DIR\_\-ONLY\_\-MODE} = 8
 \}
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual bool {\bf matches\-Filter} (const  {\bf KFile\-Item} $\ast$) const 
\begin{CompactList}\small\item\em Called for every new item before emitting {\bf new\-Items}{\rm (p.\,\pageref{classKDirLister_l9})}(). \item\end{CompactList}\item 
virtual bool {\bf matches\-Mime\-Filter} (const  {\bf KFile\-Item} $\ast$) const 
\begin{CompactList}\small\item\em Called for every new item before emitting {\bf new\-Items}{\rm (p.\,\pageref{classKDirLister_l9})}(). \item\end{CompactList}\item 
virtual bool {\bf do\-Name\-Filter} (const  {\bf QString} \&{\bf name}, const  {\bf QPtr\-List}$<$ {\bf QReg\-Exp} $>$ \&filters) const 
\begin{CompactList}\small\item\em Called by the public {\bf matches\-Filter}{\rm (p.\,\pageref{classKDirLister_a27})}() to do the actual filtering. \item\end{CompactList}\item 
virtual bool {\bf do\-Mime\-Filter} (const  {\bf QString} \&mime, const  {\bf QString\-List} \&filters) const 
\begin{CompactList}\small\item\em Called by the public {\bf matches\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a28})}() to do the actual filtering. \item\end{CompactList}\item 
bool {\bf do\-Mime\-Exclude\-Filter} (const  {\bf QString} \&mime\-Exclude, const  {\bf QString\-List} \&filters) const \label{classKDirLister_b4}

\item 
virtual bool {\bf valid\-URL} (const  {\bf KURL} \&) const 
\begin{CompactList}\small\item\em Checks if an url is malformed or not and displays an error message if it is and auto\-Error\-Handling is set to true. \item\end{CompactList}\item 
virtual void {\bf handle\-Error} ({\bf KIO::Job} $\ast$)
\begin{CompactList}\small\item\em Reimplement to customize error handling. \item\end{CompactList}\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKDirLister_b7}

\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
class {\bf KDir\-Lister\-Private}\label{classKDirLister_n0}

\item 
class {\bf KDir\-Lister\-Cache}\label{classKDirLister_n1}

\end{CompactItemize}


\subsection{Detailed Description}
The dir lister deals with the kiojob used to list and update a directory and has signals for the user of this class (e.g. Helper class for the kiojob used to list and update a directory. 

konqueror view or kdesktop) to create/destroy its items when asked.

This class is independent from the graphical representation of the dir (icon container, tree view, ...) and it stores the items (as KFile\-Items).

Typical usage : \begin{itemize}
\item Create an instance. \item Connect to at least update, clear, new\-Item, and delete\-Item. \item Call open\-URL - the signals will be called. \item Reuse the instance when opening a new url (open\-URL). \item Destroy the instance when not needed anymore (usually destructor).\end{itemize}
Advanced usage : call open\-URL with \_\-keep = true to list directories without forgetting the ones previously read (e.g. for a tree view)



Definition at line 54 of file kdirlister.h.

\subsection{Member Enumeration Documentation}
\index{KDirLister@{KDir\-Lister}!WhichItems@{WhichItems}}
\index{WhichItems@{WhichItems}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KDir\-Lister::Which\-Items}}\label{classKDirLister_w2}


Used by {\bf items}{\rm (p.\,\pageref{classKDirLister_a31})}() and {\bf items\-For\-Dir}{\rm (p.\,\pageref{classKDirLister_a32})}() to specify whether you want all items for a directory or just the filtered ones. 



Definition at line 350 of file kdirlister.h.

\subsection{Constructor \& Destructor Documentation}
\index{KDirLister@{KDir\-Lister}!KDirLister@{KDirLister}}
\index{KDirLister@{KDirLister}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDir\-Lister::KDir\-Lister (bool {\em \_\-delayed\-Mime\-Types} = false)}\label{classKDirLister_a0}


Create a directory lister. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-delayed\-Mime\-Types}]if true, mime types will be fetched on demand. If false, they will always be fetched immediately \end{description}
\end{Desc}


Definition at line 1512 of file kdirlister.cpp.

References set\-Auto\-Error\-Handling\-Enabled(), set\-Auto\-Update(), set\-Dir\-Only\-Mode(), and set\-Showing\-Dot\-Files().\index{KDirLister@{KDir\-Lister}!~KDirLister@{$\sim$KDirLister}}
\index{~KDirLister@{$\sim$KDirLister}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDir\-Lister::$\sim${\bf KDir\-Lister} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a1}


Destroy the directory lister. 



Definition at line 1526 of file kdirlister.cpp.

References stop().

\subsection{Member Function Documentation}
\index{KDirLister@{KDir\-Lister}!openURL@{openURL}}
\index{openURL@{openURL}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::open\-URL (const {\bf KURL} \& {\em \_\-url}, bool {\em \_\-keep} = false, bool {\em \_\-reload} = false)\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a2}


Run the directory lister on the given url. 

This method causes KDir\-Lister to emit \_\-all\_\- the items of {\tt \_\-url}, in any case. Depending on {\tt \_\-keep} either {\bf clear}{\rm (p.\,\pageref{classKDirLister_l7})}() or {\bf clear}{\rm (p.\,\pageref{classKDirLister_l7})}(const {\bf KURL} \&) will be emitted first.

The {\bf new\-Items}{\rm (p.\,\pageref{classKDirLister_l9})}() signal may be emitted more than once to supply you with KFile\-Items, up until the signal {\bf completed}{\rm (p.\,\pageref{classKDirLister_l1})}() is emitted (and {\bf is\-Finished}{\rm (p.\,\pageref{classKDirLister_a16})}() returns true).

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-url}]the directory URL. \item[{\em \_\-keep}]if true the previous directories aren't forgotten (they are still watched by kdirwatch and their items are kept for this KDir\-Lister). This is useful for e.g. a treeview. \item[{\em \_\-reload}]indicates wether to use the cache (false) or to reread the directory from the disk. Use only when opening a dir not yet listed by this lister without using the cache. Otherwise use update\-Directory. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]true if successful, false otherwise (e.g. invalid {\tt \_\-url}) \end{Desc}


Definition at line 1535 of file kdirlister.cpp.

References emit\-Changes(), KURL::pretty\-URL(), and valid\-URL().

Referenced by KFile\-Tree\-Branch::populate(), KDir\-Operator::reread\-Dir(), and KDir\-Operator::set\-URL().\index{KDirLister@{KDir\-Lister}!stop@{stop}}
\index{stop@{stop}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::stop ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a3}


Stop listing all directories currently being listed. 

Emits {\bf canceled}{\rm (p.\,\pageref{classKDirLister_l3})}() if there was at least one job running. Emits {\bf canceled}{\rm (p.\,\pageref{classKDirLister_l3})}( const {\bf KURL}\& ) for each stopped job if there are at least two dirctories being watched by KDir\-Lister. 

Definition at line 1554 of file kdirlister.cpp.

Referenced by KDir\-Operator::close(), and $\sim$KDir\-Lister().\index{KDirLister@{KDir\-Lister}!stop@{stop}}
\index{stop@{stop}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::stop (const {\bf KURL} \& {\em \_\-url})\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a4}


Stop listing the given directory. 

Emits {\bf canceled}{\rm (p.\,\pageref{classKDirLister_l3})}() if the killed job was the last running one. Emits {\bf canceled}{\rm (p.\,\pageref{classKDirLister_l3})}( const {\bf KURL}\& ) for the killed job if there are at least two directories being watched by KDir\-Lister. No signal is emitted if there was no job running for {\tt \_\-url}. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-url}]the directory URL \end{description}
\end{Desc}


Definition at line 1560 of file kdirlister.cpp.

References KURL::pretty\-URL().\index{KDirLister@{KDir\-Lister}!autoUpdate@{autoUpdate}}
\index{autoUpdate@{autoUpdate}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::auto\-Update () const}\label{classKDirLister_a5}


Checks whether {\bf KDir\-Watch}{\rm (p.\,\pageref{classKDirWatch})} will automatically update directories. 

This is enabled by default. \begin{Desc}
\item[Returns:]true if {\bf KDir\-Watch}{\rm (p.\,\pageref{classKDirWatch})} is used to automatically update directories. \end{Desc}


Definition at line 1566 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!setAutoUpdate@{setAutoUpdate}}
\index{setAutoUpdate@{setAutoUpdate}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::set\-Auto\-Update (bool {\em enable})\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a6}


Enable/disable automatic directory updating, when a directory changes (using {\bf KDir\-Watch}{\rm (p.\,\pageref{classKDirWatch})}). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em enable}]true to enable, false to disable \end{description}
\end{Desc}


Definition at line 1571 of file kdirlister.cpp.

Referenced by KDir\-Lister(), and KDir\-Operator::set\-Dir\-Lister().\index{KDirLister@{KDir\-Lister}!autoErrorHandlingEnabled@{autoErrorHandlingEnabled}}
\index{autoErrorHandlingEnabled@{autoErrorHandlingEnabled}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::auto\-Error\-Handling\-Enabled () const}\label{classKDirLister_a7}


Check whether auto error handling is enabled. 

If enabled, it will show an error dialog to the user when an error occurs. It is turned on by default. \begin{Desc}
\item[Returns:]true if auto error handling is enabled, false otherwise \end{Desc}
\begin{Desc}
\item[See also:]{\bf set\-Auto\-Error\-Handling\-Enabled()}{\rm (p.\,\pageref{classKDirLister_a8})} \end{Desc}


Definition at line 1608 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!setAutoErrorHandlingEnabled@{setAutoErrorHandlingEnabled}}
\index{setAutoErrorHandlingEnabled@{setAutoErrorHandlingEnabled}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::set\-Auto\-Error\-Handling\-Enabled (bool {\em enable}, {\bf QWidget} $\ast$ {\em parent})}\label{classKDirLister_a8}


Enable or disable auto error handling is enabled. 

If enabled, it will show an error dialog to the user when an error occurs. It is turned on by default. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em enable}]true to enable auto error handling, false to disable \item[{\em parent}]the parent widget for the error dialogs, can be 0 for top-level \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf auto\-Error\-Handling\-Enabled()}{\rm (p.\,\pageref{classKDirLister_a7})} \end{Desc}


Definition at line 1613 of file kdirlister.cpp.

Referenced by KDir\-Lister().\index{KDirLister@{KDir\-Lister}!showingDotFiles@{showingDotFiles}}
\index{showingDotFiles@{showingDotFiles}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::showing\-Dot\-Files () const}\label{classKDirLister_a9}


Checks whether hidden files (files beginning with a dot) will be shown. 

By default this option is disabled (hidden files will be not shown). \begin{Desc}
\item[Returns:]true if dot files are shown, false otherwise \end{Desc}
\begin{Desc}
\item[See also:]{\bf set\-Showing\-Dot\-Files()}{\rm (p.\,\pageref{classKDirLister_a10})} \end{Desc}


Definition at line 1580 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!setShowingDotFiles@{setShowingDotFiles}}
\index{setShowingDotFiles@{setShowingDotFiles}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::set\-Showing\-Dot\-Files (bool {\em \_\-show\-Dot\-Files})\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a10}


Changes the \char`\"{}is viewing dot files\char`\"{} setting. 

Calls {\bf update\-Directory}{\rm (p.\,\pageref{classKDirLister_a15})}() if setting changed. By default this option is disabled (hidden files will not be shown). \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-show\-Dot\-Files}]true to enable showing hidden files, false to disable \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf showing\-Dot\-Files()}{\rm (p.\,\pageref{classKDirLister_a9})} \end{Desc}


Definition at line 1585 of file kdirlister.cpp.

Referenced by KDir\-Lister(), KFile\-Tree\-Branch::KFile\-Tree\-Branch(), and KDir\-Operator::read\-Config().\index{KDirLister@{KDir\-Lister}!dirOnlyMode@{dirOnlyMode}}
\index{dirOnlyMode@{dirOnlyMode}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::dir\-Only\-Mode () const}\label{classKDirLister_a11}


Checks whether the KDir\-Lister only lists directories or all files. 

By default this option is disabled (all files will be shown). \begin{Desc}
\item[Returns:]true if set\-Dir\-Only\-Mode(true) was called \end{Desc}


Definition at line 1594 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!setDirOnlyMode@{setDirOnlyMode}}
\index{setDirOnlyMode@{setDirOnlyMode}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::set\-Dir\-Only\-Mode (bool {\em dirs\-Only})\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a12}


Call this to list only directories. 

By default this option is disabled (all files will be shown). \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em dirs\-Only}]true to list only directories \end{description}
\end{Desc}


Definition at line 1599 of file kdirlister.cpp.

Referenced by KDir\-Lister(), KFile\-Tree\-View::set\-Dir\-Only\-Mode(), and KDir\-Operator::set\-Mode().\index{KDirLister@{KDir\-Lister}!url@{url}}
\index{url@{url}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const  {\bf KURL} \& KDir\-Lister::url () const}\label{classKDirLister_a13}


Returns the URL that is listed by this KDir\-Lister. 

It might be different from the one given with {\bf open\-URL}{\rm (p.\,\pageref{classKDirLister_a2})}(). if there was a redirection. If you called {\bf open\-URL}{\rm (p.\,\pageref{classKDirLister_a2})}() with {\tt \_\-keep} == true, this is the first url opened (in e.g. a treeview this is the root).

\begin{Desc}
\item[Returns:]the url used by this instance to list the files. \end{Desc}


Definition at line 1619 of file kdirlister.cpp.

Referenced by items().\index{KDirLister@{KDir\-Lister}!emitChanges@{emitChanges}}
\index{emitChanges@{emitChanges}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::emit\-Changes ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a14}


Actually emit the changes made with set\-Showing\-Dot\-Files, set\-Dir\-Only\-Mode, set\-Name\-Filter and set\-Mime\-Filter. 



Definition at line 1624 of file kdirlister.cpp.

References QPtr\-List\-Iterator::current(), delete\-Item(), do\-Mime\-Filter(), do\-Name\-Filter(), QValue\-List$<$ KURL $>$::Iterator(), and KGlobal::static\-QString().

Referenced by open\-URL(), and KDir\-Operator::update\-Dir().\index{KDirLister@{KDir\-Lister}!updateDirectory@{updateDirectory}}
\index{updateDirectory@{updateDirectory}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::update\-Directory (const {\bf KURL} \& {\em \_\-dir})\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a15}


Update the directory {\tt \_\-dir}. 

This method causes KDir\-Lister to \_\-only\_\- emit the items of {\tt \_\-dir} that actually changed compared to the current state in the cache and updates the cache.

The current implementation calls update\-Directory automatically for local files, using {\bf KDir\-Watch}{\rm (p.\,\pageref{classKDirWatch})} (if {\bf auto\-Update()}{\rm (p.\,\pageref{classKDirLister_a5})} is true), but it might be useful to force an update manually.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-dir}]the directory URL \end{description}
\end{Desc}


Definition at line 1713 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!isFinished@{isFinished}}
\index{isFinished@{isFinished}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::is\-Finished () const}\label{classKDirLister_a16}


Returns true if no io operation is currently in progress. 

\begin{Desc}
\item[Returns:]true if finished, false otherwise \end{Desc}


Definition at line 1718 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!rootItem@{rootItem}}
\index{rootItem@{rootItem}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KFile\-Item} $\ast$ KDir\-Lister::root\-Item () const}\label{classKDirLister_a17}


Returns the file item of the URL. 

\begin{Desc}
\item[Returns:]the file item for {\bf url()}{\rm (p.\,\pageref{classKDirLister_a13})} itself (\char`\"{}.\char`\"{}) \end{Desc}


Definition at line 1723 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!findByURL@{findByURL}}
\index{findByURL@{findByURL}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KFile\-Item} $\ast$ KDir\-Lister::find\-By\-URL (const {\bf KURL} \& {\em \_\-url}) const\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a18}


Find an item by its URL. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-url}]the item URL \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the pointer to the {\bf KFile\-Item}{\rm (p.\,\pageref{classKFileItem})} \end{Desc}


Definition at line 1728 of file kdirlister.cpp.

Referenced by KFile\-Tree\-Branch::find\-TVIBy\-URL().\index{KDirLister@{KDir\-Lister}!findByName@{findByName}}
\index{findByName@{findByName}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KFile\-Item} $\ast$ KDir\-Lister::find\-By\-Name (const {\bf QString} \& {\em name}) const\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a20}


Find an item by its name. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]the item name \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the pointer to the {\bf KFile\-Item}{\rm (p.\,\pageref{classKFileItem})} \end{Desc}


Definition at line 1733 of file kdirlister.cpp.

Referenced by KDir\-Operator::set\-Current\-Item().\index{KDirLister@{KDir\-Lister}!setNameFilter@{setNameFilter}}
\index{setNameFilter@{setNameFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::set\-Name\-Filter (const {\bf QString} \& {\em filter})\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a21}


Set a name filter to only list items matching this name, e.g. 

\char`\"{}$\ast$.cpp\char`\"{}.

You can set more than one filter by separating them with whitespace, e.g \char`\"{}$\ast$.cpp $\ast$.h\char`\"{}. Note: the direcory is not automatically reloaded.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em filer}]the new filter, QString::null to disable filtering \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf matches\-Filter}{\rm (p.\,\pageref{classKDirLister_a27})} \end{Desc}


Definition at line 1748 of file kdirlister.cpp.

References QString\-List::split().

Referenced by KDir\-Operator::clear\-Filter(), and KDir\-Operator::set\-Name\-Filter().\index{KDirLister@{KDir\-Lister}!nameFilter@{nameFilter}}
\index{nameFilter@{nameFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const  {\bf QString} \& KDir\-Lister::name\-Filter () const}\label{classKDirLister_a22}


Returns the current name filter, as set via {\bf set\-Name\-Filter}{\rm (p.\,\pageref{classKDirLister_a21})}(). 

\begin{Desc}
\item[Returns:]the current name filter, can be QString::null if filtering is turned off \end{Desc}


Definition at line 1769 of file kdirlister.cpp.

Referenced by KDir\-Operator::name\-Filter().\index{KDirLister@{KDir\-Lister}!setMimeFilter@{setMimeFilter}}
\index{setMimeFilter@{setMimeFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::set\-Mime\-Filter (const {\bf QString\-List} \& {\em mime\-List})\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a23}


Set mime-based filter to only list items matching the given mimetypes. 

NOTE: setting the filter does not automatically reload direcory. Also calling this function will not affect any named filter already set.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mime\-List}]a list of mime-types.\end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf clear\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a25})} 

{\bf matches\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a28})} \end{Desc}


Definition at line 1774 of file kdirlister.cpp.

Referenced by KDir\-Operator::set\-Mime\-Filter().\index{KDirLister@{KDir\-Lister}!setMimeExcludeFilter@{setMimeExcludeFilter}}
\index{setMimeExcludeFilter@{setMimeExcludeFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::set\-Mime\-Exclude\-Filter (const {\bf QString\-List} \& {\em mime\-List})}\label{classKDirLister_a24}


Filtering should be done with KFile\-Filter. 

This will be implemented in a later revision of KDir\-Lister. This method may be removed then.

Set mime-based exclude filter to only list items not matching the given mimetypes

NOTE: setting the filter does not automatically reload direcory. Also calling this function will not affect any named filter already set.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mime\-List}]a list of mime-types. \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf clear\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a25})} 

{\bf matches\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a28})} \end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 1788 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!clearMimeFilter@{clearMimeFilter}}
\index{clearMimeFilter@{clearMimeFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::clear\-Mime\-Filter ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKDirLister_a25}


Clears the mime based filter. 

\begin{Desc}
\item[See also:]{\bf set\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a23})} \end{Desc}


Definition at line 1798 of file kdirlister.cpp.

Referenced by KDir\-Operator::clear\-Filter().\index{KDirLister@{KDir\-Lister}!mimeFilters@{mimeFilters}}
\index{mimeFilters@{mimeFilters}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const  {\bf QString\-List} \& KDir\-Lister::mime\-Filters () const}\label{classKDirLister_a26}


Returns the list of mime based filters, as set via {\bf set\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a23})}(). 

\begin{Desc}
\item[Returns:]the list of mime based filters. Empty, when no mime filter is set. \end{Desc}


Definition at line 1810 of file kdirlister.cpp.

Referenced by KDir\-Operator::mime\-Filter().\index{KDirLister@{KDir\-Lister}!matchesFilter@{matchesFilter}}
\index{matchesFilter@{matchesFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::matches\-Filter (const {\bf QString} \& {\em name}) const}\label{classKDirLister_a27}


Checks whether {\tt name} matches a filter in the list of name filters. 

\begin{Desc}
\item[Returns:]true if {\tt name} matches a filter in the list, otherwise false. \end{Desc}
\begin{Desc}
\item[See also:]{\bf set\-Name\-Filter}{\rm (p.\,\pageref{classKDirLister_a21})} \end{Desc}


Definition at line 1815 of file kdirlister.cpp.

References do\-Name\-Filter(), and KStd\-Accel::name().

Referenced by items\-For\-Dir(), and matches\-Filter().\index{KDirLister@{KDir\-Lister}!matchesMimeFilter@{matchesMimeFilter}}
\index{matchesMimeFilter@{matchesMimeFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::matches\-Mime\-Filter (const {\bf QString} \& {\em mime}) const}\label{classKDirLister_a28}


Checks whether {\tt mime} matches a filter in the list of mime types. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mime}]the mimetype to find in the filter list. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]true if {\tt name} matches a filter in the list, otherwise false. \end{Desc}
\begin{Desc}
\item[See also:]{\bf set\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a23})}. \end{Desc}


Definition at line 1820 of file kdirlister.cpp.

References do\-Mime\-Filter().

Referenced by items\-For\-Dir(), and matches\-Mime\-Filter().\index{KDirLister@{KDir\-Lister}!setMainWindow@{setMainWindow}}
\index{setMainWindow@{setMainWindow}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::set\-Main\-Window ({\bf QWidget} $\ast$ {\em window})}\label{classKDirLister_a29}


Pass the main window this object is associated with this is used for caching authentication data. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em window}]the window to associate with, 0 to disassociate \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 2094 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!mainWindow@{mainWindow}}
\index{mainWindow@{mainWindow}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QWidget} $\ast$ KDir\-Lister::main\-Window ()}\label{classKDirLister_a30}


Returns the main window associated with this object. 

\begin{Desc}
\item[Returns:]the associated main window, or 0 if there is none \end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 2099 of file kdirlister.cpp.\index{KDirLister@{KDir\-Lister}!items@{items}}
\index{items@{items}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KFile\-Item\-List} KDir\-Lister::items ({\bf Which\-Items} {\em which} = Filtered\-Items) const}\label{classKDirLister_a31}


Returns the items listed for the current {\bf url}{\rm (p.\,\pageref{classKDirLister_a13})}(). 

This method will NOT start listing a directory, you should only call this when receiving the finished() signal.

The items in the KFile\-Item\-List are references to the items used by KDir\-Lister, so e.g. an item gets destroyed when the {\bf delete\-Item}{\rm (p.\,\pageref{classKDirLister_l11})}() signal is emitted.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em which}]specifies whether the returned list will contain all entries or only the ones that passed the {\bf name\-Filter}{\rm (p.\,\pageref{classKDirLister_a22})}(), mime\-Filter(), etc. Note that the latter causes iteration over all the items, filtering them. If this is too slow for you, use the {\bf new\-Items}{\rm (p.\,\pageref{classKDirLister_l9})}() signal, sending out filtered items in chunks. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the items listed for the current {\bf url}{\rm (p.\,\pageref{classKDirLister_a13})}(). \end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 2104 of file kdirlister.cpp.

References items\-For\-Dir(), and url().\index{KDirLister@{KDir\-Lister}!itemsForDir@{itemsForDir}}
\index{itemsForDir@{itemsForDir}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KFile\-Item\-List} KDir\-Lister::items\-For\-Dir (const {\bf KURL} \& {\em dir}, {\bf Which\-Items} {\em which} = Filtered\-Items) const}\label{classKDirLister_a32}


Returns the items listed for the given {\tt dir}. 

This method will NOT start listing {\tt dir}, you should only call this when receiving the finished() signal.

The items in the KFile\-Item\-List are references to the items used by KDir\-Lister, so e.g. an item gets destroyed when the {\bf delete\-Item}{\rm (p.\,\pageref{classKDirLister_l11})}() signal is emitted.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em dir}]specifies the url for which the items should be returned. This is only useful if you use KDir\-Lister with multiple URLs i.e. using bool keep = true in {\bf open\-URL}{\rm (p.\,\pageref{classKDirLister_a2})}(). \item[{\em which}]specifies whether the returned list will contain all entries or only the ones that passed the name\-Filter, mime\-Filter, etc. Note that the latter causes iteration over all the items, filtering them. If this is too slow for you, use the {\bf new\-Items}{\rm (p.\,\pageref{classKDirLister_l9})}() signal, sending out filtered items in chunks. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the items listed for the current {\bf url}{\rm (p.\,\pageref{classKDirLister_a13})}(). \end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 2109 of file kdirlister.cpp.

References QPtr\-List::append(), QPtr\-List\-Iterator::current(), KFile\-Item::is\-Dir(), matches\-Filter(), and matches\-Mime\-Filter().

Referenced by items().\index{KDirLister@{KDir\-Lister}!started@{started}}
\index{started@{started}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::started (const {\bf KURL} \& {\em \_\-url})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l0}


Tell the view that we started to list {\tt \_\-url}. 

NOTE: this does \_\-not\_\- imply that there is really a job running! I.e. KDir\-Lister::jobs() may return an empty list. In this case the items are taken from the cache.

The view knows that open\-URL should start it, so it might seem useless, but the view also needs to know when an automatic update happens. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-url}]the URL to list \end{description}
\end{Desc}


Referenced by KFile\-Tree\-Branch::KFile\-Tree\-Branch().\index{KDirLister@{KDir\-Lister}!completed@{completed}}
\index{completed@{completed}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::completed ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l1}


Tell the view that listing is finished. 

There are no jobs running anymore. 

Referenced by KFile\-Tree\-Branch::KFile\-Tree\-Branch().\index{KDirLister@{KDir\-Lister}!completed@{completed}}
\index{completed@{completed}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::completed (const {\bf KURL} \& {\em \_\-url})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l2}


Tell the view that the listing of the directory {\tt \_\-url} is finished. 

There might be other running jobs left. This signal is only emitted if KDir\-Lister is watching more than one directory. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-url}]the directory URL \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!canceled@{canceled}}
\index{canceled@{canceled}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::canceled ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l3}


Tell the view that the user canceled the listing. 

No running jobs are left. 

Referenced by KFile\-Tree\-Branch::KFile\-Tree\-Branch().\index{KDirLister@{KDir\-Lister}!canceled@{canceled}}
\index{canceled@{canceled}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::canceled (const {\bf KURL} \& {\em \_\-url})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l4}


Tell the view that the listing of the directory {\tt \_\-url} was canceled. 

There might be other running jobs left. This signal is only emitted if KDir\-Lister is watching more than one directory. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-url}]the directory URL \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!redirection@{redirection}}
\index{redirection@{redirection}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::redirection (const {\bf KURL} \& {\em \_\-url})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l5}


Signal a redirection. 

Only emitted if there's just one directory to list, i.e. most probably {\bf open\-URL}{\rm (p.\,\pageref{classKDirLister_a2})}() has been called with  == false. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-url}]the new URL \end{description}
\end{Desc}


Referenced by KFile\-Tree\-Branch::KFile\-Tree\-Branch().\index{KDirLister@{KDir\-Lister}!redirection@{redirection}}
\index{redirection@{redirection}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::redirection (const {\bf KURL} \& {\em old\-Url}, const {\bf KURL} \& {\em new\-Url})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l6}


Signal a redirection. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em old\-Url}]the original URL \item[{\em new\-Url}]the new URL \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!clear@{clear}}
\index{clear@{clear}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::clear ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l7}


Signal to clear all items. 

It must always be connected to this signal to avoid doubled items! 

Referenced by KFile\-Tree\-Branch::KFile\-Tree\-Branch().\index{KDirLister@{KDir\-Lister}!clear@{clear}}
\index{clear@{clear}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::clear (const {\bf KURL} \& {\em \_\-url})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l8}


Signal to empty the directory {\tt \_\-url}. 

It is only emitted if the lister is holding more than one directory. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-url}]the directory that will be emptied \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!newItems@{newItems}}
\index{newItems@{newItems}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::new\-Items (const {\bf KFile\-Item\-List} \& {\em items})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l9}


Signal new items. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em items}]a list of new items \end{description}
\end{Desc}


Referenced by KFile\-Tree\-Branch::KFile\-Tree\-Branch().\index{KDirLister@{KDir\-Lister}!itemsFilteredByMime@{itemsFilteredByMime}}
\index{itemsFilteredByMime@{itemsFilteredByMime}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::items\-Filtered\-By\-Mime (const {\bf KFile\-Item\-List} \& {\em items})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l10}


Send a list of items filtered-out by mime-type. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em items}]the list of filtered items \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!deleteItem@{deleteItem}}
\index{deleteItem@{deleteItem}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::delete\-Item ({\bf KFile\-Item} $\ast$ {\em \_\-file\-Item})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l11}


Signal an item to remove. 

ATTENTION: if {\tt \_\-file\-Item} == {\bf root\-Item}{\rm (p.\,\pageref{classKDirLister_a17})}() the directory this lister is holding was deleted and you HAVE to release especially the {\bf root\-Item}{\rm (p.\,\pageref{classKDirLister_a17})}() of this lister, otherwise your app will CRASH!! The {\bf clear}{\rm (p.\,\pageref{classKDirLister_l7})}() signals have been emitted already. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em the}]file\-Item to delete \end{description}
\end{Desc}


Referenced by emit\-Changes(), and KFile\-Tree\-Branch::KFile\-Tree\-Branch().\index{KDirLister@{KDir\-Lister}!refreshItems@{refreshItems}}
\index{refreshItems@{refreshItems}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::refresh\-Items (const {\bf KFile\-Item\-List} \& {\em items})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l12}


Signal an item to refresh (its mimetype/icon/name has changed). 

Note: {\bf KFile\-Item::refresh}{\rm (p.\,\pageref{classKFileItem_a5})} has already been called on those items. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em items}]the items to refresh \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!infoMessage@{infoMessage}}
\index{infoMessage@{infoMessage}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::info\-Message (const {\bf QString} \& {\em msg})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l13}


Emitted to display information about running jobs. 

Examples of message are \char`\"{}Resolving host\char`\"{}, \char`\"{}Connecting to host...\char`\"{}, etc. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em msg}]the info message \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!percent@{percent}}
\index{percent@{percent}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::percent (int {\em percent})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l14}


Progress signal showing the overall progress of the KDir\-Lister. 

This allows using a progress bar very easily. (see {\bf KProgress}) \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em percent}]the progress in percent \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!totalSize@{totalSize}}
\index{totalSize@{totalSize}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::total\-Size (KIO::filesize\_\-t {\em size})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l15}


Emitted when we know the size of the jobs. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]the total size in bytes \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!processedSize@{processedSize}}
\index{processedSize@{processedSize}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::processed\-Size (KIO::filesize\_\-t {\em size})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l16}


Regularly emitted to show the progress of this KDir\-Lister. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]the processed size in bytes \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!speed@{speed}}
\index{speed@{speed}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::speed (int {\em bytes\_\-per\_\-second})\hspace{0.3cm}{\tt  [signal]}}\label{classKDirLister_l17}


Emitted to display information about the speed of the jobs. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em bytes\_\-per\_\-second}]the speed in bytes/s \end{description}
\end{Desc}
\index{KDirLister@{KDir\-Lister}!matchesFilter@{matchesFilter}}
\index{matchesFilter@{matchesFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::matches\-Filter (const {\bf KFile\-Item} $\ast$) const\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classKDirLister_b0}


Called for every new item before emitting {\bf new\-Items}{\rm (p.\,\pageref{classKDirLister_l9})}(). 

You may reimplement this method in a subclass to implement your own filtering. The default implementation filters out \char`\"{}..\char`\"{} and everything not matching the name filter(s) \begin{Desc}
\item[Returns:]true if the item is \char`\"{}ok\char`\"{}. false if the item shall not be shown in a view, e.g. files not matching a pattern $\ast$.cpp (KFile\-Item::is\-Hidden()) \end{Desc}
\begin{Desc}
\item[See also:]{\bf matches\-Filter}{\rm (p.\,\pageref{classKDirLister_a27})} 

{\bf set\-Name\-Filter}{\rm (p.\,\pageref{classKDirLister_a21})} \end{Desc}


Definition at line 1827 of file kdirlister.cpp.

References KFile\-Item::is\-Dir(), matches\-Filter(), KGlobal::static\-QString(), and KFile\-Item::text().\index{KDirLister@{KDir\-Lister}!matchesMimeFilter@{matchesMimeFilter}}
\index{matchesMimeFilter@{matchesMimeFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::matches\-Mime\-Filter (const {\bf KFile\-Item} $\ast$) const\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classKDirLister_b1}


Called for every new item before emitting {\bf new\-Items}{\rm (p.\,\pageref{classKDirLister_l9})}(). 

You may reimplement this method in a subclass to implement your own filtering. The default implementation filters out \char`\"{}..\char`\"{} and everything not matching the name filter(s) \begin{Desc}
\item[Returns:]true if the item is \char`\"{}ok\char`\"{}. false if the item shall not be shown in a view, e.g. files not matching a pattern $\ast$.cpp (KFile\-Item::is\-Hidden()) \end{Desc}
\begin{Desc}
\item[See also:]{\bf matches\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a28})} 

{\bf set\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a23})} \end{Desc}


Definition at line 1844 of file kdirlister.cpp.

References matches\-Mime\-Filter(), and KFile\-Item::mimetype().\index{KDirLister@{KDir\-Lister}!doNameFilter@{doNameFilter}}
\index{doNameFilter@{doNameFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::do\-Name\-Filter (const {\bf QString} \& {\em name}, const {\bf QPtr\-List}$<$ {\bf QReg\-Exp} $>$ \& {\em filters}) const\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classKDirLister_b2}


Called by the public {\bf matches\-Filter}{\rm (p.\,\pageref{classKDirLister_a27})}() to do the actual filtering. 

Those methods may be reimplemented to customize filtering. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]the name to filter \item[{\em filers}]a list of regular expressions for filtering \end{description}
\end{Desc}


Definition at line 1850 of file kdirlister.cpp.

References QPtr\-List\-Iterator::current(), and KStd\-Accel::name().

Referenced by emit\-Changes(), and matches\-Filter().\index{KDirLister@{KDir\-Lister}!doMimeFilter@{doMimeFilter}}
\index{doMimeFilter@{doMimeFilter}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::do\-Mime\-Filter (const {\bf QString} \& {\em mime}, const {\bf QString\-List} \& {\em filters}) const\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classKDirLister_b3}


Called by the public {\bf matches\-Mime\-Filter}{\rm (p.\,\pageref{classKDirLister_a28})}() to do the actual filtering. 

Those methods may be reimplemented to customize filtering. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mime}]the mime type to filter \item[{\em filters}]the list of mime types to filter \end{description}
\end{Desc}


Definition at line 1859 of file kdirlister.cpp.

Referenced by emit\-Changes(), and matches\-Mime\-Filter().\index{KDirLister@{KDir\-Lister}!validURL@{validURL}}
\index{validURL@{validURL}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDir\-Lister::valid\-URL (const {\bf KURL} \&) const\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classKDirLister_b5}


Checks if an url is malformed or not and displays an error message if it is and auto\-Error\-Handling is set to true. 

\begin{Desc}
\item[Returns:]true if url is valid, otherwise false. \end{Desc}


Definition at line 1886 of file kdirlister.cpp.

References KMessage\-Box::error(), KURL::is\-Malformed(), and KURL::pretty\-URL().

Referenced by open\-URL().\index{KDirLister@{KDir\-Lister}!handleError@{handleError}}
\index{handleError@{handleError}!KDirLister@{KDir\-Lister}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDir\-Lister::handle\-Error ({\bf KIO::Job} $\ast$)\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classKDirLister_b6}


Reimplement to customize error handling. 



Definition at line 1903 of file kdirlister.cpp.

References KIO::Job::show\-Error\-Dialog().

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