← Back to branch summary

~ubuntu-branches/ubuntu/utopic/kde-workspace/utopic-proposed

« back to all changes in this revision

Viewing changes to khotkeys/libkhotkeysprivate/shortcuts_handler.h

  • Committer: Bazaar Package Importer
  • Author(s): Michał Zając
  • Date: 2011-07-09 08:31:15 UTC
  • Revision ID: james.westby@ubuntu.com-20110709083115-ohyxn6z93mily9fc
Tags: upstream-4.6.90
Import upstream version 4.6.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
#include <fixx11h.h>
 
27
 
 
28
 
 
29
class KAction;
 
30
class KShortcut;
 
31
 
 
32
namespace KHotKeys {
 
33
 
 
34
/**
 
35
 * @author Michael Jansen <kde@michael-jansen.biz>
 
36
 */
 
37
class ShortcutsHandler : public QObject
 
38
    {
 
39
    Q_OBJECT
 
40
 
 
41
public:
 
42
 
 
43
    enum HandlerType {
 
44
        Active,             //!< Create real actions
 
45
        Configuration };    //!< Create configuration actions ( not active )
 
46
 
 
47
    /**
 
48
     * Default constructor
 
49
     *
 
50
     * \param Should 
 
51
     */
 
52
    ShortcutsHandler( HandlerType type = Active, QObject *parent = 0 );
 
53
 
 
54
    /**
 
55
     * Destructor
 
56
     */
 
57
    ~ShortcutsHandler();
 
58
 
 
59
    /**
 
60
     * Create a action.
 
61
     *
 
62
     * The action stays in the ownership of this class. Do not delete.
 
63
     *
 
64
     * \param id        Persistent id for the action
 
65
     * \param name      Name for the action. Is used in the global shortcut
 
66
     *                  configuration dialog
 
67
     * \param shortcut  Shortcut that triggers the action
 
68
     *
 
69
     * \return The new action or 0 if an error occurred.
 
70
     *
 
71
     * \see KAction::registerGlobalShortcut()
 
72
     */
 
73
    KAction *addAction(
 
74
        const QString &id,
 
75
        const QString &text,
 
76
        const KShortcut &shortcut );
 
77
 
 
78
    /**
 
79
     * Remove a action from the collection.
 
80
     *
 
81
     * \param id        Persistent id for the action
 
82
     *
 
83
     * \return The action or 0 if not found.
 
84
     */
 
85
    QAction *getAction( const QString &id );
 
86
 
 
87
    /**
 
88
     * Remove a action from the collection.
 
89
     *
 
90
     * \param id        Persistent id for the action
 
91
     *
 
92
     * \return true if the action was removed.
 
93
     */
 
94
    bool removeAction( const QString &id );
 
95
 
 
96
    /**
 
97
     * From Kbd.
 
98
     *
 
99
     * \warning Does nothing, returns false
 
100
     */
 
101
    bool send_macro_key( const QKeySequence &key, Window window_P );
 
102
 
 
103
Q_SIGNALS:
 
104
 
 
105
    /**
 
106
     * One of the actions shortcuts was changed.
 
107
     */
 
108
    void shortcutChanged() const;
 
109
 
 
110
private:
 
111
 
 
112
    HandlerType _type;
 
113
 
 
114
    KActionCollection *_actions;
 
115
 
 
116
};
 
117
 
 
118
} // namespace KHotKeys
 
119
 
 
120
#endif /* #ifndef SHORTCUTACTIONS_H */