OLD | NEW |
---|---|
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CONTENT_PUBLIC_BROWSER_WEB_INTENTS_DISPATCHER_H_ | 5 #ifndef CONTENT_PUBLIC_BROWSER_WEB_INTENTS_DISPATCHER_H_ |
6 #define CONTENT_PUBLIC_BROWSER_WEB_INTENTS_DISPATCHER_H_ | 6 #define CONTENT_PUBLIC_BROWSER_WEB_INTENTS_DISPATCHER_H_ |
7 | 7 |
8 #include "base/callback.h" | 8 #include "base/callback.h" |
9 #include "content/common/content_export.h" | |
9 #include "webkit/glue/web_intent_reply_data.h" | 10 #include "webkit/glue/web_intent_reply_data.h" |
10 | 11 |
11 namespace webkit_glue { | 12 namespace webkit_glue { |
12 enum WebIntentReplyType; | 13 enum WebIntentReplyType; |
13 struct WebIntentData; | 14 struct WebIntentData; |
14 } | 15 } |
15 | 16 |
16 namespace content { | 17 namespace content { |
17 | 18 |
18 class WebContents; | 19 class WebContents; |
19 | 20 |
20 // This class is the coordinator for dispatching web intents and seeing that | 21 // This class is the coordinator for dispatching web intents and seeing that |
21 // return messages are sent to the correct invoking context. The WebContents | 22 // return messages are sent to the correct invoking context. The WebContents |
22 // for the invoking context will create one of these for each intent and hand | 23 // for the invoking context will create one of these for each intent and hand |
23 // a pointer to the client WebContentsDelegate code. The WebContentsDelegate | 24 // a pointer to the client WebContentsDelegate code. The WebContentsDelegate |
24 // code can then read the intent data, create UI to pick the service, and | 25 // code can then read the intent data, create UI to pick the service, and |
25 // create a new context for that service. | 26 // create a new context for that service. |
26 // | 27 // |
27 // At that point, it should call DispatchIntent, which will connect the object | 28 // At that point, it should call DispatchIntent, which will deliver the intent |
28 // to the new context. If anything goes wrong, the client should call | 29 // to the new context. If anything goes wrong during setup, the client |
29 // SendReplyMessage with an error. That will self-delete the object. | 30 // should call SendReplyMessage with an error. The dispatcher lives until the |
31 // SendReplyMessage method is called, which will self-delete the object. | |
30 // | 32 // |
31 // At that point, before the client may use the object again, it must register a | 33 // The client should also register a reply notification, so it can avoid |
32 // reply notification, so it can avoid referencing the dispatcher after other | 34 // referencing the dispatcher after other code calls SendReplyMessage, which can |
33 // code calls SendReplyMessage. | 35 // happen if, for example, the user closes the delivery context. |
34 class CONTENT_EXPORT WebIntentsDispatcher { | 36 class CONTENT_EXPORT WebIntentsDispatcher { |
35 public: | 37 public: |
36 virtual ~WebIntentsDispatcher() {} | 38 virtual ~WebIntentsDispatcher() {} |
37 | 39 |
38 // Get the intent data being dispatched. | 40 // Get the intent data being dispatched. |
39 virtual const webkit_glue::WebIntentData& GetIntent() = 0; | 41 virtual const webkit_glue::WebIntentData& GetIntent() = 0; |
40 | 42 |
41 // Attach the intent to a new context in which the service page is loaded. | 43 // Attach the intent to a new context in which the service page is loaded. |
44 // |web_contents| cannot be null. | |
James Hawkins
2012/03/13 00:59:02
s/cannot/must not/
It actually *can* be null ;-)
James Hawkins
2012/03/13 00:59:02
s/null/NULL/
Greg Billock
2012/03/13 17:42:38
Done.
| |
42 virtual void DispatchIntent(WebContents* web_contents) = 0; | 45 virtual void DispatchIntent(WebContents* web_contents) = 0; |
43 | 46 |
44 // Return a success or failure message to the source context which invoked | 47 // Return a success or failure message to the source context which invoked |
45 // the intent. Deletes the object; it should not be used after this call | 48 // the intent. Deletes the object; it should not be used after this call |
46 // returns. Calls the reply notification, if registered. | 49 // returns. Calls the reply notifications, if any are registered. |
47 virtual void SendReplyMessage(webkit_glue::WebIntentReplyType reply_type, | 50 virtual void SendReplyMessage(webkit_glue::WebIntentReplyType reply_type, |
48 const string16& data) = 0; | 51 const string16& data) = 0; |
49 | 52 |
50 // Register a callback to be notified when SendReplyMessage is called. | 53 // Register a callback to be notified when SendReplyMessage is called. |
54 // Multiple callbacks may be registered. | |
51 virtual void RegisterReplyNotification( | 55 virtual void RegisterReplyNotification( |
52 const base::Callback<void(webkit_glue::WebIntentReplyType)>& closure) = 0; | 56 const base::Callback<void(webkit_glue::WebIntentReplyType)>& closure) = 0; |
53 }; | 57 }; |
54 | 58 |
55 } // namespace content | 59 } // namespace content |
56 | 60 |
57 #endif // CONTENT_PUBLIC_BROWSER_WEB_INTENTS_DISPATCHER_H_ | 61 #endif // CONTENT_PUBLIC_BROWSER_WEB_INTENTS_DISPATCHER_H_ |
OLD | NEW |