From: Sungmin Kwak Date: Fri, 20 Mar 2015 11:57:36 +0000 (+0900) Subject: Initial codes X-Git-Tag: submit/tizen/20150612.011258~10 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F45%2F40945%2F1;p=platform%2Fcore%2Fapi%2Finputmethod-manager.git Initial codes Change-Id: I6e2a0be836410407c922a136ae7d5dd2754556ac --- diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..4f62b8a --- /dev/null +++ b/AUTHORS @@ -0,0 +1,3 @@ +Sungmin Kwak +Jihoon Kim +Jae Yong Lee diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..de266fb --- /dev/null +++ b/LICENSE @@ -0,0 +1,204 @@ +Copyright (c) 2014 - 2015 Samsung Electronics Co., Ltd. All rights reserved. + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/capi-ui-inputmethod-manager.manifest b/capi-ui-inputmethod-manager.manifest new file mode 100644 index 0000000..dfdc35c --- /dev/null +++ b/capi-ui-inputmethod-manager.manifest @@ -0,0 +1,5 @@ + + + + + diff --git a/capi-ui-inputmethod-manager.pc.in b/capi-ui-inputmethod-manager.pc.in new file mode 100644 index 0000000..76f4d7e --- /dev/null +++ b/capi-ui-inputmethod-manager.pc.in @@ -0,0 +1,14 @@ +# Package Information for pkg-config + +prefix=@PREFIX@ +exec_prefix=/usr +libdir=/usr/lib +includedir=/usr/include + +Name: @PC_NAME@ +Description: @PACKAGE_DESCRIPTION@ +Version: @VERSION@ +Requires: @PC_REQUIRED@ +Libs: -L${libdir} @PC_LDFLAGS@ +Cflags: -I${includedir} + diff --git a/doc/inputmethod_manager_doc.h b/doc/inputmethod_manager_doc.h new file mode 100644 index 0000000..eca6f6c --- /dev/null +++ b/doc/inputmethod_manager_doc.h @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2014-2015 Samsung Electronics Co., Ltd All Rights Reserved + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an AS IS BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef __TIZEN_UIX_INPUTMETHOD_MANAGER_DOC_H__ +#define __TIZEN_UIX_INPUTMETHOD_MANAGER_DOC_H__ + +/** + * @ingroup CAPI_UIX_FRAMEWORK + * @defgroup CAPI_UIX_INPUTMETHOD_MANAGER_MODULE Input Method Manager + * @brief The @ref CAPI_UIX_INPUTMETHOD_MANAGER_MODULE API provides the functions for launching input method editor (IME) + * list and selector settings. A user can manage the installed IMEs in the system. + * + * @section CAPI_UIX_INPUTMETHOD_MANAGER_MODULE_HEADER Required Header + * \#include + * + * @section CAPI_UIX_INPUTMETHOD_MANAGER_MODULE_OVERVIEW Overview + * Input method editor (IME) is an input panel that lets users provide input and the platform receive the text data entered. + * Input method manager is a module for managing the installed IMEs. IME developers can use this module to open the installed + * IME list or selector menu after their IME installation; then guide to select the installed IME. + */ + +#endif // __TIZEN_UIX_INPUTMETHOD_MANAGER_DOC_H__ + diff --git a/include/inputmethod_manager.h b/include/inputmethod_manager.h new file mode 100644 index 0000000..c9e96fb --- /dev/null +++ b/include/inputmethod_manager.h @@ -0,0 +1,124 @@ +/* + * Copyright (c) 2014-2015 Samsung Electronics Co., Ltd All Rights Reserved + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an AS IS BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef __TIZEN_UIX_INPUTMETHOD_MANAGER_H__ +#define __TIZEN_UIX_INPUTMETHOD_MANAGER_H__ + +/** + * @file inputmethod_manager.h + * @brief This file contains input method manager APIs for input method editor (IME) list and selector settings. + */ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @addtogroup CAPI_UIX_INPUTMETHOD_MANAGER_MODULE + * @{ + */ + +/** + * @brief Enumeration for input method manager function error + * + * @since_tizen 2.4 + */ +typedef enum +{ + IME_MANAGER_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + IME_MANAGER_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ + IME_MANAGER_ERROR_OPERATION_FAILED = TIZEN_ERROR_UIX_CLASS | 0x0004, /**< Operation failed */ +} ime_manager_error_e; + +/** + * @brief Requests to open the installed IME list menu. + * + * @details This function provides the installed IME list menu for the IME developers who might want to open it to enable their IME. + * + * @since_tizen 2.4 + * + * @return 0 on success, otherwise a negative error value + * @retval #IME_MANAGER_ERROR_NONE No error + * @retval #IME_MANAGER_ERROR_OPERATION_FAILED Operation failed + * + * @see ime_manager_show_ime_selector + */ +EXPORT_API int ime_manager_show_ime_list(void); + +/** + * @brief Requests to open the IME selector menu. + * + * @details This function provides the IME selector menu for the IME or other application developers who might want to change the default IME. + * + * @since_tizen 2.4 + * + * @return 0 on success, otherwise a negative error value + * @retval #IME_MANAGER_ERROR_NONE No error + * @retval #IME_MANAGER_ERROR_OPERATION_FAILED Operation failed + * + * @see ime_manager_show_ime_list + */ +EXPORT_API int ime_manager_show_ime_selector(void); + +/** + * @brief Checks if the specific IME is enabled or disabled in the system keyboard setting. + * + * @details The IME developers can use this function to check their IME is enabled or not. + * + * @since_tizen 2.4 + * + * @param[in] app_id The application ID of the IME + * @param[out] enabled The On (enabled) and Off (disabled) state of the IME + * + * @return 0 on success, otherwise a negative error value + * @retval #IME_MANAGER_ERROR_NONE No error + * @retval #IME_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IME_MANAGER_ERROR_OPERATION_FAILED Operation failed + * + * @see ime_manager_show_ime_list + */ +EXPORT_API int ime_manager_is_ime_enabled(const char *app_id, bool *enabled); + +/** + * @brief Checks which IME is the current activated (selected) IME. + * + * @remarks @a app_id must be released using free(). + * + * @since_tizen 2.4 + * + * @param[out] app_id The application ID of the active IME + * + * @return 0 on success, otherwise a negative error value + * @retval #IME_MANAGER_ERROR_NONE No error + * @retval #IME_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #IME_MANAGER_ERROR_OPERATION_FAILED Operation failed + * + * @see ime_manager_show_ime_selector + */ +EXPORT_API int ime_manager_get_active_ime(char **app_id); + +/** + * @} + */ + +#ifdef __cplusplus +} +#endif + +#endif // __TIZEN_UIX_INPUTMETHOD_MANAGER_H__ + diff --git a/packaging/capi-ui-inputmethod-manager.spec b/packaging/capi-ui-inputmethod-manager.spec new file mode 100644 index 0000000..93713e4 --- /dev/null +++ b/packaging/capi-ui-inputmethod-manager.spec @@ -0,0 +1,63 @@ +Name: capi-ui-inputmethod-manager +Summary: Input Method Manager Library +Version: 0.0.1 +Release: 1 +Group: Graphics & UI Framework/Input +License: Apache-2.0 +Source0: %{name}-%{version}.tar.gz +BuildRequires: cmake +BuildRequires: pkgconfig(dlog) +BuildRequires: pkgconfig(isf) +Requires(post): /sbin/ldconfig +Requires(postun): /sbin/ldconfig + +%description + + +%package devel +Summary: Input Method Manager Library (Development) +Group: Development/Libraries +Requires: %{name} = %{version}-%{release} + +%description devel + + + +%prep +%setup -q + + +%build +export CFLAGS+=" -DTIZEN_DEBUG_ENABLE -fPIC -fvisibility=hidden" +export CXXFLAGS+=" -DTIZEN_DEBUG_ENABLE -fPIC -fvisibility=hidden" +export FFLAGS+=" -DTIZEN_DEBUG_ENABLE -fPIC -fvisibility=hidden" + +rm -rf CMakeFiles +rm -rf CMakeCache.txt +MAJORVER=`echo %{version} | awk 'BEGIN {FS="."}{print $1}'` +cmake . -DCMAKE_INSTALL_PREFIX=/usr -DFULLVER=%{version} -DMAJORVER=${MAJORVER} + +make %{?jobs:-j%jobs} + +%install +rm -rf %{buildroot} +%make_install +mkdir -p %{buildroot}/usr/share/license +cp LICENSE %{buildroot}/usr/share/license/%{name} + +%post -p /sbin/ldconfig + +%postun -p /sbin/ldconfig + + +%files +%manifest capi-ui-inputmethod-manager.manifest +%{_libdir}/libcapi-ui-inputmethod-manager.so* +/usr/share/license/capi-ui-inputmethod-manager + +%files devel +%{_includedir}/inputmethod-manager*.h +%{_libdir}/pkgconfig/*.pc +%{_libdir}/libcapi-ui-inputmethod-manager.so + +