1/*
2 * Copyright (C) 2013 Apple 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
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef PageBanner_h
27#define PageBanner_h
28
29#include "APIObject.h"
30#include "WebEvent.h"
31#include <wtf/PassRefPtr.h>
32
33#if PLATFORM(MAC)
34OBJC_CLASS CALayer;
35#include <wtf/RetainPtr.h>
36#endif
37
38namespace WebCore {
39class GraphicsLayer;
40}
41
42namespace WebKit {
43
44class WebPage;
45
46class PageBanner : public API::ObjectImpl<API::Object::Type::BundlePageBanner> {
47public:
48    enum Type {
49        NotSet,
50        Header,
51        Footer
52    };
53
54    class Client {
55    protected:
56        virtual ~Client() { }
57
58    public:
59        virtual void pageBannerDestroyed(PageBanner*) = 0;
60        virtual bool mouseEvent(PageBanner*, WebEvent::Type, WebMouseEvent::Button, const WebCore::IntPoint&) = 0;
61    };
62
63#if PLATFORM(MAC)
64    static PassRefPtr<PageBanner> create(CALayer *, int height, Client*);
65    CALayer *layer();
66#endif
67
68    virtual ~PageBanner();
69
70    void addToPage(Type, WebPage*);
71    void detachFromPage();
72
73    void hide();
74    void showIfHidden();
75
76    bool mouseEvent(const WebMouseEvent&);
77    void didChangeDeviceScaleFactor(float scaleFactor);
78
79    void didAddParentLayer(WebCore::GraphicsLayer*);
80
81private:
82#if PLATFORM(MAC)
83    explicit PageBanner(CALayer *, int height, Client*);
84#endif
85
86    Type m_type;
87    Client* m_client;
88    WebPage* m_webPage;
89
90    bool m_mouseDownInBanner;
91    bool m_isHidden;
92
93#if PLATFORM(MAC)
94    RetainPtr<CALayer> m_layer;
95    int m_height;
96#endif
97};
98
99} // namespace WebKit
100
101#endif // PageBanner_h
102