ldapclient.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 KLDAP_LDAPCLIENT_H
#define KLDAP_LDAPCLIENT_H

#include "libkdepim/kdepim_export.h"

#include <QtCore/QObject>
#include <QtCore/QStringList>

class KJob;

namespace KLDAP {

class LdapObject;
class LdapServer;

class KDEPIM_EXPORT LdapClient : public QObject
{
    Q_OBJECT

public:
    explicit LdapClient( int clientNumber, QObject *parent = 0 );

    virtual ~LdapClient();

    int clientNumber() const;

    bool isActive() const;

    void setCompletionWeight( int weight );

    int completionWeight() const;

    void setServer( const KLDAP::LdapServer &server );

    const KLDAP::LdapServer server() const;

    void setAttributes( const QStringList &attributes );

    QStringList attributes() const;

    void setScope( const QString scope );

    void startQuery( const QString &filter );

    void cancelQuery();

Q_SIGNALS:
    void done();

    void error( const QString &message );

    void result( const KLDAP::LdapClient &client, const KLDAP::LdapObject& );

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

    Q_PRIVATE_SLOT( d, void slotData( KIO::Job*, const QByteArray& ) )
    Q_PRIVATE_SLOT( d, void slotData( const QByteArray& ) )
    Q_PRIVATE_SLOT( d, void slotInfoMessage( KJob*, const QString&, const QString& ) )
    Q_PRIVATE_SLOT( d, void slotDone() )
    //@endcond
};

}

#endif