1/*
2 * Copyright (C) 2011 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 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * 2. 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 *
16 * THIS SOFTWARE IS PROVIDED BY GOOGLE INC. AND ITS CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GOOGLE INC.
20 * OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef PageOverlayList_h
30#define PageOverlayList_h
31
32#include "wtf/OwnPtr.h"
33#include "wtf/PassOwnPtr.h"
34#include "wtf/Vector.h"
35
36namespace blink {
37
38class GraphicsContext;
39class GraphicsLayer;
40class PageOverlay;
41class WebPageOverlay;
42class WebViewImpl;
43
44class PageOverlayList {
45public:
46    static PassOwnPtr<PageOverlayList> create(WebViewImpl*);
47
48    ~PageOverlayList();
49
50    bool empty() const { return !m_pageOverlays.size(); }
51
52    // Adds/removes a PageOverlay for given client.
53    // Returns true if a PageOverlay is added/removed.
54    bool add(WebPageOverlay*, int /* zOrder */);
55    bool remove(WebPageOverlay*);
56
57    void update();
58    void paintWebFrame(GraphicsContext&);
59
60    size_t findGraphicsLayer(GraphicsLayer*);
61
62private:
63    typedef Vector<OwnPtr<PageOverlay>, 2> PageOverlays;
64
65    explicit PageOverlayList(WebViewImpl*);
66
67    // Returns the index of the client found. Otherwise, returns WTF::kNotFound.
68    size_t find(WebPageOverlay*);
69
70    WebViewImpl* m_viewImpl;
71    PageOverlays m_pageOverlays;
72};
73
74} // namespace blink
75
76#endif // PageOverlayList_h
77