1/*
2 * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.  All rights reserved.
3 * Copyright (C) 2008 Collabora Ltd.  All rights reserved.
4 * Copyright (C) 2013 Google Inc.  All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
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 *
15 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
16 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#ifndef Widget_h
29#define Widget_h
30
31#include "platform/PlatformExport.h"
32#include "platform/geometry/FloatPoint.h"
33#include "platform/geometry/IntRect.h"
34#include "wtf/Forward.h"
35#include "wtf/RefCounted.h"
36
37namespace blink {
38
39class Event;
40class GraphicsContext;
41class HostWindow;
42
43// The Widget class serves as a base class for three kinds of objects:
44// (1) Scrollable areas (ScrollView)
45// (2) Scrollbars (Scrollbar)
46// (3) Plugins (PluginView)
47//
48// Widgets are connected in a hierarchy, with the restriction that plugins and
49// scrollbars are always leaves of the tree. Only ScrollViews can have children
50// (and therefore the Widget class has no concept of children).
51class PLATFORM_EXPORT Widget : public RefCounted<Widget> {
52public:
53    Widget();
54    virtual ~Widget();
55
56    int x() const { return frameRect().x(); }
57    int y() const { return frameRect().y(); }
58    int width() const { return frameRect().width(); }
59    int height() const { return frameRect().height(); }
60    IntSize size() const { return frameRect().size(); }
61    IntPoint location() const { return frameRect().location(); }
62
63    virtual void setFrameRect(const IntRect& frame) { m_frame = frame; }
64    const IntRect& frameRect() const { return m_frame; }
65    IntRect boundsRect() const { return IntRect(0, 0, width(),  height()); }
66
67    void resize(int w, int h) { setFrameRect(IntRect(x(), y(), w, h)); }
68    void resize(const IntSize& s) { setFrameRect(IntRect(location(), s)); }
69    void move(int x, int y) { setFrameRect(IntRect(x, y, width(), height())); }
70    void move(const IntPoint& p) { setFrameRect(IntRect(p, size())); }
71
72    virtual void paint(GraphicsContext*, const IntRect&) { }
73    void invalidate() { invalidateRect(boundsRect()); }
74    virtual void invalidateRect(const IntRect&) = 0;
75
76    virtual void setFocus(bool) { }
77
78    virtual void show() { }
79    virtual void hide() { }
80    bool isSelfVisible() const { return m_selfVisible; } // Whether or not we have been explicitly marked as visible or not.
81    bool isParentVisible() const { return m_parentVisible; } // Whether or not our parent is visible.
82    bool isVisible() const { return m_selfVisible && m_parentVisible; } // Whether or not we are actually visible.
83    virtual void setParentVisible(bool visible) { m_parentVisible = visible; }
84    void setSelfVisible(bool v) { m_selfVisible = v; }
85
86    virtual bool isFrameView() const { return false; }
87    virtual bool isRemoteFrameView() const { return false; }
88    virtual bool isPluginView() const { return false; }
89    virtual bool isPluginContainer() const { return false; }
90    virtual bool pluginShouldPersist() const { return false; }
91    virtual bool isScrollbar() const { return false; }
92    virtual bool isScrollView() const { return false; }
93
94    virtual HostWindow* hostWindow() const { ASSERT_NOT_REACHED(); return 0; }
95    virtual void setParent(Widget*);
96    Widget* parent() const { return m_parent; }
97    Widget* root() const;
98
99    virtual void handleEvent(Event*) { }
100
101    // It is important for cross-platform code to realize that Mac has flipped coordinates. Therefore any code
102    // that tries to convert the location of a rect using the point-based convertFromContainingWindow will end
103    // up with an inaccurate rect. Always make sure to use the rect-based convertFromContainingWindow method
104    // when converting window rects.
105    IntRect convertToContainingWindow(const IntRect&) const;
106    IntRect convertFromContainingWindow(const IntRect&) const;
107
108    IntPoint convertToContainingWindow(const IntPoint&) const;
109    IntPoint convertFromContainingWindow(const IntPoint&) const;
110    FloatPoint convertFromContainingWindow(const FloatPoint&) const;
111
112    virtual void frameRectsChanged() { }
113
114    // Notifies this widget that other widgets on the page have been repositioned.
115    virtual void widgetPositionsUpdated() { }
116
117    // Virtual methods to convert points to/from the containing ScrollView
118    virtual IntRect convertToContainingView(const IntRect&) const;
119    virtual IntRect convertFromContainingView(const IntRect&) const;
120    virtual IntPoint convertToContainingView(const IntPoint&) const;
121    virtual IntPoint convertFromContainingView(const IntPoint&) const;
122
123    // Virtual methods to convert points to/from child widgets
124    virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
125    virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
126
127    // Notifies this widget that it will no longer be receiving events.
128    virtual void eventListenersRemoved() { }
129
130#if ENABLE(OILPAN)
131    virtual void detach() { }
132#endif
133
134private:
135    Widget* m_parent;
136    IntRect m_frame;
137    bool m_selfVisible;
138    bool m_parentVisible;
139};
140
141} // namespace blink
142
143#endif // Widget_h
144