KLDAP::LdapClientSearch Class Reference

#include <ldapclientsearch.h>

Inheritance diagram for KLDAP::LdapClientSearch:

Signals
void	searchData (const QStringList &results)
void	searchData (const KLDAP::LdapResult::List &results)
void	searchData (const QList< KLDAP::LdapResultObject > &results)
void	searchDone ()

Public Member Functions
	LdapClientSearch (QObject *parent=0)
	~LdapClientSearch ()
QStringList	attributes () const
void	cancelSearch ()
QList< 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)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
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)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Since

4.5

Definition at line 68 of file ldapclientsearch.h.

Constructor & Destructor Documentation

LdapClientSearch::LdapClientSearch ( QObject *  parent = 0 )

explicit

Creates a new ldap client search object.

Parameters

parent

The parent object.

Definition at line 91 of file ldapclientsearch.cpp.

LdapClientSearch::~LdapClientSearch

(

)

Destroys the ldap client search object.

Definition at line 115 of file ldapclientsearch.cpp.

Member Function Documentation

QStringList LdapClientSearch::attributes

(

)

const

Returns the attributes, that are queried the LDAP Server.

Since

4.14

Definition at line 152 of file ldapclientsearch.cpp.

void LdapClientSearch::cancelSearch

(

)

Cancels the currently running search query.

Definition at line 247 of file ldapclientsearch.cpp.

QList< LdapClient * > LdapClientSearch::clients

(

)

const

Returns the list of configured LDAP clients.

Definition at line 137 of file ldapclientsearch.cpp.

QString LdapClientSearch::filter

(

)

const

Returns the filter for the Query.

Since

4.14

Definition at line 142 of file ldapclientsearch.cpp.

bool LdapClientSearch::isAvailable

(

)

const

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 418 of file ldapclientsearch.cpp.

void KLDAP::LdapClientSearch::searchData ( const QStringList &  results )

signal

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

Parameters

results

The contacts in the form "Full Name <email>"

void KLDAP::LdapClientSearch::searchData ( const KLDAP::LdapResult::List &  results )

signal

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

Parameters

results

The list of found contacts.

void KLDAP::LdapClientSearch::searchData ( const QList< KLDAP::LdapResultObject > &  results )

signal

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

Parameters

results

The list of found contacts.

void KLDAP::LdapClientSearch::searchDone ( )

signal

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

void LdapClientSearch::setAttributes

(

const QStringList &

attrs

)

Sets the attributes, that are queried the LDAP Server.

Since

4.14

Definition at line 157 of file ldapclientsearch.cpp.

void LdapClientSearch::setFilter

(

const QString &

filter

)

Sets the filter for the Query.

Since

4.14

Definition at line 147 of file ldapclientsearch.cpp.

void LdapClientSearch::startSearch

(

const QString &

query

)

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

Definition at line 215 of file ldapclientsearch.cpp.

void LdapClientSearch::updateCompletionWeights

(

)

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

Definition at line 129 of file ldapclientsearch.cpp.

---

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

• ldapclientsearch.h
• ldapclientsearch.cpp