---

KMainWindowInterface Class Reference

DCOP interface to KMainWindow. More...

#include <kmainwindowiface.h>

Inheritance diagram for KMainWindowInterface:

List of all members.

DCOP Methods
QCStringList	actions ()
bool	activateAction (QCString action)
bool	disableAction (QCString action)
bool	enableAction (QCString action)
bool	actionIsEnabled (QCString action)
QCString	actionToolTip (QCString action)
DCOPRef	action (const QCString &name)
QMap< QCString, DCOPRef >	actionMap ()
int	getWinID ()
void	grabWindowToClipBoard ()
Public Methods
	KMainWindowInterface (KMainWindow *mainWindow)
	~KMainWindowInterface ()
QCStringList	functionsDynamic ()
bool	processDynamic (const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData)

---

Detailed Description

DCOP interface to KMainWindow.

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

Author:

Ian Reinhart Geiser <geiseri@yahoo.com>

Definition at line 40 of file kmainwindowiface.h.

---

Constructor & Destructor Documentation

KMainWindowInterface::KMainWindowInterface (  KMainWindow *    mainWindow )

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.

---

Member Function Documentation

DCOPRef KMainWindowInterface::action (  const QCString &    name )

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.

bool KMainWindowInterface::actionIsEnabled (  QCString    action )

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.

QMap<QCString,DCOPRef> KMainWindowInterface::actionMap (    )

Returns and action map

QCStringList KMainWindowInterface::actions (    )

Return a list of actions available to the application's window. Returns: A QCStringList containing valid names actions.

QCString KMainWindowInterface::actionToolTip (  QCString    action )

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.

bool KMainWindowInterface::activateAction (  QCString    action )

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 KMainWindowInterface::disableAction (  QCString    action )

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 KMainWindowInterface::enableAction (  QCString    action )

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.

QCStringList KMainWindowInterface::functionsDynamic (    )  [virtual]

This function is of interest when you used an IDL compiler to generate the implementation for functions() but you still want to list some functions dynamically. Dynamically means that the methods may appear and vanish during runtime. Returns: A list of the additional functions, default is an empty list. See also: functions(), Reimplemented from DCOPObject.

int KMainWindowInterface::getWinID (    )

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 KMainWindowInterface::grabWindowToClipBoard (    )

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

bool KMainWindowInterface::processDynamic (  const QCString &    fun, const QByteArray &    data, QCString &    replyType, QByteArray &    replyData )  [virtual]

This function is of interest when you used an IDL compiler to generate the implementation for process() but you still want to dispatch some functions dynamically. Dynamically means that methods may appear and vanish during runtime. Parameters: fun  is the normalized function signature. Such a signature usually looks like foobar(QString,int). The return type, qualifiers like "const" etc. are not part of the signature. data  the received data replyType  write the reply type in this string replyData  write the reply data in this array Returns: true if successful, false otherwise. The default implementation returns always false. See also: process() , DCOPClient::normalizeFunctionSignature() , functions(), , DCOPClient::process() Reimplemented from DCOPObject.

---

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

• kmainwindowiface.h

---