• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kio/kio
 

kio/kio

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KURIFilterPlugin Class Referenceabstract

#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 KCModule * 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 350 of file kurifilter.h.

Constructor & Destructor Documentation

KURIFilterPlugin::KURIFilterPlugin ( TQObject *  parent = 0,
const char *  name = 0,
double  pri = 1.0 
)

Constructs a filter plugin with a given name and priority.

Parameters
parentthe parent object, or 0 for no parent
namethe name of the plugin, or 0 for no name
prithe priority of the plugin.

Definition at line 35 of file kurifilter.cpp.

Member Function Documentation

virtual KCModule* KURIFilterPlugin::configModule ( TQWidget *  ,
const char *   
) const
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 400 of file kurifilter.h.

virtual TQString KURIFilterPlugin::configName ( ) const
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 407 of file kurifilter.h.

virtual bool KURIFilterPlugin::filterURI ( KURIFilterData &  data) const
pure virtual

Filters a URI.

Parameters
datathe URI data to be filtered.
Returns
A boolean indicating whether the URI has been changed.
virtual TQString KURIFilterPlugin::name ( ) const
inlinevirtual

Returns the filter's name.

Returns
A string naming the filter.

Definition at line 372 of file kurifilter.h.

virtual double KURIFilterPlugin::priority ( ) const
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 382 of file kurifilter.h.

void KURIFilterPlugin::setArguments ( KURIFilterData &  data,
const TQString &  args 
) const
protected

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

Definition at line 212 of file kurifilter.cpp.

void KURIFilterPlugin::setErrorMsg ( KURIFilterData &  data,
const TQString &  errmsg 
) const
inlineprotected

Sets the error message in data to errormsg.

Definition at line 419 of file kurifilter.h.

void KURIFilterPlugin::setFilteredURI ( KURIFilterData &  data,
const KURL &  uri 
) const
protected

Sets the the URL in data to uri.

Definition at line 42 of file kurifilter.cpp.

void KURIFilterPlugin::setURIType ( KURIFilterData &  data,
KURIFilterData::URITypes  type 
) const
inlineprotected

Sets the URI type in data to type.

Definition at line 426 of file kurifilter.h.


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

kio/kio

Skip menu "kio/kio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kio/kio

Skip menu "kio/kio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kio/kio by doxygen 1.8.3.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |