c959c94c090f9f8cdbdb8ea038e800edc3289b19
[WebKit-https.git] / Source / WebCore / html / shadow / MediaControlElementTypes.h
1 /*
2  * Copyright (C) 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2012 Google Inc. 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
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #pragma once
31
32 #if ENABLE(VIDEO)
33
34 #include "HTMLDivElement.h"
35 #include "HTMLInputElement.h"
36 #include "HTMLMediaElement.h"
37 #include "MediaControllerInterface.h"
38 #include "RenderObject.h"
39
40 namespace WebCore {
41
42 enum MediaControlElementType {
43     MediaEnterFullscreenButton = 0,
44     MediaMuteButton,
45     MediaPlayButton,
46     MediaSeekBackButton,
47     MediaSeekForwardButton,
48     MediaSlider,
49     MediaSliderThumb,
50     MediaRewindButton,
51     MediaReturnToRealtimeButton,
52     MediaShowClosedCaptionsButton,
53     MediaHideClosedCaptionsButton,
54     MediaUnMuteButton,
55     MediaPauseButton,
56     MediaTimelineContainer,
57     MediaCurrentTimeDisplay,
58     MediaTimeRemainingDisplay,
59     MediaStatusDisplay,
60     MediaControlsPanel,
61     MediaVolumeSliderContainer,
62     MediaVolumeSlider,
63     MediaVolumeSliderThumb,
64     MediaFullScreenVolumeSlider,
65     MediaFullScreenVolumeSliderThumb,
66     MediaVolumeSliderMuteButton,
67     MediaTextTrackDisplayContainer,
68     MediaTextTrackDisplay,
69     MediaExitFullscreenButton,
70     MediaOverlayPlayButton,
71     MediaClosedCaptionsContainer,
72     MediaClosedCaptionsTrackList,
73 };
74
75 RefPtr<HTMLMediaElement> parentMediaElement(Node*);
76 inline RefPtr<HTMLMediaElement> parentMediaElement(const RenderObject& renderer) { return parentMediaElement(renderer.node()); }
77
78 MediaControlElementType mediaControlElementType(Node*);
79
80 // ----------------------------
81
82 class MediaControlElement {
83 public:
84     virtual void hide();
85     virtual void show();
86     virtual bool isShowing() const;
87
88     virtual MediaControlElementType displayType() { return m_displayType; }
89
90     virtual void setMediaController(MediaControllerInterface* controller) { m_mediaController = controller; }
91     virtual MediaControllerInterface* mediaController() const { return m_mediaController; }
92
93 protected:
94     explicit MediaControlElement(MediaControlElementType, HTMLElement*);
95     ~MediaControlElement() = default;
96
97     virtual void setDisplayType(MediaControlElementType);
98     virtual bool isMediaControlElement() const { return true; }
99
100 private:
101     MediaControllerInterface* m_mediaController;
102     MediaControlElementType m_displayType;
103     HTMLElement* m_element;
104 };
105
106 // ----------------------------
107
108 class MediaControlDivElement : public HTMLDivElement, public MediaControlElement {
109 protected:
110     explicit MediaControlDivElement(Document&, MediaControlElementType);
111
112 private:
113     bool isMediaControlElement() const final { return MediaControlElement::isMediaControlElement(); }
114 };
115
116 // ----------------------------
117
118 class MediaControlInputElement : public HTMLInputElement, public MediaControlElement {
119 protected:
120     explicit MediaControlInputElement(Document&, MediaControlElementType);
121
122 private:
123     bool isMediaControlElement() const final { return MediaControlElement::isMediaControlElement(); }
124     virtual void updateDisplayType() { }
125 };
126
127 // ----------------------------
128
129 class MediaControlTimeDisplayElement : public MediaControlDivElement {
130 public:
131     void setCurrentValue(double);
132     double currentValue() const { return m_currentValue; }
133
134 protected:
135     explicit MediaControlTimeDisplayElement(Document&, MediaControlElementType);
136
137 private:
138     double m_currentValue;
139 };
140
141 // ----------------------------
142
143 class MediaControlMuteButtonElement : public MediaControlInputElement {
144 public:
145     void changedMute();
146
147     bool willRespondToMouseClickEvents() override { return true; }
148
149 protected:
150     explicit MediaControlMuteButtonElement(Document&, MediaControlElementType);
151
152     void defaultEventHandler(Event&) override;
153
154 private:
155     void updateDisplayType() override;
156 };
157
158 // ----------------------------
159
160 class MediaControlSeekButtonElement : public MediaControlInputElement {
161 public:
162     bool willRespondToMouseClickEvents() override { return true; }
163
164 protected:
165     explicit MediaControlSeekButtonElement(Document&, MediaControlElementType);
166
167     void defaultEventHandler(Event&) override;
168     virtual bool isForwardButton() const = 0;
169
170 private:
171     void setActive(bool /*flag*/ = true, bool /*pause*/ = false) final;
172 };
173
174 // ----------------------------
175
176 class MediaControlVolumeSliderElement : public MediaControlInputElement {
177 public:
178     bool willRespondToMouseMoveEvents() override;
179     bool willRespondToMouseClickEvents() override;
180     void setVolume(double);
181     void setClearMutedOnUserInteraction(bool);
182
183 protected:
184     explicit MediaControlVolumeSliderElement(Document&);
185
186     void defaultEventHandler(Event&) override;
187
188 private:
189     bool m_clearMutedOnUserInteraction;
190 };
191
192 } // namespace WebCore
193
194 #endif // ENABLE(VIDEO)