KIO
Go to the documentation of this file.
31#include <QtCore/QObject>
32#include <QtCore/QHash>
33#include <QtCore/QPair>
34#include <QtCore/QStringList>
40class KUriFilterPrivate;
41class KUriFilterDataPrivate;
74 QString desktopEntryName()
const;
87 QString iconName()
const;
94 QStringList keys()
const;
104 QString defaultKey()
const;
112 void setDesktopEntryName(
const QString&);
113 void setIconName(
const QString&);
114 void setKeys(
const QStringList&);
115 void setName(
const QString&);
119 class KUriFilterSearchProviderPrivate;
120 KUriFilterSearchProviderPrivate *
const d;
188 enum UriTypes { NetProtocol=0, LocalFile, LocalDir, Executable, Help, Shell,
Blocked, Error, Unknown };
215 SearchFilterOptionNone = 0x0,
216 RetrieveSearchProvidersOnly = 0x01,
217 RetrievePreferredSearchProvidersOnly = 0x02,
218 RetrieveAvailableSearchProvidersOnly = (RetrievePreferredSearchProvidersOnly | RetrieveSearchProvidersOnly)
220 Q_DECLARE_FLAGS(SearchFilterOptions, SearchFilterOption)
276 QString errorMsg()
const;
286 UriTypes uriType()
const;
295 QString absolutePath()
const;
304 bool hasAbsolutePath()
const;
312 QString argsAndOptions()
const;
320 bool hasArgsAndOptions()
const;
326 bool checkForExecutables()
const;
331 QString typedString()
const;
342 QString searchTerm()
const;
354 QChar searchTermSeparator()
const;
365 QString searchProvider()
const;
391 QStringList preferredSearchProviders()
const;
418 QString queryForPreferredSearchProvider(
const QString &provider)
const;
432 QStringList allQueriesForSearchProvider(
const QString& provider)
const;
443 QString iconNameForPreferredSearchProvider(
const QString &provider)
const;
457 QStringList alternateSearchProviders()
const;
469 QString alternateDefaultSearchProvider()
const;
479 QString defaultUrlScheme()
const;
489 SearchFilterOptions searchFilteringOptions()
const;
506 void setCheckForExecutables (
bool check);
516 void setData(
const KUrl& url );
527 void setData(
const QString& url );
543 bool setAbsolutePath(
const QString& abs_path );
558 void setAlternateSearchProviders(
const QStringList &providers);
572 void setAlternateDefaultSearchProvider(
const QString &provider);
588 void setDefaultUrlScheme(
const QString&);
605 void setSearchFilteringOptions(SearchFilterOptions options);
629 KUriFilterDataPrivate *
const d;
657#ifndef KDE_NO_DEPRECATED
692 virtual QString configName()
const;
703 void setErrorMsg (
KUriFilterData& data,
const QString& errmsg )
const;
714 void setArguments(
KUriFilterData& data,
const QString& args )
const;
722 void setSearchProvider(
KUriFilterData& data,
const QString& provider,
723 const QString& term,
const QChar& separator)
const;
731#ifndef KDE_NO_DEPRECATED
765 QHostInfo resolveName (
const QString& hostname,
unsigned long timeout)
const;
768 class KUriFilterPluginPrivate *
const d;
881 NormalTextFilter = 0x01,
882 WebShortcutFilter = 0x02
884 Q_DECLARE_FLAGS(SearchFilterTypes, SearchFilterType)
907 bool filterUri(
KUriFilterData& data,
const QStringList& filters = QStringList() );
920 bool filterUri(
KUrl &uri,
const QStringList& filters = QStringList() );
933 bool filterUri( QString &uri,
const QStringList& filters = QStringList() );
946 KUrl filteredUri(
const KUrl &uri,
const QStringList& filters = QStringList() );
959 QString filteredUri(
const QString &uri,
const QStringList& filters = QStringList() );
967#ifndef KDE_NO_DEPRECATED
987 bool filterSearchUri(
KUriFilterData &data, SearchFilterTypes types);
994 QStringList pluginNames()
const;
1014 KUriFilterPrivate *
const d;
1017Q_DECLARE_OPERATORS_FOR_FLAGS(KUriFilterData::SearchFilterOptions)
1018Q_DECLARE_OPERATORS_FOR_FLAGS(KUriFilter::SearchFilterTypes)
This class is a basic messaging class used to exchange filtering information between the filter plugi...
UriTypes
Describes the type of the URI that was filtered.
SearchFilterOption
This enum describes the search filtering options to be used.
Base class for URI filter plugins.
QHash< QString, QPair< QString, QString > > ProviderInfoList
List for holding the following search provider information: ([search provider name],...
virtual bool filterUri(KUriFilterData &data) const =0
Filters a URI.
Class that holds information about a search provider.
KUriFilter applies a number of filters to a URI and returns a filtered version if any filter matches.
SearchFilterType
This enum describes the types of search plugin filters available.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by
doxygen 1.10.0 written
by
Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.