git.sesse.net Git - casparcg/blob - dependencies64/cef/linux/include/capi/cef_resource_bundle_capi.h

   1 // Copyright (c) 2017 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 // This file was generated by the CEF translator tool and should not edited
  33 // by hand. See the translator.README.txt file in the tools directory for
  34 // more information.
  35 //
  36
  37 #ifndef CEF_INCLUDE_CAPI_CEF_RESOURCE_BUNDLE_CAPI_H_
  38 #define CEF_INCLUDE_CAPI_CEF_RESOURCE_BUNDLE_CAPI_H_
  39 #pragma once
  40
  41 #include "include/capi/cef_base_capi.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47
  48 ///
  49 // Structure used for retrieving resources from the resource bundle (*.pak)
  50 // files loaded by CEF during startup or via the cef_resource_bundle_tHandler
  51 // returned from cef_app_t::GetResourceBundleHandler. See CefSettings for
  52 // additional options related to resource bundle loading. The functions of this
  53 // structure may be called on any thread unless otherwise indicated.
  54 ///
  55 typedef struct _cef_resource_bundle_t {
  56   ///
  57   // Base structure.
  58   ///
  59   cef_base_ref_counted_t base;
  60
  61   ///
  62   // Returns the localized string for the specified |string_id| or an NULL
  63   // string if the value is not found. Include cef_pack_strings.h for a listing
  64   // of valid string ID values.
  65   ///
  66   // The resulting string must be freed by calling cef_string_userfree_free().
  67   cef_string_userfree_t (CEF_CALLBACK *get_localized_string)(
  68       struct _cef_resource_bundle_t* self, int string_id);
  69
  70   ///
  71   // Retrieves the contents of the specified scale independent |resource_id|. If
  72   // the value is found then |data| and |data_size| will be populated and this
  73   // function will return true (1). If the value is not found then this function
  74   // will return false (0). The returned |data| pointer will remain resident in
  75   // memory and should not be freed. Include cef_pack_resources.h for a listing
  76   // of valid resource ID values.
  77   ///
  78   int (CEF_CALLBACK *get_data_resource)(struct _cef_resource_bundle_t* self,
  79       int resource_id, void** data, size_t* data_size);
  80
  81   ///
  82   // Retrieves the contents of the specified |resource_id| nearest the scale
  83   // factor |scale_factor|. Use a |scale_factor| value of SCALE_FACTOR_NONE for
  84   // scale independent resources or call GetDataResource instead. If the value
  85   // is found then |data| and |data_size| will be populated and this function
  86   // will return true (1). If the value is not found then this function will
  87   // return false (0). The returned |data| pointer will remain resident in
  88   // memory and should not be freed. Include cef_pack_resources.h for a listing
  89   // of valid resource ID values.
  90   ///
  91   int (CEF_CALLBACK *get_data_resource_for_scale)(
  92       struct _cef_resource_bundle_t* self, int resource_id,
  93       cef_scale_factor_t scale_factor, void** data, size_t* data_size);
  94 } cef_resource_bundle_t;
  95
  96
  97 ///
  98 // Returns the global resource bundle instance.
  99 ///
 100 CEF_EXPORT cef_resource_bundle_t* cef_resource_bundle_get_global();
 101
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif  // CEF_INCLUDE_CAPI_CEF_RESOURCE_BUNDLE_CAPI_H_