• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeabc
 

tdeabc

  • TDEABC
  • LDAPUrl
Public Types | Public Member Functions | Protected Member Functions | List of all members
TDEABC::LDAPUrl Class Reference

#include <ldapurl.h>

Inheritance diagram for TDEABC::LDAPUrl:
KURL

Public Types

enum  Scope { Base , One , Sub }
 
- Public Types inherited from KURL
enum  AdjustementFlags
 
enum  URIMode
 
enum  QueryItemsOptions
 

Public Member Functions

 LDAPUrl ()
 
 LDAPUrl (const KURL &url)
 
const TQString & dn () const
 
void setDn (const TQString &dn)
 
const TQStringList & attributes ()
 
void setAttributes (const TQStringList &attributes)
 
Scope scope () const
 
void setScope (Scope scope)
 
const TQString & filter () const
 
void setFilter (TQString filter)
 
bool hasExtension (const TQString &key) const
 
Extension extension (const TQString &key) const
 
TQString extension (const TQString &key, bool &critical) const
 
void setExtension (const TQString &key, const Extension &ext)
 
void setExtension (const TQString &key, const TQString &value, bool critical=false)
 
void removeExtension (const TQString &key)
 
void updateQuery ()
 
- Public Member Functions inherited from KURL
 KURL (const TQString &url, int encoding_hint=0)
 
 KURL (const char *url, int encoding_hint=0)
 
 KURL (const TQCString &url, int encoding_hint=0)
 
 KURL (const KURL &u)
 
 KURL (const TQUrl &u)
 
 KURL (const KURL &_baseurl, const TQString &_rel_url, int encoding_hint=0)
 
TQString protocol () const
 
void setProtocol (const TQString &_txt)
 
int uriMode () const
 
TQString user () const
 
void setUser (const TQString &_txt)
 
bool hasUser () const
 
TQString pass () const
 
void setPass (const TQString &_txt)
 
bool hasPass () const
 
TQString host () const
 
void setHost (const TQString &_txt)
 
bool hasHost () const
 
unsigned short int port () const
 
void setPort (unsigned short int _p)
 
TQString path () const
 
TQString path (int _trailing) const
 
void setPath (const TQString &path)
 
bool hasPath () const
 
void cleanPath (bool cleanDirSeparator=true)
 
void adjustPath (int _trailing)
 
void setEncodedPathAndQuery (const TQString &_txt, int encoding_hint=0)
 
void setEncodedPath (const TQString &_txt, int encoding_hint=0)
 
TQString encodedPathAndQuery (int _trailing=0, bool _no_empty_path=false, int encoding_hint=0) const
 
void setQuery (const TQString &_txt, int encoding_hint=0)
 
TQString query () const
 
TQString ref () const
 
void setRef (const TQString &_txt)
 
bool hasRef () const
 
TQString htmlRef () const
 
TQString encodedHtmlRef () const
 
void setHTMLRef (const TQString &_ref)
 
bool hasHTMLRef () const
 
bool isValid () const
 
TDE_DEPRECATED bool isMalformed () const
 
bool isLocalFile () const
 
void setFileEncoding (const TQString &encoding)
 
TQString fileEncoding () const
 
bool hasSubURL () const
 
void addPath (const TQString &txt)
 
TQString queryItem (const TQString &item) const
 
TQString queryItem (const TQString &item, int encoding_hint) const
 
TQMap< TQString, TQString > queryItems (int options, int encoding_hint) const
 
void addQueryItem (const TQString &_item, const TQString &_value, int encoding_hint=0)
 
void removeQueryItem (const TQString &_item)
 
void setFileName (const TQString &_txt)
 
TQString fileName (bool _ignore_trailing_slash_in_path=true) const
 
TQString directory (bool _strip_trailing_slash_from_result=true, bool _ignore_trailing_slash_in_path=true) const
 
void setDirectory (const TQString &dir)
 
bool cd (const TQString &_dir)
 
TQString url (int _trailing=0, int encoding_hint=0) const
 
TQString prettyURL (int _trailing=0) const
 
TQString prettyURL (int _trailing, AdjustementFlags _flags) const
 
TQString pathOrURL () const
 
TQString htmlURL () const
 
bool isEmpty () const
 
KURL upURL () const
 
bool operator< (const KURL &_u) const
 
KURL & operator= (const KURL &_u)
 
KURL & operator= (const TQString &_url)
 
KURL & operator= (const char *_url)
 
KURL & operator= (const TQUrl &u)
 
bool operator== (const KURL &_u) const
 
bool operator== (const TQString &_u) const
 
bool operator!= (const KURL &_u) const
 
bool operator!= (const TQString &_u) const
 
bool cmp (const KURL &u, bool ignore_trailing=false) const TDE_DEPRECATED
 
bool equals (const KURL &u, bool ignore_trailing=false) const
 
bool equals (const KURL &u, bool ignore_trailing, bool ignore_internalReferenceURLS) const
 
bool isParentOf (const KURL &u) const
 
TQString filename (bool _ignore_trailing_slash_in_path=true) const
 
bool urlcmp (const TQString &_url1, const TQString &_url2)
 
bool urlcmp (const TQString &_url1, const TQString &_url2, bool _ignore_trailing, bool _ignore_ref)
 

Protected Member Functions

void parseQuery ()
 
- Protected Member Functions inherited from KURL
void reset ()
 
