Merge missed development codes.

[framework/osp/ime.git] / inc / FUiImeIInputMethodListener.h

diff --git a/inc/FUiImeIInputMethodListener.h b/inc/FUiImeIInputMethodListener.h
index 06381c2..31591ec 100644 (file)
--- a/inc/FUiImeIInputMethodListener.h
+++ b/inc/FUiImeIInputMethodListener.h
@@ -64,7 +64,7 @@ class _OSP_EXPORT_ IInputMethodListener
        : virtual public Tizen::Base::Runtime::IEventListener
 {
 public:
-       /** 
+       /**
        * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this
        * interface is called.
        *
@@ -74,7 +74,7 @@ public:
        */
        virtual ~IInputMethodListener(void) {}
 
-       /** 
+       /**
        * Called when the position of the cursor in an associated text input UI control changes.
        *
        * @since 2.1
@@ -85,7 +85,21 @@ public:
        */
        virtual void OnCursorPositionChanged(int position) {}
 
-       /** 
+       /**
+       * Called when a client of the input method sends the opaque command.
+       *
+       * @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".
+       */
+       virtual void OnOpaqueCommandReceived(const Tizen::Base::String& command) {}
+
+       /**
        * Called when an associated text input UI control responds to a request with the surrounding text.
        *
        * @since 2.1
@@ -143,17 +157,6 @@ protected:
        // @since 2.1
        //
        virtual void IInputMethodListener_Reserved4(void) {}
-
-       //
-       // 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.
-       //
-       // @since 2.1
-       //
-       virtual void IInputMethodListener_Reserved5(void) {}
 };
 
 }}} // Tizen::Ui::Ime