WebDOMOperations.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  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. #import <WebKit/DOMCore.h>
  29. #import <WebKit/DOMHTML.h>
  30. #import <WebKit/DOMRange.h>
  31. @class WebArchive;
  32. @class WebFrame;
  33. @interface DOMNode (WebDOMNodeOperations)
  34. /*!
  35. @method webArchive
  36. @result A WebArchive representing the node and the children of the node.
  37. */
  38. - (WebArchive *)webArchive;
  39. @end
  40. @interface DOMDocument (WebDOMDocumentOperations)
  41. /*!
  42. @method webFrame
  43. @abstract Returns the frame of the DOM document.
  44. */
  45. - (WebFrame *)webFrame;
  46. /*!
  47. @method URLWithAttributeString:
  48. @abstract Constructs a URL given an attribute string.
  49. @discussion This method constructs a URL given an attribute string just as WebKit does.
  50. An attribute string is the value of an attribute of an element such as the href attribute on
  51. the DOMHTMLAnchorElement class. This method is only applicable to attributes that refer to URLs.
  52. */
  53. - (NSURL *)URLWithAttributeString:(NSString *)string;
  54. @end
  55. @interface DOMRange (WebDOMRangeOperations)
  56. /*!
  57. @method webArchive
  58. @result A WebArchive representing the range.
  59. */
  60. - (WebArchive *)webArchive;
  61. /*!
  62. @method markupString
  63. @result A markup string representing the range.
  64. */
  65. - (NSString *)markupString;
  66. @end
  67. @interface DOMHTMLFrameElement (WebDOMHTMLFrameElementOperations)
  68. /*!
  69. @method contentFrame
  70. @abstract Returns the content frame of the element.
  71. */
  72. - (WebFrame *)contentFrame;
  73. @end
  74. @interface DOMHTMLIFrameElement (WebDOMHTMLIFrameElementOperations)
  75. /*!
  76. @method contentFrame
  77. @abstract Returns the content frame of the element.
  78. */
  79. - (WebFrame *)contentFrame;
  80. @end
  81. @interface DOMHTMLObjectElement (WebDOMHTMLObjectElementOperations)
  82. /*!
  83. @method contentFrame
  84. @abstract Returns the content frame of the element.
  85. @discussion Returns non-nil only if the object represents a child frame
  86. such as if the data of the object is HTML content.
  87. */
  88. - (WebFrame *)contentFrame;
  89. @end