third_party/WebKit/Source/core/html/track/TextTrackContainer.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 TextTrackContainer_h
  31 #define TextTrackContainer_h
  32
  33 #include "core/html/HTMLDivElement.h"
  34
  35 namespace blink {
  36
  37 class HTMLMediaElement;
  38
  39 class TextTrackContainer final : public HTMLDivElement {
  40 public:
  41     static PassRefPtrWillBeRawPtr<TextTrackContainer> create(Document&);
  42
  43     // Runs the "rules for updating the text track rendering". The
  44     // ExposingControls enum is used in the WebVTT processing model to reset the
  45     // layout when the media controls become visible, to avoid overlapping them.
  46     enum ExposingControls {
  47         DidNotStartExposingControls,
  48         DidStartExposingControls
  49     };
  50     void updateDisplay(HTMLMediaElement&, ExposingControls);
  51
  52 private:
  53     TextTrackContainer(Document&);
  54
  55     bool isTextTrackContainer() const override { return true; }
  56
  57     LayoutObject* createLayoutObject(const ComputedStyle&) override;
  58 };
  59
  60 DEFINE_ELEMENT_TYPE_CASTS(TextTrackContainer, isTextTrackContainer());
  61
  62 } // namespace blink
  63
  64 #endif // TextTrackContainer_h