KLDAP Library
#include <ldapconfigwidget.h>
Inherits QWidget.
Signals | |
void | hostNameChanged (const QString &) |
Public Member Functions | |
LdapConfigWidget (QWidget *parent=0, Qt::WindowFlags fl=0) | |
LdapConfigWidget (WinFlags flags, QWidget *parent=0, Qt::WindowFlags fl=0) | |
virtual | ~LdapConfigWidget () |
Auth | auth () const |
QString | bindDn () const |
LdapDN | dn () const |
WinFlags | features () const |
QString | filter () const |
QString | host () const |
QString | mech () const |
int | pageSize () const |
QString | password () const |
int | port () const |
QString | realm () const |
Security | security () const |
LdapServer | server () const |
void | setAuth (Auth auth) |
void | setBindDn (const QString &binddn) |
void | setDn (const LdapDN &dn) |
void | setFeatures (WinFlags features) |
void | setFilter (const QString &filter) |
void | setHost (const QString &host) |
void | setMech (const QString &mech) |
void | setPageSize (int pagesize) |
void | setPassword (const QString &password) |
void | setPort (int port) |
void | setRealm (const QString &realm) |
void | setSecurity (Security security) |
void | setServer (const LdapServer &server) |
void | setSizeLimit (int sizelimit) |
void | setTimeLimit (int timelimit) |
void | setUrl (const LdapUrl &url) |
void | setUser (const QString &user) |
void | setVersion (int version) |
int | sizeLimit () const |
int | timeLimit () const |
LdapUrl | url () const |
QString | user () const |
int | version () const |
Properties | |
Auth | auth |
QString | bindDn |
LdapDN | dn |
WinFlags | features |
QString | filter |
QString | host |
QString | mech |
int | pageSize |
QString | password |
int | port |
QString | realm |
Security | security |
int | sizeLimit |
int | timeLimit |
QString | user |
int | version |
Detailed Description
LDAP Configuration widget.
This class can be used to query the user for LDAP connection parameters. It's KConfigXT compatible, using widget names starting with kcfg_
Definition at line 44 of file ldapconfigwidget.h.
Member Enumeration Documentation
◆ Auth
enum KLDAP::LdapConfigWidget::Auth |
Definition at line 90 of file ldapconfigwidget.h.
◆ Security
enum KLDAP::LdapConfigWidget::Security |
Definition at line 87 of file ldapconfigwidget.h.
◆ WinFlag
enum KLDAP::LdapConfigWidget::WinFlag |
Definition at line 69 of file ldapconfigwidget.h.
Constructor & Destructor Documentation
◆ LdapConfigWidget() [1/2]
|
explicit |
Constructs an empty configuration widget.
You need to call setFlags() after this.
- Parameters
-
parent the QWidget parent fl the window flags to set
Definition at line 506 of file ldapconfigwidget.cpp.
◆ LdapConfigWidget() [2/2]
|
explicit |
Constructs a configuration widget.
◆ ~LdapConfigWidget()
|
virtual |
Destructs a configuration widget.
Definition at line 520 of file ldapconfigwidget.cpp.
Member Function Documentation
◆ auth()
LdapConfigWidget::Auth LdapConfigWidget::auth | ( | ) | const |
Returns the authentication type.
Kconfig widget names: kcfg_ldapanon, kcfg_ldapsimple, kcfg_ldapsasl
- Parameters
-
auth the authentication type to set
Definition at line 822 of file ldapconfigwidget.cpp.
◆ bindDn()
QString LdapConfigWidget::bindDn | ( | ) | const |
Gets the bind dn.
Kconfig widget name: kcfg_ldapbinddn
Definition at line 679 of file ldapconfigwidget.cpp.
◆ dn()
LdapDN LdapConfigWidget::dn | ( | ) | const |
Gets the LDAP Base DN.
Kconfig widget name: kcfg_ldapdn
Definition at line 739 of file ldapconfigwidget.cpp.
◆ features()
LdapConfigWidget::WinFlags LdapConfigWidget::features | ( | ) | const |
Definition at line 869 of file ldapconfigwidget.cpp.
◆ filter()
QString LdapConfigWidget::filter | ( | ) | const |
Gets the LDAP Filter.
Kconfig widget name: kcfg_ldapfilter
Definition at line 751 of file ldapconfigwidget.cpp.
◆ host()
QString LdapConfigWidget::host | ( | ) | const |
Gets the host name.
Kconfig widget name: kcfg_ldaphost
Definition at line 703 of file ldapconfigwidget.cpp.
◆ hostNameChanged
|
signal |
- Since
- 4.13
◆ mech()
QString LdapConfigWidget::mech | ( | ) | const |
Gets the SASL Mechanism.
Kconfig widget name: kcfg_ldapsaslmech
Definition at line 776 of file ldapconfigwidget.cpp.
◆ pageSize()
int LdapConfigWidget::pageSize | ( | ) | const |
Returns the page size.
KConfig widget name: kcfg_ldappagesize
Definition at line 864 of file ldapconfigwidget.cpp.
◆ password()
QString LdapConfigWidget::password | ( | ) | const |
Gets the password.
Kconfig widget name: kcfg_ldappassword
Definition at line 667 of file ldapconfigwidget.cpp.
◆ port()
int LdapConfigWidget::port | ( | ) | const |
Gets the LDAP port.
Kconfig widget name: kcfg_ldapport
Definition at line 715 of file ldapconfigwidget.cpp.
◆ realm()
QString LdapConfigWidget::realm | ( | ) | const |
Gets the SASL realm.
Kconfig widget name: kcfg_ldaprealm
Definition at line 691 of file ldapconfigwidget.cpp.
◆ security()
LdapConfigWidget::Security LdapConfigWidget::security | ( | ) | const |
Returns the security type.
Kconfig widget names: kcfg_ldapnosec, kcfg_ldaptls, kcfg_ldapssl
- Parameters
-
security the security type to set
Definition at line 796 of file ldapconfigwidget.cpp.
◆ server()
LdapServer LdapConfigWidget::server | ( | ) | const |
Returns an LdapServer object constructed from the settings given.
Definition at line 537 of file ldapconfigwidget.cpp.
◆ setAuth()
void LdapConfigWidget::setAuth | ( | Auth | auth | ) |
Sets the authentication type (Anonymous, Simple, SASL).
Kconfig widget names: kcfg_ldapanon, kcfg_ldapsimple, kcfg_ldapsasl
- Parameters
-
auth the authentication type to set
Definition at line 807 of file ldapconfigwidget.cpp.
◆ setBindDn()
void LdapConfigWidget::setBindDn | ( | const QString & | binddn | ) |
Sets the bind dn.
Kconfig widget name: kcfg_ldapbinddn
- Parameters
-
binddn the LDAP Bind DN to set
Definition at line 672 of file ldapconfigwidget.cpp.
◆ setDn()
void LdapConfigWidget::setDn | ( | const LdapDN & | dn | ) |
Sets the LDAP Base DN.
Kconfig widget name: kcfg_ldapdn
- Parameters
-
dn the LDAP Base DN to set
Definition at line 732 of file ldapconfigwidget.cpp.
◆ setFeatures()
void LdapConfigWidget::setFeatures | ( | WinFlags | features | ) |
Definition at line 874 of file ldapconfigwidget.cpp.
◆ setFilter()
void LdapConfigWidget::setFilter | ( | const QString & | filter | ) |
Sets the LDAP Filter.
Kconfig widget name: kcfg_ldapfilter
- Parameters
-
filter the LDAP Filter to set
Definition at line 744 of file ldapconfigwidget.cpp.
◆ setHost()
void LdapConfigWidget::setHost | ( | const QString & | host | ) |
Sets the host name.
Kconfig widget name: kcfg_ldaphost
- Parameters
-
host the LDAP host to set
Definition at line 696 of file ldapconfigwidget.cpp.
◆ setMech()
void LdapConfigWidget::setMech | ( | const QString & | mech | ) |
Sets the SASL Mechanism.
Kconfig widget name: kcfg_ldapsaslmech
- Parameters
-
mech the SASL Mechanism to set
Definition at line 756 of file ldapconfigwidget.cpp.
◆ setPageSize()
void LdapConfigWidget::setPageSize | ( | int | pagesize | ) |
Sets the page size.
KConfig widget name: kcfg_ldappagesize
- Parameters
-
pagesize the page size to set
Definition at line 857 of file ldapconfigwidget.cpp.
◆ setPassword()
void LdapConfigWidget::setPassword | ( | const QString & | password | ) |
Sets the password.
Kconfig widget name: kcfg_ldappassword
- Parameters
-
password the password to set
Definition at line 660 of file ldapconfigwidget.cpp.
◆ setPort()
void LdapConfigWidget::setPort | ( | int | port | ) |
Sets the LDAP port.
Kconfig widget name: kcfg_ldapport
- Parameters
-
port the LDAP port to set
Definition at line 708 of file ldapconfigwidget.cpp.
◆ setRealm()
void LdapConfigWidget::setRealm | ( | const QString & | realm | ) |
Sets the SASL realm.
Kconfig widget name: kcfg_ldaprealm
- Parameters
-
realm the SASL realm to set
Definition at line 684 of file ldapconfigwidget.cpp.
◆ setSecurity()
void LdapConfigWidget::setSecurity | ( | Security | security | ) |
Sets the security type (None, SSL, TLS).
Kconfig widget names: kcfg_ldapnosec, kcfg_ldaptls, kcfg_ldapssl
- Parameters
-
security the security type to set
Definition at line 781 of file ldapconfigwidget.cpp.
◆ setServer()
void LdapConfigWidget::setServer | ( | const LdapServer & | server | ) |
Set up the widget via an LdapServer object.
- Parameters
-
server the LdapServer object to set
Definition at line 595 of file ldapconfigwidget.cpp.
◆ setSizeLimit()
void LdapConfigWidget::setSizeLimit | ( | int | sizelimit | ) |
Sets the size limit.
KConfig widget name: kcfg_ldapsizelimit
- Parameters
-
sizelimit the size limit to set
Definition at line 833 of file ldapconfigwidget.cpp.
◆ setTimeLimit()
void LdapConfigWidget::setTimeLimit | ( | int | timelimit | ) |
Sets the time limit.
KConfig widget name: kcfg_ldaptimelimit
- Parameters
-
timelimit the time limit to set
Definition at line 845 of file ldapconfigwidget.cpp.
◆ setUrl()
void LdapConfigWidget::setUrl | ( | const LdapUrl & | url | ) |
Set up the widget via an LDAP Url.
- Parameters
-
url the LDAP Url to set
Definition at line 530 of file ldapconfigwidget.cpp.
◆ setUser()
void LdapConfigWidget::setUser | ( | const QString & | user | ) |
Sets the user name.
Kconfig widget name: kcfg_ldapuser
- Parameters
-
user the user name to set
Definition at line 648 of file ldapconfigwidget.cpp.
◆ setVersion()
void LdapConfigWidget::setVersion | ( | int | version | ) |
Sets the LDAP protocol version.
Kconfig widget name: kcfg_ldapver
- Parameters
-
version the LDAP protocol version to set
Definition at line 720 of file ldapconfigwidget.cpp.
◆ sizeLimit()
int LdapConfigWidget::sizeLimit | ( | ) | const |
Returns the size limit.
KConfig widget name: kcfg_ldapsizelimit
Definition at line 840 of file ldapconfigwidget.cpp.
◆ timeLimit()
int LdapConfigWidget::timeLimit | ( | ) | const |
Returns the time limit.
KConfig widget name: kcfg_ldaptimelimit
Definition at line 852 of file ldapconfigwidget.cpp.
◆ url()
LdapUrl LdapConfigWidget::url | ( | ) | const |
Returns a LDAP Url constructed from the settings given.
Extensions are filled for use in the LDAP ioslave
Definition at line 525 of file ldapconfigwidget.cpp.
◆ user()
QString LdapConfigWidget::user | ( | ) | const |
Gets the user name.
Kconfig widget name: kcfg_ldapuser
Definition at line 655 of file ldapconfigwidget.cpp.
◆ version()
int LdapConfigWidget::version | ( | ) | const |
Gets the LDAP protocol version.
Kconfig widget name: kcfg_ldapver
Definition at line 727 of file ldapconfigwidget.cpp.
Property Documentation
◆ auth
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ bindDn
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ dn
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ features
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ filter
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ host
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ mech
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ pageSize
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ password
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ port
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ realm
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ security
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ sizeLimit
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ timeLimit
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ user
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
◆ version
|
readwrite |
Definition at line 1 of file ldapconfigwidget.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.