src/imports/inputcontext/inputcontextmodule.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the examples of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef INPUTCONTEXTMODULE_H
  43 #define INPUTCONTEXTMODULE_H
  44
  45 #include <QtCore/qobject.h>
  46 #include <QtCore/qrect.h>
  47 #include <QtGui/qfont.h>
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 QT_MODULE(Declarative)
  54
  55 class DeclarativeInputContext;
  56
  57 class InputContextModule : public QObject
  58 {
  59     Q_OBJECT
  60     Q_PROPERTY(bool softwareInputPanelVisible READ isVisible WRITE setVisible NOTIFY visibleChanged)
  61     Q_PROPERTY(bool focus READ hasFocus NOTIFY focusChanged)
  62     Q_PROPERTY(QString preeditText READ preeditText WRITE setPreeditText NOTIFY preeditTextChanged)
  63     Q_PROPERTY(QRect microFocus READ microFocus NOTIFY contextUpdated)
  64     Q_PROPERTY(QFont font READ font NOTIFY contextUpdated)
  65     Q_PROPERTY(int cursorPosition READ cursorPosition NOTIFY contextUpdated)
  66     Q_PROPERTY(int anchorPosition READ anchorPosition NOTIFY contextUpdated)
  67     Q_PROPERTY(int maximumTextLength READ maximumTextLength NOTIFY contextUpdated)
  68     Q_PROPERTY(QString surroundingText READ surroundingText NOTIFY contextUpdated)
  69     Q_PROPERTY(QString selectedText READ selectedText NOTIFY contextUpdated)
  70 public:
  71     explicit InputContextModule(QObject *parent = 0);
  72     ~InputContextModule();
  73
  74     bool hasFocus() const;
  75     void setFocusWidget(QWidget *widget);
  76
  77     bool isVisible() const;
  78     void setVisible(bool visible);
  79
  80     QString preeditText() const;
  81     void setPreeditText(const QString &text);
  82
  83     QRect microFocus() const;
  84     QFont font() const;
  85     int cursorPosition() const;
  86     int anchorPosition() const;
  87     int maximumTextLength() const;
  88     QString surroundingText() const;
  89     QString selectedText() const;
  90
  91     Q_INVOKABLE void sendKeyPress(
  92             int key, const QString &text, int modifiers = 0, bool autoRepeat = false, int count = 1);
  93     Q_INVOKABLE void sendKeyRelease(int key, const QString &text, int modifiers = 0, int count = 1);
  94
  95     Q_INVOKABLE void sendPreedit(const QString &text, int cursor = -1);
  96
  97     Q_INVOKABLE void commit();
  98     Q_INVOKABLE void commit(const QString &text, int replacementStart = 0, int replacementEnd = 0);
  99
 100     Q_INVOKABLE void clear();
 101
 102     void update();
 103
 104 signals:
 105     void preeditTextChanged();
 106     void visibleChanged();
 107     void contextUpdated();
 108     void focusChanged();
 109
 110 private:
 111     QString m_preeditText;
 112     DeclarativeInputContext *m_inputContext;
 113     QWidget *m_focusWidget;
 114     bool m_visible;
 115 };
 116
 117 QT_END_NAMESPACE
 118
 119 QT_END_HEADER
 120
 121 #endif