.TH "KURIFilterPlugin" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KURIFilterPlugin \- Base class for URI filter plugins. Abstract class for URI filter plugins.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kurifilter.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKURIFilterPlugin\fP (\fBQObject\fP *\fBparent\fP=0, const char *name=0, double pri=1.0)"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBname\fP () const "
.br
.ti -1c
.RI "virtual double \fBpriority\fP () const "
.br
.ti -1c
.RI "virtual bool \fBfilterURI\fP (\fBKURIFilterData\fP &data) const =0"
.br
.ti -1c
.RI "virtual \fBKCModule\fP * \fBconfigModule\fP (\fBQWidget\fP *, const char *) const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBconfigName\fP () const "
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetFilteredURI\fP (\fBKURIFilterData\fP &data, const \fBKURL\fP &uri) const "
.br
.ti -1c
.RI "void \fBsetErrorMsg\fP (\fBKURIFilterData\fP &data, const \fBQString\fP &errmsg) const "
.br
.ti -1c
.RI "void \fBsetURIType\fP (\fBKURIFilterData\fP &data, \fBKURIFilterData::URITypes\fP type) const "
.br
.ti -1c
.RI "void \fBsetArguments\fP (\fBKURIFilterData\fP &data, const \fBQString\fP &args) const "
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBQString\fP \fBm_strName\fP"
.br
.ti -1c
.RI "double \fBm_dblPriority\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
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 service should inherit from this abstract class and provide a concrete implementation.
.PP
All inheriting classes need to implement the pure virtual function filterURI.
.PP
Definition at line 344 of file kurifilter.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KURIFilterPlugin::KURIFilterPlugin (\fBQObject\fP * parent = \fC0\fP, const char * name = \fC0\fP, double pri = \fC1.0\fP)"
.PP
Constructs a filter plugin with a given name and priority. 
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP the parent object, or 0 for no parent 
.br
\fIname\fP the name of the plugin, or 0 for no name 
.br
\fIpri\fP the priority of the plugin. 
.RE
.PP

.PP
Definition at line 35 of file kurifilter.cpp.
.PP
References QString::fromLatin1(), and name().
.SH "Member Function Documentation"
.PP 
.SS "virtual \fBQString\fP KURIFilterPlugin::name () const\fC [inline, virtual]\fP"
.PP
Returns the filter's name. 
.PP
\fBReturns:\fP
.RS 4
A string naming the filter. 
.RE
.PP

.PP
Reimplemented from \fBQObject\fP.
.PP
Definition at line 365 of file kurifilter.h.
.PP
Referenced by KURIFilterPlugin().
.SS "virtual double KURIFilterPlugin::priority () const\fC [inline, virtual]\fP"
.PP
Returns the filter's priority. 
.PP
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.
.PP
\fBReturns:\fP
.RS 4
The priority of the filter. 
.RE
.PP

.PP
Definition at line 375 of file kurifilter.h.
.SS "virtual bool KURIFilterPlugin::filterURI (\fBKURIFilterData\fP & data) const\fC [pure virtual]\fP"
.PP
Filters a URI. 
.PP
\fBParameters:\fP
.RS 4
\fIdata\fP the URI data to be filtered. 
.RE
.PP
\fBReturns:\fP
.RS 4
A boolean indicating whether the URI has been changed. 
.RE
.PP

.SS "virtual \fBKCModule\fP* KURIFilterPlugin::configModule (\fBQWidget\fP *, const char *) const\fC [inline, virtual]\fP"
.PP
Creates a configuration module for the filter. 
.PP
It is the responsibility of the caller to delete the module once it is not needed anymore.
.PP
\fBReturns:\fP
.RS 4
A configuration module, 0 if the filter isn't configurable. 
.RE
.PP

.PP
Definition at line 393 of file kurifilter.h.
.SS "virtual \fBQString\fP KURIFilterPlugin::configName () const\fC [inline, virtual]\fP"
.PP
Returns the name of the configuration module for the filter. 
.PP
\fBReturns:\fP
.RS 4
the name of a configuration module or QString::null if none. 
.RE
.PP

.PP
Definition at line 400 of file kurifilter.h.
.PP
References QObject::name().
.SS "void KURIFilterPlugin::setFilteredURI (\fBKURIFilterData\fP & data, const \fBKURL\fP & uri) const\fC [protected]\fP"
.PP
Sets the the URL in \fCdata\fP to \fCuri\fP. 
.PP
Definition at line 42 of file kurifilter.cpp.
.SS "void KURIFilterPlugin::setErrorMsg (\fBKURIFilterData\fP & data, const \fBQString\fP & errmsg) const\fC [inline, protected]\fP"
.PP
Sets the error message in \fCdata\fP to \fCerrormsg\fP. 
.PP
Definition at line 412 of file kurifilter.h.
.SS "void KURIFilterPlugin::setURIType (\fBKURIFilterData\fP & data, \fBKURIFilterData::URITypes\fP type) const\fC [inline, protected]\fP"
.PP
Sets the URI type in \fCdata\fP to \fCtype\fP. 
.PP
Definition at line 419 of file kurifilter.h.
.SS "void KURIFilterPlugin::setArguments (\fBKURIFilterData\fP & data, const \fBQString\fP & args) const\fC [protected]\fP"
.PP
Sets the arguments and options string in \fCdata\fP to \fCargs\fP if any were found during filterting. 
.PP
Definition at line 200 of file kurifilter.cpp.
.PP
References QString::d().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
