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 "DOMCore.idl";
30#endif
31
32interface IDOMElement;
33
34typedef struct WebFontDescription WebFontDescription;
35
36[
37    object,
38    oleautomation,
39    uuid(7FF28EC8-6DA1-498d-9A43-7E67C2D3128F),
40    pointer_default(unique)
41]
42interface IDOMElementPrivate : IUnknown
43{
44    [local] HRESULT coreElement(void** element);
45    HRESULT isEqual([in] IDOMElement* other, [out, retval] BOOL* result);
46    HRESULT isFocused([out, retval] BOOL* result);
47    HRESULT innerText([out, retval] BSTR* result);
48    [local] HRESULT font(WebFontDescription* webFontDescription);
49    HRESULT renderedImage([out, retval] HBITMAP* image);
50    [local] HRESULT markerTextForListItem([out, retval] BSTR* markerText);
51}
52
53/*
54    All the methods in this category are used by Safari forms autofill and should not be used for any other purpose.
55    Each one should eventually be replaced by public DOM API, and when that happens Safari will switch to implementations
56    using that public API, and these will be deleted.
57
58    @interface DOMHTMLInputElement(FormsAutoFillTransition)
59*/
60[
61    object,
62    oleautomation,
63    uuid(2DF339BC-B48E-4d35-B93A-299756ED0B4B),
64    pointer_default(unique)
65]
66interface IFormsAutoFillTransition : IUnknown
67{
68    /*
69        - (BOOL)_isTextField;
70    */
71    HRESULT isTextField([out, retval] BOOL* result);
72
73    /*
74        - (NSRect)_rectOnScreen; // bounding box of the text field, in screen coordinates
75    */
76    HRESULT rectOnScreen([out, retval] LPRECT rect);
77
78    /*
79        - (void)_replaceCharactersInRange:(NSRange)targetRange withString:(NSString *)replacementString selectingFromIndex:(int)index;
80    */
81    HRESULT replaceCharactersInRange([in] int startTarget, [in] int endTarget, [in] BSTR replacementString, [in] int index);
82
83    /*
84        - (NSRange)_selectedRange;
85    */
86    HRESULT selectedRange([out] int* start, [out] int* end);
87
88    /*
89        - (void)_setAutofilled:(BOOL)filled;
90    */
91    HRESULT setAutofilled([in] BOOL filled);
92
93    /*
94        - (BOOL)_isAutofilled;
95    */
96    HRESULT isAutofilled([out, retval] BOOL* result);
97}
98
99/*
100    // These changes are necessary to detect whether a form input was modified by a user
101    // or javascript
102    @interface DOMHTMLInputElement (FormPromptAdditions)
103
104    @interface DOMHTMLTextAreaElement (FormPromptAdditions)
105*/
106[
107    object,
108    oleautomation,
109    uuid(C8C5F0CD-07B0-4a32-BFA8-AE465E80DD3C),
110    pointer_default(unique)
111]
112interface IFormPromptAdditions : IUnknown
113{
114    /*
115        - (BOOL)_isUserEdited;
116    */
117    HRESULT isUserEdited([out, retval] BOOL* result);
118}
119
120/*
121    All the methods in this category are used by Safari forms autofill and should not be used for any other purpose.
122    They are stopgap measures until we finish transitioning form controls to not use NSView. Each one should become
123    replaceable by public DOM API, and when that happens Safari will switch to implementations using that public API,
124    and these will be deleted.
125
126    @interface DOMHTMLSelectElement(FormsAutoFillTransition)
127*/
128[
129    object,
130    oleautomation,
131    uuid(6959F712-1563-4661-8D8C-F4C739C55839),
132    pointer_default(unique)
133]
134interface IFormsAutoFillTransitionSelect : IUnknown
135{
136    /*
137        - (void)_activateItemAtIndex:(int)index;
138    */
139    HRESULT activateItemAtIndex([in] int index);
140}
141