* @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 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.
* class MyListener
* : public IInputMethodListener
* {
- * ...
- * virtual void OnCursorPositionChanged(int position);
- * ...
+ * //...
+ * virtual void OnCursorPositionChanged(int position);
+ * virtual void OnOpaqueCommandReceived(const Tizen::Base::String& command);
+ * virtual void OnSurroundingTextReceived(const Tizen::Base::String& text, int cursorPosition);
+ * //...
* };
* @endcode
*
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this
+ * This polymorphic destructor should be overridden if required. @n This way, the destructors of the derived classes are called when the destructor of this
* interface is called.
*
* @since 2.1
virtual void OnCursorPositionChanged(int position) {}
/**
- * Called when a client of the input method sends the opaque command.
+ * Called when a client of the input method sends the opaque command. @n
+ * The opaque command is the engaged command between the certain input method and their clients which know opaque commands. @n
+ * It is for additional options that the input method does not provide.
*
* @since 2.1
* @privlevel partner
* @privilege %http://tizen.org/privilege/ime
*
- * @param[in] command The opaque command
- * @remarks The opaque command is the engaged command between the certain input method and their clients which know opaque commands. It is for
- * additional options that the input method does not provide. A string format of the opaque command can be described as like
- * "org.tizen.MyApp.OpaqueCommand=True".
+ * @param[in] command The opaque command that is a string format like "org.tizen.MyApp.OpaqueCommand=True"
*/
virtual void OnOpaqueCommandReceived(const Tizen::Base::String& command) {}
/**
- * Called when an associated text input UI control responds to a request with the surrounding text.
+ * Called when an associated text input UI control responds to a request with the surrounding text. @n
+ * The surrounding text can be requested by the Tizen::Ui::Ime::InputMethod::RequestSurroundingText() method.
*
* @since 2.1
* @privlevel partner
* @privilege %http://tizen.org/privilege/ime
*
- * @param[in] text The surrounding text
+ * @param[in] text The surrounding text @n
+ * The length of the surrounding text can be less than that requested by the user.
* @param[in] cursorPosition The position of the cursor
- * @remarks The surrounding text can be requested by the Tizen::Ui::Ime::InputMethod::RequestSurroundingText() method. The length of the
- * surrounding text can be less than that requested by the user.
*/
virtual void OnSurroundingTextReceived(const Tizen::Base::String& text, int cursorPosition) {}
* The IME application can then provide attributes for the soft input panel and operate according to the commands of the associated text input UI control. For
* example, when ShowInputPanel() or HideInputPanel() are called, the IME application's frame should either be hidden or made visible.
*
- * @privlevel partner
- * @privilege %http://tizen.org/privilege/ime
- *
* 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.
* class MyProvider
* : public IInputMethodProvider
* {
- * ...
- * virtual Tizen::Ui::InputPanelAction GetEnterKeyAction(void);
- * virtual Tizen::Graphics::Rectangle GetInputPanelBounds(void);
- * ...
+ * //...
+ * virtual Tizen::Graphics::Rectangle GetInputPanelBounds(void);
+ * virtual void HideInputPanel(void);
+ * virtual void ShowInputPanel(void);
+ * //...
* };
* @endcode
*
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this
+ * This polymorphic destructor should be overridden if required. @n This way, the destructors of the derived classes are called when the destructor of this
* interface is called.
*
* @since 2.1
virtual void SetCapsModeEnabled(bool enable) {}
/**
- * Called when an 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. @n
+ * The input panel can show text on the enter button according to the enter key action.
*
* @since 2.1
* @privlevel partner
* @privilege %http://tizen.org/privilege/ime
*
* @param[in] action The enter key action
- * @remarks The input panel can show text on the enter button according to the enter key action.
*/
virtual void SetEnterKeyAction(Tizen::Ui::InputPanelAction action) {}
* @since 2.1
* @privlevel partner
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The IME application developer should implement this interface.
*/
virtual void HideInputPanel(void) = 0;
* @since 2.1
* @privlevel partner
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The IME application developer should implement this interface.
*/
virtual void ShowInputPanel(void) = 0;
* 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 class provides a standard implementation of the %InputMethod class.
*
* The following example demonstrates how to use the %InputMethod class.
* class MyProvider
* : public IInputMethodProvider
* {
- * ...
+ * //...
* };
*
* class MyListener
* : public IInputMethodListener
* {
- * ...
+ * //...
* };
*
* class MyImeApp
* {
* public:
- * ...
+ * //...
* void Construct();
* };
*
* @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 the OOM exception might be thrown by this method.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - There is a high probability for an occurrence of an out-of-memory exception. @n If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
static InputMethod* GetInstance(void);
/**
- * Sets an instance of IInputMethodProvider.
+ * Sets an instance of IInputMethodProvider. @n
+ * The %InputMethod instance accepts only one provider. So users must unregister the provider by setting the specified @c pProvider as @c null before deallocating
+ * an instance of the provider.
*
* @since 2.1
* @privlevel partner
* @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 specific error code can be accessed using the GetLastResult() method.
- * - 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 IInputMethodListener.
+ * Sets an instance of IInputMethodListener. @n
+ * The %InputMethod instance accepts only one listener. So users must unregister the listener by setting the specified @c pListener as @c null before deallocating an
+ * instance of the listener.
*
* @since 2.1
* @privlevel partner
* @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 specific error code can be accessed using the GetLastResult() method.
- * - 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);
* @param[in] cursorOffset The offset value from the cursor position
* @param[in] length The length of the text to delete
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The @c length is less than or equal to @c 0.
+ * @exception E_INVALID_ARG The specified @c length is less than or equal to @c 0.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result DeleteText(int cursorOffset, int length);
result NotifyLanguageChanged(void);
/**
- * Requests the surrounding text from the position of the cursor.
+ * Requests the surrounding text from the position of the cursor. @n
+ * The requested surrounding text can be received using the Tizen::Ui::Ime::IInputMethodListener::OnSurroundingTextReceived() method.
*
* @since 2.1
* @privlevel partner
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The arguments are less than @c 0.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The requested surrounding text can be received using the Tizen::Ui::Ime::IInputMethodListener::OnSurroundingTextReceived() method.
*/
result RequestSurroundingText(int lengthBeforeCursor, int lengthAfterCursor);
/**
- * Sends a composite text to the associated text input UI control.
+ * Sends a composite text that is being modified to the associated text input UI control.
*
* @since 2.1
* @privlevel partner
* @param[in] text The composite text to send
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The composite text means a text which is being modified.
*/
result SendCompositeText(const Tizen::Base::String& text);
* @final This class is not intended for extension.\r
* @remarks A user can get the general information of the input method.\r
*\r
- * @privlevel platform\r
- * @privilege %http://tizen.org/privilege/imemanager\r
- *\r
* The %InputMethodInfo class provides a standard implementation of the %InputMethodInfo class.\r
*\r
*/\r
* @final This class is not intended for extension.\r
* @remarks A user can manage input methods installed in the system.\r
*\r
- * @privlevel platform\r
- * @privilege %http://tizen.org/privilege/imemanager\r
- *\r
* The %InputMethodManager class provides a standard implementation of the %InputMethodManager class.\r
*\r
*/\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 the OOM exception might be thrown by this method.\r
+ * @remarks \r
+ * - The specific error code can be accessed using the GetLastResult() method.\r
+ * - There is a high probability for an occurrence of an out-of-memory exception. @n If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.\r
*/\r
static InputMethodManager* GetInstance(void);\r
\r
* @privlevel platform\r
* @privilege %http://tizen.org/privilege/imemanager\r
*\r
- * @return An instance of the InputMethodInfo\r
+ * @return An instance of the InputMethodInfo @n\r
+ * This method returns @c null if it fails.\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 If an error occurs then this function returns @c null and the specific error code can be accessed using the GetLastResult() method.\r
+ * @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
InputMethodInfo* GetActiveInputMethodInfoN(void) const;\r
\r
projects / framework / osp / ime.git / commitdiff