Add support for Device Orientation / Motion permission API
[WebKit-https.git] / Source / WebCore / dom / DeviceOrientationEvent.h
1 /*
2  * Copyright 2010, The Android Open Source Project
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  *  * Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  *  * 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 THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "DeviceOrientationOrMotionEvent.h"
29 #include "Event.h"
30
31 namespace WebCore {
32
33 class DeviceOrientationData;
34
35 class DeviceOrientationEvent final : public Event, public DeviceOrientationOrMotionEvent {
36 public:
37     static Ref<DeviceOrientationEvent> create(const AtomicString& eventType, DeviceOrientationData* orientation)
38     {
39         return adoptRef(*new DeviceOrientationEvent(eventType, orientation));
40     }
41
42     static Ref<DeviceOrientationEvent> createForBindings()
43     {
44         return adoptRef(*new DeviceOrientationEvent);
45     }
46
47     virtual ~DeviceOrientationEvent();
48
49     Optional<double> alpha() const;
50     Optional<double> beta() const;
51     Optional<double> gamma() const;
52
53 #if PLATFORM(IOS_FAMILY)
54     Optional<double> compassHeading() const;
55     Optional<double> compassAccuracy() const;
56
57     void initDeviceOrientationEvent(const AtomicString& type, bool bubbles, bool cancelable, Optional<double> alpha, Optional<double> beta, Optional<double> gamma, Optional<double> compassHeading, Optional<double> compassAccuracy);
58 #else
59     Optional<bool> absolute() const;
60
61     void initDeviceOrientationEvent(const AtomicString& type, bool bubbles, bool cancelable, Optional<double> alpha, Optional<double> beta, Optional<double> gamma, Optional<bool> absolute);
62 #endif
63
64 private:
65     DeviceOrientationEvent();
66     DeviceOrientationEvent(const AtomicString& eventType, DeviceOrientationData*);
67
68     EventInterface eventInterface() const override;
69
70     RefPtr<DeviceOrientationData> m_orientation;
71 };
72
73 } // namespace WebCore