KIO
#include <kurifilter.h>

Public Types | |
typedef QHash< QString, QPair< QString, QString > > | ProviderInfoList |
Public Member Functions | |
KUriFilterPlugin (const QString &name, QObject *parent=0) | |
virtual KCModule * | configModule (QWidget *, const char *) const |
virtual QString | configName () const |
virtual bool | filterUri (KUriFilterData &data) const =0 |
Protected Member Functions | |
QString | iconNameFor (const KUrl &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 KUrl &uri) const |
void | setPreferredSearchProviders (KUriFilterData &data, const ProviderInfoList &providers) 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 |
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 645 of file kurifilter.h.
Member Typedef Documentation
◆ ProviderInfoList
typedef QHash<QString, QPair<QString, QString> > KUriFilterPlugin::ProviderInfoList |
List for holding the following search provider information: ([search provider name], [search query, search query icon name])
- Since
- 4.5
- Deprecated:
- Use KUriFilterSearchProvider instead. See setSearchProviders;
Definition at line 658 of file kurifilter.h.
Constructor & Destructor Documentation
◆ KUriFilterPlugin()
|
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 490 of file kurifilter.cpp.
Member Function Documentation
◆ configModule()
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 496 of file kurifilter.cpp.
◆ configName()
|
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 501 of file kurifilter.cpp.
◆ filterUri()
|
pure virtual |
Filters a URI.
- Parameters
-
data the URI data to be filtered.
- Returns
- A boolean indicating whether the URI has been changed.
◆ iconNameFor()
|
protected |
Returns the icon name for the given url
and URI type
.
- Since
- 4.5
Definition at line 567 of file kurifilter.cpp.
◆ resolveName()
|
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
-
hostname the hostname to lookup. timeout the amount of time in msecs to wait for the lookup.
- Returns
- the result of the host name lookup.
- Since
- 4.7
Definition at line 572 of file kurifilter.cpp.
◆ setArguments()
|
protected |
Sets the arguments and options string in data
to args
if any were found during filterting.
Definition at line 526 of file kurifilter.cpp.
◆ setErrorMsg()
|
protected |
Sets the error message in data
to errormsg
.
Definition at line 513 of file kurifilter.cpp.
◆ setFilteredUri()
|
protected |
Sets the URL in data
to uri
.
Definition at line 506 of file kurifilter.cpp.
◆ setPreferredSearchProviders()
|
protected |
Sets the name of the preferred search providers in data
.
- Since
- 4.5
- Deprecated:
- Use setSearchProviders instead.
Definition at line 541 of file kurifilter.cpp.
◆ setSearchProvider()
|
protected |
Sets the name of the search provider, the search term and keyword/term separator in data
.
- Since
- 4.5
Definition at line 532 of file kurifilter.cpp.
◆ setSearchProviders()
|
protected |
Sets the information about the search providers
in data
.
- Since
- 4.6
Definition at line 559 of file kurifilter.cpp.
◆ setUriType()
|
protected |
Sets the URI type in data
to type
.
Definition at line 519 of file kurifilter.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.