inc/FWebCtrlIJavaScriptBridge.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file                FWebCtrlIJavaScriptBridge.h
  20  * @brief               This is the header file for the %IJavaScriptBridge interface.
  21  *
  22  * This header file contains the declarations of the %IJavaScriptBridge interface.
  23  */
  24 #ifndef _FWEB_CTRL_IJAVA_SCRIPT_BRIDGE_H_
  25 #define _FWEB_CTRL_IJAVA_SCRIPT_BRIDGE_H_
  26
  27 #include <FBaseString.h>
  28
  29 namespace Tizen { namespace Web { namespace Json
  30 {
  31 class IJsonValue;
  32 }}} // Tizen::Web::Json
  33
  34 namespace Tizen { namespace Web { namespace Controls
  35 {
  36
  37 /**
  38  * @interface   IJavaScriptBridge
  39  * @brief               This interface provides a communication channel between JavaScript and native object.
  40  *
  41  * @since               2.0
  42  *
  43  * The %IJavaScriptBridge interface provides a communication channel between JavaScript and native object.
  44  *
  45  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/controls_namespace.htm">Web Controls Guide</a>.
  46  *
  47  */
  48 class _OSP_EXPORT_ IJavaScriptBridge
  49 {
  50 public:
  51         /**
  52         * 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.
  53         *
  54         * @since                        2.0
  55         */
  56         virtual ~IJavaScriptBridge(void) {}
  57
  58         /**
  59          * Called asynchronously on invocation request from JavaScript side through the requestToNative() method.
  60          *
  61          * @since                       2.0
  62          *
  63          * @param[in] pArg      The parameters delivered by JavaScript
  64          */
  65         virtual void HandleJavaScriptRequestN(Tizen::Web::Json::IJsonValue* pArg) = 0;
  66
  67         /**
  68          * Gets the name of %IJavaScriptBridge to identify each %IJavaScriptBridge.
  69          *
  70          * @since               2.0
  71          *
  72          * @return      The name of %IJavaScriptBridge
  73          */
  74         virtual Tizen::Base::String GetName(void) = 0;
  75
  76 protected:
  77         //
  78         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  79         //
  80         // Gets the Impl instance.
  81         //
  82         // @since               2.0
  83         //
  84         virtual void IJavaScriptBridge_Reserved1(void) {}
  85
  86         //
  87         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  88         //
  89         // Gets the Impl instance.
  90         //
  91         // @since               2.0
  92         //
  93         virtual void IJavaScriptBridge_Reserved2(void) {}
  94
  95         //
  96         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  97         //
  98         // Gets the Impl instance.
  99         //
 100         // @since               2.0
 101         //
 102         virtual void IJavaScriptBridge_Reserved3(void) {}
 103
 104         //
 105         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 106         //
 107         // Gets the Impl instance.
 108         //
 109         // @since               2.0
 110         //
 111         virtual void IJavaScriptBridge_Reserved4(void) {}
 112
 113         //
 114         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 115         //
 116         // Gets the Impl instance.
 117         //
 118         // @since               2.0
 119         //
 120         virtual void IJavaScriptBridge_Reserved5(void) {}
 121
 122 }; // IJavaScriptBridge
 123
 124 }}} // Tizen::Web::Controls
 125 #endif // _FWEB_CTRL_IJAVA_SCRIPT_BRIDGE_H_