KLDAPCore::LdapClientSearch

Search for usage in LXR

KLDAPCore::LdapClientSearch Class Reference

#include <ldapclientsearch.h>

Inheritance diagram for KLDAPCore::LdapClientSearch:

Signals

void searchData (const KLDAPCore::LdapResult::List &results)
 
void searchData (const KLDAPCore::LdapResultObject::List &results)
 
void searchData (const QStringList &results)
 
void searchDone ()
 

Public Member Functions

 LdapClientSearch (const QStringList &attr, QObject *parent=nullptr)
 
 LdapClientSearch (QObject *parent=nullptr)
 
 ~LdapClientSearch () override
 
QStringList attributes () const
 
void cancelSearch ()
 
QList< KLDAPCore::LdapClient * > clients () const
 
QString filter () const
 
bool isAvailable () const
 
void setAttributes (const QStringList &)
 
void setFilter (const QString &)
 
void startSearch (const QString &query)
 
void updateCompletionWeights ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () const const
 

Static Public Member Functions

static QStringList defaultAttributes ()
 
- 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

- Public Types inherited from QObject
typedef  QObjectList
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Since
4.5

Definition at line 51 of file ldapclientsearch.h.

Constructor & Destructor Documentation

◆ LdapClientSearch() [1/2]

LdapClientSearch::LdapClientSearch ( QObject * parent = nullptr)
explicit

Creates a new ldap client search object.

Parameters
parentThe parent object.

Definition at line 70 of file ldapclientsearch.cpp.

◆ LdapClientSearch() [2/2]

LdapClientSearch::LdapClientSearch ( const QStringList & attr,
QObject * parent = nullptr )
explicit

Creates a new ldap client search object.

Parameters
attrThe attributes.
parentThe parent object.

Definition at line 77 of file ldapclientsearch.cpp.

◆ ~LdapClientSearch()

LdapClientSearch::~LdapClientSearch ( )
overridedefault

Destroys the ldap client search object.

Member Function Documentation

◆ attributes()

QStringList LdapClientSearch::attributes ( ) const
nodiscard

Returns the attributes, that are queried the LDAP Server.

Since
4.14

Definition at line 137 of file ldapclientsearch.cpp.

◆ cancelSearch()

void LdapClientSearch::cancelSearch ( )

Cancels the currently running search query.

Definition at line 243 of file ldapclientsearch.cpp.

◆ clients()

QList< KLDAPCore::LdapClient * > LdapClientSearch::clients ( ) const
nodiscard

Returns the list of configured LDAP clients.

Definition at line 122 of file ldapclientsearch.cpp.

◆ defaultAttributes()

QStringList LdapClientSearch::defaultAttributes ( )
staticnodiscard

Definition at line 150 of file ldapclientsearch.cpp.

◆ filter()

QString LdapClientSearch::filter ( ) const
nodiscard

Returns the filter for the Query.

Since
4.14

Definition at line 127 of file ldapclientsearch.cpp.

◆ isAvailable()

bool LdapClientSearch::isAvailable ( ) const
nodiscard

Returns whether LDAP search is possible at all.

Note
This method can return false if either no LDAP is configured or the system does not support the KIO LDAP protocol.

Definition at line 413 of file ldapclientsearch.cpp.

◆ searchData [1/3]

void KLDAPCore::LdapClientSearch::searchData ( const KLDAPCore::LdapResult::List & results)
signal

This signal is emitted whenever new contacts have been found during the lookup.

Parameters
resultsThe list of found contacts.

◆ searchData [2/3]

void KLDAPCore::LdapClientSearch::searchData ( const KLDAPCore::LdapResultObject::List & results)
signal

This signal is emitted whenever new contacts have been found during the lookup.

Parameters
resultsThe list of found contacts.

◆ searchData [3/3]

void KLDAPCore::LdapClientSearch::searchData ( const QStringList & results)
signal

This signal is emitted whenever new contacts have been found during the lookup.

Parameters
resultsThe contacts in the form "Full Name <email>"

◆ searchDone

void KLDAPCore::LdapClientSearch::searchDone ( )
signal

This signal is emitted whenever the lookup is complete or the user has canceled the query.

◆ setAttributes()

void LdapClientSearch::setAttributes ( const QStringList & attrs)

Sets the attributes, that are queried the LDAP Server.

Since
4.14

Definition at line 142 of file ldapclientsearch.cpp.

◆ setFilter()

void LdapClientSearch::setFilter ( const QString & filter)

Sets the filter for the Query.

Since
4.14

Definition at line 132 of file ldapclientsearch.cpp.

◆ startSearch()

void LdapClientSearch::startSearch ( const QString & query)

Starts the LDAP search on all configured LDAP clients with the given search query.

Definition at line 210 of file ldapclientsearch.cpp.

◆ updateCompletionWeights()

void LdapClientSearch::updateCompletionWeights ( )

Updates the completion weights for the configured LDAP clients from the configuration file.

Definition at line 114 of file ldapclientsearch.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 Oct 4 2024 12:00:03 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.