#include <kurifilter.h>
Inherits TQObject.
Public Member Functions | |
KURIFilterPlugin (TQObject *parent=0, const char *name=0, double pri=1.0) | |
virtual TQString | name () const |
virtual double | priority () const |
virtual bool | filterURI (KURIFilterData &data) const =0 |
virtual TDECModule * | configModule (TQWidget *, const char *) const |
virtual TQString | configName () const |
Protected Member Functions | |
void | setFilteredURI (KURIFilterData &data, const KURL &uri) const |
void | setErrorMsg (KURIFilterData &data, const TQString &errmsg) const |
void | setURIType (KURIFilterData &data, KURIFilterData::URITypes type) const |
void | setArguments (KURIFilterData &data, const TQString &args) const |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
TQString | m_strName |
double | m_dblPriority |
Detailed Description
Base 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.
Abstract class for URI filter plugins.
Definition at line 363 of file kurifilter.h.
Constructor & Destructor Documentation
◆ KURIFilterPlugin()
KURIFilterPlugin::KURIFilterPlugin | ( | TQObject * | parent = 0 , |
const char * | name = 0 , |
||
double | pri = 1.0 |
||
) |
Constructs a filter plugin with a given name and priority.
- Parameters
-
parent the parent object, or 0 for no parent name the name of the plugin, or 0 for no name pri the priority of the plugin.
Definition at line 40 of file kurifilter.cpp.
Member Function Documentation
◆ configModule()
|
inlinevirtual |
Creates a configuration module for the filter.
It is the responsibility of the caller to delete the module once it is not needed anymore.
- Returns
- A configuration module, 0 if the filter isn't configurable.
Definition at line 413 of file kurifilter.h.
◆ configName()
|
inlinevirtual |
Returns the name of the configuration module for the filter.
- Returns
- the name of a configuration module or TQString::null if none.
Definition at line 420 of file kurifilter.h.
◆ filterURI()
|
pure virtual |
Filters a URI.
- Parameters
-
data the URI data to be filtered.
- Returns
- A boolean indicating whether the URI has been changed.
◆ name()
|
inlinevirtual |
Returns the filter's name.
- Returns
- A string naming the filter.
Definition at line 385 of file kurifilter.h.
◆ priority()
|
inlinevirtual |
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.
- Returns
- The priority of the filter.
Definition at line 395 of file kurifilter.h.
◆ setArguments()
|
protected |
Sets the arguments and options string in data
to args
if any were found during filterting.
Definition at line 319 of file kurifilter.cpp.
◆ setErrorMsg()
|
inlineprotected |
Sets the error message in data
to errormsg
.
Definition at line 432 of file kurifilter.h.
◆ setFilteredURI()
|
protected |
Sets the the URL in data
to uri
.
Definition at line 47 of file kurifilter.cpp.
◆ setURIType()
|
inlineprotected |
Sets the URI type in data
to type
.
Definition at line 439 of file kurifilter.h.
The documentation for this class was generated from the following files: