src/third_party/WebKit/Source/platform/Widget.h

   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/IntRect.h"
  33 #include "wtf/Forward.h"
  34 #include "wtf/RefCounted.h"
  35
  36 namespace WebCore {
  37
  38 class Event;
  39 class GraphicsContext;
  40 class HostWindow;
  41
  42 // The Widget class serves as a base class for three kinds of objects:
  43 // (1) Scrollable areas (ScrollView)
  44 // (2) Scrollbars (Scrollbar)
  45 // (3) Plugins (PluginView)
  46 //
  47 // Widgets are connected in a hierarchy, with the restriction that plugins and
  48 // scrollbars are always leaves of the tree. Only ScrollViews can have children
  49 // (and therefore the Widget class has no concept of children).
  50 class PLATFORM_EXPORT Widget : public RefCounted<Widget> {
  51 public:
  52     Widget();
  53     virtual ~Widget();
  54
  55     int x() const { return frameRect().x(); }
  56     int y() const { return frameRect().y(); }
  57     int width() const { return frameRect().width(); }
  58     int height() const { return frameRect().height(); }
  59     IntSize size() const { return frameRect().size(); }
  60     IntPoint location() const { return frameRect().location(); }
  61
  62     virtual void setFrameRect(const IntRect& frame) { m_frame = frame; }
  63     const IntRect& frameRect() const { return m_frame; }
  64     IntRect boundsRect() const { return IntRect(0, 0, width(),  height()); }
  65
  66     void resize(int w, int h) { setFrameRect(IntRect(x(), y(), w, h)); }
  67     void resize(const IntSize& s) { setFrameRect(IntRect(location(), s)); }
  68     void move(int x, int y) { setFrameRect(IntRect(x, y, width(), height())); }
  69     void move(const IntPoint& p) { setFrameRect(IntRect(p, size())); }
  70
  71     virtual void paint(GraphicsContext*, const IntRect&) { }
  72     void invalidate() { invalidateRect(boundsRect()); }
  73     virtual void invalidateRect(const IntRect&) = 0;
  74
  75     virtual void setFocus(bool) { }
  76
  77     virtual void show() { }
  78     virtual void hide() { }
  79     bool isSelfVisible() const { return m_selfVisible; } // Whether or not we have been explicitly marked as visible or not.
  80     bool isParentVisible() const { return m_parentVisible; } // Whether or not our parent is visible.
  81     bool isVisible() const { return m_selfVisible && m_parentVisible; } // Whether or not we are actually visible.
  82     virtual void setParentVisible(bool visible) { m_parentVisible = visible; }
  83     void setSelfVisible(bool v) { m_selfVisible = v; }
  84
  85     virtual bool isFrameView() const { return false; }
  86     virtual bool isRemoteFrameView() const { return false; }
  87     virtual bool isPluginView() const { return false; }
  88     virtual bool isPluginContainer() const { return false; }
  89     virtual bool pluginShouldPersist() const { return false; }
  90     virtual bool isScrollbar() const { return false; }
  91     virtual bool isScrollView() const { return false; }
  92
  93     virtual HostWindow* hostWindow() const { ASSERT_NOT_REACHED(); return 0; }
  94     virtual void setParent(Widget*);
  95     Widget* parent() const { return m_parent; }
  96     Widget* root() const;
  97
  98     virtual void handleEvent(Event*) { }
  99
 100     IntRect convertToRootView(const IntRect&) const;
 101     IntRect convertFromRootView(const IntRect&) const;
 102
 103     IntPoint convertToRootView(const IntPoint&) const;
 104     IntPoint convertFromRootView(const IntPoint&) const;
 105
 106     // It is important for cross-platform code to realize that Mac has flipped coordinates. Therefore any code
 107     // that tries to convert the location of a rect using the point-based convertFromContainingWindow will end
 108     // up with an inaccurate rect. Always make sure to use the rect-based convertFromContainingWindow method
 109     // when converting window rects.
 110     IntRect convertToContainingWindow(const IntRect&) const;
 111     IntRect convertFromContainingWindow(const IntRect&) const;
 112
 113     IntPoint convertToContainingWindow(const IntPoint&) const;
 114     IntPoint convertFromContainingWindow(const IntPoint&) const;
 115
 116     virtual void frameRectsChanged() { }
 117
 118     // Notifies this widget that other widgets on the page have been repositioned.
 119     virtual void widgetPositionsUpdated() { }
 120
 121     // Virtual methods to convert points to/from the containing ScrollView
 122     virtual IntRect convertToContainingView(const IntRect&) const;
 123     virtual IntRect convertFromContainingView(const IntRect&) const;
 124     virtual IntPoint convertToContainingView(const IntPoint&) const;
 125     virtual IntPoint convertFromContainingView(const IntPoint&) const;
 126
 127     // Virtual methods to convert points to/from child widgets
 128     virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
 129     virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
 130
 131     // Notifies this widget that it will no longer be receiving events.
 132     virtual void eventListenersRemoved() { }
 133
 134 private:
 135     Widget* m_parent;
 136     IntRect m_frame;
 137     bool m_selfVisible;
 138     bool m_parentVisible;
 139 };
 140
 141 } // namespace WebCore
 142
 143 #endif // Widget_h