WebCore/platform/Widget.h

   1 /*
   2  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef Widget_h
  27 #define Widget_h
  28
  29 #include <wtf/Platform.h>
  30
  31 #if PLATFORM(MAC)
  32 #ifdef __OBJC__
  33 @class NSView;
  34 #else
  35 class NSView;
  36 #endif
  37 #endif
  38
  39 #if PLATFORM(WIN)
  40 typedef struct HWND__* HWND;
  41 #endif
  42
  43 #if PLATFORM(GTK)
  44 typedef struct _GdkDrawable GdkDrawable;
  45 typedef struct _GtkWidget GtkWidget;
  46 typedef struct _GtkContainer GtkContainer;
  47 #endif
  48
  49 #if PLATFORM(QT)
  50 class QWidget;
  51 class QWebFrame;
  52 #endif
  53
  54 #if PLATFORM(WX)
  55 class wxScrolledWindow;
  56 #endif
  57
  58 namespace WebCore {
  59
  60     class Cursor;
  61     class Event;
  62     class Font;
  63     class GraphicsContext;
  64     class IntPoint;
  65     class IntRect;
  66     class IntSize;
  67     class PlatformMouseEvent;
  68     class ScrollView;
  69     class WidgetClient;
  70     class WidgetPrivate;
  71
  72     class Widget {
  73     public:
  74         Widget();
  75         virtual ~Widget();
  76
  77         virtual void setEnabled(bool);
  78         virtual bool isEnabled() const;
  79
  80         int x() const;
  81         int y() const;
  82         int width() const;
  83         int height() const;
  84         IntSize size() const;
  85         void resize(int, int);
  86         void resize(const IntSize&);
  87         IntPoint pos() const;
  88         void move(int, int);
  89         void move(const IntPoint&);
  90
  91         virtual void paint(GraphicsContext*, const IntRect&);
  92         virtual void invalidate();
  93         virtual void invalidateRect(const IntRect&);
  94
  95         virtual void setFrameGeometry(const IntRect&);
  96         virtual IntRect frameGeometry() const;
  97
  98         virtual void setFocus();
  99
 100         void setCursor(const Cursor&);
 101         Cursor cursor();
 102
 103         virtual void show();
 104         virtual void hide();
 105
 106         void setIsSelected(bool);
 107
 108         void setClient(WidgetClient*);
 109         WidgetClient* client() const;
 110
 111         virtual bool isFrameView() const;
 112
 113         virtual void removeFromParent();
 114
 115         // This method is used by plugins on all platforms to obtain a clip rect that includes clips set by WebCore,
 116         // e.g., in overflow:auto sections.  The clip rects coordinates are in the containing window's coordinate space.
 117         // This clip includes any clips that the widget itself sets up for its children.
 118         virtual IntRect windowClipRect() const;
 119
 120         virtual void handleEvent(Event*) { }
 121
 122 #if PLATFORM(WIN)
 123         void setContainingWindow(HWND);
 124         HWND containingWindow() const;
 125
 126         virtual void setParent(ScrollView*);
 127         ScrollView* parent() const;
 128
 129         virtual void attachToWindow() { }
 130         virtual void detachFromWindow() { }
 131
 132         virtual void geometryChanged() const {};
 133
 134         IntRect convertToContainingWindow(const IntRect&) const;
 135         IntPoint convertToContainingWindow(const IntPoint&) const;
 136         IntPoint convertFromContainingWindow(const IntPoint&) const;
 137
 138         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
 139         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
 140
 141         bool suppressInvalidation() const;
 142         void setSuppressInvalidation(bool);
 143
 144 #endif
 145
 146 #if PLATFORM(GTK)
 147         virtual void setParent(ScrollView*);
 148         ScrollView* parent() const;
 149
 150         void setContainingWindow(GtkContainer*);
 151         GtkContainer* containingWindow() const;
 152
 153         virtual void geometryChanged() const;
 154
 155         IntRect convertToContainingWindow(const IntRect&) const;
 156         IntPoint convertToContainingWindow(const IntPoint&) const;
 157         IntPoint convertFromContainingWindow(const IntPoint&) const;
 158
 159         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
 160         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
 161
 162         bool suppressInvalidation() const;
 163         void setSuppressInvalidation(bool);
 164
 165         GtkWidget* gtkWidget() const;
 166 protected:
 167         void setGtkWidget(GtkWidget*);
 168 #endif
 169
 170 #if PLATFORM(QT)
 171         QWidget* qwidget() const;
 172         void setQWidget(QWidget *widget);
 173         QWidget* containingWindow() const;
 174
 175         QWebFrame* qwebframe() const;
 176         void setQWebFrame(QWebFrame *webFrame);
 177         virtual void setParent(ScrollView*);
 178         ScrollView* parent() const;
 179         virtual void geometryChanged() const;
 180
 181         IntRect convertToContainingWindow(const IntRect&) const;
 182         IntPoint convertToContainingWindow(const IntPoint&) const;
 183         IntPoint convertFromContainingWindow(const IntPoint&) const;
 184
 185         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
 186         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
 187 #endif
 188
 189 #if PLATFORM(MAC)
 190         Widget(NSView*);
 191
 192         NSView* getView() const;
 193         NSView* getOuterView() const;
 194         void setView(NSView*);
 195
 196         static void beforeMouseDown(NSView*, Widget*);
 197         static void afterMouseDown(NSView*, Widget*);
 198
 199         void addToSuperview(NSView* superview);
 200         void removeFromSuperview();
 201         IntPoint convertToScreenCoordinate(NSView*, const IntPoint&);
 202 #endif
 203
 204 #if PLATFORM(WX)
 205         Widget(wxScrolledWindow*);
 206         wxScrolledWindow* nativeWindow() const;
 207         void setNativeWindow(wxScrolledWindow*);
 208 #endif
 209
 210     private:
 211         WidgetPrivate* data;
 212     };
 213
 214 } // namespace WebCore
 215
 216 #endif // Widget_h