.TH "KMainWindowInterface" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KMainWindowInterface \- This is the main interface to the \fBKMainWindow\fP. DCOP interface to \fBKMainWindow\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kmainwindowiface.h>\fP
.PP
Inherits \fBDCOPObject\fP.
.PP
.SS "DCOP Member Functions"

.in +1c
.ti -1c
.RI "QCStringList \fBactions\fP ()"
.br
.RI "\fIReturn a list of actions available to the application's window. \fP"
.ti -1c
.RI "bool \fBactivateAction\fP (\fBQCString\fP action)"
.br
.RI "\fIActivates the requested action. \fP"
.ti -1c
.RI "bool \fBdisableAction\fP (\fBQCString\fP action)"
.br
.RI "\fIDisables the requested action. \fP"
.ti -1c
.RI "bool \fBenableAction\fP (\fBQCString\fP action)"
.br
.RI "\fIEnables the requested action. \fP"
.ti -1c
.RI "bool \fBactionIsEnabled\fP (\fBQCString\fP action)"
.br
.RI "\fIReturns the status of the requested action. \fP"
.ti -1c
.RI "\fBQCString\fP \fBactionToolTip\fP (\fBQCString\fP action)"
.br
.RI "\fIReturns the tool tip text of the requested action. \fP"
.ti -1c
.RI "\fBDCOPRef\fP \fBaction\fP (const  \fBQCString\fP &name)"
.br
.RI "\fIReturns a dcop reference to the selected \fBKAction\fP. \fP"
.ti -1c
.RI "\fBQMap\fP< \fBQCString\fP, \fBDCOPRef\fP > \fBactionMap\fP ()"
.br
.RI "\fIReturns and action map. \fP"
.ti -1c
.RI "int \fBgetWinID\fP ()"
.br
.RI "\fIReturns the ID of the current main window. \fP"
.ti -1c
.RI "void \fBgrabWindowToClipBoard\fP ()"
.br
.RI "\fICopies a pixmap representation of the current main window to the clipboard. \fP"
.ti -1c
.RI "void \fBhide\fP ()"
.br
.ti -1c
.RI "void \fBmaximize\fP ()"
.br
.ti -1c
.RI "void \fBminimize\fP ()"
.br
.ti -1c
.RI "void \fBresize\fP (int newWidth, int newHeight)"
.br
.ti -1c
.RI "void \fBmove\fP (int newX, int newY)"
.br
.ti -1c
.RI "void \fBsetGeometry\fP (int newX, int newY, int newWidth, int newHeight)"
.br
.ti -1c
.RI "void \fBraise\fP ()"
.br
.ti -1c
.RI "void \fBlower\fP ()"
.br
.ti -1c
.RI "void \fBrestore\fP ()"
.br
.ti -1c
.RI "void \fBshow\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKMainWindowInterface\fP (\fBKMainWindow\fP *mainWindow)"
.br
.RI "\fIConstruct a new interface object. \fP"
.ti -1c
.RI "\fB~KMainWindowInterface\fP ()"
.br
.RI "\fIDestructor Cleans up the dcop action proxy object. \fP"
.ti -1c
.RI "QCStringList \fBfunctionsDynamic\fP ()"
.br
.ti -1c
.RI "bool \fBprocessDynamic\fP (const  \fBQCString\fP &fun, const  \fBQByteArray\fP &data, \fBQCString\fP &replyType, \fBQByteArray\fP &replyData)"
.br
.in -1c
.SH "Detailed Description"
.PP 
This is the main interface to the \fBKMainWindow\fP. DCOP interface to \fBKMainWindow\fP. 

This will provide a consistant dcop interface to all \fBKDE\fP applications that use it. 
.PP
\fBAuthor:\fP
.RS 4
Ian Reinhart Geiser <geiseri@yahoo.com> 
.RE
.PP

