KNSCore::SearchPreset

Search for usage in LXR

KNSCore::SearchPreset Class Reference

#include <searchpreset.h>

Public Types

enum class  Type {
  NoPresetType = 0 , GoBack , Root , Start ,
  Popular , Featured , Recommended , Shelf ,
  Subscription , New , FolderUp , AllEntries
}
 

Public Member Functions

QString displayName () const
 
QString iconName () const
 
QString providerId () const
 
SearchRequest request () const
 
Type type () const
 

Detailed Description

Describes a search request that may come from the provider.

This is used by the OPDS provider to handle the different urls.

Since
6.9

Definition at line 24 of file searchpreset.h.

Member Enumeration Documentation

◆ Type

enum class KNSCore::SearchPreset::Type
strong

The SearchPresetTypes enum the preset type enum is a helper to identify the kind of label and icon the search preset should have if none are found.

Since
6.9
Enumerator
GoBack 

preset representing the previous search.

Root 

preset indicating a root directory.

Start 

preset indicating the first entry.

Popular 

preset indicating popular items.

Featured 

preset for featured items.

Recommended 

preset for recommended. This may be customized by the server per user.

Shelf 

preset indicating previously acquired items.

Subscription 

preset indicating items that the user is subscribed to.

New 

preset indicating new items.

FolderUp 

preset indicating going up in the search result hierarchy.

AllEntries 

preset indicating all possible entries, such as a crawlable list. Might be intense to load.

Definition at line 33 of file searchpreset.h.

Member Function Documentation

◆ displayName()

QString KNSCore::SearchPreset::displayName ( ) const
nodiscard

Definition at line 31 of file searchpreset.cpp.

◆ iconName()

QString KNSCore::SearchPreset::iconName ( ) const
nodiscard

Definition at line 36 of file searchpreset.cpp.

◆ providerId()

QString KNSCore::SearchPreset::providerId ( ) const
nodiscard

Definition at line 46 of file searchpreset.cpp.

◆ request()

SearchRequest KNSCore::SearchPreset::request ( ) const
nodiscard

Definition at line 26 of file searchpreset.cpp.

◆ type()

KNSCore::SearchPreset::Type KNSCore::SearchPreset::type ( ) const
nodiscard

Definition at line 41 of file searchpreset.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 Fri Nov 29 2024 11:53:59 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.