class KMainWindowInterface

# class KMainWindowInterface | DCOP interface to KMainWindow. More...
Definition | `#include <kmainwindowiface.h>`
Inherits | DCOPObject (dcop) [virtual public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KMainWindowInterface ( KMainWindow * mainWindow )
- ~KMainWindowInterface ()
- QCStringList functionsDynamic ()
- bool processDynamic (const QCString &fun, const QByteArray &data, QCString& replyType, QByteArray &replyData)

## Detailed Description

This is the main interface to the KMainWindow. This will provide a consistant dcop interface to all KDE applications that use it.

KMainWindowInterface ( KMainWindow * mainWindow ) | ### KMainWindowInterface

Construct a new interface object.

Parameters:

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

~KMainWindowInterface () | ### ~KMainWindowInterface

Destructor Cleans up the dcop action proxy object.

QCStringList functionsDynamic () | ### functionsDynamic

Reimplemented from DCOPObject.

bool processDynamic (const QCString &fun, const QByteArray &data, QCString& replyType, QByteArray &replyData) | ### processDynamic

Reimplemented from DCOPObject.

QCStringList actions () | ### actions

[k_dcop]

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

Returns: A QCStringList containing valid names actions.

bool activateAction ( QCString action) | ### activateAction

[k_dcop]

Activates the requested action.

Parameters:

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

Returns: The success of the operation.

bool disableAction ( QCString action) | ### disableAction

[k_dcop]

Disables the requested action.

Parameters:

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

Returns: The success of the operation.

bool enableAction ( QCString action) | ### enableAction

[k_dcop]

Enables the requested action.

Parameters:

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

Returns: The success of the operation.

bool actionIsEnabled ( QCString action) | ### actionIsEnabled

[k_dcop]

Returns the status of the requested action.

Parameters:

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

Returns: The state of the current Actions, TRUE - enabled, FALSE - disabled.

QCString actionToolTip ( QCString action) | ### actionToolTip

[k_dcop]

Returns the tool tip text of the requested action.

Parameters:

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

Returns: A QCString containing the text of the actions tool tip.

DCOPRef action ( const QCString &name ) | ### action

[k_dcop]

Returns a dcop reference to the selected KAction

Parameters:

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

Returns: A DCOPRef for the kaction.

QMap<QCString,DCOPRef> actionMap () | ### actionMap

[k_dcop]

Returns and action map

int getWinID () | ### getWinID

[k_dcop]

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.

void grabWindowToClipBoard () | ### grabWindowToClipBoard

[k_dcop]

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

- Author: Ian Reinhart Geiser
- Generated: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.