--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/hbcore/inputfw/hbinputstate.h	Mon Apr 19 14:02:13 2010 +0300
@@ -0,0 +1,157 @@
+/****************************************************************************
+**
+** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (developer.feedback@nokia.com)
+**
+** This file is part of the HbCore module of the UI Extensions for Mobile.
+**
+** GNU Lesser General Public License Usage
+** This file may be used 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.
+** Please review the following information to ensure the GNU Lesser General
+** Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at developer.feedback@nokia.com.
+**
+****************************************************************************/
+
+#ifndef HB_INPUT_STATE_H
+#define HB_INPUT_STATE_H
+
+#include <hbinputlanguage.h>
+
+/*!
+@alpha
+@hbcore
+\class HbInputState
+\brief Holds all the information for defining an input state.
+
+This class describes the state of the input framework.
+Active input method is notified every time the state changes.
+If the active input method cannot handle new state, the framework will find 
+suitable handler for it. The input state is a combination of input mode, text case,
+keyboard type and language.
+
+This class is for input method developers, it should never be needed in application code.
+
+\sa HbInputMethod
+*/
+class HbInputState
+{
+public:
+    HbInputState()
+        : iModeType(HbInputModeNone),
+          iTextCase(HbTextCaseNone),
+          iKeyboardType(HbKeyboardNone),
+          iLanguage(HbInputLanguage())
+    {}
+
+    HbInputState(HbInputModeType aModeType, HbTextCase aTextCase, HbKeyboardType aKeyboardType, const HbInputLanguage &aLanguage = HbInputLanguage())
+        : iModeType(aModeType),
+          iTextCase(aTextCase),
+          iKeyboardType(aKeyboardType),
+          iLanguage(aLanguage)
+    {}
+
+    void operator=(const HbInputState& aState) {
+        iModeType = aState.iModeType;
+        iTextCase = aState.iTextCase; 
+        iKeyboardType = aState.iKeyboardType;
+        iLanguage = aState.iLanguage;
+    }
+
+    bool operator==(const HbInputState& aState) {
+        if (iModeType == aState.iModeType
+            && iTextCase == aState.iTextCase
+            && iKeyboardType == aState.iKeyboardType
+            && iLanguage == aState.iLanguage) {
+                return true;
+        }
+        return false;
+    }
+
+    /*!
+    This is same as compare operator except for the language value. If either one of the
+    states being compared has undefined language value, it will match to any language.
+    If both language values are defined, then they are compared directly.
+    */
+    bool isMatch(const HbInputState& aState) {
+        if (iModeType == aState.iModeType
+            && iTextCase == aState.iTextCase
+            && iKeyboardType == aState.iKeyboardType
+            && (iLanguage == aState.iLanguage ||
+                iLanguage.undefined() ||           // Undefined matches to anything.
+        aState.iLanguage.undefined())) {
+                return true;
+        }
+    return false;
+    }
+
+    bool operator!=(const HbInputState& aState) {
+        if (iModeType != aState.iModeType
+            || iTextCase != aState.iTextCase
+            || iKeyboardType != aState.iKeyboardType
+            || iLanguage != aState.iLanguage) {
+                return true;
+        }
+        return false;
+    }
+
+    /*!
+    Returns input mode.
+    */
+    HbInputModeType inputMode() const { return iModeType; }
+
+    /*!
+    Sets input mode.
+    */
+    void setInputMode(HbInputModeType newMode) { iModeType = newMode; }
+
+    /*!
+    Returns text case.
+    */
+    HbTextCase textCase() const { return iTextCase; }
+
+    /*!
+    Sets text case.
+    */
+    void setTextCase(HbTextCase newCase) { iTextCase = newCase; }
+
+    /*!
+    Returns keyboard type.
+    */
+    HbKeyboardType keyboard() const { return iKeyboardType; }
+
+    /*!
+    Sets keyboard type.
+    */
+    void setKeyboard(HbKeyboardType newKeyboard) { iKeyboardType = newKeyboard; } 
+
+    /*!
+    Returns language.
+    */
+    HbInputLanguage language() const { return HbInputLanguage(iLanguage); }
+
+    /*!
+    Sets language. 
+    */
+    void setLanguage(const HbInputLanguage &newLanguage) { iLanguage = newLanguage; }
+
+private:
+    HbInputModeType iModeType;
+    HbTextCase iTextCase;
+    HbKeyboardType iKeyboardType;
+    HbInputLanguage iLanguage;
+};
+
+#endif // HB_INPUT_STATE_H
+
+// End of file