1 // Copyright (c) 2015 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_H_ 38 #define CEF_INCLUDE_CEF_RESOURCE_BUNDLE_H_ 39 #pragma once 40 41 #include "include/cef_base.h" 42 #include "include/cef_values.h" 43 44 /// 45 // Class used for retrieving resources from the resource bundle (*.pak) files 46 // loaded by CEF during startup or via the CefResourceBundleHandler returned 47 // from CefApp::GetResourceBundleHandler. See CefSettings for additional options 48 // related to resource bundle loading. The methods of this class may be called 49 // on any thread unless otherwise indicated. 50 /// 51 /*--cef(source=library,no_debugct_check)--*/ 52 class CefResourceBundle : public virtual CefBaseRefCounted { 53 public: 54 typedef cef_scale_factor_t ScaleFactor; 55 56 /// 57 // Returns the global resource bundle instance. 58 /// 59 /*--cef()--*/ 60 static CefRefPtr<CefResourceBundle> GetGlobal(); 61 62 /// 63 // Returns the localized string for the specified |string_id| or an empty 64 // string if the value is not found. Include cef_pack_strings.h for a listing 65 // of valid string ID values. 66 /// 67 /*--cef()--*/ 68 virtual CefString GetLocalizedString(int string_id) = 0; 69 70 /// 71 // Returns a CefBinaryValue containing the decompressed contents of the 72 // specified scale independent |resource_id| or NULL if not found. Include 73 // cef_pack_resources.h for a listing of valid resource ID values. 74 /// 75 /*--cef()--*/ 76 virtual CefRefPtr<CefBinaryValue> GetDataResource(int resource_id) = 0; 77 78 /// 79 // Returns a CefBinaryValue containing the decompressed contents of the 80 // specified |resource_id| nearest the scale factor |scale_factor| or NULL if 81 // not found. Use a |scale_factor| value of SCALE_FACTOR_NONE for scale 82 // independent resources or call GetDataResource instead.Include 83 // cef_pack_resources.h for a listing of valid resource ID values. 84 /// 85 /*--cef()--*/ 86 virtual CefRefPtr<CefBinaryValue> GetDataResourceForScale( 87 int resource_id, 88 ScaleFactor scale_factor) = 0; 89 }; 90 91 #endif // CEF_INCLUDE_CEF_RESOURCE_BUNDLE_H_ 92