git.sesse.net Git - casparcg/blob - dependencies64/cef/windows/include/cef_resource_bundle.h

   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
  43 ///
  44 // Class used for retrieving resources from the resource bundle (*.pak) files
  45 // loaded by CEF during startup or via the CefResourceBundleHandler returned
  46 // from CefApp::GetResourceBundleHandler. See CefSettings for additional options
  47 // related to resource bundle loading. The methods of this class may be called
  48 // on any thread unless otherwise indicated.
  49 ///
  50 /*--cef(source=library,no_debugct_check)--*/
  51 class CefResourceBundle : public virtual CefBaseRefCounted {
  52  public:
  53   typedef cef_scale_factor_t ScaleFactor;
  54
  55   ///
  56   // Returns the global resource bundle instance.
  57   ///
  58   /*--cef()--*/
  59   static CefRefPtr<CefResourceBundle> GetGlobal();
  60
  61   ///
  62   // Returns the localized string for the specified |string_id| or an empty
  63   // string if the value is not found. Include cef_pack_strings.h for a listing
  64   // of valid string ID values.
  65   ///
  66   /*--cef()--*/
  67   virtual CefString GetLocalizedString(int string_id) =0;
  68
  69   ///
  70   // Retrieves the contents of the specified scale independent |resource_id|.
  71   // If the value is found then |data| and |data_size| will be populated and
  72   // this method will return true. If the value is not found then this method
  73   // will return false. The returned |data| pointer will remain resident in
  74   // memory and should not be freed. Include cef_pack_resources.h for a listing
  75   // of valid resource ID values.
  76   ///
  77   /*--cef()--*/
  78   virtual bool GetDataResource(int resource_id,
  79                                void*& data,
  80                                size_t& data_size) =0;
  81
  82   ///
  83   // Retrieves the contents of the specified |resource_id| nearest the scale
  84   // factor |scale_factor|. Use a |scale_factor| value of SCALE_FACTOR_NONE for
  85   // scale independent resources or call GetDataResource instead. If the value
  86   // is found then |data| and |data_size| will be populated and this method will
  87   // return true. If the value is not found then this method will return false.
  88   // The returned |data| pointer will remain resident in memory and should not
  89   // be freed. Include cef_pack_resources.h for a listing of valid resource ID
  90   // values.
  91   ///
  92   /*--cef()--*/
  93   virtual bool GetDataResourceForScale(int resource_id,
  94                                        ScaleFactor scale_factor,
  95                                        void*& data,
  96                                        size_t& data_size) =0;
  97 };
  98
  99 #endif  // CEF_INCLUDE_CEF_RESOURCE_BUNDLE_H_