FCL/sf/mw/hb: comparison src/hbcore/inputfw/hbinpututils.cpp

equal deleted inserted replaced

-:7516d6d86cf5
+:ed14f46c0e55
 #define HB_DIGIT_ARABIC_INDIC_START_VALUE   0x0660
 #define HB_DIGIT_EASTERN_ARABIC_START_VALUE 0x06F0
 /*!
+@stable
+@hbcore
 \class HbInputUtils
-\brief A collection input related utility methods.
+\brief The HbInputUtils class is a collection of input related utility functions.
-This class contains a collection of static input related utility methods that do not
+This class contains a collection of static input related utility functions
-naturally belong to any other scope. There are convenience methods for testing
+that do not naturally belong to any other scope. There are convenience functions
-attributes of keyboard and input mode types, instantiating plugins etc.
+for testing keyboard attributes and input mode types, instantiating plugins, and so on.
 \sa HbInputMethod
 \sa QInputContextPlugin
 */
 /*!
-Finds the fist number character bound to key using given mapping data.
+Finds the first number character bound to \a key using the given mapping data.
 */
 QChar HbInputUtils::findFirstNumberCharacterBoundToKey(const HbMappedKey *key,
 const HbInputLanguage language,
 const HbInputDigitType digitType)
 {
 return 0;
 }
 /*!
-Returns true if the concept of "text case" can be applied to given input mode.
+Returns \c true if the concept of "text case" can be applied to \a inputMode.
 For example Chinese and Japanese modes do not have text case.
 */
 bool HbInputUtils::isCaseSensitiveMode(HbInputModeType inputMode)
 {
 if (isChineseInputMode(inputMode)) {
 return true;
 }
 /*!
-Lists all Qt library files in language database directory. May return
+Lists all %Qt library files in the language database directory. Can return
 files that are not language database plugins. languageDatabasePluginInstance()
 checks the validity of plugin files provided by this function.
 \sa languageDatabasePluginInstance
 */
 }
 }
 }
 /*!
-Creates an instance of given language database plugin, if valid.
+Creates an instance of the given language database plugin, if valid.
 */
 HbLanguageDatabaseInterface *HbInputUtils::languageDatabasePluginInstance(const QString &pluginFileName, const QString &subfolder)
 {
 if (!QLibrary::isLibrary(pluginFileName)) {
 qDebug("HbInputUtils::languageDatabasePluginInstance: Not a library!");
 return res;
 }
 /*!
-Lists all the input languages that the set of available input methods supports. Excludes custom input methods.
+Lists all the input languages supported by the set of available input methods. Excludes custom input methods.
 */
 void HbInputUtils::listSupportedInputLanguages(QList<HbInputLanguage>& results)
 {
 results = HbInputModeCache::instance()->listInputLanguages();
 }
 /*!
-This method creates an instance of QWidget and wraps given graphics widget inside it.
+This function creates a QWidget instance and wraps the given graphics widget
-It creates QGraphicsScene, adds given widget there and creates a view to the scene
+inside it. It creates a QGraphicsScene object, adds \a graphicsWidget there,
-inside returned QWidget. This is utility method is mainly for internal use.
+and creates a view to the scene inside the returned %QWidget. This utility
+function is mainly for the internal use of the input framework.
 */
 QWidget *HbInputUtils::createWrapperWidget(QGraphicsWidget *graphicsWidget)
 {
 QWidget *ret = 0;
 return ret;
 }
 /*!
-A convenience method that wraps given widget inside QGraphicsProxyWidget
+A convenience function that wraps the given widget inside a QGraphicsProxyWidget
-and returns it. This is utility method is mainly for internal use.
+and returns it. This utility method is mainly for the internal use of the input
+framework.
 */
 QGraphicsWidget *HbInputUtils::createGraphicsProxyWidget(QWidget *widget)
 {
 QGraphicsProxyWidget *proxy = 0;
 return proxy;
 }
 /*!
-returns the input digit type for the given input language
+Returns the input digit type for the given input language.
 */
 HbInputDigitType HbInputUtils::inputDigitType(HbInputLanguage language)
 {
 HbInputDigitType digitType = HbDigitTypeNone;
 return digitType;
 }
 /*!
-Returns the proxy widget of the embedded widget in a graphics view ;
+Returns the proxy widget of the embedded widget in a graphics view.
-if widget does not have the proxy widget then it returns the proxy widget of its window.
+If the widget does not have a proxy widget it returns the proxy widget of its window.
-otherwise returns 0.
+Otherwise returns 0.
 */
 QGraphicsProxyWidget *HbInputUtils::graphicsProxyWidget(const QWidget *w)
 {
 QGraphicsProxyWidget *pw = w ? w->graphicsProxyWidget() : 0;
 if (w && !pw) {
 pw = w->window() ? w->window()->graphicsProxyWidget() : w->graphicsProxyWidget();
 }
 return pw;
 }
+/*!
+\fn bool HbInputUtils::isChineseInputMode(HbInputModeType inputMode)
+Returns \c true if \a inputMode is the Chinese input mode.
+*/
+/*!
+\fn bool HbInputUtils::isQwertyKeyboard(HbKeyboardType keyboardType)
+Returns \c true if \a keyboardType is a QWERTY keyboard type.
+*/
+/*!
+\fn bool HbInputUtils::isTouchKeyboard(HbKeyboardType keyboardType)
+Returns \c true if \a keyboardType is a virtual keyboard type.
+*/
 // End of file

changeset 34	ed14f46c0e55
parent 6	c3690ec91ef8