Source/WebKit/chromium/public/WebRange.h

   1 /*
   2  * Copyright (C) 2009 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebRange_h
  32 #define WebRange_h
  33
  34 #include "platform/WebCommon.h"
  35
  36 #if WEBKIT_IMPLEMENTATION
  37 namespace WebCore { class Range; }
  38 namespace WTF { template <typename T> class PassRefPtr; }
  39 #endif
  40
  41 namespace WebKit {
  42
  43 class WebFrame;
  44 class WebNode;
  45 class WebRangePrivate;
  46 class WebString;
  47
  48 // Provides readonly access to some properties of a DOM range.
  49 class WebRange {
  50 public:
  51     ~WebRange() { reset(); }
  52
  53     WebRange() : m_private(0) { }
  54     WebRange(const WebRange& r) : m_private(0) { assign(r); }
  55     WebRange& operator=(const WebRange& r)
  56     {
  57         assign(r);
  58         return *this;
  59     }
  60
  61     WEBKIT_EXPORT void reset();
  62     WEBKIT_EXPORT void assign(const WebRange&);
  63
  64     bool isNull() const { return !m_private; }
  65
  66     WEBKIT_EXPORT int startOffset() const;
  67     WEBKIT_EXPORT int endOffset() const;
  68     WEBKIT_EXPORT WebNode startContainer(int& exceptionCode) const;
  69     WEBKIT_EXPORT WebNode endContainer(int& exceptionCode) const;
  70
  71     WEBKIT_EXPORT WebString toHTMLText() const;
  72     WEBKIT_EXPORT WebString toPlainText() const;
  73
  74     WEBKIT_EXPORT static WebRange fromDocumentRange(WebFrame*, int start, int length);
  75
  76 #if WEBKIT_IMPLEMENTATION
  77     WebRange(const WTF::PassRefPtr<WebCore::Range>&);
  78     WebRange& operator=(const WTF::PassRefPtr<WebCore::Range>&);
  79     operator WTF::PassRefPtr<WebCore::Range>() const;
  80 #endif
  81
  82 private:
  83     void assign(WebRangePrivate*);
  84     WebRangePrivate* m_private;
  85 };
  86
  87 } // namespace WebKit
  88
  89 #endif