76ea49d524862fbe1f6b1b9f536ce6c23acfa509
[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 #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(const 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
92     virtual void setMediaController(MediaControllerInterface* controller) { m_mediaController = controller; }
93     virtual MediaControllerInterface* mediaController() const { return m_mediaController; }
94
95 protected:
96     explicit MediaControlElement(MediaControlElementType, HTMLElement*);
97     ~MediaControlElement() { }
98
99     virtual void setDisplayType(MediaControlElementType);
100     virtual bool isMediaControlElement() const { return true; }
101
102 private:
103     MediaControllerInterface* m_mediaController;
104     MediaControlElementType m_displayType;
105     HTMLElement* m_element;
106 };
107
108 // ----------------------------
109
110 class MediaControlDivElement : public HTMLDivElement, public MediaControlElement {
111 protected:
112     explicit MediaControlDivElement(Document&, MediaControlElementType);
113
114 private:
115     bool isMediaControlElement() const override final { return MediaControlElement::isMediaControlElement(); }
116 };
117
118 // ----------------------------
119
120 class MediaControlInputElement : public HTMLInputElement, public MediaControlElement {
121 protected:
122     explicit MediaControlInputElement(Document&, MediaControlElementType);
123
124 private:
125     bool isMediaControlElement() const override final { return MediaControlElement::isMediaControlElement(); }
126     virtual void updateDisplayType() { }
127 };
128
129 // ----------------------------
130
131 class MediaControlTimeDisplayElement : public MediaControlDivElement {
132 public:
133     void setCurrentValue(double);
134     double currentValue() const { return m_currentValue; }
135
136 protected:
137     explicit MediaControlTimeDisplayElement(Document&, MediaControlElementType);
138
139 private:
140     double m_currentValue;
141 };
142
143 // ----------------------------
144
145 class MediaControlMuteButtonElement : public MediaControlInputElement {
146 public:
147     void changedMute();
148
149     bool willRespondToMouseClickEvents() override { return true; }
150
151 protected:
152     explicit MediaControlMuteButtonElement(Document&, MediaControlElementType);
153
154     void defaultEventHandler(Event*) override;
155
156 private:
157     void updateDisplayType() override;
158 };
159
160 // ----------------------------
161
162 class MediaControlSeekButtonElement : public MediaControlInputElement {
163 public:
164     bool willRespondToMouseClickEvents() override { return true; }
165
166 protected:
167     explicit MediaControlSeekButtonElement(Document&, MediaControlElementType);
168
169     void defaultEventHandler(Event*) override;
170     virtual bool isForwardButton() const = 0;
171
172 private:
173     void setActive(bool /*flag*/ = true, bool /*pause*/ = false) override final;
174 };
175
176 // ----------------------------
177
178 class MediaControlVolumeSliderElement : public MediaControlInputElement {
179 public:
180     bool willRespondToMouseMoveEvents() override;
181     bool willRespondToMouseClickEvents() override;
182     void setVolume(double);
183     void setClearMutedOnUserInteraction(bool);
184
185 protected:
186     explicit MediaControlVolumeSliderElement(Document&);
187
188     void defaultEventHandler(Event*) override;
189
190 private:
191     bool m_clearMutedOnUserInteraction;
192 };
193
194 } // namespace WebCore
195
196 #endif // ENABLE(VIDEO)
197
198 #endif // MediaControlElementTypes_h