KConfigGui

KConfigGui Namespace Reference

Functions

KCONFIGGUI_EXPORT bool hasSessionConfig ()
 
KCONFIGGUI_EXPORT KConfigsessionConfig ()
 
KCONFIGGUI_EXPORT QString sessionConfigName ()
 
KCONFIGGUI_EXPORT void setSessionConfig (const QString &id, const QString &key)
 

Detailed Description

Interface-related functions.

Function Documentation

◆ hasSessionConfig()

bool KConfigGui::hasSessionConfig ( )

Indicates if a session config has been created for that application (i.e. if sessionConfig() got called at least once)

Returns
true if a sessionConfig object was created, false otherwise

Definition at line 48 of file kconfiggui.cpp.

◆ sessionConfig()

KConfig * KConfigGui::sessionConfig ( )

Returns the current application session config object.

Note
If Qt is built without session manager support, i.e. QT_NO_SESSIONMANAGER is defined, this by default will return nullptr, unless a custom config has been set via setSessionConfig.
Returns
A pointer to the application's instance specific KConfig object.
See also
KConfig

Definition at line 22 of file kconfiggui.cpp.

◆ sessionConfigName()

QString KConfigGui::sessionConfigName ( )

Returns the name of the application session.

Returns
the application session name
Deprecated:
since 5.11, use sessionConfig()->name()

Definition at line 54 of file kconfiggui.cpp.

◆ setSessionConfig()

void KConfigGui::setSessionConfig ( const QString id,
const QString key 
)

Replaces the current application session config object.

Parameters
idnew session id
keynew session key
Since
5.11

Definition at line 37 of file kconfiggui.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Wed Jun 29 2022 04:12:40 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.