KWindowConfig

KWindowConfig Namespace Reference

Functions

KCONFIGGUI_EXPORT bool hasSavedWindowPosition (KConfigGroup &config)
 
KCONFIGGUI_EXPORT bool hasSavedWindowSize (KConfigGroup &config)
 
KCONFIGGUI_EXPORT void restoreWindowPosition (QWindow *window, const KConfigGroup &config)
 
KCONFIGGUI_EXPORT void restoreWindowScreenPosition (QWindow *window, const QScreen *screen, const KConfigGroup &config)
 
KCONFIGGUI_EXPORT void restoreWindowSize (QWindow *window, const KConfigGroup &config)
 
KCONFIGGUI_EXPORT void saveWindowPosition (const QWindow *window, KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal)
 
KCONFIGGUI_EXPORT void saveWindowSize (const QWindow *window, KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal)
 

Detailed Description

Save and load window sizes into a config.

Function Documentation

◆ hasSavedWindowPosition()

bool KWindowConfig::hasSavedWindowPosition ( KConfigGroup & config)

Returns whether a given KConfig group has any saved window position data.

Note
: always returns false on Wayland where saving and restoring window position data is not supported.
Parameters
configThe config group to read from.
Since
6.0

Definition at line 186 of file kwindowconfig.cpp.

◆ hasSavedWindowSize()

bool KWindowConfig::hasSavedWindowSize ( KConfigGroup & config)

Returns whether a given KConfig group has any saved window size data.

Parameters
configThe config group to read from.
Since
6.0

Definition at line 132 of file kwindowconfig.cpp.

◆ restoreWindowPosition()

void KWindowConfig::restoreWindowPosition ( QWindow * window,
const KConfigGroup & config )

Restores the window's screen position from the configuration and calls restoreWindowScreenPosition.

This function has no effect on Wayland, where the compositor is responsible for window positioning.

Note
the group must be set before calling
Parameters
windowThe window whose position to restore.
configThe config group to read from.
Since
5.74

Definition at line 197 of file kwindowconfig.cpp.

◆ restoreWindowScreenPosition()

void KWindowConfig::restoreWindowScreenPosition ( QWindow * window,
const QScreen * screen,
const KConfigGroup & config )

Restores the window's position on provided screen from the configuration.

This function has no effect on Wayland, where the compositor is responsible for window positioning.

Note
the group must be set before calling
Parameters
windowThe window whose position to restore.
screenScreen on which window should be placed.
configThe config group to read from.
Since
5.99

Definition at line 225 of file kwindowconfig.cpp.

◆ restoreWindowSize()

void KWindowConfig::restoreWindowSize ( QWindow * window,
const KConfigGroup & config )

Restores the dialog's size from the configuration according to the screen size.

If you're calling this from a constructor (for a mainwindow or dialog, for instance) you should first call winId() so that a QWindow is created, then you can call windowHandle() to pass to this method.

Example code:

create(); // ensure there's a window created
const QSize availableSize = windowHandle()->screen()->availableSize();
windowHandle()->resize(availableSize.width() * 0.7, availableSize.height() * 0.5); // default size
KWindowConfig::restoreWindowSize(windowHandle(), KSharedConfig::openConfig()->group("MyDialog"));
resize(windowHandle()->size()); // workaround for QTBUG-40584
static KSharedConfig::Ptr openConfig(const QString &fileName=QString(), OpenFlags mode=FullConfig, QStandardPaths::StandardLocation type=QStandardPaths::GenericConfigLocation)
Creates a KSharedConfig object to manipulate a configuration file.
KCONFIGGUI_EXPORT void restoreWindowSize(QWindow *window, const KConfigGroup &config)
Restores the dialog's size from the configuration according to the screen size.
int height() const const
int width() const const
Note
the group must be set before calling
Parameters
windowThe window to restore size.
configThe config group to read from.
Since
5.0.

Definition at line 137 of file kwindowconfig.cpp.

◆ saveWindowPosition()

void KWindowConfig::saveWindowPosition ( const QWindow * window,
KConfigGroup & config,
KConfigGroup::WriteConfigFlags options = KConfigGroup::Normal )

Saves the window's position either to the global or application config file.

This function has no effect on Wayland, where the compositor is responsible for window positioning.

Note
the group must be set before calling
Parameters
windowThe window whose position to save.
configThe config group to read from.
optionspassed to KConfigGroup::writeEntry()
Since
5.74

Definition at line 167 of file kwindowconfig.cpp.

◆ saveWindowSize()

void KWindowConfig::saveWindowSize ( const QWindow * window,
KConfigGroup & config,
KConfigGroup::WriteConfigFlags options = KConfigGroup::Normal )

Saves the window's size dependent on the screen dimension either to the global or application config file.

Note
the group must be set before calling
Parameters
windowThe window to save size.
configThe config group to read from.
optionspassed to KConfigGroup::writeEntry()
Since
5.0

Definition at line 101 of file kwindowconfig.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 14 2024 11:57:17 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.