Akonadi::Search::SearchStore Class Reference

#include <searchstore.h>

Inheritance diagram for Akonadi::Search::SearchStore:

Public Types
using	List = QList<QSharedPointer<SearchStore>>
Public Types inherited from QObject
typedef	QObjectList

Public Member Functions
	SearchStore (QObject *parent=nullptr)
virtual void	close (int queryId)=0
virtual int	exec (const Query &query)=0
virtual QString	icon (int queryId)
virtual QByteArray	id (int queryId)=0
virtual bool	next (int queryId)=0
virtual QString	property (int queryId, const QString &propName)
virtual QString	text (int queryId)
virtual QStringList	types ()=0
virtual QUrl	url (int queryId)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static void	overrideSearchStores (const QList< SearchStore * > &overrideSearchStores)
static List	searchStores ()
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Properties inherited from QObject
	objectName
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Search store.

Definition at line 25 of file searchstore.h.

Member Typedef Documentation

List

using Akonadi::Search::SearchStore::List = QList<QSharedPointer<SearchStore>>

Definition at line 37 of file searchstore.h.

Constructor & Destructor Documentation

SearchStore()

SearchStore::SearchStore ( QObject * parent = nullptr )

explicit

Definition at line 23 of file searchstore.cpp.

Member Function Documentation

exec()

virtual int Akonadi::Search::SearchStore::exec ( const Query & query )

pure virtual

Executes the particular query synchronously.

Returns

Returns a integer representing the integer

Implemented in Akonadi::Search::XapianSearchStore.

icon()

QString SearchStore::icon ( int queryId )

nodiscardvirtual

Definition at line 35 of file searchstore.cpp.

overrideSearchStores()

void SearchStore::overrideSearchStores ( const QList< SearchStore * > & overrideSearchStores )

static

Override search stores for testing.

Definition at line 52 of file searchstore.cpp.

property()

QString SearchStore::property ( int queryId, const QString & propName )

nodiscardvirtual

Definition at line 45 of file searchstore.cpp.

searchStores()

SearchStore::List SearchStore::searchStores ( )

static

Gives a list of available search stores.

These stores must be managed and deleted by the caller

Definition at line 67 of file searchstore.cpp.

text()

QString SearchStore::text ( int queryId )

nodiscardvirtual

Definition at line 40 of file searchstore.cpp.

types()

virtual QStringList Akonadi::Search::SearchStore::types ( )

pure virtual

Returns a list of types which can be searched for in this store.

url()

QUrl SearchStore::url ( int queryId )

nodiscardvirtual

Definition at line 30 of file searchstore.cpp.

---

The documentation for this class was generated from the following files:

• searchstore.h
• searchstore.cpp