KUriFilterSearchProvider Class

Header: #include <KUriFilterSearchProvider>
CMake: find_package(KF6 REQUIRED COMPONENTS KIO)
target_link_libraries(mytarget PRIVATE KIOGui)

Public Functions

KUriFilterSearchProvider()
KUriFilterSearchProvider(const KUriFilterSearchProvider &)
virtual ~KUriFilterSearchProvider()
QString defaultKey() const
QString desktopEntryName() const
virtual QString iconName() const
QStringList keys() const
QString name() const
KUriFilterSearchProvider &operator=(const KUriFilterSearchProvider &)

Detailed Description

@class KUriFilterSearchProvider kurifilter.h <KUriFilter>

Class that holds information about a search provider.

Member Function Documentation

KUriFilterSearchProvider::KUriFilterSearchProvider()

Default constructor.

KUriFilterSearchProvider::KUriFilterSearchProvider(const KUriFilterSearchProvider &)

Copy constructor.

[virtual noexcept] KUriFilterSearchProvider::~KUriFilterSearchProvider()

Destructor.

QString KUriFilterSearchProvider::defaultKey() const

Returns the default web shortcut key for this search provider.

Right now this is the same as doing keys().first(), it might however change based on what the backend plugins do.

@see keys

QString KUriFilterSearchProvider::desktopEntryName() const

Returns the desktop filename of the search provider without any extension.

For example, if the desktop filename of the search provider was "foobar.desktop", this function will return "foobar".

[virtual] QString KUriFilterSearchProvider::iconName() const

Returns the icon name associated with the search provider when available.

QStringList KUriFilterSearchProvider::keys() const

Returns all the web shortcut keys associated with this search provider.

@see defaultKey

QString KUriFilterSearchProvider::name() const

Returns the descriptive name of the search provider, e.g. "Google News".

This name comes from the "Name=" property entry in the desktop file that contains the search provider's information.

KUriFilterSearchProvider &KUriFilterSearchProvider::operator=(const KUriFilterSearchProvider &)

Assignment operator.