third_party/WebKit/public/web/WebElementCollection.h

   1 /*
   2  * Copyright (C) 2009 Google Inc. All rights reserved.
   3  * Copyright (C) 2014 Samsung Electronics. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef WebElementCollection_h
  33 #define WebElementCollection_h
  34
  35 #include "../platform/WebCommon.h"
  36 #include "../platform/WebPrivatePtr.h"
  37
  38 #if BLINK_IMPLEMENTATION
  39 #include "platform/heap/Handle.h"
  40 namespace WTF { template <typename T> class PassRefPtr; }
  41 #endif
  42
  43 namespace blink {
  44
  45 class HTMLCollection;
  46 class WebElement;
  47
  48 // Provides readonly access to some properties of a DOM node.
  49 class WebElementCollection {
  50 public:
  51     ~WebElementCollection() { reset(); }
  52
  53     WebElementCollection() : m_current(0) { }
  54     WebElementCollection(const WebElementCollection& n) { assign(n); }
  55     WebElementCollection& operator=(const WebElementCollection& n)
  56     {
  57         assign(n);
  58         return *this;
  59     }
  60
  61     bool isNull() const { return m_private.isNull(); }
  62
  63     BLINK_EXPORT void reset();
  64     BLINK_EXPORT void assign(const WebElementCollection&);
  65
  66     BLINK_EXPORT unsigned length() const;
  67     BLINK_EXPORT WebElement nextItem() const;
  68     BLINK_EXPORT WebElement firstItem() const;
  69
  70 #if BLINK_IMPLEMENTATION
  71     WebElementCollection(const PassRefPtrWillBeRawPtr<HTMLCollection>&);
  72     WebElementCollection& operator=(const PassRefPtrWillBeRawPtr<HTMLCollection>&);
  73 #endif
  74
  75 private:
  76     WebPrivatePtr<HTMLCollection> m_private;
  77     mutable unsigned m_current;
  78 };
  79
  80 } // namespace blink
  81
  82 #endif