.TH "KURIFilterPlugin" 3 "28 Jan 2004" "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
.RI "\fIConstructs a filter plugin with a given name and priority. \fP"
.ti -1c
.RI "virtual \fBQString\fP \fBname\fP () const "
.br
.RI "\fIReturns the filter's name. \fP"
.ti -1c
.RI "virtual double \fBpriority\fP () const "
.br
.RI "\fIReturns the filter's priority. \fP"
.ti -1c
.RI "virtual bool \fBfilterURI\fP (\fBKURIFilterData\fP &data) const =0"
.br
.RI "\fIFilters a URI. \fP"
.ti -1c
.RI "virtual \fBKCModule\fP * \fBconfigModule\fP (\fBQWidget\fP *, const  char *) const "
.br
.RI "\fICreates a configuration module for the filter. \fP"
.ti -1c
.RI "virtual \fBQString\fP \fBconfigName\fP () const "
.br
.RI "\fIReturns the name of the configuration module for the filter. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetFilteredURI\fP (\fBKURIFilterData\fP &data, const  \fBKURL\fP &uri) const "
.br
.RI "\fISets the the URL in \fCdata\fP to \fCuri\fP. \fP"
.ti -1c
.RI "void \fBsetErrorMsg\fP (\fBKURIFilterData\fP &data, const  \fBQString\fP &errmsg) const "
.br
.RI "\fISets the error message in \fCdata\fP to \fCerrormsg\fP. \fP"
.ti -1c
.RI "void \fBsetURIType\fP (\fBKURIFilterData\fP &data, \fBKURIFilterData::URITypes\fP type) const "
.br
.RI "\fISets the URI type in \fCdata\fP to \fCtype\fP. \fP"
.ti -1c
.RI "void \fBsetArguments\fP (\fBKURIFilterData\fP &data, const  \fBQString\fP &args) const "
.br
.RI "\fISets the arguments and options string in \fCdata\fP to \fCargs\fP if any were found during filterting. \fP"
.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 functionalities should inherit from this abstract class and provide a specific filtering implementation.
.PP
All inheriting classes need to implement the pure virtual function \fBfilterURI\fP. Otherwise, they would also become abstract.
.PP
Definition at line 296 of file kurifilter.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KURIFilterPlugin::KURIFilterPlugin (\fBQObject\fP * parent = 0, const char * name = 0, double pri = 1.0)"
.PP
Constructs a filter plugin with a given name and priority. \fBParameters:\fP
.RS 4
\fIparent\fP the parent object. 
.br
\fIname\fP the name of the plugin. 
.br
\fIpri\fP the priority of the plugin. 
.RE
.PP
Definition at line 34 of file kurifilter.cpp.
.PP
References QString::fromLatin1(), and KStdAccel::name().
.SH "Member Function Documentation"
.PP 
.SS "virtual \fBQString\fP KURIFilterPlugin::name () const\fC [inline, virtual]\fP"
.PP
Returns the filter's name. \fBReturns:\fP
.RS 4
A string naming the filter. 
.RE
.PP
Reimplemented from \fBQObject\fP.
.PP
Definition at line 317 of file kurifilter.h.
.PP
Referenced by configName().
.SS "virtual double KURIFilterPlugin::priority () const\fC [inline, virtual]\fP"
.PP
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.
.PP
\fBReturns:\fP
.RS 4
The priority of the filter. 
.RE
.PP
Definition at line 327 of file kurifilter.h.
.SS "virtual bool KURIFilterPlugin::filterURI (\fBKURIFilterData\fP & data) const\fC [pure virtual]\fP"
.PP
Filters a URI. \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. It is the responsability of the caller to delete the module once it is not needed anymore.
.PP
\fBReturns:\fP
.RS 4
A configuration module, \fCnull\fP if the filter isn't configurable. 
.RE
.PP
Definition at line 345 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. \fBReturns:\fP
.RS 4
the name of a configuration module or \fCnull\fP if none. 
.RE
.PP
Definition at line 352 of file kurifilter.h.
.PP
References 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. Definition at line 41 of file kurifilter.cpp.
.PP
References KURIFilterData::m_bChanged, KURIFilterData::m_pURI, and KURIFilterData::uri().
.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. Definition at line 364 of file kurifilter.h.
.PP
References KURIFilterData::m_strErrMsg.
.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. Definition at line 371 of file kurifilter.h.
.PP
References KURIFilterData::m_bChanged, and KURIFilterData::m_iType.
.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. Definition at line 166 of file kurifilter.cpp.
.PP
References KURIFilterData::d.

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