CEFInterfaceSchemeHandler.h 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. // Engine/Source/Runtime/WebBrowser/Private/CEF/CEFSchemeHandler.h
  2. #pragma once
  3. #include "CoreMinimal.h"
  4. #include "IWebInterfaceBrowserSchemeHandler.h"
  5. #if WITH_CEF3
  6. #include "CEFInterfaceLibCefIncludes.h"
  7. /**
  8. * Implementation for managing CEF custom scheme handlers.
  9. */
  10. class FCefInterfaceSchemeHandlerFactories
  11. {
  12. public:
  13. /**
  14. * Adds a custom scheme handler factory, for a given scheme and domain. The domain is ignored if the scheme is not a browser built in scheme,
  15. * and all requests will go through this factory.
  16. * @param Scheme The scheme name to handle.
  17. * @param Domain The domain name to handle on the scheme. Ignored if scheme is not a built in scheme.
  18. * @param WebBrowserSchemeHandlerFactory The factory implementation for creating request handlers for this scheme.
  19. */
  20. void AddSchemeHandlerFactory(FString Scheme, FString Domain, IWebInterfaceBrowserSchemeHandlerFactory* WebBrowserSchemeHandlerFactory);
  21. /**
  22. * Remove a custom scheme handler factory. The factory may still be used by existing open browser windows, but will no longer be provided for new ones.
  23. * @param WebBrowserSchemeHandlerFactory The factory implementation to remove.
  24. */
  25. void RemoveSchemeHandlerFactory(IWebInterfaceBrowserSchemeHandlerFactory* WebBrowserSchemeHandlerFactory);
  26. /**
  27. * Register all scheme handler factories with the provided request context.
  28. * @param Context The context.
  29. */
  30. void RegisterFactoriesWith(CefRefPtr<CefRequestContext>& Context);
  31. private:
  32. /**
  33. * A struct to wrap storage of a factory with it's provided scheme and domain, inc ref counting for the cef representation.
  34. */
  35. struct FFactory
  36. {
  37. public:
  38. FFactory(FString Scheme, FString Domain, CefRefPtr<CefSchemeHandlerFactory> Factory);
  39. FString Scheme;
  40. FString Domain;
  41. CefRefPtr<CefSchemeHandlerFactory> Factory;
  42. };
  43. // Array of registered handler factories.
  44. TArray<FFactory> SchemeHandlerFactories;
  45. };
  46. #endif