1 /*

     2  * Copyright (C) 2006, 2007 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 COMPUTER, INC. ``AS IS'' AND ANY

    14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

    16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR

    17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

    18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

    19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

    20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY

    21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

    22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 

    24  */

    25 

    26 cpp_quote("/*")

    27 cpp_quote(" * Copyright (C) 2006, 2007 Apple Inc.  All rights reserved.")

    28 cpp_quote(" *")

    29 cpp_quote(" * Redistribution and use in source and binary forms, with or without")

    30 cpp_quote(" * modification, are permitted provided that the following conditions")

    31 cpp_quote(" * are met:")

    32 cpp_quote(" * 1. Redistributions of source code must retain the above copyright")

    33 cpp_quote(" *    notice, this list of conditions and the following disclaimer.")

    34 cpp_quote(" * 2. Redistributions in binary form must reproduce the above copyright")

    35 cpp_quote(" *    notice, this list of conditions and the following disclaimer in the")

    36 cpp_quote(" *    documentation and/or other materials provided with the distribution.")

    37 cpp_quote(" *")

    38 cpp_quote(" * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY")

    39 cpp_quote(" * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE")

    40 cpp_quote(" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR")

    41 cpp_quote(" * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR")

    42 cpp_quote(" * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,")

    43 cpp_quote(" * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,")

    44 cpp_quote(" * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR")

    45 cpp_quote(" * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY")

    46 cpp_quote(" * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT")

    47 cpp_quote(" * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE")

    48 cpp_quote(" * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ")

    49 cpp_quote(" */")

    50 

    51 import "oaidl.idl";

    52 import "ocidl.idl";

    53 import "IWebFrame.idl";

    54 

    55 typedef enum {

    56     WebFrameLoadTypeStandard,

    57     WebFrameLoadTypeBack,

    58     WebFrameLoadTypeForward,

    59     WebFrameLoadTypeIndexedBackForward, // a multi-item hop in the backforward list

    60     WebFrameLoadTypeReload,

    61     WebFrameLoadTypeReloadAllowingStaleData,

    62     WebFrameLoadTypeSame,               // user loads same URL again (but not reload button)

    63     WebFrameLoadTypeRedirectWithLockedHistory,

    64     WebFrameLoadTypeReplace

    65 } WebFrameLoadType;

    66 

    67 [

    68     object,

    69     oleautomation,

    70     uuid(A1657D07-4881-4475-9D10-76548731D448),

    71     pointer_default(unique)

    72 ]

    73 

    74 interface IWebFramePrivate : IUnknown

    75 {

    76     HRESULT renderTreeAsExternalRepresentation([out, retval] BSTR* result);

    77     HRESULT scrollOffset([out, retval] SIZE* offset);

    78 

    79     // FIXME: This shouldn't be needed once IWebDocumentView is implemented.

    80     HRESULT layout();

    81     HRESULT firstLayoutDone([out, retval] BOOL* result);

    82     HRESULT loadType([out, retval] WebFrameLoadType* type);

    83 

    84     HRESULT setInPrintingMode([in] BOOL value, [in] HDC printDC);

    85     HRESULT getPrintedPageCount([in] HDC printDC, [out, retval] UINT* pageCount);

    86     [local] HRESULT spoolPages([in] HDC printDC, [in] UINT startPage, [in] UINT endPage, [out, retval] void* ctx);

    87 

    88     HRESULT isFrameSet([out, retval] BOOL* result);

    89     HRESULT string([out, retval] BSTR* result);

    90 

    91     HRESULT size([out, retval] SIZE* size);

    92     HRESULT hasScrollBars([out, retval] BOOL* result);

    93     HRESULT contentBounds([out, retval] RECT* result);

    94     HRESULT frameBounds([out, retval] RECT* result);

    95 

    96     HRESULT isDescendantOfFrame([in] IWebFrame* ancestor, [out, retval] BOOL* result);

    97 }