third_party/WebKit/public/web/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 "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 WebString;
  43
  44 // Provides readonly access to some properties of a DOM range.
  45 class WebRange {
  46 public:
  47     ~WebRange() { reset(); }
  48
  49     WebRange() { }
  50     WebRange(const WebRange& r) { assign(r); }
  51     WebRange& operator=(const WebRange& r)
  52     {
  53         assign(r);
  54         return *this;
  55     }
  56
  57     BLINK_EXPORT void reset();
  58     BLINK_EXPORT void assign(const WebRange&);
  59
  60     bool isNull() const { return m_private.isNull(); }
  61
  62     BLINK_EXPORT int startOffset() const;
  63     BLINK_EXPORT int endOffset() const;
  64     BLINK_EXPORT WebString toPlainText() const;
  65
  66     BLINK_EXPORT static WebRange fromDocumentRange(WebLocalFrame*, int start, int length);
  67
  68 #if BLINK_IMPLEMENTATION
  69     WebRange(const PassRefPtrWillBeRawPtr<Range>&);
  70     operator PassRefPtrWillBeRawPtr<Range>() const;
  71 #endif
  72
  73 private:
  74     WebPrivatePtr<Range> m_private;
  75 };
  76
  77 } // namespace blink
  78
  79 #endif