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	searchDone ()

Public Member Functions
	LdapClientSearch (QObject *parent=0)
	~LdapClientSearch ()
void	cancelSearch ()
QList< LdapClient * >	clients () const
bool	isAvailable () const
void	startSearch (const QString &query)
void	updateCompletionWeights ()

Detailed Description

Since

4.5

Definition at line 60 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 95 of file ldapclientsearch.cpp.

LdapClientSearch::~LdapClientSearch

(

)

Destroys the ldap client search object.

Definition at line 111 of file ldapclientsearch.cpp.

Member Function Documentation

void LdapClientSearch::cancelSearch

(

)

Cancels the currently running search query.

Definition at line 233 of file ldapclientsearch.cpp.

QList< LdapClient * > LdapClientSearch::clients

(

)

const

Returns the list of configured LDAP clients.

Definition at line 133 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 400 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::searchDone ( )

signal

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

void LdapClientSearch::startSearch

(

const QString &

query

)

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

Definition at line 188 of file ldapclientsearch.cpp.

void LdapClientSearch::updateCompletionWeights

(

)

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

Definition at line 125 of file ldapclientsearch.cpp.

---

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

• ldapclientsearch.h
• ldapclientsearch.cpp