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

   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. The methods of
  45 // this class may be called on multiple threads.
  46 ///
  47 /*--cef(source=client)--*/
  48 class CefResourceBundleHandler : public virtual CefBase {
  49  public:
  50   ///
  51   // Called to retrieve a localized translation for the string specified by
  52   // |message_id|. To provide the translation set |string| to the translation
  53   // string and return true. To use the default translation return false.
  54   // Supported message IDs are listed in cef_pack_strings.h.
  55   ///
  56   /*--cef()--*/
  57   virtual bool GetLocalizedString(int message_id,
  58                                   CefString& string) =0;
  59
  60   ///
  61   // Called to retrieve data for the resource specified by |resource_id|. To
  62   // provide the resource data set |data| and |data_size| to the data pointer
  63   // and size respectively and return true. To use the default resource data
  64   // return false. The resource data will not be copied and must remain resident
  65   // in memory. Supported resource IDs are listed in cef_pack_resources.h.
  66   ///
  67   /*--cef()--*/
  68   virtual bool GetDataResource(int resource_id,
  69                                void*& data,
  70                                size_t& data_size) =0;
  71 };
  72
  73 #endif  // CEF_INCLUDE_CEF_RESOURCE_BUNDLE_HANDLER_H_