Home | History | Annotate | Download | only in web 
      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 "WebFrame.h"
     35 #include "public/platform/WebCommon.h"
     36 #include "public/platform/WebPrivatePtr.h"
     37 #include "public/platform/WebVector.h"
     38 
     39 namespace blink {
     40 
     41 class Range;
     42 class WebNode;
     43 class WebString;
     44 
     45 // Provides readonly access to some properties of a DOM range.
     46 class WebRange {
     47 public:
     48     ~WebRange() { reset(); }
     49 
     50     WebRange() { }
     51     WebRange(const WebRange& r) { assign(r); }
     52     WebRange& operator=(const WebRange& r)
     53     {
     54         assign(r);
     55         return *this;
     56     }
     57 
     58     BLINK_EXPORT void reset();
     59     BLINK_EXPORT void assign(const WebRange&);
     60 
     61     bool isNull() const { return m_private.isNull(); }
     62 
     63     BLINK_EXPORT int startOffset() const;
     64     BLINK_EXPORT int endOffset() const;
     65     BLINK_EXPORT WebNode startContainer(int& exceptionCode) const;
     66     BLINK_EXPORT WebNode endContainer(int& exceptionCode) const;
     67 
     68     BLINK_EXPORT WebString toHTMLText() const;
     69     BLINK_EXPORT WebString toPlainText() const;
     70 
     71     BLINK_EXPORT WebRange expandedToParagraph() const;
     72 
     73     BLINK_EXPORT static WebRange fromDocumentRange(WebLocalFrame*, int start, int length);
     74 
     75 #if BLINK_IMPLEMENTATION
     76     WebRange(const PassRefPtrWillBeRawPtr<Range>&);
     77     operator PassRefPtrWillBeRawPtr<Range>() const;
     78 #endif
     79 
     80 private:
     81     WebPrivatePtr<Range> m_private;
     82 };
     83 
     84 } // namespace blink
     85 
     86 #endif
     87