kgesture.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 2006,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.
*/

#ifndef KGESTURE_H
#define KGESTURE_H

#include <kdeui_export.h>

#include <QtCore/QString>
#include <QtGui/QPolygon>

/*
 kinds of gestures:
 -shapes like triangle, right angle, line
 -"rocker" (i.e. two mouse button) gestures
 */


class KShapeGesturePrivate;
//TODO: implement operator== for special situations like in KKeyChooser.
class KDEUI_EXPORT KShapeGesture
{
public:
    KShapeGesture();

    KShapeGesture(const QPolygon &shape);

    KShapeGesture(const QString &description);

    KShapeGesture(const KShapeGesture &other);

    ~KShapeGesture();

    void setShape(const QPolygon &shape);

    void setShapeName(const QString &friendlyName);

    QString shapeName() const;

    bool isValid() const;

    QString toString() const;

    QByteArray toSvg(const QString &attributes = QString()) const;

    float distance(const KShapeGesture &other, float abortThreshold) const;

    KShapeGesture &operator=(const KShapeGesture &other);

    bool operator==(const KShapeGesture &other) const;

    bool operator!=(const KShapeGesture &other) const;

    uint hashable() const;

private:
    KShapeGesturePrivate * const d;
};

uint qHash(int);
inline uint qHash(const KShapeGesture &key)
{
    return qHash(key.hashable());
}

class KRockerGesturePrivate;

class KDEUI_EXPORT KRockerGesture
{
public:
    KRockerGesture();

    KRockerGesture(enum Qt::MouseButton hold, enum Qt::MouseButton thenPush);

    KRockerGesture(const QString &description);

    KRockerGesture(const KRockerGesture &other);

    ~KRockerGesture();

    void setButtons(Qt::MouseButton hold, Qt::MouseButton thenPush);

    void getButtons(Qt::MouseButton *hold, Qt::MouseButton *thenPush) const;

    QString rockerName() const;

    static QString mouseButtonName(Qt::MouseButton button);

    bool isValid() const;

    QString toString() const;

    KRockerGesture &operator=(const KRockerGesture &other);

    bool operator==(const KRockerGesture &other) const;

    bool operator!=(const KRockerGesture &other) const;

    uint hashable() const;

private:
    KRockerGesturePrivate * const d;
};

inline uint qHash(const KRockerGesture &key)
{
    return qHash(key.hashable());
}

//KGESTURE_H
#endif