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 #include "hbinputvirtualkeyboard.h"

    27 

    28 /*!

    29 \proto

    30 \class HbVirtualKeyboard

    31 \brief Abstract base class for virtual keyboards.

    32 

    33 This class is an abstract base class for virtual keyaboards. This class is

    34 not reponsible for the visual appearance of the keyboard, but contains methods that HbVkbHost

    35 class needs when interacting with the keyboard. The actual Qt widget inheriting from this

    36 class will fill and layout the keyboard contents.

    37 

    38 The virtual keyboard host calls aboutToOpen() method when it is about to open the keyboard

    39 and aboutToClose() when it is about to close it. Similarily, it calls keyboardOpened()

    40 and keyboardClosed() methods when open and close operations have been completed.

    41 

    42 Every time the host runs keyboard related animations, it calls keyboardAnimationFrame()

    43 method after each frame so that that the keyboard widget has possibility to run local animation

    44 effects inside the widget if needed.

    45 

    46 \sa HbVkbHost

    47 */

    48 

    49 /*!

    50 \fn void HbVirtualKeyboard::aboutToOpen(HbVkbHost *host)

    51 

    52 HbVkbHost calls this method right before keyboard becomes visible.

    53 Virtual keyboard widget can then do any last minute initializations

    54 if needed. The default implementation is empty.

    55 

    56 \sa HbVkbHost

    57 */

    58 

    59 /*!

    60 \fn void HbVirtualKeyboard::aboutToClose(HbVkbHost *host)

    61 

    62 HbVkbHost calls this method right before keyboard becomes visible.

    63 Virtual keyboard widget can then do any cleaning operations it needs to do.

    64 The default implemntation is empty.

    65 

    66 \sa HbVkbHost

    67 */

    68 

    69 /*!

    70 \fn void HbVirtualKeyboard::keyboardOpened(HbVkbHost *host)

    71 

    72 HbVkbHost calls this method when the keyboard open operation is finished and the keyboard is

    73 visible on the screen in its final position. The default implementation is empty.

    74 

    75 \sa HbVkbHost

    76 */

    77 

    78 /*!

    79 \fn void HbVirtualKeyboard::keyboardClosed(HbVkbHost *host)

    80 

    81 HbVkbHost calls this method when keyboard closing operation is finished and the keyboard is not

    82 visible on the screen anymore. The deafult implementation is empty.

    83 */

    84 

    85 /*!

    86 \fn void HbVirtualKeyboard::keyboardMinimized(HbVkbHost *host)

    87 

    88 HbVkbHost calls this method when keyboard minimizing operation is finished and only the close bar

    89 is visible on the keypad. The deafult implementation is empty.

    90 */

    91 

    92 /*!

    93 \fn QSizeF HbVirtualKeyboard::minimizedKeyboardSize()

    94 This function is used by HbVkbHost to show the keypad in minimized state.

    95 */

    96 

    97 /*!

    98 \fn void HbVirtualKeyboard::keyboardAnimationFrame(HbVkbAnimationType type, qreal x)

    99 

   100 Vkb host calls this method when keyboard animation frame is drawn. Keyboard widget may then

   101 animate its contents if needed. Parameter type specifies animation type and value

   102 x is animation phase (between 0.0 and 1.0). The default implementation is empty.

   103 */

   104 

   105 // End of file