File: fcitxqtkeysequencewidget.h

package info (click to toggle)
fcitx5-qt 5.1.9-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,336 kB
  • sloc: cpp: 11,663; xml: 243; ansic: 46; makefile: 14; sh: 9
file content (152 lines) | stat: -rw-r--r-- 4,655 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*
 * SPDX-FileCopyrightText: 2013~2017 CSSlayer <wengxt@gmail.com>
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING. If not,
 * see <http://www.gnu.org/licenses/>.
 */
#ifndef _WIDGETSADDONS_FCITXQTKEYSEQUENCEWIDGET_H_
#define _WIDGETSADDONS_FCITXQTKEYSEQUENCEWIDGET_H_

/* this is forked from kdelibs/kdeui/kkeysequencewidget.h */

/*
    Original Copyright header
    This file is part of the KDE libraries
    SPDX-FileCopyrightText: 2001, 2002 Ellis Whitehead <ellis@kde.org>
    SPDX-FileCopyrightText: 2007 Andreas Hartmetz <ahartmetz@gmail.com>

    This library 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 library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#include <QList>
#include <QPushButton>
#include <fcitx-utils/key.h>

#include "fcitx5qt6widgetsaddons_export.h"

namespace fcitx {

class FcitxQtKeySequenceWidgetPrivate;

class FCITX5QT6WIDGETSADDONS_EXPORT FcitxQtKeySequenceWidget : public QWidget {
    Q_OBJECT

    Q_PROPERTY(bool multiKeyShortcutsAllowed READ multiKeyShortcutsAllowed WRITE
                   setMultiKeyShortcutsAllowed)

    Q_PROPERTY(bool modifierlessAllowed READ isModifierlessAllowed WRITE
                   setModifierlessAllowed)

    Q_PROPERTY(
        bool modifierAllowed READ isModifierAllowed WRITE setModifierAllowed)

    Q_PROPERTY(
        bool keycodeAllowed READ isKeycodeAllowed WRITE setKeycodeAllowed)

    Q_PROPERTY(bool modifierOnlyAllowed READ isModifierOnlyAllowed WRITE
                   setModifierOnlyAllowed)

public:
    /**
     * Constructor.
     */
    explicit FcitxQtKeySequenceWidget(QWidget *parent = 0);

    /**
     * Destructs the widget.
     */
    virtual ~FcitxQtKeySequenceWidget();

    /**
     * @brief Set whether allow multiple shortcuts.
     *
     * @param  allow
     */
    void setMultiKeyShortcutsAllowed(bool allow);
    bool multiKeyShortcutsAllowed() const;

    /**
     * @brief Set whether allow modifier less that produce text, such as just
     * key A.
     *
     * @param allow
     */
    void setModifierlessAllowed(bool allow);
    // FIXME: remove this
    bool isModifierlessAllowed();
    bool isModifierlessAllowed() const;

    /**
     * @brief Set whether allow key that has modifier.
     *
     * @param allow
     * @since 5.0.12
     */
    void setModifierAllowed(bool allow);
    bool isModifierAllowed() const;

    /**
     * @brief Set whether allow key to use key code.
     *
     * @param allow
     * @since 5.0.12
     */
    void setKeycodeAllowed(bool allow);
    bool isKeycodeAllowed() const;

    /**
     * @brief Set whether allow modifier only key, such as only left control.
     *
     * @param allow allow modifier only key to be captured.
     */
    void setModifierOnlyAllowed(bool allow);
    // FIXME: remove this
    bool isModifierOnlyAllowed();
    bool isModifierOnlyAllowed() const;

    void setClearButtonShown(bool show);
    bool isClearButtonVisible() const;

    const QList<Key> &keySequence() const;

Q_SIGNALS:
    void keySequenceChanged(const QList<Key> &seq);

public Q_SLOTS:
    void captureKeySequence();
    void setKeySequence(const QList<Key> &seq);
    void clearKeySequence();

private:
    friend class FcitxQtKeySequenceWidgetPrivate;
    FcitxQtKeySequenceWidgetPrivate *const d;

    Q_DISABLE_COPY(FcitxQtKeySequenceWidget)
};
} // namespace fcitx

#endif // _WIDGETSADDONS_FCITXQTKEYSEQUENCEWIDGET_H_