.TH "KABC::LDAPUrl" kde3 "11 Jun 2005" "Version Version 3.4.1" "kabc Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KABC::LDAPUrl \- \fBLDAPUrl\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ldapurl.h>\fP
.PP
Inherits \fBKURL\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBScope\fP { \fBBase\fP, \fBOne\fP, \fBSub\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBLDAPUrl\fP ()"
.br
.ti -1c
.RI "\fBLDAPUrl\fP (const \fBKURL\fP &\fBurl\fP)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBdn\fP () const "
.br
.ti -1c
.RI "void \fBsetDn\fP (const \fBQString\fP &dn)"
.br
.ti -1c
.RI "const \fBQStringList\fP & \fBattributes\fP ()"
.br
.ti -1c
.RI "void \fBsetAttributes\fP (const \fBQStringList\fP &attributes)"
.br
.ti -1c
.RI "Scope \fBscope\fP () const "
.br
.ti -1c
.RI "void \fBsetScope\fP (Scope scope)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBfilter\fP () const "
.br
.ti -1c
.RI "void \fBsetFilter\fP (\fBQString\fP filter)"
.br
.ti -1c
.RI "bool \fBhasExtension\fP (const \fBQString\fP &key) const "
.br
.ti -1c
.RI "Extension \fBextension\fP (const \fBQString\fP &key) const "
.br
.ti -1c
.RI "\fBQString\fP \fBextension\fP (const \fBQString\fP &key, bool &critical) const "
.br
.ti -1c
.RI "void \fBsetExtension\fP (const \fBQString\fP &key, const Extension &ext)"
.br
.ti -1c
.RI "void \fBsetExtension\fP (const \fBQString\fP &key, const \fBQString\fP &value, bool critical=false)"
.br
.ti -1c
.RI "void \fBremoveExtension\fP (const \fBQString\fP &key)"
.br
.ti -1c
.RI "void \fBupdateQuery\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBparseQuery\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBLDAPUrl\fP. 

\fBLDAPUrl\fP implements an RFC 2255 compliant LDAP Url parser, with minimal differences. LDAP Urls implemented by this class has the following format: ldap[s]://[user[:password]@]hostname[:port]['/' [dn ['?' [attributes] ['?' [scope] ['?' [filter] ['?' extensions]]]]]] 
.PP
Definition at line 42 of file ldapurl.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "LDAPUrl::LDAPUrl ()"
.PP
Constructs an empty KLDAPUrl. 
.PP
Definition at line 29 of file ldapurl.cpp.
.SS "LDAPUrl::LDAPUrl (const \fBKURL\fP & url)"
.PP
Constructs a KLDAPUrl from a \fBKURL\fP. 
.PP
Definition at line 34 of file ldapurl.cpp.
.PP
References KURL::path(), and QString::remove().
.SH "Member Function Documentation"
.PP 
.SS "const \fBQString\fP& KABC::LDAPUrl::dn () const\fC [inline]\fP"
.PP
Returns the dn part of the LDAP Url (same as \fBpath()\fP, but slash removed from the beginning). 
.PP
Definition at line 62 of file ldapurl.h.
.PP
Referenced by setDn().
.SS "void LDAPUrl::setDn (const \fBQString\fP & dn)"
.PP
Sets the the dn part of the LDAP Url. 
.PP
Definition at line 47 of file ldapurl.cpp.
.PP
References dn(), QString::remove(), and KURL::setPath().
.PP
Referenced by KABC::LdapConfigWidget::url().
.SS "const \fBQStringList\fP& KABC::LDAPUrl::attributes ()\fC [inline]\fP"
.PP
Returns the attributes part of the LDAP Url. 
.PP
Definition at line 67 of file ldapurl.h.
.SS "void KABC::LDAPUrl::setAttributes (const \fBQStringList\fP & attributes)\fC [inline]\fP"
.PP
Sets the attributes part of the LDAP Url. 
.PP
Definition at line 69 of file ldapurl.h.
.SS "Scope KABC::LDAPUrl::scope () const\fC [inline]\fP"
.PP
Returns the scope part of the LDAP Url. 
.PP
Definition at line 73 of file ldapurl.h.
.SS "void KABC::LDAPUrl::setScope (Scope scope)\fC [inline]\fP"
.PP
Sets the scope part of the LDAP Url. 
.PP
Definition at line 75 of file ldapurl.h.
.SS "const \fBQString\fP& KABC::LDAPUrl::filter () const\fC [inline]\fP"
.PP
Returns the filter part of the LDAP Url. 
.PP
Definition at line 78 of file ldapurl.h.
.SS "void KABC::LDAPUrl::setFilter (\fBQString\fP filter)\fC [inline]\fP"
.PP
Sets the filter part of the LDAP Url. 
.PP
Definition at line 80 of file ldapurl.h.
.PP
Referenced by KABC::LdapConfigWidget::url().
.SS "bool LDAPUrl::hasExtension (const \fBQString\fP & key) const"
.PP
Returns if the specified extension exists in the LDAP Url. 
.PP
Definition at line 59 of file ldapurl.cpp.
.PP
References QMap::contains().
.SS "LDAPUrl::Extension LDAPUrl::extension (const \fBQString\fP & key) const"
.PP
Returns the specified extension. 
.PP
Definition at line 64 of file ldapurl.cpp.
.PP
References QMap::constEnd(), and QMap::find().
.PP
Referenced by extension().
.SS "\fBQString\fP LDAPUrl::extension (const \fBQString\fP & key, bool & critical) const"
.PP
Returns the specified extension. 
.PP
Definition at line 79 of file ldapurl.cpp.
.PP
References extension().
.SS "void LDAPUrl::setExtension (const \fBQString\fP & key, const Extension & ext)"
.PP
Sets the specified extension key with the value and criticality in ext. 
.PP
Definition at line 88 of file ldapurl.cpp.
.PP
References updateQuery().
.PP
Referenced by setExtension(), and KABC::LdapConfigWidget::url().
.SS "void LDAPUrl::setExtension (const \fBQString\fP & key, const \fBQString\fP & value, bool critical = \fCfalse\fP)"
.PP
Sets the specified extension key with the value and criticality specified. 
.PP
Definition at line 94 of file ldapurl.cpp.
.PP
References setExtension().
.SS "void LDAPUrl::removeExtension (const \fBQString\fP & key)"
.PP
Removes the specified extension. 
.PP
Definition at line 102 of file ldapurl.cpp.
.PP
References QMap::remove(), and updateQuery().
.SS "void LDAPUrl::updateQuery ()"
.PP
Updates the query component from the attributes, scope, filter and extensions. 
.PP
Definition at line 108 of file ldapurl.cpp.
.PP
References QMap::begin(), QMap::end(), endl(), QString::endsWith(), QMap::isEmpty(), QString::isEmpty(), QStringList::join(), kdDebug(), QString::length(), KURL::prettyURL(), QString::remove(), and KURL::setQuery().
.PP
Referenced by removeExtension(), and setExtension().

.SH "Author"
.PP 
Generated automatically by Doxygen for kabc Library from the source code.
