1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (developer.feedback@nokia.com)

     6 **

     7 ** This file is part of the HbCore module of the UI Extensions for Mobile.

     8 **

     9 ** GNU Lesser General Public License Usage

    10 ** This file may be used under the terms of the GNU Lesser General Public

    11 ** License version 2.1 as published by the Free Software Foundation and

    12 ** appearing in the file LICENSE.LGPL included in the packaging of this file.

    13 ** Please review the following information to ensure the GNU Lesser General

    14 ** Public License version 2.1 requirements will be met:

    15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    16 **

    17 ** In addition, as a special exception, Nokia gives you certain additional

    18 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    20 **

    21 ** If you have questions regarding the use of this file, please contact

    22 ** Nokia at developer.feedback@nokia.com.

    23 **

    24 ****************************************************************************/

    25 

    26 #ifndef HB_INPUT_VKB_HOST_H

    27 #define HB_INPUT_VKB_HOST_H

    28 

    29 #include <QObject>

    30 #include <QSizeF>

    31 #include <QRectF>

    32 #include <QPointer>

    33 

    34 #include <hbinputdef.h>

    35 

    36 class QWidget;

    37 class QGraphicsWidget;

    38 class HbVirtualKeyboard;

    39 class HbInputMethod;

    40 

    41 class HB_CORE_EXPORT HbVkbHost : public QObject

    42 {

    43     Q_OBJECT

    44 

    45 public:

    46       /*!

    47       \deprecated

    48       Enumerates known virtual keyboard host priorities.

    49       NOTE: all these values are deprecated.

    50       */

    51       enum HbVkbHostPriority {

    52           HbVkbHostPriorityDefault = 1000,

    53           HbVkbHostPriorityPopup = 2000,

    54           HbVkbHostPriorityCustom = 5000 

    55       };

    56 

    57       /*!

    58       Enumerates different keypad states.

    59       */

    60       enum HbVkbStatus {

    61         HbVkbStatusClosed,

    62         HbVkbStatusMinimized,

    63         HbVkbStatusOpened,

    64       };

    65 

    66 public:

    67     virtual ~HbVkbHost() {}

    68     virtual void openKeypad(HbVirtualKeyboard *vkb = 0, HbInputMethod* owner = 0, bool animationAllowed = true) = 0;

    69     virtual void openMinimizedKeypad(HbVirtualKeyboard *vkb, HbInputMethod* owner) = 0;

    70     virtual void closeKeypad(bool animationAllowed = true) = 0;

    71     virtual void minimizeKeypad(bool animationAllowed = true) = 0;

    72     virtual HbVkbStatus keypadStatus() const = 0;

    73     virtual int priority() const = 0; 

    74     virtual QSizeF keyboardArea() const = 0;

    75     virtual void preferredSizeChanged(const QSizeF& newSize) = 0;

    76     virtual HbVirtualKeyboard* activeKeypad() const = 0;

    77     virtual QRectF applicationArea() const = 0;

    78     virtual HbVkbStatus keypadStatusBeforeOrientationChange() const = 0;

    79 

    80     static void attachHost(HbVkbHost* host, QObject* object);

    81     static void detachHost(QObject* object);

    82     static HbVkbHost *getVkbHost(QObject *object);

    83     static HbVkbHost *activeVkbHost();

    84 

    85 public slots:

    86     virtual void ensureCursorVisibility() = 0;

    87 

    88 signals:

    89     void keypadOpened();

    90     void keypadClosed();

    91 

    92 protected:

    93     virtual void refresh() = 0;

    94 

    95     friend class HbInputMethod;

    96 };

    97 

    98 #endif // HB_INPUT_VKB_HOST_H

    99 

   100 // End of file