Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

KUriFilterSearchProvider Class

Class that holds information about a search provider. More...

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

List of all members, including inherited members

#Public Functions

• KUriFilterSearchProvider()
• KUriFilterSearchProvider(const KUriFilterSearchProvider &)
• QString defaultKey() const
• QString desktopEntryName() const
• QString iconName() const
• QStringList keys() const
• QString name() const

#Protected Functions

• void setDesktopEntryName(const QString &)
• void setIconName(const QString &)
• void setKeys(const QStringList &)
• void setName(const QString &)

#Detailed Description

#Member Function Documentation

#KUriFilterSearchProvider::KUriFilterSearchProvider()

Default constructor.

#KUriFilterSearchProvider::KUriFilterSearchProvider(const KUriFilterSearchProvider &)

Copy constructor.

#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 also 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".

See also setDesktopEntryName()

#[virtual] QString KUriFilterSearchProvider::iconName() const

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

See also setIconName()

#QStringList KUriFilterSearchProvider::keys() const

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

See also setKeys(), 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.

See also setName()

#[protected] void KUriFilterSearchProvider::setDesktopEntryName(const QString &)

See also desktopEntryName()

#[protected] void KUriFilterSearchProvider::setIconName(const QString &)

See also iconName()

#[protected] void KUriFilterSearchProvider::setKeys(const QStringList &)

See also keys()

#[protected] void KUriFilterSearchProvider::setName(const QString &)

See also name()