4f0e85ba56dbec7a677acfc1e41815fd2ebdd304
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / C / WKPagePrivate.h
1 /*
2  * Copyright (C) 2010 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 #ifndef WKPagePrivate_h
27 #define WKPagePrivate_h
28
29 #include <WebKit2/WKBase.h>
30 #include <WebKit2/WKPage.h>
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 typedef void (*WKPageRenderTreeExternalRepresentationFunction)(WKStringRef, WKErrorRef, void*);
37 WK_EXPORT void WKPageRenderTreeExternalRepresentation(WKPageRef page, void *context, WKPageRenderTreeExternalRepresentationFunction function);
38
39 #ifdef __BLOCKS__
40 typedef void (^WKPageRenderTreeExternalRepresentationBlock)(WKStringRef, WKErrorRef);
41 WK_EXPORT void WKPageRenderTreeExternalRepresentation_b(WKPageRef page, WKPageRenderTreeExternalRepresentationBlock block);
42 #endif
43
44 enum {
45     kWKDebugFlashViewUpdates = 1 << 0,
46     kWKDebugFlashBackingStoreUpdates = 1 << 1
47 };
48 typedef unsigned WKPageDebugPaintFlags;
49
50 WK_EXPORT void WKPageSetDebugPaintFlags(WKPageDebugPaintFlags flags);
51 WK_EXPORT WKPageDebugPaintFlags WKPageGetDebugPaintFlags(void);
52
53 WK_EXPORT WKStringRef WKPageCopyStandardUserAgentWithApplicationName(WKStringRef);
54
55 enum {
56     kWKPaginationModeUnpaginated,
57     kWKPaginationModeLeftToRight,
58     kWKPaginationModeRightToLeft,
59     kWKPaginationModeTopToBottom,
60     kWKPaginationModeBottomToTop,
61 };
62 typedef uint32_t WKPaginationMode;
63
64 WK_EXPORT void WKPageSetPaginationMode(WKPageRef page, WKPaginationMode paginationMode);
65 WK_EXPORT WKPaginationMode WKPageGetPaginationMode(WKPageRef page);
66 WK_EXPORT void WKPageSetPaginationBehavesLikeColumns(WKPageRef page, bool behavesLikeColumns);
67 WK_EXPORT bool WKPageGetPaginationBehavesLikeColumns(WKPageRef page);
68 WK_EXPORT void WKPageSetPageLength(WKPageRef page, double pageLength);
69 WK_EXPORT double WKPageGetPageLength(WKPageRef page);
70 WK_EXPORT void WKPageSetGapBetweenPages(WKPageRef page, double gap);
71 WK_EXPORT double WKPageGetGapBetweenPages(WKPageRef page);
72
73 WK_EXPORT unsigned WKPageGetPageCount(WKPageRef page);
74
75 struct WKPrintInfo {
76     float pageSetupScaleFactor;
77     float availablePaperWidth;
78     float availablePaperHeight;
79 };
80 typedef struct WKPrintInfo WKPrintInfo;
81
82 typedef void (*WKPageComputePagesForPrintingFunction)(WKRect* pageRects, uint32_t pageCount, double resultPageScaleFactor, WKErrorRef error, void* functionContext);
83 WK_EXPORT void WKPageComputePagesForPrinting(WKPageRef page, WKFrameRef frame, WKPrintInfo, WKPageComputePagesForPrintingFunction, void* context);
84
85 typedef void (*WKPageDrawToPDFFunction)(WKDataRef data, WKErrorRef error, void* functionContext);
86 WK_EXPORT void WKPageBeginPrinting(WKPageRef page, WKFrameRef frame, WKPrintInfo printInfo);
87 WK_EXPORT void WKPageDrawPagesToPDF(WKPageRef page, WKFrameRef frame, WKPrintInfo printInfo, uint32_t first, uint32_t count, WKPageDrawToPDFFunction callback, void* context);
88 WK_EXPORT void WKPageEndPrinting(WKPageRef page);
89
90 // FIXME https://bugs.webkit.org/show_bug.cgi?id=66979: Remove this sync call.
91 WK_EXPORT WKImageRef WKPageCreateSnapshotOfVisibleContent(WKPageRef page);
92
93 WK_EXPORT void WKPageSetShouldSendEventsSynchronously(WKPageRef page, bool sync);
94
95 WK_EXPORT void WKPageSetMediaVolume(WKPageRef page, float volume);
96 WK_EXPORT void WKPageSetMayStartMediaWhenInWindow(WKPageRef page, bool mayStartMedia);
97
98 WK_EXPORT WKArrayRef WKPageCopyRelatedPages(WKPageRef page);
99
100 #ifdef __cplusplus
101 }
102 #endif
103
104 #endif /* WKPagePrivate_h */