doc/inputmethod_doc.h

   1 /*
   2  * Copyright (c) 2014-2015 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __TIZEN_UIX_INPUTMETHOD_DOC_H__
  18 #define __TIZEN_UIX_INPUTMETHOD_DOC_H__
  19
  20
  21 /**
  22  * @ingroup CAPI_UIX_FRAMEWORK
  23  * @defgroup CAPI_UIX_INPUTMETHOD_MODULE Input Method
  24  * @brief The @ref CAPI_UIX_INPUTMETHOD_MODULE API provides the functions for starting IME application lifecycle,
  25  *        methods to interact with current UI state of IME, and getting attributes/events.
  26  * @section CAPI_UIX_INPUTMETHOD_MODULE_HEADER Required Header
  27  * \#include <inputmethod.h>
  28  *
  29  * @section CAPI_UIX_INPUTMETHOD_MODULE_OVERVIEW Overview
  30  * Input method editor (IME) is an input panel that lets users provide input and the platform receive the text data entered.
  31  * Custom keyboards can be built according to the application's necessity by these API sets.
  32  * Tizen provides a framework to create such input method editors. Such extra input methods can be selected from Settings.
  33  */
  34
  35
  36 #endif /* __TIZEN_UIX_INPUTMETHOD_DOC_H__ */
  37