1ecfb5100df925f69933ca90978443979e845006
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKBrowsingContextControllerPrivate.h
1 /*
2  * Copyright (C) 2011 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
26 #import <WebKit2/WKBrowsingContextController.h>
27
28 #if WK_API_ENABLED
29
30 #import <WebKit2/WKBase.h>
31
32 typedef NS_ENUM(NSUInteger, WKBrowsingContextPaginationMode) {
33     WKPaginationModeUnpaginated,
34     WKPaginationModeLeftToRight,
35     WKPaginationModeRightToLeft,
36     WKPaginationModeTopToBottom,
37     WKPaginationModeBottomToTop,
38 };
39
40 @class WKBrowsingContextHandle;
41 @class WKRemoteObjectRegistry;
42
43 @interface WKBrowsingContextController (Private)
44
45 @property (readonly) WKPageRef _pageRef;
46
47 @property (readonly) BOOL hasOnlySecureContent;
48
49 @property WKBrowsingContextPaginationMode paginationMode;
50
51 // Whether the column-break-{before,after} properties are respected instead of the
52 // page-break-{before,after} properties.
53 @property BOOL paginationBehavesLikeColumns;
54
55 // Set to 0 to have the page length equal the view length.
56 @property CGFloat pageLength;
57 @property CGFloat gapBetweenPages;
58
59 @property (readonly) NSUInteger pageCount;
60
61 @property (nonatomic, readonly) WKBrowsingContextHandle *handle;
62
63 @property (nonatomic, readonly) WKRemoteObjectRegistry *remoteObjectRegistry;
64
65 @property (nonatomic, readonly) pid_t processIdentifier;
66
67 @end
68
69 #endif // WK_API_ENABLED