Functions with no parameters in WebKit/Shared/API/c and WebKit/UIProcess/API/C are
[WebKit-https.git] / Source / WebKit / Shared / API / c / WKRenderLayer.h
1 /*
2  * Copyright (C) 2012 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 WKRenderLayer_h
27 #define WKRenderLayer_h
28
29
30 #include <WebKit/WKBase.h>
31 #include <WebKit/WKGeometry.h>
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 WK_EXPORT WKTypeID WKRenderLayerGetTypeID(void);
38
39 WK_EXPORT WKRenderObjectRef WKRenderLayerGetRenderer(WKRenderLayerRef renderLayer);
40
41 // FIXME: Remove this function once Safari does not require it. Clients can access this data via the renderer.
42 WK_EXPORT WKStringRef WKRenderLayerCopyRendererName(WKRenderLayerRef renderLayer);
43
44 // FIXME: Remove these three functions once Safari does not require them.
45 WK_EXPORT WKStringRef WKRenderLayerCopyElementTagName(WKRenderLayerRef renderLayer);
46 WK_EXPORT WKStringRef WKRenderLayerCopyElementID(WKRenderLayerRef renderLayer);
47 WK_EXPORT WKArrayRef WKRenderLayerGetElementClassNames(WKRenderLayerRef renderLayer);
48
49 WK_EXPORT WKRect WKRenderLayerGetAbsoluteBounds(WKRenderLayerRef renderLayer);
50
51 WK_EXPORT bool WKRenderLayerIsClipping(WKRenderLayerRef renderLayer);
52 WK_EXPORT bool WKRenderLayerIsClipped(WKRenderLayerRef renderLayer);
53 WK_EXPORT bool WKRenderLayerIsReflection(WKRenderLayerRef renderLayer);
54
55 enum WKCompositingLayerType {
56     kWKCompositingLayerTypeNone,
57     kWKCompositingLayerTypeNormal,
58     kWKCompositingLayerTypeTiled,
59     kWKCompositingLayerTypeMedia,
60     kWKCompositingLayerTypeContainer
61 };
62 typedef enum WKCompositingLayerType WKCompositingLayerType;
63
64 WK_EXPORT WKCompositingLayerType WKRenderLayerGetCompositingLayerType(WKRenderLayerRef renderLayer);
65 WK_EXPORT double WKRenderLayerGetBackingStoreMemoryEstimate(WKRenderLayerRef renderLayer);
66
67 WK_EXPORT WKArrayRef WKRenderLayerGetNegativeZOrderList(WKRenderLayerRef renderLayer);
68 WK_EXPORT WKArrayRef WKRenderLayerGetNormalFlowList(WKRenderLayerRef renderLayer);
69 WK_EXPORT WKArrayRef WKRenderLayerGetPositiveZOrderList(WKRenderLayerRef renderLayer);
70
71 WK_EXPORT WKRenderLayerRef WKRenderLayerGetFrameContentsLayer(WKRenderLayerRef renderLayer);
72
73 #ifdef __cplusplus
74 }
75 #endif
76
77 #endif // WKRenderLayer_h