• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2012 Marshall A. Greenblatt. All rights reserved.
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are
5 // met:
6 //
7 //    * Redistributions of source code must retain the above copyright
8 // notice, this list of conditions and the following disclaimer.
9 //    * Redistributions in binary form must reproduce the above
10 // copyright notice, this list of conditions and the following disclaimer
11 // in the documentation and/or other materials provided with the
12 // distribution.
13 //    * Neither the name of Google Inc. nor the name Chromium Embedded
14 // Framework nor the names of its contributors may be used to endorse
15 // or promote products derived from this software without specific prior
16 // written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // ---------------------------------------------------------------------------
31 //
32 // The contents of this file must follow a specific format in order to
33 // support the CEF translator tool. See the translator.README.txt file in the
34 // tools directory for more information.
35 //
36 
37 #ifndef CEF_INCLUDE_CEF_RESOURCE_BUNDLE_HANDLER_H_
38 #define CEF_INCLUDE_CEF_RESOURCE_BUNDLE_HANDLER_H_
39 #pragma once
40 
41 #include "include/cef_base.h"
42 
43 ///
44 // Class used to implement a custom resource bundle interface. See CefSettings
45 // for additional options related to resource bundle loading. The methods of
46 // this class may be called on multiple threads.
47 ///
48 /*--cef(source=client)--*/
49 class CefResourceBundleHandler : public virtual CefBaseRefCounted {
50  public:
51   typedef cef_scale_factor_t ScaleFactor;
52 
53   ///
54   // Called to retrieve a localized translation for the specified |string_id|.
55   // To provide the translation set |string| to the translation string and
56   // return true. To use the default translation return false. Include
57   // cef_pack_strings.h for a listing of valid string ID values.
58   ///
59   /*--cef()--*/
60   virtual bool GetLocalizedString(int string_id, CefString& string) = 0;
61 
62   ///
63   // Called to retrieve data for the specified scale independent |resource_id|.
64   // To provide the resource data set |data| and |data_size| to the data pointer
65   // and size respectively and return true. To use the default resource data
66   // return false. The resource data will not be copied and must remain resident
67   // in memory. Include cef_pack_resources.h for a listing of valid resource ID
68   // values.
69   ///
70   /*--cef()--*/
71   virtual bool GetDataResource(int resource_id,
72                                void*& data,
73                                size_t& data_size) = 0;
74 
75   ///
76   // Called to retrieve data for the specified |resource_id| nearest the scale
77   // factor |scale_factor|. To provide the resource data set |data| and
78   // |data_size| to the data pointer and size respectively and return true. To
79   // use the default resource data return false. The resource data will not be
80   // copied and must remain resident in memory. Include cef_pack_resources.h for
81   // a listing of valid resource ID values.
82   ///
83   /*--cef()--*/
84   virtual bool GetDataResourceForScale(int resource_id,
85                                        ScaleFactor scale_factor,
86                                        void*& data,
87                                        size_t& data_size) = 0;
88 };
89 
90 #endif  // CEF_INCLUDE_CEF_RESOURCE_BUNDLE_HANDLER_H_
91