kdeui/xmlgui/kmainwindowiface_p.h

   1 /* This file is part of the KDE project
   2    Copyright (C) 2001 Ian Reinhart Geiser <geiseri@yahoo.com>
   3    Copyright (C) 2006 Thiago Macieira <thiago@kde.org>
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Library General Public
   7    License as published by the Free Software Foundation; either
   8    version 2 of the License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13     General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public License
  16    along with this program; see the file COPYING.  If not, write to
  17    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18    Boston, MA 02110-1301, USA.
  19 */
  20
  21 #ifndef KMAINWINDOWIFACE_P_H
  22 #define KMAINWINDOWIFACE_P_H
  23
  24 #include <kdeui_export.h>
  25 #include <QtDBus/QtDBus>
  26 #include <QtCore/QMap>
  27
  28 class KXmlGuiWindow;
  29
  30 /**
  31  * @short D-Bus interface to KMainWindow.
  32  *
  33  * This is the main interface to the KMainWindow.  This will provide a consistent
  34  * D-Bus interface to all KDE applications that use it.
  35  *
  36  * @author Ian Reinhart Geiser <geiseri@yahoo.com>
  37  */
  38 class KMainWindowInterface : public QDBusAbstractAdaptor
  39 {
  40         Q_OBJECT
  41         Q_CLASSINFO("D-Bus Interface", "org.kde.KMainWindow")
  42
  43 public:
  44         /**
  45         Construct a new interface object.
  46         @param mainWindow - The parent KMainWindow object
  47         that will provide us with the KAction objects.
  48         */
  49         KMainWindowInterface( KXmlGuiWindow * mainWindow );
  50         /**
  51         Destructor
  52         Cleans up the dcop action proxy object.
  53         **/
  54         ~KMainWindowInterface();
  55
  56 public Q_SLOTS:
  57         /**
  58         Return a list of actions available to the application's window.
  59         @return A QStringList containing valid names actions.
  60         */
  61         QStringList actions();
  62
  63         /**
  64         Activates the requested action.
  65         @param action The name of the action to activate.  The names of valid
  66         actions can be found by calling actions().
  67         @return The success of the operation.
  68         */
  69         bool activateAction( const QString& action);
  70
  71         /**
  72         Disables the requested action.
  73         @param action The name of the action to disable.  The names of valid
  74         actions can be found by calling actions().
  75         @return The success of the operation.
  76         */
  77         bool disableAction( const QString& action);
  78
  79         /**
  80         Enables the requested action.
  81         @param action The name of the action to enable.  The names of valid
  82         actions can be found by calling actions().
  83         @return The success of the operation.
  84         */
  85         bool enableAction( const QString& action);
  86
  87         /**
  88         Returns the status of the requested action.
  89         @param action The name of the action.  The names of valid
  90         actions can be found by calling actions().
  91         @returns The state of the action, true - enabled, false - disabled.
  92         */
  93         bool actionIsEnabled( const QString& action);
  94
  95         /**
  96         Returns the tool tip text of the requested action.
  97         @param action The name of the action to activate.  The names of valid
  98         actions can be found by calling actions().
  99         @return A QString containing the text of the action's tool tip.
 100         */
 101         QString actionToolTip( const QString& action);
 102
 103         /**
 104         Returns the ID of the current main window.
 105         This is useful for automated screen captures or other evil
 106         widget fun.
 107         @return A integer value of the main window's ID.
 108         **/
 109         qlonglong winId();
 110         /**
 111         Copies a pixmap representation of the current main window to
 112         the clipboard.
 113         **/
 114         void grabWindowToClipBoard();
 115 private:
 116         KXmlGuiWindow *m_MainWindow;
 117 };
 118
 119 #endif // KMAINWINDOWIFACE_P_H
 120
 121