Use "= default" to denote default constructor or destructor
[WebKit-https.git] / Source / WebCore / html / shadow / MediaControls.h
index 433b17b..c2bae97 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Copyright (C) 2011 Apple Inc. All rights reserved.
- * Copyright (C) 2011 Google Inc. All rights reserved.
+ * Copyright (C) 2011, 2012 Apple Inc. All rights reserved.
+ * Copyright (C) 2011, 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
- * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef MediaControls_h
-#define MediaControls_h
+#pragma once
 
 #if ENABLE(VIDEO)
 
+#include "Chrome.h"
 #include "HTMLDivElement.h"
+#include "MediaControlElements.h"
+#include <wtf/RefPtr.h>
+
+#if ENABLE(VIDEO_TRACK)
+#include "TextTrackCue.h"
+#endif
 
 namespace WebCore {
 
-class HTMLMediaElement;
+class Document;
+class Event;
+class MediaPlayer;
+
+class RenderBox;
+class RenderMedia;
 
+// An abstract class with the media control elements that all ports support.
 class MediaControls : public HTMLDivElement {
   public:
-    virtual ~MediaControls() {}
+    virtual ~MediaControls() = default;
 
     // This function is to be implemented in your port-specific media
-    // controls implementation.
-    static PassRefPtr<MediaControls> create(HTMLMediaElement*);
+    // controls implementation since it will return a child instance.
+    static RefPtr<MediaControls> tryCreate(Document&);
+
+    virtual void setMediaController(MediaControllerInterface*);
+
+    virtual void reset();
+    virtual void reportedError();
+    virtual void loadedMetadata();
 
-    virtual void show() = 0;
-    virtual void hide() = 0;
-    virtual void makeOpaque() = 0;
-    virtual void makeTransparent() = 0;
+    virtual void show();
+    virtual void hide();
+    virtual void makeOpaque();
+    virtual void makeTransparent();
+    virtual bool shouldHideControls();
 
-    virtual void reset() = 0;
+    virtual void bufferingProgressed();
+    virtual void playbackStarted();
+    virtual void playbackProgressed();
+    virtual void playbackStopped();
 
-    virtual void playbackProgressed() = 0;
-    virtual void playbackStarted() = 0;
-    virtual void playbackStopped() = 0;
+    virtual void updateStatusDisplay() { };
+    virtual void updateCurrentTimeDisplay();
+    virtual void showVolumeSlider();
 
-    virtual void changedMute() = 0;
-    virtual void changedVolume() = 0;
+    virtual void changedMute();
+    virtual void changedVolume();
 
-    virtual void enteredFullscreen() = 0;
-    virtual void exitedFullscreen() = 0;
+    virtual void changedClosedCaptionsVisibility();
+    virtual void refreshClosedCaptionsButtonVisibility();
+    virtual void toggleClosedCaptionTrackList() { }
+    virtual void closedCaptionTracksChanged();
 
-    virtual void reportedError() = 0;
-    virtual void loadedMetadata() = 0;
-    virtual void changedClosedCaptionsVisibility() = 0;
+    virtual void enteredFullscreen();
+    virtual void exitedFullscreen();
 
-    virtual void showVolumeSlider() = 0;
-    virtual void updateTimeDisplay() = 0;
-    virtual void updateStatusDisplay() = 0;
+#if !PLATFORM(IOS)
+    bool willRespondToMouseMoveEvents() override { return true; }
+#endif
 
-    virtual bool shouldHideControls() = 0;
+    virtual void hideFullscreenControlsTimerFired();
+    virtual void startHideFullscreenControlsTimer();
+    virtual void stopHideFullscreenControlsTimer();
+
+#if ENABLE(VIDEO_TRACK)
+    virtual void createTextTrackDisplay();
+    virtual void showTextTrackDisplay();
+    virtual void hideTextTrackDisplay();
+    virtual void updateTextTrackDisplay();
+    virtual void textTrackPreferencesChanged();
+    virtual void clearTextDisplayContainer();
+#endif
 
 protected:
-    MediaControls(HTMLMediaElement*);
+    explicit MediaControls(Document&);
+
+    void defaultEventHandler(Event&) override;
+
+    virtual bool containsRelatedTarget(Event&);
+
+    void setSliderVolume();
+
+    MediaControllerInterface* m_mediaController;
+
+    // Container for the media control elements.
+    MediaControlPanelElement* m_panel;
+
+    // Container for the text track cues.
+#if ENABLE(VIDEO_TRACK)
+    MediaControlTextTrackContainerElement* m_textDisplayContainer;
+#endif
+
+    // Media control elements.
+    MediaControlPlayButtonElement* m_playButton;
+    MediaControlCurrentTimeDisplayElement* m_currentTimeDisplay;
+    MediaControlTimelineElement* m_timeline;
+    MediaControlPanelMuteButtonElement* m_panelMuteButton;
+    MediaControlPanelVolumeSliderElement* m_volumeSlider;
+    MediaControlToggleClosedCaptionsButtonElement* m_toggleClosedCaptionsButton;
+    MediaControlFullscreenButtonElement* m_fullScreenButton;
+
+    Timer m_hideFullscreenControlsTimer;
+    bool m_isFullscreen;
+    bool m_isMouseOverControls;
 
 private:
-    MediaControls();
+    bool isMediaControls() const final { return true; }
 };
 
+inline MediaControls* toMediaControls(Node* node)
+{
+    ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isMediaControls());
+    return static_cast<MediaControls*>(node);
 }
 
-#endif
+// This will catch anyone doing an unneccessary cast.
+void toMediaControls(const MediaControls*);
 
-#endif
+} // namespace WebCore
+
+#endif // ENABLE(VIDEO)