ldapclientsearch.h

Go to the documentation of this file.

/* kldapclient.h - LDAP access
 *      Copyright (C) 2002 Klarälvdalens Datakonsult AB
 *
 *      Author: Steffen Hansen <hansen@kde.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef LDAPCLIENTSEARCH_H
#define LDAPCLIENTSEARCH_H

#include "libkdepim/kdepim_export.h"
#include <kldap/ldapobject.h>
#include <QtCore/QObject>
#include <QtCore/QStringList>



namespace KLDAP {
class LdapClient;


struct LdapResultObject {
    const LdapClient *client;
    KLDAP::LdapObject object;
};

struct LdapResult
{
    typedef QList<LdapResult> List;

    LdapDN dn;
    QString name;         
    QStringList email;    
    int clientNumber;     
    int completionWeight; 
};

class KDEPIM_EXPORT LdapClientSearch : public QObject
{
    Q_OBJECT

public:
    explicit LdapClientSearch( QObject *parent = 0 );

    ~LdapClientSearch();

    void startSearch( const QString &query );

    void cancelSearch();

    bool isAvailable() const;

    void updateCompletionWeights();

    QList<LdapClient*> clients() const;


    QString filter() const;

    void setFilter(const QString &);

    QStringList attributes() const;

    void setAttributes(const QStringList&);

Q_SIGNALS:
    void searchData( const QStringList &results );

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

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

    void searchDone();

private:
    //@cond PRIVATE
    class Private;
    Private* const d;

    Q_PRIVATE_SLOT( d, void slotLDAPResult( const KLDAP::LdapClient&, const KLDAP::LdapObject& ) )
    Q_PRIVATE_SLOT( d, void slotLDAPError( const QString& ) )
    Q_PRIVATE_SLOT( d, void slotLDAPDone() )
    Q_PRIVATE_SLOT( d, void slotDataTimer() )
    Q_PRIVATE_SLOT( d, void slotFileChanged( const QString& ) )
    //@endcond
};

}

#endif // LDAPCLIENTSEARCH_H