Home | History | Annotate | Download | only in C 
      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 <WebKit2/WKBase.h>
     30 
     31 #ifndef __cplusplus
     32 #include <stdbool.h>
     33 #endif
     34 
     35 #ifdef __cplusplus
     36 extern "C" {
     37 #endif
     38 
     39 enum {
     40     kWKFrameLoadStateProvisional = 0,
     41     kWKFrameLoadStateCommitted = 1,
     42     kWKFrameLoadStateFinished = 2
     43 };
     44 typedef uint32_t WKFrameLoadState;
     45 
     46 WK_EXPORT WKTypeID WKFrameGetTypeID();
     47 
     48 WK_EXPORT bool WKFrameIsMainFrame(WKFrameRef frame);
     49 WK_EXPORT WKFrameLoadState WKFrameGetFrameLoadState(WKFrameRef frame);
     50 WK_EXPORT WKURLRef WKFrameCopyProvisionalURL(WKFrameRef frame);
     51 WK_EXPORT WKURLRef WKFrameCopyURL(WKFrameRef frame);
     52 WK_EXPORT WKURLRef WKFrameCopyUnreachableURL(WKFrameRef frame);
     53 
     54 WK_EXPORT void WKFrameStopLoading(WKFrameRef frame);
     55 
     56 WK_EXPORT WKStringRef WKFrameCopyMIMEType(WKFrameRef frame);
     57 WK_EXPORT WKStringRef WKFrameCopyTitle(WKFrameRef frame);
     58 
     59 WK_EXPORT WKPageRef WKFrameGetPage(WKFrameRef frame);
     60 
     61 WK_EXPORT WKArrayRef WKFrameCopyChildFrames(WKFrameRef frame);
     62 
     63 WK_EXPORT WKFrameRef WKFrameGetParentFrame(WKFrameRef frame);
     64 
     65 WK_EXPORT WKCertificateInfoRef WKFrameGetCertificateInfo(WKFrameRef frame);
     66 
     67 WK_EXPORT bool WKFrameCanProvideSource(WKFrameRef frame);
     68 WK_EXPORT bool WKFrameCanShowMIMEType(WKFrameRef frame, WKStringRef mimeType);
     69 
     70 WK_EXPORT bool WKFrameIsDisplayingStandaloneImageDocument(WKFrameRef frame);
     71 WK_EXPORT bool WKFrameIsDisplayingMarkupDocument(WKFrameRef frame);
     72 
     73 WK_EXPORT bool WKFrameIsFrameSet(WKFrameRef frame);
     74 
     75 typedef void (*WKFrameGetResourceDataFunction)(WKDataRef data, WKErrorRef error, void* functionContext);
     76 WK_EXPORT void WKFrameGetMainResourceData(WKFrameRef frame, WKFrameGetResourceDataFunction function, void* functionContext);
     77 WK_EXPORT void WKFrameGetResourceData(WKFrameRef frame, WKURLRef resourceURL, WKFrameGetResourceDataFunction function, void* functionContext);
     78 #ifdef __BLOCKS__
     79 typedef void (^WKFrameGetResourceDataBlock)(WKDataRef data, WKErrorRef error);
     80 WK_EXPORT void WKFrameGetMainResourceData_b(WKFrameRef frame, WKFrameGetResourceDataBlock block);
     81 WK_EXPORT void WKFrameGetResourceData_b(WKFrameRef frame, WKURLRef resourceURL, WKFrameGetResourceDataBlock block);
     82 #endif
     83 
     84 typedef void (*WKFrameGetWebArchiveFunction)(WKDataRef archiveData, WKErrorRef error, void* functionContext);
     85 WK_EXPORT void WKFrameGetWebArchive(WKFrameRef frame, WKFrameGetWebArchiveFunction function, void* functionContext);
     86 #ifdef __BLOCKS__
     87 typedef void (^WKFrameGetWebArchiveBlock)(WKDataRef archiveData, WKErrorRef error);
     88 WK_EXPORT void WKFrameGetWebArchive_b(WKFrameRef frame, WKFrameGetWebArchiveBlock block);
     89 #endif
     90 
     91 #ifdef __cplusplus
     92 }
     93 #endif
     94 
     95 #endif /* WKFrame_h */
     96