\section{KURIFilter\-Plugin Class Reference}
\label{classKURIFilterPlugin}\index{KURIFilterPlugin@{KURIFilterPlugin}}
Base class for URI filter plugins. Abstract class for URI filter plugins.  


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

Inheritance diagram for KURIFilter\-Plugin:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=67pt]{classKURIFilterPlugin__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KURIFilter\-Plugin:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=99pt]{classKURIFilterPlugin__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KURIFilter\-Plugin} ({\bf QObject} $\ast${\bf parent}=0, const  char $\ast$name=0, double pri=1.0)
\begin{CompactList}\small\item\em Constructs a filter plugin with a given name and priority. \item\end{CompactList}\item 
virtual {\bf QString} {\bf name} () const 
\begin{CompactList}\small\item\em Returns the filter's name. \item\end{CompactList}\item 
virtual double {\bf priority} () const 
\begin{CompactList}\small\item\em Returns the filter's priority. \item\end{CompactList}\item 
virtual bool {\bf filter\-URI} ({\bf KURIFilter\-Data} \&data) const =0
\begin{CompactList}\small\item\em Filters a URI. \item\end{CompactList}\item 
virtual {\bf KCModule} $\ast$ {\bf config\-Module} ({\bf QWidget} $\ast$, const  char $\ast$) const 
\begin{CompactList}\small\item\em Creates a configuration module for the filter. \item\end{CompactList}\item 
virtual {\bf QString} {\bf config\-Name} () const 
\begin{CompactList}\small\item\em Returns the name of the configuration module for the filter. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void {\bf set\-Filtered\-URI} ({\bf KURIFilter\-Data} \&data, const  {\bf KURL} \&uri) const 
\begin{CompactList}\small\item\em Sets the the URL in {\tt data} to {\tt uri}. \item\end{CompactList}\item 
void {\bf set\-Error\-Msg} ({\bf KURIFilter\-Data} \&data, const  {\bf QString} \&errmsg) const 
\begin{CompactList}\small\item\em Sets the error message in {\tt data} to {\tt errormsg}. \item\end{CompactList}\item 
void {\bf set\-URIType} ({\bf KURIFilter\-Data} \&data, {\bf KURIFilter\-Data::URITypes} type) const 
\begin{CompactList}\small\item\em Sets the URI type in {\tt data} to {\tt type}. \item\end{CompactList}\item 
void {\bf set\-Arguments} ({\bf KURIFilter\-Data} \&data, const  {\bf QString} \&args) const 
\begin{CompactList}\small\item\em Sets the arguments and options string in {\tt data} to {\tt args} if any were found during filterting. \item\end{CompactList}\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKURIFilterPlugin_b4}

\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
{\bf QString} {\bf m\_\-str\-Name}\label{classKURIFilterPlugin_p0}

\item 
double {\bf m\_\-dbl\-Priority}\label{classKURIFilterPlugin_p1}

\end{CompactItemize}


\subsection{Detailed Description}
Base class for URI filter plugins. Abstract class for URI filter plugins. 

This class applies a single filter to a URI. All plugins designed to provide URI filtering functionalities should inherit from this abstract class and provide a specific filtering implementation.

All inheriting classes need to implement the pure virtual function {\bf filter\-URI}{\rm (p.\,\pageref{classKURIFilterPlugin_a3})}. Otherwise, they would also become abstract.



Definition at line 296 of file kurifilter.h.

\subsection{Constructor \& Destructor Documentation}
\index{KURIFilterPlugin@{KURIFilter\-Plugin}!KURIFilterPlugin@{KURIFilterPlugin}}
\index{KURIFilterPlugin@{KURIFilterPlugin}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KURIFilter\-Plugin::KURIFilter\-Plugin ({\bf QObject} $\ast$ {\em parent} = 0, const char $\ast$ {\em name} = 0, double {\em pri} = 1.0)}\label{classKURIFilterPlugin_a0}


Constructs a filter plugin with a given name and priority. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em parent}]the parent object. \item[{\em name}]the name of the plugin. \item[{\em pri}]the priority of the plugin. \end{description}
\end{Desc}


Definition at line 34 of file kurifilter.cpp.

References QString::from\-Latin1(), and KStd\-Accel::name().

\subsection{Member Function Documentation}
\index{KURIFilterPlugin@{KURIFilter\-Plugin}!name@{name}}
\index{name@{name}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QString} KURIFilter\-Plugin::name () const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKURIFilterPlugin_a1}


Returns the filter's name. 

\begin{Desc}
\item[Returns:]A string naming the filter. \end{Desc}


Reimplemented from {\bf QObject}.