void parseURL (const TQString &_url, int encoding_hint=0)
 
void parseRawURI (const TQString &_url, int encoding_hint=0)
 
void parseMailto (const TQString &_url, int encoding_hint=0)
 
void parse (const TQString &_url, int encoding_hint=0)
 

Additional Inherited Members

- Static Public Member Functions inherited from KURL
static List split (const TQString &_url)
 
static List split (const KURL &_url)
 
static KURL join (const List &_list)
 
static KURL fromPathOrURL (const TQString &text)
 
static TQString encode_string (const TQString &str, int encoding_hint=0)
 
static TQString encode_string_no_slash (const TQString &str, int encoding_hint=0)
 
static TQString decode_string (const TQString &str, int encoding_hint=0)
 
static bool isRelativeURL (const TQString &_url)
 
static TQString relativeURL (const KURL &base_url, const KURL &url, int encoding_hint=0)
 
static TQString relativePath (const TQString &base_dir, const TQString &path, bool *isParent=0)
 
static URIMode uriModeForProtocol (const TQString &protocol)
 
- Public Attributes inherited from KURL
 NoAdjustements
 
 StripFileProtocol
 
 Auto
 
 Invalid
 
 RawURI
 
 URL
 
 Mailto
 
 CaseInsensitiveKeys
 

Detailed Description

LDAPUrl.

LDAPUrl 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]]]]]]

Definition at line 42 of file ldapurl.h.

Member Enumeration Documentation

◆ Scope

enum TDEABC::LDAPUrl::Scope

Definition at line 51 of file ldapurl.h.

Constructor & Destructor Documentation

◆ LDAPUrl() [1/2]

LDAPUrl::LDAPUrl ( )

Constructs an empty KLDAPUrl.

Definition at line 29 of file ldapurl.cpp.

◆ LDAPUrl() [2/2]

LDAPUrl::LDAPUrl ( const KURL &  url)

Constructs a KLDAPUrl from a KURL.

Definition at line 34 of file ldapurl.cpp.

Member Function Documentation

◆ attributes()

const TQStringList & TDEABC::LDAPUrl::attributes ( )
inline

Returns the attributes part of the LDAP Url.

Definition at line 67 of file ldapurl.h.

◆ dn()

const TQString & TDEABC::LDAPUrl::dn ( ) const
inline

Returns the dn part of the LDAP Url (same as path(), but slash removed from the beginning).

Definition at line 62 of file ldapurl.h.

◆ extension() [1/2]

LDAPUrl::Extension LDAPUrl::extension ( const TQString &  key) const

Returns the specified extension.

Definition at line 64 of file ldapurl.cpp.

◆ extension() [2/2]

TQString LDAPUrl::extension ( const TQString &  key,
bool &  critical 
) const

Returns the specified extension.

Definition at line 79 of file ldapurl.cpp.

◆ filter()

const TQString & TDEABC::LDAPUrl::filter ( ) const
inline

Returns the filter part of the LDAP Url.

Definition at line 78 of file ldapurl.h.

◆ hasExtension()

bool LDAPUrl::hasExtension ( const TQString &  key) const

Returns if the specified extension exists in the LDAP Url.

Definition at line 59 of file ldapurl.cpp.

◆ parseQuery()

void LDAPUrl::parseQuery ( )
protected

Definition at line 152 of file ldapurl.cpp.

◆ removeExtension()

void LDAPUrl::removeExtension ( const TQString &  key)

Removes the specified extension.

Definition at line 102 of file ldapurl.cpp.

◆ scope()

Scope TDEABC::LDAPUrl::scope ( ) const
inline

Returns the scope part of the LDAP Url.

Definition at line 73 of file ldapurl.h.

◆ setAttributes()

void TDEABC::LDAPUrl::setAttributes ( const TQStringList &  attributes)
inline

Sets the attributes part of the LDAP Url.

Definition at line 69 of file ldapurl.h.

◆ setDn()

void LDAPUrl::setDn ( const TQString &  dn)

Sets the the dn part of the LDAP Url.

Definition at line 47 of file ldapurl.cpp.

◆ setExtension() [1/2]

void LDAPUrl::setExtension ( const TQString &  key,
const Extension &  ext 
)

Sets the specified extension key with the value and criticality in ext.

Definition at line 88 of file ldapurl.cpp.

◆ setExtension() [2/2]

void LDAPUrl::setExtension ( const TQString &  key,
const TQString &  value,
bool  critical = false 
)

Sets the specified extension key with the value and criticality specified.

Definition at line 94 of file ldapurl.cpp.

◆ setFilter()

void TDEABC::LDAPUrl::setFilter ( TQString  filter)
inline

Sets the filter part of the LDAP Url.

Definition at line 80 of file ldapurl.h.

◆ setScope()

void TDEABC::LDAPUrl::setScope ( Scope  scope)
inline

Sets the scope part of the LDAP Url.

Definition at line 75 of file ldapurl.h.

◆ updateQuery()

void LDAPUrl::updateQuery ( )

Updates the query component from the attributes, scope, filter and extensions.

Definition at line 108 of file ldapurl.cpp.


The documentation for this class was generated from the following files:
  • ldapurl.h
  • ldapurl.cpp

tdeabc

Skip menu "tdeabc"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeabc

Skip menu "tdeabc"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeabc by doxygen 1.9.4
This website is maintained by Timothy Pearson.