webengine/osswebengine/WebKit/DOM/WebDOMOperations.h
changeset 0 dd21522fd290
equal deleted inserted replaced
-1:000000000000 0:dd21522fd290
       
     1 /*
       
     2  * Copyright (C) 2004, 2005 Apple Computer, 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  *
       
     8  * 1.  Redistributions of source code must retain the above copyright
       
     9  *     notice, this list of conditions and the following disclaimer. 
       
    10  * 2.  Redistributions in binary form must reproduce the above copyright
       
    11  *     notice, this list of conditions and the following disclaimer in the
       
    12  *     documentation and/or other materials provided with the distribution. 
       
    13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
       
    14  *     its contributors may be used to endorse or promote products derived
       
    15  *     from this software without specific prior written permission. 
       
    16  *
       
    17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
       
    18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       
    19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
       
    20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
       
    21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
       
    22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
       
    23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
       
    24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
       
    25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
       
    26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       
    27  */
       
    28 
       
    29 #import <WebKit/DOMCore.h>
       
    30 #import <WebKit/DOMHTML.h>
       
    31 #import <WebKit/DOMRange.h>
       
    32 
       
    33 @class WebArchive;
       
    34 @class WebFrame;
       
    35 
       
    36 @interface DOMNode (WebDOMNodeOperations)
       
    37 
       
    38 /*!
       
    39     @method webArchive
       
    40     @result A WebArchive representing the node and the children of the node.
       
    41 */
       
    42 - (WebArchive *)webArchive;
       
    43 
       
    44 @end
       
    45 
       
    46 @interface DOMDocument (WebDOMDocumentOperations)
       
    47 
       
    48 /*!
       
    49     @method webFrame
       
    50     @abstract Returns the frame of the DOM document.
       
    51 */
       
    52 - (WebFrame *)webFrame;
       
    53 
       
    54 /*!
       
    55     @method URLWithAttributeString:
       
    56     @abstract Constructs a URL given an attribute string.
       
    57     @discussion This method constructs a URL given an attribute string just as WebKit does. 
       
    58     An attribute string is the value of an attribute of an element such as the href attribute on 
       
    59     the DOMHTMLAnchorElement class. This method is only applicable to attributes that refer to URLs.
       
    60 */
       
    61 - (NSURL *)URLWithAttributeString:(NSString *)string;
       
    62 
       
    63 @end
       
    64 
       
    65 @interface DOMRange (WebDOMRangeOperations)
       
    66 
       
    67 /*!
       
    68     @method webArchive
       
    69     @result A WebArchive representing the range.
       
    70 */
       
    71 - (WebArchive *)webArchive;
       
    72 
       
    73 /*!
       
    74     @method markupString
       
    75     @result A markup string representing the range.
       
    76 */
       
    77 - (NSString *)markupString;
       
    78 
       
    79 @end
       
    80 
       
    81 @interface DOMHTMLFrameElement (WebDOMHTMLFrameElementOperations)
       
    82 
       
    83 /*!
       
    84     @method contentFrame
       
    85     @abstract Returns the content frame of the element.
       
    86 */
       
    87 - (WebFrame *)contentFrame;
       
    88 
       
    89 @end
       
    90 
       
    91 @interface DOMHTMLIFrameElement (WebDOMHTMLIFrameElementOperations)
       
    92 
       
    93 /*!
       
    94     @method contentFrame
       
    95     @abstract Returns the content frame of the element.
       
    96 */
       
    97 - (WebFrame *)contentFrame;
       
    98 
       
    99 @end
       
   100 
       
   101 @interface DOMHTMLObjectElement (WebDOMHTMLObjectElementOperations)
       
   102 
       
   103 /*!
       
   104     @method contentFrame
       
   105     @abstract Returns the content frame of the element.
       
   106     @discussion Returns non-nil only if the object represents a child frame
       
   107     such as if the data of the object is HTML content.
       
   108 */
       
   109 - (WebFrame *)contentFrame;
       
   110 
       
   111 @end