# class KUriFilterPlugin

### abstract class

Table of contents
Modules
kio Classes
All Classes

Module | kio
Namespace | global
Class | KUriFilterPlugin
Inherits | QObject

Overloaded assigenment operator.

This function allows you to easily assign a KUrl to a KUriFilterData object.

Returns an instance of a KUriFilterData object. Overloaded assigenment operator.

This function allows you to easily assign a QString to a KUriFilterData object.

Returns an instance of a KUriFilterData object. 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.

### methods

- KUriFilterPlugin (name, parent)

  returns a KUriFilterPlugin object

  Argument | Type | Default
  --- | --- | ---
  name | QString |
  parent | QObject | None

  Constructs a filter plugin with a given name

  parent - the parent object, or 0 for no parent

  name - the name of the plugin, mandatory

- configModule (a0, a1)

  returns (KCModule)

  Argument | Type | Default
  --- | --- | ---
  a0 | QWidget |
  a1 | char |

  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.

- configName ()

  returns (QString)

  Returns the name of the configuration module for the filter.

  Returns the name of a configuration module or QString() if none.

- filterUri (data)

  returns (bool)
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  data | KUriFilterData |

  Filters a URI.

  data - the URI data to be filtered. Returns A boolean indicating whether the URI has been changed.

- setArguments (data, args)

  returns nothing

  Argument | Type | Default
  --- | --- | ---
  data | KUriFilterData |
  args | QString |

  Sets the arguments and options string in data to args if any were found during filterting.

- setErrorMsg (data, errmsg)

  returns nothing

  Argument | Type | Default
  --- | --- | ---
  data | KUriFilterData |
  errmsg | QString |

  Sets the error message in data to errormsg.

- setFilteredUri (data, uri)

  returns nothing

  Argument | Type | Default
  --- | --- | ---
  data | KUriFilterData |
  uri | KUrl |

  Sets the the URL in data to uri.

- setUriType (data, type)

  returns nothing

  Argument | Type | Default
  --- | --- | ---
  data | KUriFilterData |
  type | KUriFilterData.UriTypes |

  Sets the URI type in data to type.