KMainWindowInterface Class Reference

D-Bus interface to KMainWindow. More...

#include <kmainwindowiface_p.h>

Inheritance diagram for KMainWindowInterface:

[legend]

List of all members.

Public Slots
bool	actionIsEnabled (const QString &action)
QStringList	actions ()
QString	actionToolTip (const QString &action)
bool	activateAction (const QString &action)
bool	disableAction (const QString &action)
bool	enableAction (const QString &action)
void	grabWindowToClipBoard ()
qlonglong	winId ()
Public Member Functions
	KMainWindowInterface (KXmlGuiWindow *mainWindow)
	~KMainWindowInterface ()

---

Detailed Description

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>

Definition at line 38 of file kmainwindowiface_p.h.

---

Constructor & Destructor Documentation

KMainWindowInterface::KMainWindowInterface

(

KXmlGuiWindow *

mainWindow

)

Construct a new interface object.

Parameters:

mainWindow

- The parent KMainWindow object that will provide us with the KAction objects.

Definition at line 30 of file kmainwindowiface.cpp.

KMainWindowInterface::~KMainWindowInterface

(

)

Destructor Cleans up the dcop action proxy object.

Definition at line 36 of file kmainwindowiface.cpp.

---

Member Function Documentation

bool KMainWindowInterface::actionIsEnabled

(

const QString &

action

)

[slot]

Returns the status of the requested action.

Parameters:

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.

Definition at line 87 of file kmainwindowiface.cpp.

QStringList KMainWindowInterface::actions

(

)

[slot]

Return a list of actions available to the application's window.

Returns:

A QStringList containing valid names actions.

Definition at line 40 of file kmainwindowiface.cpp.

QString KMainWindowInterface::actionToolTip

(

const QString &

action

)

[slot]

Returns the tool tip text of the requested action.

Parameters:

action

The name of the action to activate. The names of valid actions can be found by calling actions().

Returns:

A QString containing the text of the action's tool tip.

Definition at line 98 of file kmainwindowiface.cpp.

bool KMainWindowInterface::activateAction

(

const QString &

action

)

[slot]

Activates the requested action.

Parameters:

action

The name of the action to activate. The names of valid actions can be found by calling actions().

Returns:

The success of the operation.

Definition at line 51 of file kmainwindowiface.cpp.

bool KMainWindowInterface::disableAction

(

const QString &

action

)

[slot]

Disables the requested action.

Parameters:

action

The name of the action to disable. The names of valid actions can be found by calling actions().

Returns:

The success of the operation.

Definition at line 63 of file kmainwindowiface.cpp.

bool KMainWindowInterface::enableAction

(

const QString &

action

)

[slot]

Enables the requested action.

Parameters:

action

The name of the action to enable. The names of valid actions can be found by calling actions().

Returns:

The success of the operation.

Definition at line 75 of file kmainwindowiface.cpp.

void KMainWindowInterface::grabWindowToClipBoard

(

)

[slot]

Copies a pixmap representation of the current main window to the clipboard.

Definition at line 114 of file kmainwindowiface.cpp.

qlonglong KMainWindowInterface::winId

(

)

[slot]

Returns the ID of the current main window.

This is useful for automated screen captures or other evil widget fun.

Returns:

A integer value of the main window's ID.

Definition at line 109 of file kmainwindowiface.cpp.

---

The documentation for this class was generated from the following files:

• kmainwindowiface_p.h
• kmainwindowiface.cpp