tizen 2.4 release
[framework/api/inputmethod-manager.git] / doc / inputmethod_manager_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_MANAGER_DOC_H__
18 #define __TIZEN_UIX_INPUTMETHOD_MANAGER_DOC_H__
19
20 /**
21  * @ingroup CAPI_UIX_FRAMEWORK
22  * @defgroup CAPI_UIX_INPUTMETHOD_MANAGER_MODULE Input Method Manager
23  * @brief The @ref CAPI_UIX_INPUTMETHOD_MANAGER_MODULE API provides the functions for launching input method editor (IME)
24  * list and selector settings. A user can manage the installed IMEs in the system.
25  *
26  * @section CAPI_UIX_INPUTMETHOD_MANAGER_MODULE_HEADER Required Header
27  *   \#include <inputmethod_manager.h>
28  *
29  * @section CAPI_UIX_INPUTMETHOD_MANAGER_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  * Input method manager is a module for managing the installed IMEs. IME developers can use this module to open the installed
32  * IME list or selector menu after their IME installation; then guide to select the installed IME.
33  */
34
35 #endif // __TIZEN_UIX_INPUTMETHOD_MANAGER_DOC_H__
36