Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(295)

Unified Diff: ios/public/provider/web/web_ui_ios.h

Issue 1110213002: Upstream most of the iOS WebUI support in ios/web/ (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 5 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: ios/public/provider/web/web_ui_ios.h
diff --git a/ios/public/provider/web/web_ui_ios.h b/ios/public/provider/web/web_ui_ios.h
new file mode 100644
index 0000000000000000000000000000000000000000..4a88043f23670b1e91d8a0f4406580fe67507611
--- /dev/null
+++ b/ios/public/provider/web/web_ui_ios.h
@@ -0,0 +1,87 @@
+// Copyright 2014 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef IOS_PUBLIC_PROVIDER_WEB_WEB_UI_IOS_H_
+#define IOS_PUBLIC_PROVIDER_WEB_WEB_UI_IOS_H_
+
+#include <vector>
+
+#include "base/basictypes.h"
+#include "base/callback.h"
+#include "base/strings/string16.h"
+
+class GURL;
+
+namespace base {
+class ListValue;
+class Value;
+}
+
+namespace web {
+
+class WebState;
+class WebUIIOSController;
+class WebUIIOSMessageHandler;
+
+// A WebUIIOS sets up the datasources and message handlers for a given
+// HTML-based UI.
+class WebUIIOS {
+ public:
+ // Returns JavaScript code that, when executed, calls the function specified
+ // by |function_name| with the arguments specified in |arg_list|.
+ static base::string16 GetJavascriptCall(
+ const std::string& function_name,
+ const std::vector<const base::Value*>& arg_list);
+
+ virtual ~WebUIIOS() {}
+
Eugene But (OOO till 7-30) 2015/04/28 20:23:01 NIT: Do you need comments for these?
+ virtual web::WebState* GetWebState() const = 0;
+
+ virtual WebUIIOSController* GetController() const = 0;
+ virtual void SetController(WebUIIOSController* controller) = 0;
+
+ // Takes ownership of |handler|, which will be destroyed when the WebUIIOS is.
+ virtual void AddMessageHandler(WebUIIOSMessageHandler* handler) = 0;
+
+ // Used by WebUIIOSMessageHandlers. If the given message is already
+ // registered, the call has no effect unless |register_callback_overwrites_|
+ // is set to true.
+ typedef base::Callback<void(const base::ListValue*)> MessageCallback;
+ virtual void RegisterMessageCallback(const std::string& message,
+ const MessageCallback& callback) = 0;
+
+ // This is only needed if an embedder overrides handling of a WebUIIOSMessage
+ // and then later wants to undo that, or to route it to a different WebUIIOS
+ // object.
+ virtual void ProcessWebUIIOSMessage(const GURL& source_url,
+ const std::string& message,
+ const base::ListValue& args) = 0;
+
+ // Call a Javascript function. This is asynchronous; there's no way to get
+ // the result of the call, and should be thought of more like sending a
+ // message to the page. All function names in WebUI must consist of only
+ // ASCII characters. There are variants for calls with more arguments.
+ virtual void CallJavascriptFunction(const std::string& function_name) = 0;
+ virtual void CallJavascriptFunction(const std::string& function_name,
+ const base::Value& arg) = 0;
+ virtual void CallJavascriptFunction(const std::string& function_name,
+ const base::Value& arg1,
+ const base::Value& arg2) = 0;
+ virtual void CallJavascriptFunction(const std::string& function_name,
+ const base::Value& arg1,
+ const base::Value& arg2,
+ const base::Value& arg3) = 0;
+ virtual void CallJavascriptFunction(const std::string& function_name,
+ const base::Value& arg1,
+ const base::Value& arg2,
+ const base::Value& arg3,
+ const base::Value& arg4) = 0;
+ virtual void CallJavascriptFunction(
+ const std::string& function_name,
+ const std::vector<const base::Value*>& args) = 0;
+};
+
+} // namespace web
+
+#endif // IOS_PUBLIC_PROVIDER_WEB_WEB_UI_IOS_H_

Powered by Google App Engine
This is Rietveld 408576698