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 a native object.
  40  *
  41  * @since               2.0
  42  *
  43  * The %IJavaScriptBridge interface provides a communication channel between JavaScript and a 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. @n
  53         * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  54         *
  55         * @since                        2.0
  56         */
  57         virtual ~IJavaScriptBridge(void) {}
  58
  59         /**
  60          * Called asynchronously on an invocation request from JavaScript through the requestToNative() method.
  61          *
  62          * @since                       2.0
  63          *
  64          * @param[in] pArg      The parameters delivered by JavaScript
  65          */
  66         virtual void HandleJavaScriptRequestN(Tizen::Web::Json::IJsonValue* pArg) = 0;
  67
  68         /**
  69          * Gets the name of %IJavaScriptBridge to identify each %IJavaScriptBridge.
  70          *
  71          * @since               2.0
  72          *
  73          * @return      The name of %IJavaScriptBridge
  74          */
  75         virtual Tizen::Base::String GetName(void) = 0;
  76
  77 protected:
  78         //
  79         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  80         //
  81         // Gets the Impl instance.
  82         //
  83         // @since               2.0
  84         //
  85         virtual void IJavaScriptBridge_Reserved1(void) {}
  86
  87         //
  88         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  89         //
  90         // Gets the Impl instance.
  91         //
  92         // @since               2.0
  93         //
  94         virtual void IJavaScriptBridge_Reserved2(void) {}
  95
  96         //
  97         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  98         //
  99         // Gets the Impl instance.
 100         //
 101         // @since               2.0
 102         //
 103         virtual void IJavaScriptBridge_Reserved3(void) {}
 104
 105         //
 106         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 107         //
 108         // Gets the Impl instance.
 109         //
 110         // @since               2.0
 111         //
 112         virtual void IJavaScriptBridge_Reserved4(void) {}
 113
 114         //
 115         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 116         //
 117         // Gets the Impl instance.
 118         //
 119         // @since               2.0
 120         //
 121         virtual void IJavaScriptBridge_Reserved5(void) {}
 122
 123 }; // IJavaScriptBridge
 124
 125 }}} // Tizen::Web::Controls
 126 #endif // _FWEB_CTRL_IJAVA_SCRIPT_BRIDGE_H_