OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 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 CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_REQUEST_H_ | 5 #ifndef CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_REQUEST_H_ |
6 #define CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_REQUEST_H_ | 6 #define CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_REQUEST_H_ |
7 | 7 |
8 #include "base/strings/string16.h" | 8 #include "base/strings/string16.h" |
| 9 #include "url/gurl.h" |
9 | 10 |
10 // Describes the interface a feature utilizing permission bubbles should | 11 // Describes the interface a feature utilizing permission bubbles should |
11 // implement. A class of this type is registered with the permission bubble | 12 // implement. A class of this type is registered with the permission bubble |
12 // manager to receive updates about the result of the permissions request | 13 // manager to receive updates about the result of the permissions request |
13 // from the bubble. It should live until it is unregistered or until | 14 // from the bubble. It should live until it is unregistered or until |
14 // PermissionsBubbleDestroyed is called. | 15 // PermissionsBubbleDestroyed is called. |
15 // Note that no particular guarantees are made about what exact UI surface | 16 // Note that no particular guarantees are made about what exact UI surface |
16 // is presented to the user. The delegate may be coalesced with other bubble | 17 // is presented to the user. The delegate may be coalesced with other bubble |
17 // requests, or depending on the situation, not shown at all. | 18 // requests, or depending on the situation, not shown at all. |
18 class PermissionBubbleRequest { | 19 class PermissionBubbleRequest { |
19 public: | 20 public: |
20 virtual ~PermissionBubbleRequest() {} | 21 virtual ~PermissionBubbleRequest() {} |
21 | 22 |
| 23 // The icon to use next to the message text fragment in the permission bubble. |
| 24 // Must be a valid icon of size 16x16. (TODO(gbillock): tbd size) |
| 25 virtual int GetIconID() const = 0; |
| 26 |
22 // Returns the full prompt text for this permission. This is the only text | 27 // Returns the full prompt text for this permission. This is the only text |
23 // that will be shown in the single-permission case and should be phrased | 28 // that will be shown in the single-permission case and should be phrased |
24 // positively as a complete sentence. | 29 // positively as a complete sentence. |
25 virtual base::string16 GetMessageText() const = 0; | 30 virtual base::string16 GetMessageText() const = 0; |
26 | 31 |
27 // Returns the shortened prompt text for this permission. Must be phrased | 32 // Returns the shortened prompt text for this permission. Must be phrased |
28 // positively -- the permission bubble may coalesce different requests, and | 33 // as a heading, e.g. "Location", or "Camera". The permission bubble may |
29 // if it does, this text will be displayed next to a bullet or checkbox | 34 // coalesce different requests, and if it does, this text will be displayed |
30 // indicating the user grants the permission. | 35 // next to an image and indicate the user grants the permission. |
31 virtual base::string16 GetMessageTextFragment() const = 0; | 36 virtual base::string16 GetMessageTextFragment() const = 0; |
32 | 37 |
33 // May return alternative text for the accept button in the case where this | 38 // Get whether this request was accompanied by a user gesture. User gestured |
34 // single permission request is triggered in the bubble. If it returns an | 39 // permissions requests will not be suppressed. |
35 // empty string the default is used. | 40 virtual bool HasUserGesture() const = 0; |
36 // If the permission request is coalesced, the text will revert to the default | |
37 // "Accept"-alike, so the message text must be clear enough for users to | |
38 // understand even if this text is not used. | |
39 virtual base::string16 GetAlternateAcceptButtonText() const = 0; | |
40 | 41 |
41 // May return alternative text for the deny button in the case where this | 42 // Get the hostname on whose behalf this permission request is being made. |
42 // single permission request is triggered in the bubble. If it returns an | 43 virtual GURL GetRequestingHostname() const = 0; |
43 // empty string the default is used. This text may not be used at all, | |
44 // so the |GetMessageText()| prompt should be clear enough to convey the | |
45 // permission request with generic button text. | |
46 virtual base::string16 GetAlternateDenyButtonText() const = 0; | |
47 | 44 |
48 // Called when the user has granted the requested permission. | 45 // Called when the user has granted the requested permission. |
49 virtual void PermissionGranted() = 0; | 46 virtual void PermissionGranted() = 0; |
50 | 47 |
51 // Called when the user has denied the requested permission. | 48 // Called when the user has denied the requested permission. |
52 virtual void PermissionDenied() = 0; | 49 virtual void PermissionDenied() = 0; |
53 | 50 |
54 // Called when the user has cancelled the permission request. This | 51 // Called when the user has cancelled the permission request. This |
55 // corresponds to a denial, but is segregated in case the context needs to | 52 // corresponds to a denial, but is segregated in case the context needs to |
56 // be able to distinguish between an active refusal or an implicit refusal. | 53 // be able to distinguish between an active refusal or an implicit refusal. |
57 virtual void Cancelled() = 0; | 54 virtual void Cancelled() = 0; |
58 | 55 |
59 // The bubble this request was associated with was answered by the user. | 56 // The bubble this request was associated with was answered by the user. |
60 // It is safe for the request to be deleted at this point -- it will receive | 57 // It is safe for the request to be deleted at this point -- it will receive |
61 // no further message from the permission bubble system. This method will | 58 // no further message from the permission bubble system. This method will |
62 // eventually be called on every request which is not unregistered. | 59 // eventually be called on every request which is not unregistered. |
63 virtual void RequestFinished() = 0; | 60 virtual void RequestFinished() = 0; |
64 }; | 61 }; |
65 | 62 |
66 #endif // CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_REQUEST_H_ | 63 #endif // CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_REQUEST_H_ |
OLD | NEW |