minputmethodstate.h

Go to the documentation of this file.

/***************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (directui@nokia.com)
**
** This file is part of libmeegotouch.
**
** If you have questions regarding the use of this file, please contact
** Nokia at directui@nokia.com.
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation
** and appearing in the file LICENSE.LGPL included in the packaging
** of this file.
**
****************************************************************************/

#ifndef MINPUTMETHODSTATE_H
#define MINPUTMETHODSTATE_H

#include <QObject>
#include <QRect>

#include "mnamespace.h"
#include "mexport.h"

class QKeyEvent;

class MInputMethodStatePrivate;

class M_CORE_EXPORT MInputMethodState : public QObject
{
    Q_OBJECT

public:
    static MInputMethodState *instance();

    QRect inputMethodArea() const;

    M::OrientationAngle activeWindowOrientationAngle() const;

    static void requestSoftwareInputPanel();

    static void closeSoftwareInputPanel();

    void emitKeyPress(const QKeyEvent &event);
    void emitKeyRelease(const QKeyEvent &event);

    // returns the identifiers of registered toolbars
    QList<int> toolbarIds() const;

    // providing item name -> (attribute name -> attribute value)
    typedef QMap<QString, QVariant> AttributeMap;
    typedef QMap<QString, AttributeMap> ItemAttributeMap;

    // returns state set for a toolbar
    ItemAttributeMap toolbarState(int id) const;

public Q_SLOTS:
    void setActiveWindowOrientationAngle(M::OrientationAngle newOrientation);

    void setInputMethodArea(const QRect &newRegion);

    int registerToolbar(const QString &fileName);

    void unregisterToolbar(int id);

    void setToolbarItemAttribute(int id, const QString &item,
                                 const QString &attribute, const QVariant &value);

    QString toolbar(int id) const;

Q_SIGNALS:
    void inputMethodAreaChanged(const QRect &region);

    void activeWindowOrientationAngleChanged(M::OrientationAngle orientation);

    void toolbarRegistered(int id, const QString &fileName);

    void toolbarUnregistered(int id);

    void toolbarItemAttributeChanged(int id, const QString &item, const QString &attribute,
                                     const QVariant &value);

    void keyPress(const QKeyEvent &);

    void keyRelease(const QKeyEvent &);

private:
    MInputMethodState();
    ~MInputMethodState();
    Q_DISABLE_COPY(MInputMethodState)

    MInputMethodStatePrivate *const d_ptr;

    Q_DECLARE_PRIVATE(MInputMethodState)
};

#endif