KUriFilterSearchProvider

Search for usage in LXR

KUriFilterSearchProvider Class Reference

#include <KUriFilter>

Inherited by SearchProvider.

Public Member Functions

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

Protected Member Functions

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

Detailed Description

Class that holds information about a search provider.

Definition at line 38 of file kurifilter.h.

Constructor & Destructor Documentation

◆ KUriFilterSearchProvider() [1/2]

KUriFilterSearchProvider::KUriFilterSearchProvider ( )

Default constructor.

Definition at line 89 of file kurifilter.cpp.

◆ KUriFilterSearchProvider() [2/2]

KUriFilterSearchProvider::KUriFilterSearchProvider ( const KUriFilterSearchProvider & other)

Copy constructor.

Definition at line 94 of file kurifilter.cpp.

◆ ~KUriFilterSearchProvider()

KUriFilterSearchProvider::~KUriFilterSearchProvider ( )
virtualdefault

Destructor.

Member Function Documentation

◆ defaultKey()

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

Definition at line 121 of file kurifilter.cpp.

◆ desktopEntryName()

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

Definition at line 101 of file kurifilter.cpp.

◆ iconName()

QString KUriFilterSearchProvider::iconName ( ) const
virtual

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

Definition at line 106 of file kurifilter.cpp.

◆ keys()

QStringList KUriFilterSearchProvider::keys ( ) const

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

See also
defaultKey

Definition at line 116 of file kurifilter.cpp.

◆ name()

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.

Definition at line 111 of file kurifilter.cpp.

◆ operator=()

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

Assignment operator.

Definition at line 130 of file kurifilter.cpp.

◆ setDesktopEntryName()

void KUriFilterSearchProvider::setDesktopEntryName ( const QString & desktopEntryName)
protected

Definition at line 139 of file kurifilter.cpp.

◆ setIconName()

void KUriFilterSearchProvider::setIconName ( const QString & iconName)
protected

Definition at line 144 of file kurifilter.cpp.

◆ setKeys()

void KUriFilterSearchProvider::setKeys ( const QStringList & keys)
protected

Definition at line 154 of file kurifilter.cpp.

◆ setName()

void KUriFilterSearchProvider::setName ( const QString & name)
protected

Definition at line 149 of file kurifilter.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:18:52 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.