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 COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_ | 5 #ifndef COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_ |
6 #define COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_ | 6 #define COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
11 #include "base/compiler_specific.h" | 11 #include "base/compiler_specific.h" |
12 #include "base/memory/scoped_ptr.h" | 12 #include "base/memory/scoped_ptr.h" |
| 13 #include "base/strings/string16.h" |
13 | 14 |
14 namespace dom_distiller { | 15 namespace dom_distiller { |
15 | 16 |
16 class DistilledArticleProto; | 17 class DistilledArticleProto; |
| 18 class DistilledPageProto; |
17 class DomDistillerServiceInterface; | 19 class DomDistillerServiceInterface; |
18 class ViewerHandle; | 20 class ViewerHandle; |
19 class ViewRequestDelegate; | 21 class ViewRequestDelegate; |
20 | 22 |
21 namespace viewer { | 23 namespace viewer { |
22 | 24 |
23 // Returns a full HTML page based on the given |article_proto|. This is supposed | 25 // Returns a full HTML page based on the given |article_proto|. This is supposed |
24 // to displayed to the end user. The returned HTML should be considered unsafe, | 26 // to be displayed to the end user. The returned HTML should be considered |
25 // so callers must ensure rendering it does not compromise Chrome. | 27 // unsafe, so callers must ensure rendering it does not compromise Chrome. |
26 const std::string GetUnsafeHtml(const DistilledArticleProto* article_proto); | 28 const std::string GetUnsafeArticleHtml( |
| 29 const DistilledArticleProto* article_proto); |
| 30 |
| 31 // Returns the base Viewer HTML page based on the given |page_proto|. This is |
| 32 // supposed to be displayed to the end user. The returned HTML should be |
| 33 // considered unsafe, so callers must ensure rendering it does not compromise |
| 34 // Chrome. The difference from |GetUnsafeArticleHtml| is that this can be used |
| 35 // for displaying an in-flight distillation instead of waiting for the full |
| 36 // article. |
| 37 const std::string GetUnsafePartialArticleHtml( |
| 38 const DistilledPageProto* page_proto); |
| 39 |
| 40 // Returns a JavaScript blob for updating a partial view request with additional |
| 41 // distilled content. Meant for use when viewing a slow or long multi-page |
| 42 // article. |is_last_page| indicates whether this is the last page of the |
| 43 // article. |
| 44 const std::string GetUnsafeIncrementalDistilledPageJs( |
| 45 const DistilledPageProto* page_proto, |
| 46 const bool is_last_page); |
| 47 |
| 48 // Returns a JavaScript blob for controlling the "in-progress" indicator when |
| 49 // viewing a partially-distilled page. |is_last_page| indicates whether this is |
| 50 // the last page of the article (i.e. loading indicator should be removed). |
| 51 const std::string GetToggleLoadingIndicatorJs(const bool is_last_page); |
27 | 52 |
28 // Returns a full HTML page which displays a generic error. | 53 // Returns a full HTML page which displays a generic error. |
29 const std::string GetErrorPageHtml(); | 54 const std::string GetErrorPageHtml(); |
30 | 55 |
31 // Returns the default CSS to be used for a viewer. | 56 // Returns the default CSS to be used for a viewer. |
32 const std::string GetCss(); | 57 const std::string GetCss(); |
33 | 58 |
| 59 // Returns the default JS to be used for a viewer. |
| 60 const std::string GetJavaScript(); |
| 61 |
34 // Based on the given path, calls into the DomDistillerServiceInterface for | 62 // Based on the given path, calls into the DomDistillerServiceInterface for |
35 // viewing distilled content based on the |path|. | 63 // viewing distilled content based on the |path|. |
36 scoped_ptr<ViewerHandle> CreateViewRequest( | 64 scoped_ptr<ViewerHandle> CreateViewRequest( |
37 DomDistillerServiceInterface* dom_distiller_service, | 65 DomDistillerServiceInterface* dom_distiller_service, |
38 const std::string& path, | 66 const std::string& path, |
39 ViewRequestDelegate* view_request_delegate); | 67 ViewRequestDelegate* view_request_delegate); |
40 | 68 |
41 } // namespace viewer | 69 } // namespace viewer |
42 | 70 |
43 } // namespace dom_distiller | 71 } // namespace dom_distiller |
44 | 72 |
45 #endif // COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_ | 73 #endif // COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_ |
OLD | NEW |