workspace/khotkeys/libkhotkeysprivate/shortcuts_handler.h

   1 /*
   2    Copyright (C) 2008 Michael Jansen <kde@michael-jansen.biz>
   3
   4    This library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public
   6    License as published by the Free Software Foundation; either
   7    version 2 of the License, or (at your option) any later version.
   8
   9    This library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public License
  15    along with this library; see the file COPYING.LIB.  If not, write to
  16    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17    Boston, MA 02110-1301, USA.
  18 */
  19 #ifndef SHORTCUTACTIONS_H
  20 #define SHORTCUTACTIONS_H
  21
  22
  23 #include <KDE/KActionCollection>
  24
  25 #include <X11/X.h>
  26
  27
  28 class KAction;
  29 class KShortcut;
  30
  31 namespace KHotKeys {
  32
  33 /**
  34  * @author Michael Jansen <kde@michael-jansen.biz>
  35  */
  36 class ShortcutsHandler : public QObject
  37     {
  38     Q_OBJECT
  39
  40 public:
  41
  42     enum HandlerType {
  43         Active,             //!< Create real actions
  44         Configuration };    //!< Create configuration actions ( not active )
  45
  46     /**
  47      * Default constructor
  48      *
  49      * \param Should
  50      */
  51     ShortcutsHandler( HandlerType type = Active, QObject *parent = 0 );
  52
  53     /**
  54      * Destructor
  55      */
  56     ~ShortcutsHandler();
  57
  58     /**
  59      * Create a action.
  60      *
  61      * The action stays in the ownership of this class. Do not delete.
  62      *
  63      * \param id        Persistent id for the action
  64      * \param name      Name for the action. Is used in the global shortcut
  65      *                  configuration dialog
  66      * \param shortcut  Shortcut that triggers the action
  67      *
  68      * \return The new action or 0 if an error occurred.
  69      *
  70      * \see KAction::registerGlobalShortcut()
  71      */
  72     KAction *addAction(
  73         const QString &id,
  74         const QString &text,
  75         const KShortcut &shortcut );
  76
  77     /**
  78      * Remove a action from the collection.
  79      *
  80      * \param id        Persistent id for the action
  81      *
  82      * \return The action or 0 if not found.
  83      */
  84     QAction *getAction( const QString &id );
  85
  86     /**
  87      * Remove a action from the collection.
  88      *
  89      * \param id        Persistent id for the action
  90      *
  91      * \return true if the action was removed.
  92      */
  93     bool removeAction( const QString &id );
  94
  95     /**
  96      * From Kbd.
  97      *
  98      * \warning Does nothing, returns false
  99      */
 100     bool send_macro_key( const QString& key, Window window_P );
 101
 102 private:
 103
 104     HandlerType _type;
 105
 106     KActionCollection *_actions;
 107
 108 };
 109
 110 } // namespace KHotKeys
 111
 112 #endif /* #ifndef SHORTCUTACTIONS_H */