• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KUriFilterPlugin Class Reference

Base class for URI filter plugins. More...

#include <kurifilter.h>

Inheritance diagram for KUriFilterPlugin:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual KCModule * configModule (QWidget *, const char *) const
virtual QString configName () const
virtual bool filterUri (KUriFilterData &data) const =0
 KUriFilterPlugin (const QString &name, QObject *parent=0)

Protected Member Functions

void setArguments (KUriFilterData &data, const QString &args) const
void setErrorMsg (KUriFilterData &data, const QString &errmsg) const
void setFilteredUri (KUriFilterData &data, const KUrl &uri) const
void setUriType (KUriFilterData &data, KUriFilterData::UriTypes type) const

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 308 of file kurifilter.h.


Constructor & Destructor Documentation

KUriFilterPlugin::KUriFilterPlugin ( const QString &  name,
QObject *  parent = 0 
) [explicit]

Constructs a filter plugin with a given name.

Parameters:
parent the parent object, or 0 for no parent
name the name of the plugin, mandatory

Definition at line 246 of file kurifilter.cpp.


Member Function Documentation

KCModule * KUriFilterPlugin::configModule ( QWidget *  ,
const char *   
) const [virtual]

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 252 of file kurifilter.cpp.

QString KUriFilterPlugin::configName (  )  const [virtual]

Returns the name of the configuration module for the filter.

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

Definition at line 257 of file kurifilter.cpp.

virtual bool KUriFilterPlugin::filterUri ( KUriFilterData &  data  )  const [pure virtual]

Filters a URI.

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

void KUriFilterPlugin::setArguments ( KUriFilterData &  data,
const QString &  args 
) const [protected]

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

Definition at line 284 of file kurifilter.cpp.

void KUriFilterPlugin::setErrorMsg ( KUriFilterData &  data,
const QString &  errmsg 
) const [protected]

Sets the error message in data to errormsg.

Definition at line 271 of file kurifilter.cpp.

void KUriFilterPlugin::setFilteredUri ( KUriFilterData &  data,
const KUrl &  uri 
) const [protected]

Sets the URL in data to uri.

Definition at line 262 of file kurifilter.cpp.

void KUriFilterPlugin::setUriType ( KUriFilterData &  data,
KUriFilterData::UriTypes  type 
) const [protected]

Sets the URI type in data to type.

Definition at line 277 of file kurifilter.cpp.


The documentation for this class was generated from the following files:
  • kurifilter.h
  • kurifilter.cpp

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal