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 WKFrame_h
27#define WKFrame_h
28
29#include <WebKit/WKBase.h>
30
31#ifndef __cplusplus
32#include <stdbool.h>
33#endif
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39enum {
40    kWKFrameLoadStateProvisional = 0,
41    kWKFrameLoadStateCommitted = 1,
42    kWKFrameLoadStateFinished = 2
43};
44typedef uint32_t WKFrameLoadState;
45
46WK_EXPORT WKTypeID WKFrameGetTypeID();
47
48WK_EXPORT bool WKFrameIsMainFrame(WKFrameRef frame);
49WK_EXPORT WKFrameLoadState WKFrameGetFrameLoadState(WKFrameRef frame);
50WK_EXPORT WKURLRef WKFrameCopyProvisionalURL(WKFrameRef frame);
51WK_EXPORT WKURLRef WKFrameCopyURL(WKFrameRef frame);
52WK_EXPORT WKURLRef WKFrameCopyUnreachableURL(WKFrameRef frame);
53
54WK_EXPORT void WKFrameStopLoading(WKFrameRef frame);
55
56WK_EXPORT WKStringRef WKFrameCopyMIMEType(WKFrameRef frame);
57WK_EXPORT WKStringRef WKFrameCopyTitle(WKFrameRef frame);
58
59WK_EXPORT WKPageRef WKFrameGetPage(WKFrameRef frame);
60
61WK_EXPORT WKCertificateInfoRef WKFrameGetCertificateInfo(WKFrameRef frame);
62
63WK_EXPORT bool WKFrameCanProvideSource(WKFrameRef frame);
64WK_EXPORT bool WKFrameCanShowMIMEType(WKFrameRef frame, WKStringRef mimeType);
65
66WK_EXPORT bool WKFrameIsDisplayingStandaloneImageDocument(WKFrameRef frame);
67WK_EXPORT bool WKFrameIsDisplayingMarkupDocument(WKFrameRef frame);
68
69WK_EXPORT bool WKFrameIsFrameSet(WKFrameRef frame);
70
71typedef void (*WKFrameGetResourceDataFunction)(WKDataRef data, WKErrorRef error, void* functionContext);
72WK_EXPORT void WKFrameGetMainResourceData(WKFrameRef frame, WKFrameGetResourceDataFunction function, void* functionContext);
73WK_EXPORT void WKFrameGetResourceData(WKFrameRef frame, WKURLRef resourceURL, WKFrameGetResourceDataFunction function, void* functionContext);
74
75typedef void (*WKFrameGetWebArchiveFunction)(WKDataRef archiveData, WKErrorRef error, void* functionContext);
76WK_EXPORT void WKFrameGetWebArchive(WKFrameRef frame, WKFrameGetWebArchiveFunction function, void* functionContext);
77
78// NOTE: These are deprecated and should be removed. They currently do nothing.
79
80WK_EXPORT WKArrayRef WKFrameCopyChildFrames(WKFrameRef frame);
81WK_EXPORT WKFrameRef WKFrameGetParentFrame(WKFrameRef frame);
82
83#ifdef __cplusplus
84}
85#endif
86
87#endif /* WKFrame_h */
88