WKWebpagePreferences.h 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. /*
  2. * Copyright (C) 2019 Apple Inc. All rights reserved.
  3. *
  4. * Redistribution and use in source and binary forms, with or without
  5. * modification, are permitted provided that the following conditions
  6. * are met:
  7. * 1. Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * 2. Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. *
  13. * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15. * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17. * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23. * THE POSSIBILITY OF SUCH DAMAGE.
  24. */
  25. #import <WebKit/WKFoundation.h>
  26. #import <Foundation/Foundation.h>
  27. /*! @enum WKContentMode
  28. @abstract A content mode represents the type of content to load, as well as
  29. additional layout and rendering adaptations that are applied as a result of
  30. loading the content
  31. @constant WKContentModeRecommended The recommended content mode for the current platform
  32. @constant WKContentModeMobile Represents content targeting mobile browsers
  33. @constant WKContentModeDesktop Represents content targeting desktop browsers
  34. @discussion WKContentModeRecommended behaves like WKContentModeMobile on iPhone and iPad mini
  35. and WKContentModeDesktop on other iPad models as well as Mac.
  36. */
  37. typedef NS_ENUM(NSInteger, WKContentMode) {
  38. WKContentModeRecommended,
  39. WKContentModeMobile,
  40. WKContentModeDesktop
  41. } API_AVAILABLE(ios(13.0));
  42. /*! A WKWebpagePreferences object is a collection of properties that
  43. determine the preferences to use when loading and rendering a page.
  44. @discussion Contains properties used to determine webpage preferences.
  45. */
  46. WK_EXTERN API_AVAILABLE(macos(10.15), ios(13.0))
  47. @interface WKWebpagePreferences : NSObject
  48. /*! @abstract A WKContentMode indicating the content mode to prefer
  49. when loading and rendering a webpage.
  50. @discussion The default value is WKContentModeRecommended. The stated
  51. preference is ignored on subframe navigation
  52. */
  53. @property (nonatomic) WKContentMode preferredContentMode API_AVAILABLE(ios(13.0));
  54. @end