projects / platform / core / uifw / dali-toolkit.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: b6e05a0)
Change WebView API 21/193921/9
authorJiyun Yang <ji.yang@samsung.com>
Wed, 21 Nov 2018 10:53:39 +0000 (19:53 +0900)
committerJiyun Yang <ji.yang@samsung.com>
Mon, 21 Jan 2019 05:31:09 +0000 (14:31 +0900)
* Rename AddJavaScriptInterface to AddJavaScriptMessageHandler
* Change arguments of AddJavaScriptMessageHandler
* Remove RemoveJavascriptInterface

Change-Id: I8bd1eba255fec8913410cac82527be53e5daa832
Signed-off-by: Jiyun Yang <ji.yang@samsung.com>
automated-tests/src/dali-toolkit/dali-toolkit-test-utils/toolkit-web-engine.cpp patch | blob | history
automated-tests/src/dali-toolkit/utc-Dali-WebView.cpp patch | blob | history
dali-toolkit/devel-api/controls/web-view/web-view.cpp patch | blob | history
dali-toolkit/devel-api/controls/web-view/web-view.h patch | blob | history
dali-toolkit/internal/controls/web-view/web-view-impl.cpp patch | blob | history
dali-toolkit/internal/controls/web-view/web-view-impl.h patch | blob | history

diff --git a/automated-tests/src/dali-toolkit/dali-toolkit-test-utils/toolkit-web-engine.cpp b/automated-tests/src/dali-toolkit/dali-toolkit-test-utils/toolkit-web-engine.cpp
index 3f2797a491a87fdad6db191e6418a0404a3550d1..29f26b9e759b396318f1056d850bb81b6614d3aa 100755 (executable)
--- a/automated-tests/src/dali-toolkit/dali-toolkit-test-utils/toolkit-web-engine.cpp
+++ b/automated-tests/src/dali-toolkit/dali-toolkit-test-utils/toolkit-web-engine.cpp
@@ -307,11 +307,7 @@ void WebEngine::EvaluateJavaScript( const std::string& script )
 {
 }
 
-void WebEngine::AddJavaScriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName, std::function< std::string(const std::string&) > cb )
-{
-}
-
-void WebEngine::RemoveJavascriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName )
+void WebEngine::AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void(const std::string&) > handler )
 {
 }
 
diff --git a/automated-tests/src/dali-toolkit/utc-Dali-WebView.cpp b/automated-tests/src/dali-toolkit/utc-Dali-WebView.cpp
index e2ee8e6dc4ac8b181872d952ecc6f0cec7b8b689..cd49363d221da92a9514fad19fa598568e4f8763 100644 (file)
--- a/automated-tests/src/dali-toolkit/utc-Dali-WebView.cpp
+++ b/automated-tests/src/dali-toolkit/utc-Dali-WebView.cpp
@@ -265,13 +265,11 @@ int UtcDaliWebViewMethodsForCoverage(void)
   WebView view = WebView::New( "ko-KR", "Asia/Seoul" );
 
   view.LoadHTMLString( "<body>Hello World!</body>" );
-  view.AddJavaScriptInterface( "jsObject", "jsFunction",
-    []( const std::string& arg ) -> std::string {
-      return arg + " World!";
+  view.AddJavaScriptMessageHandler( "jsObject",
+    []( const std::string& arg ) {
     }
   );
-  view.EvaluateJavaScript( "jsObject.jsFunction('Hello')" );
-  view.RemoveJavascriptInterface( "jsObject", "jsFunction" );
+  view.EvaluateJavaScript( "jsObject.postMessage('Hello')" );
 
   DALI_TEST_CHECK( view );
 
diff --git a/dali-toolkit/devel-api/controls/web-view/web-view.cpp b/dali-toolkit/devel-api/controls/web-view/web-view.cpp
index 0b3698b345a52110729ef6b467d878068e88f71b..0d1c6809343ecd685ce1976dc4e3a0391119aa15 100644 (file)
--- a/dali-toolkit/devel-api/controls/web-view/web-view.cpp
+++ b/dali-toolkit/devel-api/controls/web-view/web-view.cpp
@@ -115,14 +115,9 @@ void WebView::EvaluateJavaScript( const std::string& script )
   Dali::Toolkit::GetImpl( *this ).EvaluateJavaScript( script );
 }
 
-void WebView::AddJavaScriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName, std::function< std::string(const std::string&) > callback )
+void WebView::AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler )
 {
-  Dali::Toolkit::GetImpl( *this ).AddJavaScriptInterface( exposedObjectName, jsFunctionName, callback );
-}
-
-void WebView::RemoveJavascriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName )
-{
-  Dali::Toolkit::GetImpl( *this ).RemoveJavascriptInterface( exposedObjectName, jsFunctionName );
+  Dali::Toolkit::GetImpl( *this ).AddJavaScriptMessageHandler( exposedObjectName, handler );
 }
 
 void WebView::ClearHistory()
