KLDAPWidgets::LdapConfigWidget Class

LDAP Configuration widget inmodule LdapWidgets. More...

Header: #include <KLDAPWidgets/LdapConfigWidget>
CMake: find_package(KPim6LdapWidgets REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::LdapWidgets)

Public Functions

LdapConfigWidget(QWidget *parent = nullptr, Qt::WindowFlags fl = {})
LdapConfigWidget(KLDAPWidgets::LdapConfigWidget::WinFlags flags, QWidget *parent = nullptr, Qt::WindowFlags fl = {})
virtual ~LdapConfigWidget() override
KLDAPWidgets::LdapConfigWidget::Auth auth() const
QString bindDn() const
KLDAPCore::LdapDN dn() const
KLDAPWidgets::LdapConfigWidget::WinFlags features() const
QString filter() const
QString host() const
QString mech() const
int pageSize() const
QString password() const
int port() const
QString realm() const
KLDAPWidgets::LdapConfigWidget::Security security() const
KLDAPCore::LdapServer server() const
void setAuth(KLDAPWidgets::LdapConfigWidget::Auth auth)
void setBindDn(const QString &binddn)
void setDn(const KLDAPCore::LdapDN &dn)
void setFeatures(KLDAPWidgets::LdapConfigWidget::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(KLDAPWidgets::LdapConfigWidget::Security security)
void setServer(const KLDAPCore::LdapServer &server)
void setSizeLimit(int sizelimit)
void setTimeLimit(int timelimit)
void setUrl(const KLDAPCore::LdapUrl &url)
void setUser(const QString &user)
void setVersion(int version)
int sizeLimit() const
int timeLimit() const
KLDAPCore::LdapUrl url() const
QString user() const
int version() const

Signals

void hostNameChanged(const QString &)

Detailed Description

This class can be used to query the user for LDAP connection parameters. It's KConfigXT compatible, using widget names starting with kcfg_

Member Function Documentation

[explicit] LdapConfigWidget::LdapConfigWidget(QWidget *parent = nullptr, Qt::WindowFlags fl = {})

Constructs an empty configuration widget. You need to call setFeatures() after this. parent the parent widget fl the window flags to set

[explicit] LdapConfigWidget::LdapConfigWidget(KLDAPWidgets::LdapConfigWidget::WinFlags flags, QWidget *parent = nullptr, Qt::WindowFlags fl = {})

Constructs a configuration widget with the specified features. flags the configuration window flags parent the parent widget fl the window flags to set

[override virtual noexcept] LdapConfigWidget::~LdapConfigWidget()

Destroys the configuration widget.

KLDAPWidgets::LdapConfigWidget::Auth LdapConfigWidget::auth() const

Returns the authentication type. KConfig widget names: kcfg_ldapanon, kcfg_ldapsimple, kcfg_ldapsasl

See also setAuth().

QString LdapConfigWidget::bindDn() const

Returns the bind DN. KConfig widget name: kcfg_ldapbinddn

See also setBindDn().

KLDAPCore::LdapDN LdapConfigWidget::dn() const

Returns the LDAP Base DN. KConfig widget name: kcfg_ldapdn

See also setDn().

KLDAPWidgets::LdapConfigWidget::WinFlags LdapConfigWidget::features() const

Returns the features flags.

See also setFeatures().

QString LdapConfigWidget::filter() const

Returns the LDAP Filter. KConfig widget name: kcfg_ldapfilter

See also setFilter().

QString LdapConfigWidget::host() const

Returns the host name. KConfig widget name: kcfg_ldaphost

See also setHost().

[signal] void LdapConfigWidget::hostNameChanged(const QString &)

Emitted when the host name has changed. hostName the new host name

QString LdapConfigWidget::mech() const

Returns the SASL Mechanism. KConfig widget name: kcfg_ldapsaslmech

See also setMech().

int LdapConfigWidget::pageSize() const

Returns the page size. KConfig widget name: kcfg_ldappagesize

See also setPageSize().

QString LdapConfigWidget::password() const

Returns the password. KConfig widget name: kcfg_ldappassword

See also setPassword().

int LdapConfigWidget::port() const

Returns the LDAP port. KConfig widget name: kcfg_ldapport

See also setPort().

QString LdapConfigWidget::realm() const

Returns the SASL realm. KConfig widget name: kcfg_ldaprealm

See also setRealm().

KLDAPWidgets::LdapConfigWidget::Security LdapConfigWidget::security() const

Returns the security type. KConfig widget names: kcfg_ldapnosec, kcfg_ldaptls, kcfg_ldapssl

See also setSecurity().

KLDAPCore::LdapServer LdapConfigWidget::server() const

Returns an LdapServer object constructed from the settings given.

See also setServer().

void LdapConfigWidget::setAuth(KLDAPWidgets::LdapConfigWidget::Auth auth)

Sets the authentication type (Anonymous, Simple, SASL). KConfig widget names: kcfg_ldapanon, kcfg_ldapsimple, kcfg_ldapsasl auth the authentication type to set

See also auth().

void LdapConfigWidget::setBindDn(const QString &binddn)

Sets the bind DN. KConfig widget name: kcfg_ldapbinddn binddn the LDAP Bind DN to set

See also bindDn().

void LdapConfigWidget::setDn(const KLDAPCore::LdapDN &dn)

Sets the LDAP Base DN. KConfig widget name: kcfg_ldapdn dn the LDAP Base DN to set

See also dn().

void LdapConfigWidget::setFeatures(KLDAPWidgets::LdapConfigWidget::WinFlags features)

Sets the features flags. features the features to set

See also features().

void LdapConfigWidget::setFilter(const QString &filter)

Sets the LDAP Filter. KConfig widget name: kcfg_ldapfilter filter the LDAP Filter to set

See also filter().

void LdapConfigWidget::setHost(const QString &host)

Sets the host name. KConfig widget name: kcfg_ldaphost host the LDAP host to set

See also host().

void LdapConfigWidget::setMech(const QString &mech)

Sets the SASL Mechanism. KConfig widget name: kcfg_ldapsaslmech mech the SASL Mechanism to set

See also mech().

void LdapConfigWidget::setPageSize(int pagesize)

Sets the page size. KConfig widget name: kcfg_ldappagesize pagesize the page size to set

See also pageSize().

void LdapConfigWidget::setPassword(const QString &password)

Sets the password. KConfig widget name: kcfg_ldappassword password the password to set

See also password().

void LdapConfigWidget::setPort(int port)

Sets the LDAP port. KConfig widget name: kcfg_ldapport port the LDAP port to set

See also port().

void LdapConfigWidget::setRealm(const QString &realm)

Sets the SASL realm. KConfig widget name: kcfg_ldaprealm realm the SASL realm to set

See also realm().

void LdapConfigWidget::setSecurity(KLDAPWidgets::LdapConfigWidget::Security security)

Sets the security type (None, SSL, TLS). KConfig widget names: kcfg_ldapnosec, kcfg_ldaptls, kcfg_ldapssl security the security type to set

See also security().

void LdapConfigWidget::setServer(const KLDAPCore::LdapServer &server)

Sets up the widget via an LdapServer object. server the LdapServer object to set

See also server().

void LdapConfigWidget::setSizeLimit(int sizelimit)

Sets the size limit. KConfig widget name: kcfg_ldapsizelimit sizelimit the size limit to set

See also sizeLimit().

void LdapConfigWidget::setTimeLimit(int timelimit)

Sets the time limit. KConfig widget name: kcfg_ldaptimelimit timelimit the time limit to set

See also timeLimit().

void LdapConfigWidget::setUrl(const KLDAPCore::LdapUrl &url)

Sets up the widget via an LDAP URL. url the LDAP URL to set

See also url().

void LdapConfigWidget::setUser(const QString &user)

Sets the user name. KConfig widget name: kcfg_ldapuser user the user name to set

See also user().

void LdapConfigWidget::setVersion(int version)

Sets the LDAP protocol version. KConfig widget name: kcfg_ldapver version the LDAP protocol version to set

See also version().

int LdapConfigWidget::sizeLimit() const

Returns the size limit. KConfig widget name: kcfg_ldapsizelimit

See also setSizeLimit().

int LdapConfigWidget::timeLimit() const

Returns the time limit. KConfig widget name: kcfg_ldaptimelimit

See also setTimeLimit().

KLDAPCore::LdapUrl LdapConfigWidget::url() const

Returns an LDAP URL constructed from the settings given. Extensions are filled for use in the LDAP KIO worker.

See also setUrl().

QString LdapConfigWidget::user() const

Returns the user name. KConfig widget name: kcfg_ldapuser

See also setUser().

int LdapConfigWidget::version() const

Returns the LDAP protocol version. KConfig widget name: kcfg_ldapver

See also setVersion().