• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KLDAP Library

  • kldap
ldapsearch.h
1/*
2 This file is part of libkldap.
3 Copyright (c) 2004-2006 Szombathelyi György <gyurco@freemail.hu>
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to
17 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
19*/
20
21#ifndef KLDAP_LDAPSEARCH_H
22#define KLDAP_LDAPSEARCH_H
23
24#include <QtCore/QByteArray>
25#include <QtCore/QList>
26#include <QtCore/QObject>
27#include <QtCore/QString>
28
29#include "kldap_export.h"
30
31#include "ldapconnection.h"
32#include "ldapcontrol.h"
33#include "ldapobject.h"
34#include "ldapoperation.h"
35#include "ldapserver.h"
36#include "ldapurl.h"
37
38namespace KLDAP {
39
45class KLDAP_EXPORT LdapSearch : public QObject
46{
47 Q_OBJECT
48
49 public:
53 LdapSearch();
54
61 explicit LdapSearch( LdapConnection &connection );
62
63 virtual ~LdapSearch();
64
70 void setConnection( LdapConnection &connection );
71
75 void setClientControls( const LdapControls &ctrls );
76
80 void setServerControls( const LdapControls &ctrls );
81
89 bool search( const LdapServer &server,
90 const QStringList &attributes = QStringList(), int count = 0 );
91
95 bool search( const LdapUrl &url, int count = 0 );
96
101 bool search( const LdapDN &base,
102 LdapUrl::Scope scope = LdapUrl::Sub,
103 const QString &filter = QString(),
104 const QStringList &attributes = QStringList(),
105 int pagesize = 0, int count = 0 );
106
110 void continueSearch();
114 bool isFinished();
118 void abandon();
119
123 int error() const;
124
128 QString errorString() const;
129
130 Q_SIGNALS:
134 void data( KLDAP::LdapSearch *search, const KLDAP::LdapObject &obj );
135
139 void result( KLDAP::LdapSearch *search );
140
141 private:
142 class Private;
143 Private *const d;
144
145 Q_PRIVATE_SLOT( d, void result() )
146
147 Q_DISABLE_COPY( LdapSearch )
148};
149
150}
151
152#endif
KLDAP::LdapConnection
This class represents a connection to an LDAP server.
Definition ldapconnection.h:37
KLDAP::LdapObject
This class represents an LDAP Object.
Definition ldapobject.h:42
KLDAP::LdapSearch
This class starts a search operation on a LDAP server and returns the search values via a Qt signal.
Definition ldapsearch.h:46
KLDAP::LdapSearch::data
void data(KLDAP::LdapSearch *search, const KLDAP::LdapObject &obj)
Emitted for each result object.
KLDAP::LdapSearch::result
void result(KLDAP::LdapSearch *search)
Emitted when the searching finished.
KLDAP::LdapServer
A class that contains LDAP server connection settings.
Definition ldapserver.h:39
KLDAP::LdapUrl
A special url class for LDAP.
Definition ldapurl.h:43
KLDAP::LdapUrl::Scope
Scope
Describes the scope of the LDAP url.
Definition ldapurl.h:58
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KLDAP Library

Skip menu "KLDAP Library"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal