kmodifierkeyinfo.h

Go to the documentation of this file.

/*
    Copyright 2009  Michael Leupold <lemma@confuego.org>

    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.1 of the License, or (at your option) version 3, or any
    later version accepted by the membership of KDE e.V. (or its
    successor approved by the membership of KDE e.V.), which shall
    act as a proxy defined in Section 6 of version 3 of the license.

    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.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef KMODIFIERKEYINFO_H
#define KMODIFIERKEYINFO_H

#include <kdeui_export.h>

#include <QtCore/QObject>

class KModifierKeyInfoProvider;

class KDEUI_EXPORT KModifierKeyInfo : public QObject
{
    Q_OBJECT

public:
    KModifierKeyInfo(QObject *parent = 0);
    
    virtual ~KModifierKeyInfo();

    bool knowsKey(Qt::Key key) const;

    const QList<Qt::Key> knownKeys() const;

    bool isKeyPressed(Qt::Key key) const;
    
    bool isKeyLatched(Qt::Key key) const;

    bool setKeyLatched(Qt::Key key, bool latched);

    bool isKeyLocked(Qt::Key key) const;

    bool setKeyLocked(Qt::Key key, bool locked);

    bool isButtonPressed(Qt::MouseButton button) const;

Q_SIGNALS:
    void keyPressed(Qt::Key key, bool pressed);
    
    void keyLatched(Qt::Key key, bool latched);

    void keyLocked(Qt::Key key, bool locked);

    void buttonPressed(Qt::MouseButton button, bool pressed);

    void keyAdded(Qt::Key key);

    void keyRemoved(Qt::Key key);

private:
    Q_DISABLE_COPY(KModifierKeyInfo)
    KModifierKeyInfoProvider * const p; // krazy:exclude=dpointer
};

#endif