Files
RedBear-OS/local/recipes/kde/kf6-kxmlgui/source/src/kmainwindowiface_p.h
T
2026-04-14 10:51:06 +01:00

107 lines
3.0 KiB
C++

/*
This file is part of the KDE project
SPDX-FileCopyrightText: 2001 Ian Reinhart Geiser <geiseri@yahoo.com>
SPDX-FileCopyrightText: 2006 Thiago Macieira <thiago@kde.org>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KMAINWINDOWIFACE_P_H
#define KMAINWINDOWIFACE_P_H
#include <QDBusAbstractAdaptor>
class KXmlGuiWindow;
/**
* @short D-Bus interface to KMainWindow.
*
* This is the main interface to the KMainWindow. This will provide a consistent
* D-Bus interface to all KDE applications that use it.
*
* @author Ian Reinhart Geiser <geiseri@yahoo.com>
*/
class KMainWindowInterface : public QDBusAbstractAdaptor
{
Q_OBJECT
Q_CLASSINFO("D-Bus Interface", "org.kde.KMainWindow")
public:
/**
Construct a new interface object.
@param mainWindow - The parent KMainWindow object
that will provide us with the QAction objects.
*/
explicit KMainWindowInterface(KXmlGuiWindow *mainWindow);
/**
Destructor
Cleans up the dcop action proxy object.
**/
~KMainWindowInterface() override;
public Q_SLOTS:
/**
Return a list of actions available to the application's window.
@return A QStringList containing valid names actions.
*/
QStringList actions();
/**
Activates the requested action.
@param action The name of the action to activate. The names of valid
actions can be found by calling actions().
@return The success of the operation.
*/
bool activateAction(const QString &action);
/**
Disables the requested action.
@param action The name of the action to disable. The names of valid
actions can be found by calling actions().
@return The success of the operation.
*/
bool disableAction(const QString &action);
/**
Enables the requested action.
@param action The name of the action to enable. The names of valid
actions can be found by calling actions().
@return The success of the operation.
*/
bool enableAction(const QString &action);
/**
Returns the status of the requested action.
@param action The name of the action. The names of valid
actions can be found by calling actions().
@returns The state of the action, true - enabled, false - disabled.
*/
bool actionIsEnabled(const QString &action);
/**
Returns the tool tip text of the requested action.
@param action The name of the action to activate. The names of valid
actions can be found by calling actions().
@return A QString containing the text of the action's tool tip.
*/
QString actionToolTip(const QString &action);
/**
Returns the ID of the current main window.
This is useful for automated screen captures or other evil
widget fun.
@return A integer value of the main window's ID.
**/
qlonglong winId();
/**
Copies a pixmap representation of the current main window to
the clipboard.
**/
void grabWindowToClipBoard();
private:
KXmlGuiWindow *m_MainWindow;
};
#endif // KMAINWINDOWIFACE_P_H