KGuiAddons

kjobwindows.h
1/*
2 This file is part of the KDE libraries
3 SPDX-FileCopyrightText: 2013 David Faure <faure@kde.org>
4
5 SPDX-License-Identifier: LGPL-2.0-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
6*/
7
8#ifndef KJOBWINDOWS_H
9#define KJOBWINDOWS_H
10
11#include <kguiaddons_export.h>
12
13class QWindow;
14class QObject;
15
16/**
17 * KJobWindows namespace
18 */
19namespace KJobWindows
20{
21/**
22 * Associate this job with a window given by @p window.
23 *
24 * @param job should be a KJob subclass
25 *
26 * This is used:
27 * @li by KDialogJobUiDelegate as parent widget for error messages
28 * @li by KWidgetJobTracker as parent widget for progress dialogs
29 * @li by KIO::AbstractJobInteractionInterface as parent widget for rename/skip dialogs
30 * and possibly more.
31 * @li by KIO::DropJob as parent widget of popup menus.
32 * This is required on Wayland to properly position the menu.
33 *
34 * @since 6.0
35 */
36KGUIADDONS_EXPORT void setWindow(QObject *job, QWindow *window);
37
38/**
39 * Return the window associated with this job.
40 *
41 * @param job should be a KJob subclass
42 *
43 * @since 6.0
44 */
45KGUIADDONS_EXPORT QWindow *window(QObject *job);
46}
47
48#endif
KJobWindows namespace.
Definition kjobwindows.h:20
KGUIADDONS_EXPORT void setWindow(QObject *job, QWindow *window)
Associate this job with a window given by window.
KGUIADDONS_EXPORT QWindow * window(QObject *job)
Return the window associated with this job.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:59:55 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.