Definition at line 317 of file kurifilter.h.

Referenced by config\-Name().\index{KURIFilterPlugin@{KURIFilter\-Plugin}!priority@{priority}}
\index{priority@{priority}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual double KURIFilter\-Plugin::priority () const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKURIFilterPlugin_a2}


Returns the filter's priority. 

Each filter has an assigned priority, a float from 0 to 1. Filters with the lowest priority are first given a chance to filter a URI.

\begin{Desc}
\item[Returns:]The priority of the filter. \end{Desc}


Definition at line 327 of file kurifilter.h.\index{KURIFilterPlugin@{KURIFilter\-Plugin}!filterURI@{filterURI}}
\index{filterURI@{filterURI}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KURIFilter\-Plugin::filter\-URI ({\bf KURIFilter\-Data} \& {\em data}) const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKURIFilterPlugin_a3}


Filters a URI. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em data}]the URI data to be filtered. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A boolean indicating whether the URI has been changed. \end{Desc}
\index{KURIFilterPlugin@{KURIFilter\-Plugin}!configModule@{configModule}}
\index{configModule@{configModule}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf KCModule}$\ast$ KURIFilter\-Plugin::config\-Module ({\bf QWidget} $\ast$, const char $\ast$) const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKURIFilterPlugin_a4}


Creates a configuration module for the filter. 

It is the responsability of the caller to delete the module once it is not needed anymore.

\begin{Desc}
\item[Returns:]A configuration module, {\tt null} if the filter isn't configurable. \end{Desc}


Definition at line 345 of file kurifilter.h.\index{KURIFilterPlugin@{KURIFilter\-Plugin}!configName@{configName}}
\index{configName@{configName}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QString} KURIFilter\-Plugin::config\-Name () const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKURIFilterPlugin_a5}


Returns the name of the configuration module for the filter. 

\begin{Desc}
\item[Returns:]the name of a configuration module or {\tt null} if none. \end{Desc}


Definition at line 352 of file kurifilter.h.

References name().\index{KURIFilterPlugin@{KURIFilter\-Plugin}!setFilteredURI@{setFilteredURI}}
\index{setFilteredURI@{setFilteredURI}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KURIFilter\-Plugin::set\-Filtered\-URI ({\bf KURIFilter\-Data} \& {\em data}, const {\bf KURL} \& {\em uri}) const\hspace{0.3cm}{\tt  [protected]}}\label{classKURIFilterPlugin_b0}


Sets the the URL in {\tt data} to {\tt uri}. 



Definition at line 41 of file kurifilter.cpp.

References KURIFilter\-Data::m\_\-b\-Changed, KURIFilter\-Data::m\_\-p\-URI, and KURIFilter\-Data::uri().\index{KURIFilterPlugin@{KURIFilter\-Plugin}!setErrorMsg@{setErrorMsg}}
\index{setErrorMsg@{setErrorMsg}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KURIFilter\-Plugin::set\-Error\-Msg ({\bf KURIFilter\-Data} \& {\em data}, const {\bf QString} \& {\em errmsg}) const\hspace{0.3cm}{\tt  [inline, protected]}}\label{classKURIFilterPlugin_b1}


Sets the error message in {\tt data} to {\tt errormsg}. 



Definition at line 364 of file kurifilter.h.

References KURIFilter\-Data::m\_\-str\-Err\-Msg.\index{KURIFilterPlugin@{KURIFilter\-Plugin}!setURIType@{setURIType}}
\index{setURIType@{setURIType}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KURIFilter\-Plugin::set\-URIType ({\bf KURIFilter\-Data} \& {\em data}, {\bf KURIFilter\-Data::URITypes} {\em type}) const\hspace{0.3cm}{\tt  [inline, protected]}}\label{classKURIFilterPlugin_b2}


Sets the URI type in {\tt data} to {\tt type}. 



Definition at line 371 of file kurifilter.h.

References KURIFilter\-Data::m\_\-b\-Changed, and KURIFilter\-Data::m\_\-i\-Type.\index{KURIFilterPlugin@{KURIFilter\-Plugin}!setArguments@{setArguments}}
\index{setArguments@{setArguments}!KURIFilterPlugin@{KURIFilter\-Plugin}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KURIFilter\-Plugin::set\-Arguments ({\bf KURIFilter\-Data} \& {\em data}, const {\bf QString} \& {\em args}) const\hspace{0.3cm}{\tt  [protected]}}\label{classKURIFilterPlugin_b3}


Sets the arguments and options string in {\tt data} to {\tt args} if any were found during filterting. 



Definition at line 166 of file kurifilter.cpp.

References KURIFilter\-Data::d.

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