/*

   Copyright (C) 1997 Martin Jones (mjones@kde.org)

             (C) 1998 Waldo Bastian (bastian@kde.org)

             (C) 1998, 1999 Torben Weis (weis@kde.org)

             (C) 1999 Lars Knoll (knoll@kde.org)

             (C) 1999 Antti Koivisto (koivisto@kde.org)

   Copyright (C) 2004, 2005, 2006, 2007 Apple 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

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

   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 FrameView_h

#define FrameView_h

#include "ScrollView.h"

#include "IntSize.h"

#include <wtf/Forward.h>

#include <wtf/OwnPtr.h>

namespace WebCore {

class Color;

class Event;

class EventTargetNode;

class Frame;

class FrameViewPrivate;

class IntRect;

class PlatformMouseEvent;

class Node;

class RenderLayer;

class RenderObject;

class RenderPartObject;

class String;

template <typename T> class Timer;

class FrameView : public ScrollView {

public:

    FrameView(Frame*);

    virtual ~FrameView();

    Frame* frame() const { return m_frame.get(); }

    void clearFrame();

    void ref() { ++m_refCount; }

    void deref() { if (!--m_refCount) delete this; }

    bool hasOneRef() { return m_refCount == 1; }

    int marginWidth() const { return m_margins.width(); } // -1 means default

    int marginHeight() const { return m_margins.height(); } // -1 means default

    void setMarginWidth(int);

    void setMarginHeight(int);

    virtual void setVScrollbarMode(ScrollbarMode);

    virtual void setHScrollbarMode(ScrollbarMode);

    virtual void setScrollbarsMode(ScrollbarMode);

    void layout(bool allowSubtree = true);

    bool didFirstLayout() const;

    void layoutTimerFired(Timer<FrameView>*);

    void scheduleRelayout();

    void scheduleRelayoutOfSubtree(Node*);

    void unscheduleRelayout();

    bool layoutPending() const;

    Node* layoutRoot() const;

    int layoutCount() const;

    // These two helper functions just pass through to the RenderView.

    bool needsLayout() const;

    void setNeedsLayout();

    bool needsFullRepaint() const;

    void repaintRectangle(const IntRect&, bool immediate);

    void addRepaintInfo(RenderObject*, const IntRect&);

    void resetScrollbars();

    void clear();

    bool isTransparent() const;

    void setTransparent(bool isTransparent);

    Color baseBackgroundColor() const;

    void setBaseBackgroundColor(Color);

    void adjustViewSize();

    void initScrollbars();

    virtual IntRect windowClipRect() const;

    IntRect windowClipRect(bool clipToContents) const;

    IntRect windowClipRectForLayer(const RenderLayer*, bool clipToLayerContents) const;

    virtual void scrollRectIntoViewRecursively(const IntRect&);

    virtual void setContentsPos(int x, int y);

    String mediaType() const;

    void setMediaType(const String&);

    void setUseSlowRepaints();

    void addSlowRepaintObject();

    void removeSlowRepaintObject();

    void updateDashboardRegions();

    void updateControlTints();

    void restoreScrollbar();

    void scheduleEvent(PassRefPtr<Event>, PassRefPtr<EventTargetNode>, bool tempEvent);

    void pauseScheduledEvents();

    void resumeScheduledEvents();

    bool wasScrolledByUser() const;

    void setWasScrolledByUser(bool);

    void addWidgetToUpdate(RenderPartObject*);

    void removeWidgetToUpdate(RenderPartObject*);

    // FIXME: This method should be used by all platforms, but currently depends on ScrollView::children,

    // which not all methods have. Once FrameView and ScrollView are merged, this #if should be removed.

#if PLATFORM(WIN) || PLATFORM(GTK)

    void layoutIfNeededRecursive();

#endif

private:

    void init();

    virtual bool isFrameView() const;

    bool scrollTo(const IntRect&);

    bool useSlowRepaints() const;

    void applyOverflowToViewport(RenderObject*, ScrollbarMode& hMode, ScrollbarMode& vMode);

    void updateBorder();

    void updateOverflowStatus(bool horizontalOverflow, bool verticalOverflow);

    void dispatchScheduledEvents();

    unsigned m_refCount;

    IntSize m_size;

    IntSize m_margins;

    OwnPtr<HashSet<RenderPartObject*> > m_widgetUpdateSet;

    RefPtr<Frame> m_frame;

    FrameViewPrivate* d;

};

}

#endif