* @brief This interface provides a listener for the InputMethod class to receive asynchronous callbacks from the input service.
* @since 2.1
*
- * @remarks IME application developers can implement a class that is derived from %IInputMethodListener and use it to receive asynchronous callbacks
+ * @remarks The IME application developers can implement a class that is derived from %IInputMethodListener and use it to receive asynchronous callbacks
* from the input service.
*
* @privlevel partner
* @privilege http://tizen.org/privilege/ime
*
- * The %IInputMethodListener provides a listener for the %InputMethod class to receive asynchronous callbacks from the input service.
+ * The %IInputMethodListener interface provides a listener for the InputMethod class to receive asynchronous callbacks from the input service.
*
* The following example demonstrates how to use the %IInputMethodListener interface.
* @code
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without
- // prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.1
//
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without
- // prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.1
//
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without
- // prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.1
//
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without
- // prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.1
//
/**
* @interface IInputMethodProvider
- * @brief This is an interface for the InputMethod class that interacts with the associated text input UI control.
+ * @brief This interface is for the InputMethod class that interacts with the associated text input UI control.
* @since 2.1
*
* @remarks The IME application developers can implement a class derived from %IInputMethodProvider and set it as the provider of the InputMethod class.
* @privlevel partner
* @privilege http://tizen.org/privilege/ime
*
- * The %IInputMethodProvider interface is an interface for the InputMethod class that interacts with the associated text input UI control.
+ * The %IInputMethodProvider interface is for the InputMethod class that interacts with the associated text input UI control.
*
* The following example demonstrates how to use the %IInputMethodProvider interface.
* @code
virtual ~IInputMethodProvider(void) {}
/**
- * Called when the associated text input UI control requests the enter key action of the input panel.
+ * Called when an associated text input UI control requests the enter key action of the input panel.
*
* @since 2.1
* @privlevel partner
}
/**
- * Called when the associated text input UI control requests the position and size of the input panel.
+ * Called when an associated text input UI control requests the position and size of the input panel.
*
* @since 2.1
* @privlevel partner
virtual Tizen::Graphics::Rectangle GetInputPanelBounds(void) = 0;
/**
- * Called when the associated text input UI control requests the style of the input panel.
+ * Called when an associated text input UI control requests the style of the input panel.
*
* @since 2.1
* @privlevel partner
}
/**
- * Called when the associated text input UI control requests the input panel to enable or disable the caps mode.
+ * Called when an associated text input UI control requests the input panel to enable or disable the caps mode.
*
* @since 2.1
* @privlevel partner
virtual void SetCapsModeEnabled(bool enable) {}
/**
- * Called when the associated text input UI control requests the input panel to set the enter key action.
+ * Called when an associated text input UI control requests the input panel to set the enter key action.
*
* @since 2.1
* @privlevel partner
virtual void SetEnterKeyAction(Tizen::Ui::InputPanelAction action) {}
/**
- * Called when the associated text input UI control requests the input panel to enable or disable the enter key action.
+ * Called when an associated text input UI control requests the input panel to enable or disable the enter key action.
*
* @since 2.1
* @privlevel partner
virtual void SetEnterKeyActionEnabled(bool enable) {}
/**
- * Called when the associated text input UI control requests the input panel to set its style.
+ * Called when an associated text input UI control requests the input panel to set its style.
*
* @since 2.1
* @privlevel partner
virtual void SetInputPanelStyle(Tizen::Ui::InputPanelStyle style) {}
/**
- * Called when the associated text input UI control requests the input panel to hide itself.
+ * Called when an associated text input UI control requests the input panel to hide itself.
*
* @since 2.1
* @privlevel partner
virtual void HideInputPanel(void) = 0;
/**
- * Called when the associated text input UI control checks whether the enter key action is enabled or not.
+ * Called when an associated text input UI control checks whether the enter key action is enabled or not.
*
* @since 2.1
* @privlevel partner
}
/**
- * Called when the associated text input UI control requests the input panel to show itself.
+ * Called when an associated text input UI control requests the input panel to show itself.
*
* @since 2.1
* @privlevel partner
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without
- // prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.1
//
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without
- // prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.1
//
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without
- // prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.1
//
// This method is for internal use only. Using this method can cause behavioral, security-related,
// and consistency-related issues in the application.
//
- // Following method is reserved and may change its name at any time without
- // prior notice.
+ // This method is reserved and may change its name at any time without prior notice.
//
// @since 2.1
//
/**
* @class InputMethod
- * @brief This class provides a standard implementation of the %InputMethod.
+ * @brief This class provides a standard implementation of the %InputMethod class.
* @since 2.1
*
* @final This class is not intended for extension.
- * @remarks IME application developers can use the %InputMethod to communicate with the associated text input UI control. First, set the provider which
+ * @remarks The IME application developers can use the %InputMethod class to communicate with the associated text input UI control. First, set the provider which
* provides attributes of the soft input panel. Next, set the listener which lets the IME application receive asynchronous callbacks from the input service. These
- * allow the IME application to interact with the associated text input UI control properly. After that, request the %InputMethod to send a text or a key event
+ * allow the IME application to interact with the associated text input UI control properly. After that, request the %InputMethod class to send a text or a key event
* which is to be displayed in the associated text input UI control.
*
* @privlevel partner
* @privilege http://tizen.org/privilege/ime
*
- * The %InputMethod provides a standard implementation of the %InputMethod.
+ * The %InputMethod class provides a standard implementation of the %InputMethod class.
*
* The following example demonstrates how to use the %InputMethod class.
* @code
{
public:
/**
- * Gets an instance of the %InputMethod.
+ * Gets an instance of %InputMethod.
*
* @since 2.1
* @privlevel partner
* @privilege http://tizen.org/privilege/ime
*
- * @return An instance of the %InputMethod
+ * @return An instance of %InputMethod
* @exception E_SUCCESS The method is successful.
* @exception E_CONNECTION_FAILED The connection to the input service fails.
* @exception E_SYSTEM A failure occurs from the underlying system.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The specific error code can be accessed using the GetLastResult() method and OOM might be thrown by this method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method and the OOM exception might be thrown by this method.
*/
static InputMethod* GetInstance(void);
/**
- * Sets an instance of the IInputMethodProvider.
+ * Sets an instance of IInputMethodProvider.
*
* @since 2.1
* @privlevel partner
* @privilege http://tizen.org/privilege/ime
*
- * @param[in] pProvider An instance of the IInputMethodProvider
+ * @param[in] pProvider An instance of IInputMethodProvider
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The %InputMethod accepts only one provider. So users should unregister the provider by setting @c pProvider as @c null before
+ * @remarks The %InputMethod instance accepts only one provider. So users must unregister the provider by setting @c pProvider as @c null before
* deallocating an instance of the provider.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void SetInputMethodProvider(IInputMethodProvider* pProvider);
/**
- * Sets an instance of the IInputMethodListener.
+ * Sets an instance of IInputMethodListener.
*
* @since 2.1
* @privlevel partner
* @privilege http://tizen.org/privilege/ime
*
- * @param[in] pListener An instance of the IInputMethodListener
+ * @param[in] pListener An instance of IInputMethodListener
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The %InputMethod accepts only one listener. So users should unregister the listener by setting @c pListener as @c null before
+ * @remarks The %InputMethod instance accepts only one listener. So users must unregister the listener by setting @c pListener as @c null before
* deallocating an instance of the listener.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void SetInputMethodListener(IInputMethodListener* pListener);
/**
- * Deletes text at the position of the cursor.
+ * Deletes a text at the position of the cursor.
*
* @since 2.1
* @privlevel partner
result SendKeyEvent(Tizen::Ui::KeyCode code, Tizen::Ui::KeyState state);
/**
- * Sends text to the associated text input UI control.
+ * Sends a text to the associated text input UI control.
*
* @since 2.1
* @privlevel partner
\r
/**\r
* @class InputMethodInfo\r
- * @brief This class provides a standard implementation of the %InputMethodInfo.\r
+ * @brief This class provides a standard implementation of the %InputMethodInfo class.\r
* @since 2.1\r
*\r
* @final This class is not intended for extension.\r
* @privlevel platform\r
* @privilege http://tizen.org/privilege/imemanager\r
*\r
- * The %InputMethodInfo class provides a standard implementation of the %InputMethodInfo.\r
+ * The %InputMethodInfo class provides a standard implementation of the %InputMethodInfo class.\r
*\r
*/\r
class _OSP_EXPORT_ InputMethodInfo\r
* @privlevel platform\r
* @privilege http://tizen.org/privilege/imemanager\r
*\r
- * @return An instance of the language list that consists of the Locale instances\r
+ * @return An instance of the language list that consists of the Tizen::Locales::Locale instances\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @remarks The %InputMethodInfo automatically deallocates the memory of the language list when it is destroyed. Therefore a user should not\r
- * manually deallocate the memory of the language list.\r
+ * @remarks The %InputMethodInfo instance automatically deallocates the memory assigned to the language list when it is destroyed. Therefore, a user must not\r
+ * manually deallocate the memory assigned to the language list.\r
*/\r
const Tizen::Base::Collection::IList* GetLanguageList(void) const;\r
\r
* @privlevel platform\r
* @privilege http://tizen.org/privilege/imemanager\r
*\r
- * @return The name\r
+ * @return The name of an input method\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
*/\r
\r
/**\r
* @class InputMethodManager\r
- * @brief This class provides a standard implementation of the %InputMethodManager.\r
+ * @brief This class provides a standard implementation of the %InputMethodManager class.\r
* @since 2.1\r
*\r
* @final This class is not intended for extension.\r
* @privlevel platform\r
* @privilege http://tizen.org/privilege/imemanager\r
*\r
- * The %InputMethodManager provides a standard implementation of the %InputMethodManager.\r
+ * The %InputMethodManager class provides a standard implementation of the %InputMethodManager class.\r
*\r
*/\r
class _OSP_EXPORT_ InputMethodManager\r
{\r
public:\r
/**\r
- * Gets an instance of the %InputMethodManager.\r
+ * Gets an instance of %InputMethodManager.\r
*\r
* @since 2.1\r
* @privlevel platform\r
* @privilege http://tizen.org/privilege/imemanager\r
*\r
- * @return An instance of the %InputMethodManager\r
+ * @return An instance of %InputMethodManager \r
* @exception E_SUCCESS The method is successful.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
- * @remarks The specific error code can be accessed using the GetLastResult() method and OOM might be thrown by this method.\r
+ * @remarks The specific error code can be accessed using the GetLastResult() method and the OOM exception might be thrown by this method.\r
*/\r
static InputMethodManager* GetInstance(void);\r
\r
InputMethodInfo* GetActiveInputMethodInfoN(void) const;\r
\r
/**\r
- * Gets the list of the %InputMethodInfo of the input methods installed in the system.\r
+ * Gets the list of InputMethodInfo for all the input methods installed in a system.\r
*\r
* @since 2.1\r
* @privlevel platform\r
* @return An error code\r
* @param[in] id An application ID\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_APP_NOT_INSTALLED The specified ID doesn't match with any of the application ID for the input method installed in the system.\r
+ * @exception E_APP_NOT_INSTALLED The specified ID does not match with any of the application IDs for the input methods installed in the system.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
*/\r
result SetInputMethod(const Tizen::App::AppId& id);\r
projects / platform / framework / native / ime.git / commitdiff