Init Tizen 2.2.1
[framework/osp/web.git] / inc / FWebCtrlIWebKeypadEventListener.h
old mode 100755 (executable)
new mode 100644 (file)
index 7318aa3..e7feba6
@@ -36,9 +36,9 @@ namespace Tizen { namespace Web { namespace Controls
 
 /**
  * @interface  IWebKeypadEventListener
- * @brief          This interface provides a listener for keypad events invoked by the <textarea> or <input> tag, which has "text" or "password" value as its attribute.
+ * @brief              This interface provides a listener for keypad events invoked by the <textarea> or <input> tag, which has "text" or "password" value as its attribute.
  *
- * @since          2.0
+ * @since              2.0
  *
  * The %IWebKeypadEventListener interface provides a listener for keypad events invoked by the <textarea> or <input> tag, which has "text" or "password" value as its attribute.
  * It also enables the implementer class to receive the overlay keypad related events.
@@ -48,7 +48,8 @@ class _OSP_EXPORT_ IWebKeypadEventListener
 {
 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.
+        * 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.0
         */
@@ -57,24 +58,21 @@ public:
        /**
         * Called when the keypad is about to be shown on the screen.
         *
-        * @since               2.0
+        * @since               2.0
         *
-        * @param[in]           source          The source of the event
-        * @remarks             When the overlay keypad appears on the screen, the current Form's
-        *                      area is adjusted to account for the space that is taken up by the overlay keypad.
-        * @see                 Tizen::Ui::Controls::Form::GetClientAreaBounds()
+        * @param[in]   source                  The source of the event
         */
        virtual void OnWebKeypadWillOpen(Tizen::Web::Controls::Web& source) = 0;
 
        /**
         * Called when the keypad is shown on the screen.
         *
-        * @since               2.0
+        * @since               2.0
         *
-        * @param[in]           source          The source of the event
+        * @param[in]   source                  The source of the event
         * @remarks             When the overlay keypad appears on the screen, the current Form's
-        *                      area is adjusted to account for the space that is taken up by the overlay keypad.
-        * @see                 Tizen::Ui::Controls::Form::GetClientAreaBounds()
+        *                          area is adjusted to account for the space that is taken up by the overlay keypad.
+        * @see Tizen::Ui::Controls::Form::GetClientAreaBounds()
         */
        virtual void OnWebKeypadOpened(Tizen::Web::Controls::Web& source) = 0;
 
@@ -83,18 +81,18 @@ public:
         *
         * @since               2.0
         *
-        * @param[in]           source          The source of the event
-        * @see                 Tizen::Ui::Controls::Form::GetClientAreaBounds()
+        * @param[in]   source                  The source of the event
+        * @see Tizen::Ui::Controls::Form::GetClientAreaBounds()
         */
        virtual void OnWebKeypadClosed(Tizen::Web::Controls::Web& source) = 0;
 
        /**
-        * Called when the keypad bounds are changed, for instance when the predictive text window which is located in the upper side of the keypad is shown.
+        * Called when the keypad bounds are changed, for instance when the predictive text window which is located in the upper part of the keypad is shown.
         *
-        * @since 2.0
+        * @since               2.0
         *
-        * @param[in]           source          The source of the event
-        * @see                 Tizen::Ui::Controls::Form::GetClientAreaBounds()
+        * @param[in]   source                  The source of the event
+        * @see Tizen::Ui::Controls::Form::GetClientAreaBounds()
         */
        virtual void OnWebKeypadBoundsChanged(Tizen::Web::Controls::Web& source) {};