<HTML>
<HEAD>
<TITLE>class KURIFilterPlugin</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class KURIFilterPlugin</h1>
</TD>
<TD valign="top" align="right" colspan="1">Abstract class for URI filter plugins.
<small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH colspan="2">Contains pure virtuals</TH></TR><TR><TH>Definition</TH><TD><code>#include <<A HREF="kurifilter_h.html">kurifilter.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qobject.html">QObject</A> <small>(qt)</small> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-KURIFilterPlugin.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI> <b><A HREF="#ref1">KURIFilterPlugin</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qobject.html">QObject</A> *parent = 0, const char *name = 0, double pri = 1.0 )
</LI>
<LI>virtual <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <b><A HREF="#ref2">name</A></b> () const
</LI>
<LI>virtual double <b><A HREF="#ref3">priority</A></b> () const
</LI>
<LI>virtual bool <b><i><A HREF="#ref4">filterURI</A></i></b> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data ) const
</LI>
<LI>virtual <A HREF="../kdeui/KCModule.html">KCModule</A> * <b><A HREF="#ref5">configModule</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>*, const char* ) const
</LI>
<LI>virtual <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <b><A HREF="#ref6">configName</A></b> () const
</LI>
</ul><h4>Protected Methods</h4><ul><LI>void <b><A HREF="#ref7">setFilteredURI</A></b> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data, const <A HREF="../kdecore/KURL.html">KURL</A>& uri ) const
</LI>
<LI>void <b><A HREF="#ref8">setErrorMsg</A></b> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& errmsg ) const
</LI>
<LI>void <b><A HREF="#ref9">setURIType</A></b> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data, <A HREF="KURIFilterData.html#URITypes">KURIFilterData::URITypes</A> type) const
</LI>
<LI>void <b><A HREF="#ref10">setArguments</A></b> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& args ) const
</LI>
</ul><h4>Protected Members</h4><ul><LI>QString <b><A HREF="#ref11">m_strName</A></b></LI>
<LI>double <b><A HREF="#ref12">m_dblPriority</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Base class for URI filter plugins.
</p>
<p> 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.
</p>
<p> All inheriting classes need to implement the pure
virtual function <A HREF="KURIFilterPlugin.html#filterURI">filterURI</A>. Otherwise, they
would also become abstract.
</p>
<p></p>
<A NAME="KURIFilterPlugin"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>KURIFilterPlugin</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qobject.html">QObject</A> *parent = 0, const char *name = 0, double pri = 1.0 )
<br></td><td align="right"><h3><strong>KURIFilterPlugin</strong></h3></td></tr></table><p></p><p>
Constructor to create a filter plugin with a given name and
priority.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>parent</i></TD><TD align="left" valign="top">the parent object.
</TD></TR>
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">the name of the plugin.
</TD></TR>
<TR><TD align="left" valign="top"><i>pri</i></TD><TD align="left" valign="top">the priority of the plugin.
</TD></TR>
</TABLE></P>
<A NAME="name"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>name</strong> ()
<br></td><td align="right"><h3><strong>name</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Return the filter's name.
</p>
<p></p>
<p><b>Returns</b>: A string naming the filter.
</p>
<p>Reimplemented from <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qobject.html#6f3030">QObject</A>.</p>
<A NAME="priority"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> double <strong>priority</strong> ()
<br></td><td align="right"><h3><strong>priority</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Return the filter's .
</p>
<p> 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.
</p>
<p></p>
<p><b>Returns</b>: The priority of the filter.
</p>
<A NAME="filterURI"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <i><strong>filterURI</strong></i> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data )
<br></td><td align="right"><h3><i><strong>filterURI</strong></i></h3></td></tr></table><p> <small>[const pure virtual]</small></p><p>
Filters a URI.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">the URI data to be filtered.
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: A boolean indicating whether the URI has been changed.
</p>
<A NAME="configModule"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="../kdeui/KCModule.html">KCModule</A> * <strong>configModule</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qwidget.html">QWidget</A>*, const char* )
<br></td><td align="right"><h3><strong>configModule</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Returns a configuration module for the filter.
</p>
<p> It is the responsability of the caller to delete the module
once it is not needed anymore.
</p>
<p></p>
<p><b>Returns</b>: A configuration module, <code>null</code> if the filter isn't configurable.
</p>
<A NAME="configName"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>configName</strong> ()
<br></td><td align="right"><h3><strong>configName</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Returns the name of the configuration module for the filter.
</p>
<p></p>
<p><b>Returns</b>: the name of a configuration module or <code>null</code> if none.
</p>
<A NAME="setFilteredURI"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setFilteredURI</strong> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data, const <A HREF="../kdecore/KURL.html">KURL</A>& uri )
<br></td><td align="right"><h3><strong>setFilteredURI</strong></h3></td></tr></table><p> <small>[protected const]</small></p><p>
Sets the the URL in <code>data</code> to <code>uri</code>.
</p>
<A NAME="setErrorMsg"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setErrorMsg</strong> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& errmsg )
<br></td><td align="right"><h3><strong>setErrorMsg</strong></h3></td></tr></table><p> <small>[protected const]</small></p><p>
Sets the error message in <code>data</code> to <code>errormsg</code>.
</p>
<A NAME="setURIType"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setURIType</strong> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data, <A HREF="KURIFilterData.html#URITypes">KURIFilterData::URITypes</A> type)
<br></td><td align="right"><h3><strong>setURIType</strong></h3></td></tr></table><p> <small>[protected const]</small></p><p>
Sets the URI type in <code>data</code> to <code>type</code>.
</p>
<A NAME="setArguments"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setArguments</strong> ( <A HREF="KURIFilterData.html">KURIFilterData</A>& data, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& args )
<br></td><td align="right"><h3><strong>setArguments</strong></h3></td></tr></table><p> <small>[protected const]</small></p><p>
Sets the arguments and options string in <code>data</code>
to <code>args</code> if any were found during filterting.
</p>
<A NAME="m_strName"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>m_strName</strong>
</td><td align="right"><h3><strong>m_strName</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_dblPriority"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>double <strong>m_dblPriority</strong>
</td><td align="right"><h3><strong>m_dblPriority</strong></h3></td></tr></table><p> <small>[protected]</small></p><HR>
<table>
<tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:09:14 2002, using kdoc 2.0a53.</small></td></tr>
</table>
</BODY>
</HTML>
