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.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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.
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"
40 class GraphicsContext;
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)
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).
51 class PLATFORM_EXPORT Widget : public RefCounted<Widget> {
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(); }
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()); }
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())); }
72 virtual void paint(GraphicsContext*, const IntRect&) { }
73 void invalidate() { invalidateRect(boundsRect()); }
74 virtual void invalidateRect(const IntRect&) = 0;
76 virtual void setFocus(bool) { }
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; }
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; }
94 virtual HostWindow* hostWindow() const { ASSERT_NOT_REACHED(); return 0; }
95 virtual void setParent(Widget*);
96 Widget* parent() const { return m_parent; }
99 virtual void handleEvent(Event*) { }
101 IntRect convertToRootView(const IntRect&) const;
102 IntRect convertFromRootView(const IntRect&) const;
104 IntPoint convertToRootView(const IntPoint&) const;
105 IntPoint convertFromRootView(const IntPoint&) const;
107 // It is important for cross-platform code to realize that Mac has flipped coordinates. Therefore any code
108 // that tries to convert the location of a rect using the point-based convertFromContainingWindow will end
109 // up with an inaccurate rect. Always make sure to use the rect-based convertFromContainingWindow method
110 // when converting window rects.
111 IntRect convertToContainingWindow(const IntRect&) const;
112 IntRect convertFromContainingWindow(const IntRect&) const;
114 IntPoint convertToContainingWindow(const IntPoint&) const;
115 IntPoint convertFromContainingWindow(const IntPoint&) const;
116 FloatPoint convertFromContainingWindow(const FloatPoint&) const;
118 virtual void frameRectsChanged() { }
120 // Notifies this widget that other widgets on the page have been repositioned.
121 virtual void widgetPositionsUpdated() { }
123 // Virtual methods to convert points to/from the containing ScrollView
124 virtual IntRect convertToContainingView(const IntRect&) const;
125 virtual IntRect convertFromContainingView(const IntRect&) const;
126 virtual IntPoint convertToContainingView(const IntPoint&) const;
127 virtual IntPoint convertFromContainingView(const IntPoint&) const;
129 // Virtual methods to convert points to/from child widgets
130 virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
131 virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
133 // Notifies this widget that it will no longer be receiving events.
134 virtual void eventListenersRemoved() { }
137 virtual void detach() { }
144 bool m_parentVisible;