Home | History | Annotate | Download | only in public 
      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 "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 WebNode;
     44 class WebRangePrivate;
     45 class WebString;
     46 
     47 // Provides readonly access to some properties of a DOM range.
     48 class WebRange {
     49 public:
     50     ~WebRange() { reset(); }
     51 
     52     WebRange() : m_private(0) { }
     53     WebRange(const WebRange& r) : m_private(0) { assign(r); }
     54     WebRange& operator=(const WebRange& r)
     55     {
     56         assign(r);
     57         return *this;
     58     }
     59 
     60     WEBKIT_API void reset();
     61     WEBKIT_API void assign(const WebRange&);
     62 
     63     bool isNull() const { return !m_private; }
     64 
     65     WEBKIT_API int startOffset() const;
     66     WEBKIT_API int endOffset() const;
     67     WEBKIT_API WebNode startContainer(int& exceptionCode) const;
     68     WEBKIT_API WebNode endContainer(int& exceptionCode) const;
     69 
     70     WEBKIT_API WebString toHTMLText() const;
     71     WEBKIT_API WebString toPlainText() const;
     72 
     73 #if WEBKIT_IMPLEMENTATION
     74     WebRange(const WTF::PassRefPtr<WebCore::Range>&);
     75     WebRange& operator=(const WTF::PassRefPtr<WebCore::Range>&);
     76     operator WTF::PassRefPtr<WebCore::Range>() const;
     77 #endif
     78 
     79 private:
     80     void assign(WebRangePrivate*);
     81     WebRangePrivate* m_private;
     82 };
     83 
     84 } // namespace WebKit
     85 
     86 #endif
     87