blob: 8234a5dc0e4fa21c11ad58540f07ce19c18b02f1 [file] [log] [blame]
* Copyright (C) 1999 Lars Knoll (
* (C) 1999 Antti Koivisto (
* (C) 2001 Dirk Mueller (
* (C) 2006 Alexey Proskuryakov (
* Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012 Apple Inc. All
* rights reserved.
* Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved.
* (
* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
* Copyright (C) 2013 Google Inc. All rights reserved.
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
#ifndef Fullscreen_h
#define Fullscreen_h
#include "base/memory/scoped_refptr.h"
#include "core/CoreExport.h"
#include "core/dom/ContextLifecycleObserver.h"
#include "core/dom/Document.h"
#include "core/dom/Element.h"
#include "platform/Supplementable.h"
#include "platform/geometry/LayoutRect.h"
#include "platform/wtf/Deque.h"
#include "platform/wtf/Vector.h"
namespace blink {
class ComputedStyle;
class LayoutFullScreen;
// The Fullscreen class implements most of the Fullscreen API Standard,
//, especially its algorithms. It is a
// Document supplement as each document has some fullscreen state, and to
// actually enter and exit fullscreen it (indirectly) uses FullscreenController.
class CORE_EXPORT Fullscreen final
: public GarbageCollectedFinalized<Fullscreen>,
public Supplement<Document>,
public ContextLifecycleObserver {
virtual ~Fullscreen();
static const char* SupplementName();
static Fullscreen& From(Document&);
static Fullscreen* FromIfExists(Document&);
static Element* FullscreenElementFrom(Document&);
static Element* FullscreenElementForBindingFrom(TreeScope&);
static size_t FullscreenElementStackSizeFrom(Document&);
static bool IsFullscreenElement(const Element&);
static bool IsInFullscreenElementStack(const Element&);
enum class RequestType {
// Element.requestFullscreen()
// Element.webkitRequestFullscreen()/webkitRequestFullScreen() and
// HTMLVideoElement.webkitEnterFullscreen()/webkitEnterFullScreen()
// For WebRemoteFrameImpl to notify that a cross-process descendant frame
// has requested and is about to enter fullscreen.
static void RequestFullscreen(Element&);
static void RequestFullscreen(Element&, RequestType);
static void FullyExitFullscreen(Document&);
static void ExitFullscreen(Document&);
static bool FullscreenEnabled(Document&);
Element* FullscreenElement() const {
return !fullscreen_element_stack_.IsEmpty()
? fullscreen_element_stack_.back().first.Get()
: nullptr;
// Called by FullscreenController to notify that we've entered or exited
// fullscreen. All frames are notified, so there may be no pending request.
void DidEnterFullscreen();
void DidExitFullscreen();
void SetFullScreenLayoutObject(LayoutFullScreen*);
LayoutFullScreen* FullScreenLayoutObject() const {
return full_screen_layout_object_;
void FullScreenLayoutObjectDestroyed();
void ElementRemoved(Element&);
// ContextLifecycleObserver:
void ContextDestroyed(ExecutionContext*) override;
virtual void Trace(blink::Visitor*);
static Fullscreen* FromIfExistsSlow(Document&);
explicit Fullscreen(Document&);
Document* GetDocument();
static void ContinueRequestFullscreen(Document&,
bool error);
static void ContinueExitFullscreen(Document*, bool resize);
void ClearFullscreenElementStack();
void PopFullscreenElementStack();
void PushFullscreenElementStack(Element&, RequestType);
void FullscreenElementChanged(Element* old_element,
Element* new_element,
RequestType new_request_type);
using ElementStackEntry = std::pair<Member<Element>, RequestType>;
using ElementStack = HeapVector<ElementStackEntry>;
ElementStack pending_requests_;
ElementStack fullscreen_element_stack_;
LayoutFullScreen* full_screen_layout_object_;
LayoutRect saved_placeholder_frame_rect_;
scoped_refptr<ComputedStyle> saved_placeholder_computed_style_;
inline Fullscreen* Fullscreen::FromIfExists(Document& document) {
if (!document.HasFullscreenSupplement())
return nullptr;
return FromIfExistsSlow(document);
inline bool Fullscreen::IsFullscreenElement(const Element& element) {
if (Fullscreen* found = FromIfExists(element.GetDocument()))
return found->FullscreenElement() == &element;
return false;
} // namespace blink
#endif // Fullscreen_h