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
32#if PLATFORM(MAC)
33OBJC_CLASS CALayer;
34#include <wtf/RetainPtr.h>
35#endif
36
37namespace WebCore {
38class GraphicsLayer;
39}
40
41namespace WebKit {
42
43class WebPage;
44
45class PageBanner : public API::ObjectImpl<API::Object::Type::BundlePageBanner> {
46public:
47 enum Type {
48 NotSet,
49 Header,
50 Footer
51 };
52
53 class Client {
54 protected:
55 virtual ~Client() { }
56
57 public:
58 virtual void pageBannerDestroyed(PageBanner*) = 0;
59 virtual bool mouseEvent(PageBanner*, WebEvent::Type, WebMouseEvent::Button, const WebCore::IntPoint&) = 0;
60 };
61
62#if PLATFORM(MAC)
63 static Ref<PageBanner> create(CALayer *, int height, Client*);
64 CALayer *layer();
65#endif
66
67 virtual ~PageBanner();
68
69 void addToPage(Type, WebPage*);
70 void detachFromPage();
71
72 void hide();
73 void showIfHidden();
74
75 bool mouseEvent(const WebMouseEvent&);
76 void didChangeDeviceScaleFactor(float scaleFactor);
77
78 void didAddParentLayer(WebCore::GraphicsLayer*);
79
80private:
81#if PLATFORM(MAC)
82 explicit PageBanner(CALayer *, int height, Client*);
83#endif
84
85 Client* m_client;
86
87#if PLATFORM(MAC)
88 Type m_type = NotSet;
89 WebPage* m_webPage = 0;
90 bool m_mouseDownInBanner = false;
91 bool m_isHidden = false;
92
93 RetainPtr<CALayer> m_layer;
94 int m_height;
95#endif
96};
97
98} // namespace WebKit
99
100#endif // PageBanner_h
101