TDEMainWindowInterface Class Reference

DCOP interface to TDEMainWindow. More...

#include <tdemainwindowiface.h>

Inheritance diagram for TDEMainWindowInterface:

List of all members.

Public Member Functions
	TDEMainWindowInterface (TDEMainWindow *mainWindow)
	~TDEMainWindowInterface ()
QCStringList	functionsDynamic ()
bool	processDynamic (const TQCString &fun, const TQByteArray &data, TQCString &replyType, TQByteArray &replyData)

---

Detailed Description

DCOP interface to TDEMainWindow.

This is the main interface to the TDEMainWindow. This will provide a consistent DCOP interface to all KDE applications that use it.

Author:

Ian Reinhart Geiser <geiseri@yahoo.com>

Definition at line 40 of file tdemainwindowiface.h.

---

Constructor & Destructor Documentation

TDEMainWindowInterface::TDEMainWindowInterface

(

TDEMainWindow *

mainWindow

)

Construct a new interface object.

Parameters:

mainWindow

- The parent TDEMainWindow object that will provide us with the TDEAction objects.

Definition at line 32 of file tdemainwindowiface.cpp.

TDEMainWindowInterface::~TDEMainWindowInterface

(

)

Destructor Cleans up the dcop action proxy object.

Definition at line 40 of file tdemainwindowiface.cpp.

---

Member Function Documentation

DCOPRef TDEMainWindowInterface::action

(

const TQCString &

name

)

Returns a dcop reference to the selected TDEAction.

Parameters:

name

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

Returns:

A DCOPRef for the tdeaction.

Definition at line 123 of file tdemainwindowiface.cpp.

bool TDEMainWindowInterface::actionIsEnabled

(

TQCString

action

)

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 98 of file tdemainwindowiface.cpp.

TQMap< TQCString, DCOPRef > TDEMainWindowInterface::actionMap

(

)

Returns and action map.

Definition at line 128 of file tdemainwindowiface.cpp.

QCStringList TDEMainWindowInterface::actions

(

)

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

Returns:

A QCStringList containing valid names actions.

Definition at line 46 of file tdemainwindowiface.cpp.

TQCString TDEMainWindowInterface::actionToolTip

(

TQCString

action

)

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 TQCString containing the text of the action's tool tip.

Definition at line 110 of file tdemainwindowiface.cpp.

bool TDEMainWindowInterface::activateAction

(

TQCString

action

)

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 59 of file tdemainwindowiface.cpp.

bool TDEMainWindowInterface::disableAction

(

TQCString

action

)

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 72 of file tdemainwindowiface.cpp.

bool TDEMainWindowInterface::enableAction

(

TQCString

action

)

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 85 of file tdemainwindowiface.cpp.

int TDEMainWindowInterface::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.

Definition at line 133 of file tdemainwindowiface.cpp.

void TDEMainWindowInterface::grabWindowToClipBoard

(

)

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

Definition at line 137 of file tdemainwindowiface.cpp.

---

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

• tdemainwindowiface.h
• tdemainwindowiface.cpp