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) | |
Constructs a filter plugin with a given name and priority. | |
virtual QString | name () const |
Returns the filter's name. | |
virtual double | priority () const |
Returns the filter's priority. | |
virtual bool | filterURI (KURIFilterData &data) const =0 |
Filters a URI. | |
virtual KCModule * | configModule (QWidget *, const char *) const |
Creates a configuration module for the filter. | |
virtual QString | configName () const |
Returns the name of the configuration module for the filter. | |
Protected Member Functions | |
void | setFilteredURI (KURIFilterData &data, const KURL &uri) const |
Sets the the URL in data to uri . | |
void | setErrorMsg (KURIFilterData &data, const QString &errmsg) const |
Sets the error message in data to errormsg . | |
void | setURIType (KURIFilterData &data, KURIFilterData::URITypes type) const |
Sets the URI type in data to type . | |
void | setArguments (KURIFilterData &data, const QString &args) const |
Sets the arguments and options string in data to args if any were found during filterting. | |
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 functionalities should inherit from this abstract class and provide a specific filtering implementation.
All inheriting classes need to implement the pure virtual function filterURI. Otherwise, they would also become abstract.
Definition at line 296 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 QString::fromLatin1(), and KStdAccel::name(). |
Member Function Documentation
|
Returns the filter's name.
Reimplemented from QObject. Definition at line 317 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 327 of file kurifilter.h. |
|
Filters a URI.
|
|
Creates a configuration module for the filter. It is the responsability of the caller to delete the module once it is not needed anymore.
Definition at line 345 of file kurifilter.h. |
|
Returns the name of the configuration module for the filter.
Definition at line 352 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, and KURIFilterData::uri(). |
|
Sets the error message in
Definition at line 364 of file kurifilter.h. References KURIFilterData::m_strErrMsg. |
|
Sets the URI type in
Definition at line 371 of file kurifilter.h. References KURIFilterData::m_bChanged, and KURIFilterData::m_iType. |
|
Sets the arguments and options string in
Definition at line 166 of file kurifilter.cpp. References KURIFilterData::d. |
The documentation for this class was generated from the following files: