2009-07-02 Pierre d'Herbemont <pdherbemont@apple.com>
[WebKit-https.git] / WebCore / rendering / MediaControlElements.h
1 /*
2  * Copyright (C) 2008 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef MediaControlElements_h
30 #define MediaControlElements_h
31
32 #if ENABLE(VIDEO)
33
34 #include "HTMLDivElement.h"
35 #include "HTMLInputElement.h"
36 #include "HTMLMediaElement.h"
37 #include "RenderBlock.h"
38
39 // These are the shadow elements used in RenderMedia
40
41 namespace WebCore {
42
43 class Event;
44 class Frame;
45
46 // Must match WebKitSystemInterface.h
47 enum MediaControlElementType {
48     MediaFullscreenButton = 0,
49     MediaMuteButton,
50     MediaPlayButton,
51     MediaSeekBackButton,
52     MediaSeekForwardButton,
53     MediaSlider,
54     MediaSliderThumb,
55     MediaRewindButton,
56     MediaReturnToRealtimeButton,
57     MediaUnMuteButton,
58     MediaPauseButton,
59     MediaTimelineContainer,
60     MediaCurrentTimeDisplay, 
61     MediaTimeRemainingDisplay,
62     MediaStatusDisplay,
63     MediaControlsPanel
64 };
65
66 class MediaControlShadowRootElement : public HTMLDivElement {
67 public:
68     MediaControlShadowRootElement(Document*, HTMLMediaElement*);
69     
70     virtual bool isShadowNode() const { return true; }
71     virtual Node* shadowParentNode() { return m_mediaElement; }
72
73     void updateStyle();
74     
75 private:
76     HTMLMediaElement* m_mediaElement;    
77 };
78
79 // ----------------------------
80
81 class MediaControlElement : public HTMLDivElement
82 {
83 public:
84     MediaControlElement(Document*, PseudoId, HTMLMediaElement*);
85     void attachToParent(Element*);
86     void update();
87     void updateStyle();
88 protected:
89     HTMLMediaElement* m_mediaElement;   
90     PseudoId m_pseudoStyleId;
91 };
92
93 // ----------------------------
94
95 class MediaControlTimelineContainerElement : public MediaControlElement {
96 public:
97     MediaControlTimelineContainerElement(Document*, HTMLMediaElement*);
98     virtual bool rendererIsNeeded(RenderStyle* style);
99 };
100
101 // ----------------------------
102
103 class MediaControlStatusDisplayElement : public MediaControlElement {
104 public:
105     MediaControlStatusDisplayElement(Document*, HTMLMediaElement*);
106     virtual void update();
107     virtual bool rendererIsNeeded(RenderStyle* style);
108 private:
109     enum StateBeingDisplayed { Nothing, Loading, LiveBroadcast };
110     StateBeingDisplayed m_stateBeingDisplayed;
111 };
112
113 // ----------------------------
114
115 class MediaControlInputElement : public HTMLInputElement {
116 public:
117     MediaControlInputElement(Document*, PseudoId, const String& type, HTMLMediaElement*, MediaControlElementType);
118     void attachToParent(Element*);
119     void update();
120     virtual void updateStyle();
121     bool hitTest(const IntPoint& absPoint);
122     MediaControlElementType displayType() const { return m_displayType; }
123
124 protected:
125     virtual void updateDisplayType() { }
126     void setDisplayType(MediaControlElementType);
127
128     HTMLMediaElement* m_mediaElement;   
129     PseudoId m_pseudoStyleId;
130     MediaControlElementType m_displayType;  // some elements can show multiple types (e.g. play/pause)
131 };
132
133 // ----------------------------
134
135 class MediaControlMuteButtonElement : public MediaControlInputElement {
136 public:
137     MediaControlMuteButtonElement(Document*, HTMLMediaElement*);
138     virtual void defaultEventHandler(Event*);
139     virtual void updateDisplayType();
140 };
141
142 // ----------------------------
143
144 class MediaControlPlayButtonElement : public MediaControlInputElement {
145 public:
146     MediaControlPlayButtonElement(Document*, HTMLMediaElement*);
147     virtual void defaultEventHandler(Event*);
148     virtual void updateDisplayType();
149 };
150
151 // ----------------------------
152
153 class MediaControlSeekButtonElement : public MediaControlInputElement {
154 public:
155     MediaControlSeekButtonElement(Document*, HTMLMediaElement*, bool forward);
156     virtual void defaultEventHandler(Event*);
157     void seekTimerFired(Timer<MediaControlSeekButtonElement>*);
158
159 private:
160     bool m_forward;
161     bool m_seeking;
162     bool m_capturing;
163     Timer<MediaControlSeekButtonElement> m_seekTimer;
164 };
165     
166 // ----------------------------
167
168 class MediaControlRewindButtonElement : public MediaControlInputElement {
169 public:
170     MediaControlRewindButtonElement(Document*, HTMLMediaElement*);
171     virtual void defaultEventHandler(Event*);
172 };
173
174 // ----------------------------
175
176 class MediaControlReturnToRealtimeButtonElement : public MediaControlInputElement {
177 public:
178     MediaControlReturnToRealtimeButtonElement(Document*, HTMLMediaElement*);
179     virtual void defaultEventHandler(Event*);
180     virtual bool rendererIsNeeded(RenderStyle*);
181 };    
182
183 // ----------------------------
184
185 class MediaControlTimelineElement : public MediaControlInputElement {
186 public:
187     MediaControlTimelineElement(Document*, HTMLMediaElement*);
188     virtual void defaultEventHandler(Event*);
189     void update(bool updateDuration = true);
190 };
191
192 // ----------------------------
193
194 class MediaControlFullscreenButtonElement : public MediaControlInputElement {
195 public:
196     MediaControlFullscreenButtonElement(Document*, HTMLMediaElement*);
197     virtual void defaultEventHandler(Event*);
198     virtual bool rendererIsNeeded(RenderStyle*);
199 };
200
201 // ----------------------------
202
203 class RenderMediaControlShadowRoot : public RenderBlock {
204 public:
205     RenderMediaControlShadowRoot(Element* e) : RenderBlock(e) { }
206     void setParent(RenderObject* p) { RenderObject::setParent(p); }
207 };
208     
209 // ----------------------------
210
211 } //namespace WebCore
212 #endif // enable(video)
213 #endif // MediaControlElements_h