KUriFilterPlugin

#include <KUriFilter>

Inheritance diagram for KUriFilterPlugin:

Public Types

typedef QHash< QString, QPair< QString, QString > > ProviderInfoList
 

Public Member Functions

 KUriFilterPlugin (const QString &name, QObject *parent=nullptr)
 
virtual KCModuleconfigModule (QWidget *, const char *) const
 
virtual QString configName () const
 
virtual bool filterUri (KUriFilterData &data) const =0
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Member Functions

QString iconNameFor (const QUrl &url, KUriFilterData::UriTypes type) const
 
QHostInfo resolveName (const QString &hostname, unsigned long timeout) const
 
void setArguments (KUriFilterData &data, const QString &args) const
 
void setErrorMsg (KUriFilterData &data, const QString &errmsg) const
 
void setFilteredUri (KUriFilterData &data, const QUrl &uri) const
 
void setSearchProvider (KUriFilterData &data, const QString &provider, const QString &term, const QChar &separator) const
 
void setSearchProviders (KUriFilterData &data, const QList< KUriFilterSearchProvider * > &providers) const
 
void setUriType (KUriFilterData &data, KUriFilterData::UriTypes type) const
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

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

Member Typedef Documentation

List for holding the following search provider information: ([search provider name], [search query, search query icon name])

Since
4.5
Deprecated:
Since 4.6, use KUriFilterSearchProvider instead. See setSearchProviders;

Definition at line 646 of file kurifilter.h.

Constructor & Destructor Documentation

KUriFilterPlugin::KUriFilterPlugin ( const QString name,
QObject parent = nullptr 
)
explicit

Constructs a filter plugin with a given name.

Parameters
parentthe parent object, or nullptr for no parent
namethe name of the plugin, mandatory

Definition at line 464 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, or nullptr if the filter isn't configurable.

Reimplemented in KShortUriFilter.

Definition at line 475 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.

Reimplemented in KShortUriFilter.

Definition at line 480 of file kurifilter.cpp.

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.

Implemented in KShortUriFilter, LocalDomainUriFilter, and FixHostUriFilter.

QString KUriFilterPlugin::iconNameFor ( const QUrl url,
KUriFilterData::UriTypes  type 
) const
protected

Returns the icon name for the given url and URI type.

Since
4.5

Definition at line 528 of file kurifilter.cpp.

QHostInfo KUriFilterPlugin::resolveName ( const QString hostname,
unsigned long  timeout 
) const
protected

Performs a DNS lookup for hostname and returns the result.

This function uses the KIO/KHTML DNS cache to speed up the lookup. It also avoids doing a reverse lookup if the given host name is already an ip address.

Note
All uri filter plugins that need to perform a hostname lookup should use this function.
Parameters
hostnamethe hostname to lookup.
timeoutthe amount of time in msecs to wait for the lookup.
Returns
the result of the host name lookup.
Since
4.7

Definition at line 533 of file kurifilter.cpp.

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 filtering.

Definition at line 505 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 492 of file kurifilter.cpp.

void KUriFilterPlugin::setFilteredUri ( KUriFilterData data,
const QUrl uri 
) const
protected

Sets the URL in data to uri.

Definition at line 485 of file kurifilter.cpp.

void KUriFilterPlugin::setSearchProvider ( KUriFilterData data,
const QString provider,
const QString term,
const QChar separator 
) const
protected

Sets the name of the search provider, the search term and keyword/term separator in data.

Since
4.5

Definition at line 511 of file kurifilter.cpp.

void KUriFilterPlugin::setSearchProviders ( KUriFilterData data,
const QList< KUriFilterSearchProvider * > &  providers 
) const
protected

Sets the information about the search providers in data.

Since
4.6

Definition at line 519 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 498 of file kurifilter.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Sep 23 2020 23:01:43 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.