KURIFilterPlugin Class Reference
Base class for URI filter plugins. Abstract class for URI filter plugins. More...
#include <kurifilter.h>
Inheritance diagram for KURIFilterPlugin:

Public Member Functions | |
KURIFilterPlugin (QObject *parent=0, const char *name=0, double pri=1.0) | |
virtual QString | name () const |
virtual double | priority () const |
virtual bool | filterURI (KURIFilterData &data) const =0 |
virtual KCModule * | configModule (QWidget *, const char *) const |
virtual QString | configName () const |
Protected Member Functions | |
void | setFilteredURI (KURIFilterData &data, const KURL &uri) const |
void | setErrorMsg (KURIFilterData &data, const QString &errmsg) const |
void | setURIType (KURIFilterData &data, KURIFilterData::URITypes type) const |
void | setArguments (KURIFilterData &data, const QString &args) const |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
QString | m_strName |
double | m_dblPriority |
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 service should inherit from this abstract class and provide a concrete implementation.
All inheriting classes need to implement the pure virtual function filterURI.
Definition at line 341 of file kurifilter.h.
Constructor & Destructor Documentation
|
Constructs a filter plugin with a given name and priority.
Definition at line 34 of file kurifilter.cpp. References KURIFilterPlugin(). Referenced by KURIFilterPlugin(). |
Member Function Documentation
|
Returns the filter's name.
Definition at line 362 of file kurifilter.h. Referenced by configName(). |
|
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.
Definition at line 372 of file kurifilter.h. |
|
Filters a URI.
|
|
Creates a configuration module for the filter. It is the responsibility of the caller to delete the module once it is not needed anymore.
Definition at line 390 of file kurifilter.h. References configModule(). Referenced by configModule(). |
|
Returns the name of the configuration module for the filter.
Definition at line 397 of file kurifilter.h. References name(). |
|
Sets the the URL in
Definition at line 41 of file kurifilter.cpp. References KURIFilterData::m_bChanged, KURIFilterData::m_pURI, setFilteredURI(), and KURIFilterData::uri(). Referenced by setFilteredURI(). |
|
Sets the error message in
Definition at line 409 of file kurifilter.h. References KURIFilterData::m_strErrMsg, and setErrorMsg(). Referenced by setErrorMsg(). |
|
Sets the URI type in
Definition at line 416 of file kurifilter.h. References KURIFilterData::m_bChanged, KURIFilterData::m_iType, and setURIType(). Referenced by setURIType(). |
|
Sets the arguments and options string in
Definition at line 195 of file kurifilter.cpp. References KURIFilterData::d, and setArguments(). Referenced by setArguments(). |
The documentation for this class was generated from the following files: