diff options
Diffstat (limited to 'tdeui/kmainwindowiface.h')
| -rw-r--r-- | tdeui/kmainwindowiface.h | 161 |
1 files changed, 161 insertions, 0 deletions
diff --git a/tdeui/kmainwindowiface.h b/tdeui/kmainwindowiface.h new file mode 100644 index 000000000..f7f7a0bb8 --- /dev/null +++ b/tdeui/kmainwindowiface.h @@ -0,0 +1,161 @@ +/* This file is part of the KDE project + Copyright (C) 2001 Ian Reinhart Geiser <geiseri@yahoo.com> + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this program; see the file COPYING. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. +*/ + +#ifndef KWINDOW_INTERFACE_H +#define KWINDOW_INTERFACE_H + +#include <dcopobject.h> +#include <tqstringlist.h> +#include <tqcstring.h> +#include <dcopref.h> + +class KDCOPActionProxy; +class KDCOPPropertyProxy; +class KMainWindow; + +/** + * @short DCOP interface to KMainWindow. + * + * This is the main interface to the KMainWindow. This will provide a consistent + * DCOP interface to all KDE applications that use it. + * + * @author Ian Reinhart Geiser <geiseri@yahoo.com> + */ +class KDEUI_EXPORT KMainWindowInterface : virtual public DCOPObject +{ +K_DCOP + +public: + /** + Construct a new interface object. + @param mainWindow - The parent KMainWindow object + that will provide us with the KAction objects. + */ + KMainWindowInterface( KMainWindow * mainWindow ); + /** + Destructor + Cleans up the dcop action proxy object. + **/ + ~KMainWindowInterface(); + + QCStringList functionsDynamic(); + bool processDynamic(const TQCString &fun, const TQByteArray &data, TQCString& replyType, TQByteArray &replyData); + + +k_dcop: + /** + Return a list of actions available to the application's window. + @return A QCStringList containing valid names actions. + */ + QCStringList actions(); + + /** + Activates the requested action. + @param action The name of the action to activate. The names of valid + actions can be found by calling actions(). + @return The success of the operation. + */ + bool activateAction( TQCString action); + + /** + Disables the requested action. + @param action The name of the action to disable. The names of valid + actions can be found by calling actions(). + @return The success of the operation. + */ + bool disableAction( TQCString action); + + /** + Enables the requested action. + @param action The name of the action to enable. The names of valid + actions can be found by calling actions(). + @return The success of the operation. + */ + bool enableAction( TQCString action); + + /** + Returns the status of the requested action. + @param 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. + */ + bool actionIsEnabled( TQCString action); + + /** + Returns the tool tip text of the requested action. + @param action The name of the action to activate. The names of valid + actions can be found by calling actions(). + @return A TQCString containing the text of the action's tool tip. + */ + TQCString actionToolTip( TQCString action); + + /** + Returns a dcop reference to the selected KAction + @param name The name of the action. The names of valid + actions can be found by calling actions(). + @return A DCOPRef for the kaction. + **/ + DCOPRef action( const TQCString &name ); + + /** + Returns and action map + **/ + TQMap<TQCString,DCOPRef> actionMap(); + /** + Returns the ID of the current main window. + This is useful for automated screen captures or other evil + widget fun. + @return A integer value of the main window's ID. + **/ + int getWinID(); + /** + Copies a pixmap representation of the current main window to + the clipboard. + **/ + void grabWindowToClipBoard(); +// bool isHidden(); + void hide(); +// bool isMaximized(); + void maximize(); +// bool isMinimized(); + void minimize(); +// int width(); +// int height(); + void resize(int newWidth, int newHeight); +// int Xpos(); +// int Ypos(); + void move(int newX, int newY); + void setGeometry(int newX, int newY, int newWidth, int newHeight); + void raise(); + void lower(); + void restore(); + void show(); + void close(); + +// QCStringList getQTProperties(); + +private: + KMainWindow *m_MainWindow; + KDCOPActionProxy *m_dcopActionProxy; + KDCOPPropertyProxy *m_dcopPropertyProxy; +}; + +#endif + + |