KIO
kurifilter.h
688 * bool filtered = KUriFilter::self()->filterSearchUri(filterData, KUriFilterData::NormalTextFilter);
This class is a basic messaging class used to exchange filtering information between the filter plugi...
Definition kurifilter.h:153
QStringList allQueriesForSearchProvider(const QString &provider) const
Returns all the query urls for the given search provider.
Definition kurifilter.cpp:266
QString absolutePath() const
Returns the absolute path if one has already been set.
Definition kurifilter.cpp:196
KUriFilterSearchProvider queryForSearchProvider(const QString &provider) const
Returns information about provider.
Definition kurifilter.cpp:246
QFlags< SearchFilterOption > SearchFilterOptions
Stores a combination of SearchFilterOption values.
Definition kurifilter.h:202
void setSearchFilteringOptions(SearchFilterOptions options)
Sets the options used by search filter plugins to filter requests.
Definition kurifilter.cpp:360
bool setAbsolutePath(const QString &abs_path)
Sets the absolute path to be used whenever the supplied data is a relative local URL.
Definition kurifilter.cpp:329
QString iconNameForPreferredSearchProvider(const QString &provider) const
Returns the icon associated with the given preferred search provider.
Definition kurifilter.cpp:275
void setDefaultUrlScheme(const QString &)
Sets the default scheme used when filtering potentially valid url inputs.
Definition kurifilter.cpp:355
QString argsAndOptions() const
Returns the command line options and arguments for a local resource when present.
Definition kurifilter.cpp:206
QString iconName()
The name of the icon that matches the current filtered URL.
Definition kurifilter.cpp:304
bool hasAbsolutePath() const
Checks whether the supplied data had an absolute path.
Definition kurifilter.cpp:201
SearchFilterOptions searchFilteringOptions() const
Returns the specified search filter options.
Definition kurifilter.cpp:299
QStringList preferredSearchProviders() const
Returns a list of the names of preferred or available search providers.
Definition kurifilter.cpp:241
QStringList alternateSearchProviders() const
Returns the list of alternate search providers.
Definition kurifilter.cpp:284
QString searchTerm() const
Returns the search term portion of the typed string.
Definition kurifilter.cpp:226
QString typedString() const
The string as typed by the user, before any URL processing is done.
Definition kurifilter.cpp:221
@ Error
An incorrect URI (ex: "~johndoe" when user johndoe does not exist in that system)
Definition kurifilter.h:166
@ Unknown
A URI that is not identified. Default value when a KUriFilterData is first created.
Definition kurifilter.h:167
QString defaultUrlScheme() const
Returns the default protocol to use when filtering potentially valid url inputs.
Definition kurifilter.cpp:294
SearchFilterOption
This enum describes the search filtering options to be used.
Definition kurifilter.h:193
void setAlternateDefaultSearchProvider(const QString &provider)
Sets the search provider to use in case no default provider is available.
Definition kurifilter.cpp:350
QString queryForPreferredSearchProvider(const QString &provider) const
Returns the web shortcut url for the given preferred search provider.
Definition kurifilter.cpp:257
KUriFilterData & operator=(const QUrl &url)
Overloaded assignment operator.
Definition kurifilter.cpp:365
QString searchProvider() const
Returns the name of the search service provider, e.g. Google.
Definition kurifilter.cpp:236
void setCheckForExecutables(bool check)
Check whether the provided uri is executable or not.
Definition kurifilter.cpp:340
bool hasArgsAndOptions() const
Checks whether the current data is a local resource with command line options and arguments.
Definition kurifilter.cpp:211
void setData(const QUrl &url)
Same as above except the argument is a URL.
Definition kurifilter.cpp:319
QString alternateDefaultSearchProvider() const
Returns the search provider to use when a default provider is not available.
Definition kurifilter.cpp:289
void setAlternateSearchProviders(const QStringList &providers)
Sets a list of search providers to use in case no preferred search providers are available.
Definition kurifilter.cpp:345
QChar searchTermSeparator() const
Returns the character that is used to separate the search term from the keyword.
Definition kurifilter.cpp:231
Class that holds information about a search provider.
Definition kurifilter.h:39
QStringList keys() const
Returns all the web shortcut keys associated with this search provider.
Definition kurifilter.cpp:116
KUriFilterSearchProvider & operator=(const KUriFilterSearchProvider &)
Assignment operator.
Definition kurifilter.cpp:130
virtual QString iconName() const
Returns the icon name associated with the search provider when available.
Definition kurifilter.cpp:106
QString defaultKey() const
Returns the default web shortcut key for this search provider.
Definition kurifilter.cpp:121
QString name() const
Returns the descriptive name of the search provider, e.g. "Google News".
Definition kurifilter.cpp:111
QString desktopEntryName() const
Returns the desktop filename of the search provider without any extension.
Definition kurifilter.cpp:101
bool filterSearchUri(KUriFilterData &data, SearchFilterTypes types)
Filter data using the criteria specified by types.
Definition kurifilter.cpp:476
SearchFilterType
This enum describes the types of search plugin filters available.
Definition kurifilter.h:711
QUrl filteredUri(const QUrl &uri, const QStringList &filters=QStringList())
Returns the filtered URI.
Definition kurifilter.cpp:462
QStringList pluginNames() const
Return a list of the names of all loaded plugins.
Definition kurifilter.cpp:491
QFlags< SearchFilterType > SearchFilterTypes
Stores a combination of SearchFilterType values.
Definition kurifilter.h:718
bool filterUri(KUriFilterData &data, const QStringList &filters=QStringList())
Filters data using the specified filters.
Definition kurifilter.cpp:425
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 24 2025 11:49:37 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 24 2025 11:49:37 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.