Change all uses of FINAL to final now that all our compilers support it
[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 Computer, 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 #ifndef MediaControlElementTypes_h
31 #define MediaControlElementTypes_h
32
33 #if ENABLE(VIDEO)
34
35 #include "HTMLDivElement.h"
36 #include "HTMLInputElement.h"
37 #include "HTMLMediaElement.h"
38 #include "MediaControllerInterface.h"
39 #include "RenderBlock.h"
40
41 namespace WebCore {
42
43 // Must match WebKitSystemInterface.h
44 enum MediaControlElementType {
45     MediaEnterFullscreenButton = 0,
46     MediaMuteButton,
47     MediaPlayButton,
48     MediaSeekBackButton,
49     MediaSeekForwardButton,
50     MediaSlider,
51     MediaSliderThumb,
52     MediaRewindButton,
53     MediaReturnToRealtimeButton,
54     MediaShowClosedCaptionsButton,
55     MediaHideClosedCaptionsButton,
56     MediaUnMuteButton,
57     MediaPauseButton,
58     MediaTimelineContainer,
59     MediaCurrentTimeDisplay,
60     MediaTimeRemainingDisplay,
61     MediaStatusDisplay,
62     MediaControlsPanel,
63     MediaVolumeSliderContainer,
64     MediaVolumeSlider,
65     MediaVolumeSliderThumb,
66     MediaFullScreenVolumeSlider,
67     MediaFullScreenVolumeSliderThumb,
68     MediaVolumeSliderMuteButton,
69     MediaTextTrackDisplayContainer,
70     MediaTextTrackDisplay,
71     MediaExitFullscreenButton,
72     MediaOverlayPlayButton,
73     MediaClosedCaptionsContainer,
74     MediaClosedCaptionsTrackList,
75 };
76
77 HTMLMediaElement* parentMediaElement(Node*);
78 inline HTMLMediaElement* parentMediaElement(RenderObject& renderer) { return parentMediaElement(renderer.node()); }
79
80 MediaControlElementType mediaControlElementType(Node*);
81
82 // ----------------------------
83
84 class MediaControlElement {
85 public:
86     virtual void hide();
87     virtual void show();
88     virtual bool isShowing() const;
89
90     virtual MediaControlElementType displayType() { return m_displayType; }
91     virtual const AtomicString& shadowPseudoId() const = 0;
92
93     virtual void setMediaController(MediaControllerInterface* controller) { m_mediaController = controller; }
94     virtual MediaControllerInterface* mediaController() const { return m_mediaController; }
95
96 protected:
97     explicit MediaControlElement(MediaControlElementType, HTMLElement*);
98     ~MediaControlElement() { }
99
100     virtual void setDisplayType(MediaControlElementType);
101     virtual bool isMediaControlElement() const { return true; }
102
103 private:
104     MediaControllerInterface* m_mediaController;
105     MediaControlElementType m_displayType;
106     HTMLElement* m_element;
107 };
108
109 // ----------------------------
110
111 class MediaControlDivElement : public HTMLDivElement, public MediaControlElement {
112 protected:
113     virtual bool isMediaControlElement() const override { return MediaControlElement::isMediaControlElement(); }
114     explicit MediaControlDivElement(Document&, MediaControlElementType);
115 };
116
117 // ----------------------------
118
119 class MediaControlInputElement : public HTMLInputElement, public MediaControlElement {
120 protected:
121     virtual bool isMediaControlElement() const override { return MediaControlElement::isMediaControlElement(); }
122     explicit MediaControlInputElement(Document&, MediaControlElementType);
123
124 private:
125     virtual void updateDisplayType() { }
126 };
127
128 // ----------------------------
129
130 class MediaControlTimeDisplayElement : public MediaControlDivElement {
131 public:
132     void setCurrentValue(double);
133     double currentValue() const { return m_currentValue; }
134
135 protected:
136     explicit MediaControlTimeDisplayElement(Document&, MediaControlElementType);
137
138 private:
139     double m_currentValue;
140 };
141
142 // ----------------------------
143
144 class MediaControlMuteButtonElement : public MediaControlInputElement {
145 public:
146     void changedMute();
147
148     virtual bool willRespondToMouseClickEvents() override { return true; }
149
150 protected:
151     explicit MediaControlMuteButtonElement(Document&, MediaControlElementType);
152
153     virtual void defaultEventHandler(Event*) override;
154
155 private:
156     virtual void updateDisplayType() override;
157 };
158
159 // ----------------------------
160
161 class MediaControlSeekButtonElement : public MediaControlInputElement {
162 public:
163     virtual bool willRespondToMouseClickEvents() override { return true; }
164
165 protected:
166     explicit MediaControlSeekButtonElement(Document&, MediaControlElementType);
167
168     virtual void defaultEventHandler(Event*) override;
169     virtual bool isForwardButton() const = 0;
170
171 private:
172     virtual void setActive(bool /*flag*/ = true, bool /*pause*/ = false) override final;
173
174     void startTimer();
175     void stopTimer();
176     double nextRate() const;
177     void seekTimerFired(Timer<MediaControlSeekButtonElement>&);
178
179     enum ActionType { Nothing, Play, Pause };
180     ActionType m_actionOnStop;
181     enum SeekType { Skip, Scan };
182     SeekType m_seekType;
183     Timer<MediaControlSeekButtonElement> m_seekTimer;
184 };
185
186 // ----------------------------
187
188 class MediaControlVolumeSliderElement : public MediaControlInputElement {
189 public:
190     virtual bool willRespondToMouseMoveEvents() override;
191     virtual bool willRespondToMouseClickEvents() override;
192     void setVolume(double);
193     void setClearMutedOnUserInteraction(bool);
194
195 protected:
196     explicit MediaControlVolumeSliderElement(Document&);
197
198     virtual void defaultEventHandler(Event*) override;
199
200 private:
201     bool m_clearMutedOnUserInteraction;
202 };
203
204 } // namespace WebCore
205
206 #endif // ENABLE(VIDEO)
207
208 #endif // MediaControlElementTypes_h