org.kde.koala

Class KURIFilterPlugin

public class KURIFilterPlugin extends QObject

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 function filterURI.

UNKNOWN: Abstract class for URI filter plugins.

Constructor Summary
protected	KURIFilterPlugin(Class dummy)

Method Summary
String	className()
KCModule	configModule(QWidget arg1, String arg2) Creates a configuration module for the filter.
String	configName() Returns the name of the configuration module for the filter.
boolean	filterURI(KURIFilterData data) Filters a URI.
QMetaObject	metaObject()
String	name() Returns the filter's name.
double	priority() Returns the filter's priority.

Constructor Detail

KURIFilterPlugin

protected KURIFilterPlugin(Class dummy)

Method Detail

className

public String className()

configModule

public KCModule configModule(QWidget arg1, String arg2)

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.

UNKNOWN: Creates a configuration module for the filter.

configName

public String configName()

Returns the name of the configuration module for the filter.

Returns: the name of a configuration module or null if none.

UNKNOWN: Returns the name of the configuration module for the filter.

filterURI

public boolean filterURI(KURIFilterData data)

Filters a URI.

Parameters: data the URI data to be filtered.

Returns: A boolean indicating whether the URI has been changed.

UNKNOWN: Filters a URI.

metaObject

public QMetaObject metaObject()

name

public String name()

Returns the filter's name.

Returns: A string naming the filter.

UNKNOWN: Returns the filter's name.

priority

public double priority()

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.

UNKNOWN: Returns the filter's priority.