.PP
Definition at line 40 of file kmainwindowiface.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KMainWindowInterface::KMainWindowInterface (\fBKMainWindow\fP * mainWindow)"
.PP
Construct a new interface object. \fBParameters:\fP
.RS 4
\fImainWindow\fP - The parent \fBKMainWindow\fP object that will provide us with the \fBKAction\fP objects.
.RE
.PP
Definition at line 31 of file kmainwindowiface.cpp.
.PP
References KXMLGUIClient::actionCollection(), and KStdAccel::name().
.SS "KMainWindowInterface::~\fBKMainWindowInterface\fP ()"
.PP
Destructor Cleans up the dcop action proxy object. Definition at line 39 of file kmainwindowiface.cpp.
.SH "Member Function Documentation"
.PP 
.SS "QCStringList KMainWindowInterface::actions ()"
.PP
Return a list of actions available to the application's window. \fBReturns:\fP
.RS 4
A QCStringList containing valid names actions.
.RE
.PP
Definition at line 45 of file kmainwindowiface.cpp.
.SS "bool KMainWindowInterface::activateAction (\fBQCString\fP action)"
.PP
Activates the requested action. \fBParameters:\fP
.RS 4
\fIaction\fP The name of the action to activate. The names of valid can actions can be found by calling \fBactions\fP(). 
.RE
.PP
\fBReturns:\fP
.RS 4
The success of the operation.
.RE
.PP
Definition at line 58 of file kmainwindowiface.cpp.
.SS "bool KMainWindowInterface::disableAction (\fBQCString\fP action)"
.PP
Disables the requested action. \fBParameters:\fP
.RS 4
\fIaction\fP The name of the action to activate. The names of valid can actions can be found by calling \fBactions\fP(). 
.RE
.PP
\fBReturns:\fP
.RS 4
The success of the operation.
.RE
.PP
Definition at line 71 of file kmainwindowiface.cpp.
.SS "bool KMainWindowInterface::enableAction (\fBQCString\fP action)"
.PP
Enables the requested action. \fBParameters:\fP
.RS 4
\fIaction\fP The name of the action to activate. The names of valid can actions can be found by calling \fBactions\fP(). 
.RE
.PP
\fBReturns:\fP
.RS 4
The success of the operation.
.RE
.PP
Definition at line 84 of file kmainwindowiface.cpp.
.SS "bool KMainWindowInterface::actionIsEnabled (\fBQCString\fP action)"
.PP
Returns the status of the requested action. \fBParameters:\fP
.RS 4
\fIaction\fP The name of the action to activate. The names of valid can actions can be found by calling \fBactions\fP(). 
.RE
.PP
\fBReturns:\fP
.RS 4
The state of the current Actions, TRUE - enabled, FALSE - disabled.
.RE
.PP
Definition at line 97 of file kmainwindowiface.cpp.
.SS "\fBQCString\fP KMainWindowInterface::actionToolTip (\fBQCString\fP action)"
.PP
Returns the tool tip text of the requested action. \fBParameters:\fP
.RS 4
\fIaction\fP The name of the action to activate. The names of valid can actions can be found by calling \fBactions\fP(). 
.RE
.PP
\fBReturns:\fP
.RS 4
A \fBQCString\fP containing the text of the actions tool tip.
.RE
.PP
Definition at line 109 of file kmainwindowiface.cpp.
.SS "\fBDCOPRef\fP KMainWindowInterface::action (const \fBQCString\fP & name)"
.PP
Returns a dcop reference to the selected \fBKAction\fP. \fBParameters:\fP
.RS 4
\fIaction\fP The name of the action to activate, The names of valid actions can be found by calling (). 
.RE
.PP
\fBReturns:\fP
.RS 4
A \fBDCOPRef\fP for the kaction. 
.RE
.PP
Definition at line 122 of file kmainwindowiface.cpp.
.SS "\fBQMap\fP< \fBQCString\fP, \fBDCOPRef\fP > KMainWindowInterface::actionMap ()"
.PP
Returns and action map. Definition at line 127 of file kmainwindowiface.cpp.
.SS "int KMainWindowInterface::getWinID ()"
.PP
Returns the ID of the current main window. This is useful for automated screen captures or other evil widget fun. 
.PP
\fBReturns:\fP
.RS 4
A integer value of the main window's ID. 
.RE
.PP
Definition at line 132 of file kmainwindowiface.cpp.
.SS "void KMainWindowInterface::grabWindowToClipBoard ()"
.PP
Copies a pixmap representation of the current main window to the clipboard. Definition at line 136 of file kmainwindowiface.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
