blob: 0937f95e287c1a3e1e88a4f141d197eb050f750e [file] [log] [blame]
* Copyright (C) 1998, 1999 Torben Weis <>
* 1999-2001 Lars Knoll <>
* 1999-2001 Antti Koivisto <>
* 2000-2001 Simon Hausmann <>
* 2000-2001 Dirk Mueller <>
* 2000 Stefan Schimanski <>
* Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
* Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
* Copyright (C) 2008 Eric Seidel <>
* 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 Frame_h
#define Frame_h
#include "core/loader/FrameLoader.h"
#include "core/loader/NavigationScheduler.h"
#include "core/frame/AdjustViewSizeOrNot.h"
#include "core/page/FrameTree.h"
#include "platform/geometry/IntSize.h"
#include "platform/scroll/ScrollTypes.h"
#include "wtf/Forward.h"
#include "wtf/RefCounted.h"
namespace WebCore {
class AnimationController;
class Color;
class DOMWindow;
class Document;
class DragImage;
class Editor;
class Element;
class EventHandler;
class FetchContext;
class FloatSize;
class FrameDestructionObserver;
class FrameSelection;
class FrameView;
class HTMLFrameOwnerElement;
class HTMLTableCellElement;
class InputMethodController;
class IntPoint;
class Node;
class Range;
class RenderPart;
class RenderView;
class TreeScope;
class ScriptController;
class Settings;
class SpellChecker;
class TreeScope;
class VisiblePosition;
class Widget;
class Frame : public RefCounted<Frame> {
static PassRefPtr<Frame> create(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
void init();
void setView(PassRefPtr<FrameView>);
void createView(const IntSize&, const Color&, bool,
ScrollbarMode = ScrollbarAuto, bool horizontalLock = false,
ScrollbarMode = ScrollbarAuto, bool verticalLock = false);
void addDestructionObserver(FrameDestructionObserver*);
void removeDestructionObserver(FrameDestructionObserver*);
void willDetachPage();
void detachFromPage();
void disconnectOwnerElement();
Page* page() const;
HTMLFrameOwnerElement* ownerElement() const;
void setDOMWindow(PassRefPtr<DOMWindow>);
DOMWindow* domWindow() const;
Document* document() const;
FrameView* view() const;
Editor& editor() const;
EventHandler& eventHandler() const;
FrameLoader& loader() const;
NavigationScheduler& navigationScheduler() const;
FrameSelection& selection() const;
FrameTree& tree() const;
AnimationController& animation() const;
InputMethodController& inputMethodController() const;
FetchContext& fetchContext() const { return loader().fetchContext(); }
ScriptController& script();
SpellChecker& spellChecker() const;
RenderView* contentRenderer() const; // Root of the render tree for the document contained in this frame.
RenderPart* ownerRenderer() const; // Renderer for the element that contains this frame.
void dispatchVisibilityStateChangeEvent();
// ======== All public functions below this point are candidates to move out of Frame into another class. ========
bool inScope(TreeScope*) const;
// See GraphicsLayerClient.h for accepted flags.
String layerTreeAsText(unsigned flags = 0) const;
String trackedRepaintRectsAsText() const;
Settings* settings() const; // can be NULL
void setPrinting(bool printing, const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkRatio, AdjustViewSizeOrNot);
bool shouldUsePrintingLayout() const;
FloatSize resizePageRectsKeepingRatio(const FloatSize& originalSize, const FloatSize& expectedSize);
bool inViewSourceMode() const;
void setInViewSourceMode(bool = true);
void setPageZoomFactor(float factor);
float pageZoomFactor() const { return m_pageZoomFactor; }
void setTextZoomFactor(float factor);
float textZoomFactor() const { return m_textZoomFactor; }
void setPageAndTextZoomFactors(float pageZoomFactor, float textZoomFactor);
void deviceOrPageScaleFactorChanged();
double devicePixelRatio() const;
// Orientation is the interface orientation in degrees. Some examples are:
// 0 is straight up; -90 is when the device is rotated 90 clockwise;
// 90 is when rotated counter clockwise.
void sendOrientationChangeEvent(int orientation);
int orientation() const { return m_orientation; }
String documentTypeString() const;
PassOwnPtr<DragImage> nodeImage(Node*);
PassOwnPtr<DragImage> dragImageForSelection();
String selectedText() const;
String selectedTextForClipboard() const;
VisiblePosition visiblePositionForPoint(const IntPoint& framePoint);
Document* documentAtPoint(const IntPoint& windowPoint);
PassRefPtr<Range> rangeForPoint(const IntPoint& framePoint);
// Should only be called on the main frame of a page.
void notifyChromeClientWheelEventHandlerCountChanged() const;
bool isURLAllowed(const KURL&) const;
// ========
Frame(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
HashSet<FrameDestructionObserver*> m_destructionObservers;
Page* m_page;
mutable FrameTree m_treeNode;
mutable FrameLoader m_loader;
mutable NavigationScheduler m_navigationScheduler;
HTMLFrameOwnerElement* m_ownerElement;
RefPtr<FrameView> m_view;
RefPtr<DOMWindow> m_domWindow;
OwnPtr<ScriptController> m_script;
const OwnPtr<Editor> m_editor;
const OwnPtr<SpellChecker> m_spellChecker;
const OwnPtr<FrameSelection> m_selection;
const OwnPtr<EventHandler> m_eventHandler;
OwnPtr<AnimationController> m_animationController;
OwnPtr<InputMethodController> m_inputMethodController;
float m_pageZoomFactor;
float m_textZoomFactor;
int m_orientation;
bool m_inViewSourceMode;
inline void Frame::init()
inline FrameLoader& Frame::loader() const
return m_loader;
inline NavigationScheduler& Frame::navigationScheduler() const
return m_navigationScheduler;
inline FrameView* Frame::view() const
return m_view.get();
inline ScriptController& Frame::script()
return *m_script;
inline DOMWindow* Frame::domWindow() const
return m_domWindow.get();
inline FrameSelection& Frame::selection() const
return *m_selection;
inline Editor& Frame::editor() const
return *m_editor;
inline SpellChecker& Frame::spellChecker() const
return *m_spellChecker;
inline AnimationController& Frame::animation() const
return *m_animationController;
inline InputMethodController& Frame::inputMethodController() const
return *m_inputMethodController;
inline HTMLFrameOwnerElement* Frame::ownerElement() const
return m_ownerElement;
inline bool Frame::inViewSourceMode() const
return m_inViewSourceMode;
inline void Frame::setInViewSourceMode(bool mode)
m_inViewSourceMode = mode;
inline FrameTree& Frame::tree() const
return m_treeNode;
inline Page* Frame::page() const
return m_page;
inline EventHandler& Frame::eventHandler() const
return *m_eventHandler;
} // namespace WebCore
#endif // Frame_h