KLDAPCore::LdapClient
#include <ldapclient.h>
Signals | |
void | done () |
void | error (const QString &message) |
void | result (const KLDAPCore::LdapClient &client, const KLDAPCore::LdapObject &) |
Public Member Functions | |
LdapClient (int clientNumber, QObject *parent=nullptr) | |
~LdapClient () override | |
QStringList | attributes () const |
void | cancelQuery () |
int | clientNumber () const |
int | completionWeight () const |
bool | isActive () const |
const KLDAPCore::LdapServer | server () const |
void | setAttributes (const QStringList &attributes) |
void | setCompletionWeight (int weight) |
void | setScope (const QString &scope) |
void | setServer (const KLDAPCore::LdapServer &server) |
void | startQuery (const QString &filter) |
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 |
Additional Inherited Members | |
Public Types inherited from QObject | |
typedef | QObjectList |
Properties inherited from QObject | |
objectName | |
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) |
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
An object that represents a configured LDAP server.
This class represents a client that to an LDAP server that can be used for LDAP lookups. Every client is identified by a unique numeric id.
- Since
- 4.5
Definition at line 28 of file ldapclient.h.
Constructor & Destructor Documentation
◆ LdapClient()
|
explicit |
Creates a new ldap client.
- Parameters
-
clientNumber The unique number of this client. parent The parent object.
Definition at line 62 of file ldapclient.cpp.
◆ ~LdapClient()
|
overridedefault |
Destroys the ldap client.
Member Function Documentation
◆ attributes()
|
nodiscard |
Returns the LDAP attributes that should be returned in the query result.
Definition at line 93 of file ldapclient.cpp.
◆ cancelQuery()
void LdapClient::cancelQuery | ( | ) |
Cancels a running query.
Definition at line 135 of file ldapclient.cpp.
◆ clientNumber()
|
nodiscard |
Returns the number of this client.
Definition at line 262 of file ldapclient.cpp.
◆ completionWeight()
|
nodiscard |
Returns the completion weight of this client.
Definition at line 267 of file ldapclient.cpp.
◆ done
|
signal |
This signal is emitted when the query has finished.
◆ error
|
signal |
This signal is emitted in case of an error.
- Parameters
-
message A message that describes the error.
◆ isActive()
|
nodiscard |
Returns whether this client is currently running a search query.
Definition at line 72 of file ldapclient.cpp.
◆ result
|
signal |
This signal is emitted once for each object that is returned from the query.
◆ server()
const KLDAPCore::LdapServer LdapClient::server | ( | ) | const |
Returns the ldap server information that are used by this client.
Definition at line 82 of file ldapclient.cpp.
◆ setAttributes()
void LdapClient::setAttributes | ( | const QStringList & | attributes | ) |
Sets the LDAP attributes
that should be returned in the query result.
Pass an empty list to include all available attributes.
Definition at line 87 of file ldapclient.cpp.
◆ setCompletionWeight()
void LdapClient::setCompletionWeight | ( | int | weight | ) |
Sets the completion weight
of this client.
This value will be used to sort the results of this client when used for auto completion.
Definition at line 272 of file ldapclient.cpp.
◆ setScope()
void LdapClient::setScope | ( | const QString & | scope | ) |
Sets the scope
of the LDAP query.
Valid values are 'one' or 'sub'.
Definition at line 98 of file ldapclient.cpp.
◆ setServer()
void LdapClient::setServer | ( | const KLDAPCore::LdapServer & | server | ) |
Sets the LDAP server
information that shall be used by this client.
Definition at line 77 of file ldapclient.cpp.
◆ startQuery()
void LdapClient::startQuery | ( | const QString & | filter | ) |
Starts the query with the given filter
.
Definition at line 103 of file ldapclient.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:09:16 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.