qxtglobalshortcut
qxtglobalshortcut.h
1 #ifndef QXTGLOBALSHORTCUT_H
2 /****************************************************************************
3 ** Copyright (c) 2006 - 2011, the LibQxt project.
4 ** See the Qxt AUTHORS file for a list of authors and copyright holders.
5 ** All rights reserved.
6 **
7 ** Redistribution and use in source and binary forms, with or without
8 ** modification, are permitted provided that the following conditions are met:
9 ** * Redistributions of source code must retain the above copyright
10 ** notice, this list of conditions and the following disclaimer.
11 ** * Redistributions in binary form must reproduce the above copyright
12 ** notice, this list of conditions and the following disclaimer in the
13 ** documentation and/or other materials provided with the distribution.
14 ** * Neither the name of the LibQxt project nor the
15 ** names of its contributors may be used to endorse or promote products
16 ** derived from this software without specific prior written permission.
17 **
18 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 ** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 ** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 ** DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
22 ** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 ** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 ** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 ** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 ** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 **
29 ** <http://libqxt.org> <foundation@libqxt.org>
30 *****************************************************************************/
31 
32 #define QXTGLOBALSHORTCUT_H
33 
34 #include "private/qxtglobalshortcut_export.h"
35 
36 #include <QObject>
37 #include <QKeySequence>
38 
40 
41 class QXTGLOBALSHORTCUT_EXPORT QxtGlobalShortcut : public QObject
42 {
43  Q_OBJECT
44  Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled)
45  Q_PROPERTY(bool valid READ isValid)
46  Q_PROPERTY(QKeySequence shortcut READ shortcut WRITE setShortcut)
47 
48 public:
49  explicit QxtGlobalShortcut(QObject* parent = nullptr);
50  explicit QxtGlobalShortcut(const QKeySequence& shortcut, QObject* parent = nullptr);
52 
53  QKeySequence shortcut() const;
54  bool setShortcut(const QKeySequence& shortcut);
55 
56  bool isEnabled() const;
57 
58  bool isValid() const;
59 
60 public Q_SLOTS:
61  void setEnabled(bool enabled = true);
62  void setDisabled(bool disabled = true);
63 
64 Q_SIGNALS:
65  void activated(QxtGlobalShortcut *self);
66 
67 private:
68  friend class QxtGlobalShortcutPrivate;
69  QxtGlobalShortcutPrivate *d_ptr;
70 };
71 
72 #endif // QXTGLOBALSHORTCUT_H
The QxtGlobalShortcut class provides a global shortcut aka "hotkey".
Definition: qxtglobalshortcut.h:41
Definition: qxtglobalshortcut_p.h:44