1/*
2 * Copyright (C) 2006, 2007, 2008 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#ifndef DO_NO_IMPORTS
27import "oaidl.idl";
28import "ocidl.idl";
29import "IWebDocument.idl";
30#endif
31
32/*!
33    @class WebFrameView
34    @interface WebFrameView : NSView
35*/
36interface IWebFrame;
37interface IWebDocumentView;
38
39[
40    object,
41    oleautomation,
42    uuid(E23E1B15-78F6-4e89-AD2E-49992A040A35),
43    pointer_default(unique)
44]
45interface IWebFrameView : IUnknown
46{
47    /*!
48        @method webFrame
49        @abstract Returns the WebFrame associated with this WebFrameView
50        @result The WebFrameView's frame.
51        - (WebFrame *)webFrame;
52   */
53   HRESULT webFrame([out, retval] IWebFrame** frame);
54
55    /*!
56        @method documentView
57        @abstract Returns the WebFrameView's document subview
58        @result The subview that renders the WebFrameView's contents
59        - (NSView <WebDocumentView> *)documentView;
60    */
61   HRESULT documentView([out, retval] IWebDocumentView** view);
62
63    /*!
64        @method setAllowsScrolling:
65        @abstract Sets whether the WebFrameView allows its document to be scrolled
66        @param flag YES to allow the document to be scrolled, NO to disallow scrolling
67        - (void)setAllowsScrolling:(BOOL)flag;
68    */
69   HRESULT setAllowsScrolling([in] BOOL flag);
70
71    /*!
72        @method allowsScrolling
73        @abstract Returns whether the WebFrameView allows its document to be scrolled
74        @result YES if the document is allowed to scroll, otherwise NO
75        - (BOOL)allowsScrolling;
76    */
77   HRESULT allowsScrolling([out, retval] BOOL* flag);
78}
79