diff --git a/dali-toolkit/devel-api/controls/web-view/web-view.h b/dali-toolkit/devel-api/controls/web-view/web-view.h
index 71d05d3f54c9e0b6b6f74c31da0a0126b01af49b..8d33f3a9ea8389ba02977d7d639743d2c99dd88b 100644 (file)
--- a/dali-toolkit/devel-api/controls/web-view/web-view.h
+++ b/dali-toolkit/devel-api/controls/web-view/web-view.h
@@ -191,28 +191,37 @@ public:
   void GoBack();
 
   /**
-    * @brief Evaluates JavaScript code represented as a string.
-    *
-    * @param[in] script The JavaScript code
-    */
+   * @brief Evaluates JavaScript code represented as a string.
+   *
+   * @param[in] script The JavaScript code
+   */
   void EvaluateJavaScript( const std::string& script );
 
   /**
-    * @brief Adds a JavaScript interface.
-    *
-    * @param[in] exposedObjectName The name of exposed object
-    * @param[in] jsFunctionName The name of JavaScript function
-    * @param[in] callback The callback function
-    */
-  void AddJavaScriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName, std::function< std::string(const std::string&) > callback );
-
-  /**
-    * @brief Removes a JavaScript interface.
-    *
-    * @param[in] exposedObjectName The name of exposed object
-    * @param[in] jsFunctionName The name of JavaScript function
-    */
-  void RemoveJavascriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName );
+   * @brief Inject a JavaScript object with a message handler into the WebView.
+   *
+   * @note The injected object will appear in the JavaScript context to be loaded next.
+   *
+   * Example:
+   *
+   * 1. Native
+   *
+   *     webview.AddJavaScriptMessageHandler( "myObject", []( const std::string& message ) {
+   *         printf( "Received a message from JS: %s", message.c_str() );
+   *     });
+   *
+   *     // Start WebView by loading URL
+   *     webview.LoadUrl( url );
+   *
+   * 2. JavaScript
+   *
+   *     myObject.postMessage( "Hello World!" ); // "Received a message from JS: Hello World!"
+   *
+   *
+   * @param[in] exposedObjectName The name of exposed object
+   * @param[in] handler The callback function
+   */
+  void AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler );
 
   /**
    * @brief Clears the history of Web.
diff --git a/dali-toolkit/internal/controls/web-view/web-view-impl.cpp b/dali-toolkit/internal/controls/web-view/web-view-impl.cpp
index 9cc4454bfdc377f8ffb050975aaabc326b835640..5836f42537083a9a3974a6f7ff4adec3df194ed8 100644 (file)
--- a/dali-toolkit/internal/controls/web-view/web-view-impl.cpp
+++ b/dali-toolkit/internal/controls/web-view/web-view-impl.cpp
@@ -200,19 +200,11 @@ void WebView::EvaluateJavaScript( const std::string& script )
   }
 }
 
-void WebView::AddJavaScriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName, std::function< std::string(const std::string&) > callback )
+void WebView::AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler )
 {
   if ( mWebEngine )
   {
-    mWebEngine.AddJavaScriptInterface( exposedObjectName, jsFunctionName, callback );
-  }
-}
-
-void WebView::RemoveJavascriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName )
-{
-  if ( mWebEngine )
-  {
-    mWebEngine.RemoveJavascriptInterface( exposedObjectName, jsFunctionName );
+    mWebEngine.AddJavaScriptMessageHandler( exposedObjectName, handler );
   }
 }
 
diff --git a/dali-toolkit/internal/controls/web-view/web-view-impl.h b/dali-toolkit/internal/controls/web-view/web-view-impl.h
index 54a679ff142df43e581ddb12833912e33fc61449..2bc7ddf719894701c808a5ddcc6d07ff1307098c 100644 (file)
--- a/dali-toolkit/internal/controls/web-view/web-view-impl.h
+++ b/dali-toolkit/internal/controls/web-view/web-view-impl.h
@@ -113,14 +113,9 @@ public:
   void EvaluateJavaScript( const std::string& script );
 
   /**
-   * @copydoc Dali::WebEngine::AddJavaScriptInterface()
+   * @copydoc Dali::WebEngine::AddJavaScriptMessageHandler()
    */
-  void AddJavaScriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName, std::function< std::string(const std::string&) > callback );
-
-  /**
-   * @copydoc Dali::WebEngine::RemoveJavascriptInterface()
-   */
-  void RemoveJavascriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName );
+  void AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler );
 
   /**
    * @copydoc Dali::WebEngine::ClearHistory()
Domain: Graphics System / DALi;