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

   1 // Copyright (c) 2013 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_REQUEST_CONTEXT_H_
  38 #define CEF_INCLUDE_CEF_REQUEST_CONTEXT_H_
  39 #pragma once
  40
  41 #include "include/cef_request_context_handler.h"
  42
  43 ///
  44 // A request context provides request handling for a set of related browser
  45 // objects. A request context is specified when creating a new browser object
  46 // via the CefBrowserHost static factory methods. Browser objects with different
  47 // request contexts will never be hosted in the same render process. Browser
  48 // objects with the same request context may or may not be hosted in the same
  49 // render process depending on the process model. Browser objects created
  50 // indirectly via the JavaScript window.open function or targeted links will
  51 // share the same render process and the same request context as the source
  52 // browser. When running in single-process mode there is only a single render
  53 // process (the main process) and so all browsers created in single-process mode
  54 // will share the same request context. This will be the first request context
  55 // passed into a CefBrowserHost static factory method and all other request
  56 // context objects will be ignored.
  57 ///
  58 /*--cef(source=library,no_debugct_check)--*/
  59 class CefRequestContext : public virtual CefBase {
  60  public:
  61   ///
  62   // Returns the global context object.
  63   ///
  64   /*--cef()--*/
  65   static CefRefPtr<CefRequestContext> GetGlobalContext();
  66
  67   ///
  68   // Creates a new context object with the specified handler.
  69   ///
  70   /*--cef(optional_param=handler)--*/
  71   static CefRefPtr<CefRequestContext> CreateContext(
  72       CefRefPtr<CefRequestContextHandler> handler);
  73
  74   ///
  75   // Returns true if this object is pointing to the same context as |that|
  76   // object.
  77   ///
  78   /*--cef()--*/
  79   virtual bool IsSame(CefRefPtr<CefRequestContext> other) =0;
  80
  81   ///
  82   // Returns true if this object is the global context.
  83   ///
  84   /*--cef()--*/
  85   virtual bool IsGlobal() =0;
  86
  87   ///
  88   // Returns the handler for this context if any.
  89   ///
  90   /*--cef()--*/
  91   virtual CefRefPtr<CefRequestContextHandler> GetHandler() =0;
  92 };
  93
  94 #endif  // CEF_INCLUDE_CEF_REQUEST_CONTEXT_H_