KWindowConfig

KWindowConfig Namespace Reference

Functions

KCONFIGGUI_EXPORT void restoreWindowPosition (QWindow *window, 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

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

Restores the window's position 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.
configThe config group to read from.
Since
5.74

Definition at line 98 of file kwindowconfig.cpp.

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
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 49 of file kwindowconfig.cpp.

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 76 of file kwindowconfig.cpp.

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 17 of file kwindowconfig.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Aug 12 2020 22:48:17 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.