Reviewed by Hyatt.
[WebKit-https.git] / 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 WEBCORE_PLATFORM_WIDGET_H_
27 #define WEBCORE_PLATFORM_WIDGET_H_
28
29 namespace WebCore {
30     class Font;
31 }
32
33 #if __APPLE__
34 #ifdef __OBJC__
35 @class NSView;
36 #else
37 class NSView;
38 #endif
39 #endif
40
41 #if WIN32
42 typedef struct HWND__ *HWND;
43 typedef struct HINSTANCE__ *HINSTANCE;
44 #endif
45
46 namespace WebCore {
47
48     class Cursor;
49     class GraphicsContext;
50     class IntPoint;
51     class IntRect;
52     class IntSize;
53     class WidgetClient;
54     class WidgetPrivate;
55
56     enum HorizontalAlignment { AlignLeft, AlignRight, AlignHCenter };
57
58     class Widget {
59     public:
60
61         enum FocusPolicy {
62             NoFocus = 0,
63             TabFocus = 0x1,
64             ClickFocus = 0x2,
65             StrongFocus = 0x3,
66             WheelFocus = 0x7
67         };
68
69         Widget();
70         virtual ~Widget();
71
72         virtual IntSize sizeHint() const;
73         
74         virtual void setEnabled(bool);
75         virtual bool isEnabled() const;
76         
77         void setActiveWindow();
78
79         int x() const;
80         int y() const;
81         int width() const;
82         int height() const;
83         IntSize size() const;
84         void resize(int, int);
85         void resize(const IntSize&);
86         IntPoint pos() const;
87         void move(int, int);
88         void move(const IntPoint&);
89
90         virtual void paint(GraphicsContext*, const IntRect&);
91
92         virtual IntRect frameGeometry() const;
93         virtual void setFrameGeometry(const IntRect&);
94
95         virtual int baselinePosition(int height) const; // relative to the top of the widget
96
97         virtual IntPoint mapFromGlobal(const IntPoint&) const;
98
99         bool hasFocus() const;
100         void setFocus();
101         void clearFocus();
102         virtual bool checksDescendantsForFocus() const;
103
104         virtual FocusPolicy focusPolicy() const;
105
106         const Font& font() const;
107         virtual void setFont(const Font&);
108
109         void setCursor(const Cursor&);
110         Cursor cursor();
111
112         void show();
113         void hide();
114
115         virtual void populate() {}
116
117         GraphicsContext* lockDrawingFocus();
118         void unlockDrawingFocus(GraphicsContext*);
119         void enableFlushDrawing();
120         void disableFlushDrawing();
121
122         void setIsSelected(bool);
123
124         void setClient(WidgetClient*);
125         WidgetClient* client() const;
126
127         virtual bool isFrameView() const;
128
129 #if WIN32
130         Widget(HWND);
131         HWND windowHandle() const;
132         void setWindowHandle(HWND);
133         // The global DLL or application instance used for all WebCore windows.
134         static HINSTANCE instanceHandle;
135 #endif
136
137 #if __APPLE__
138         Widget(NSView* view);
139
140         NSView* getView() const;
141         NSView* getOuterView() const;
142         void setView(NSView*);
143
144         void sendConsumedMouseUp();
145         
146         static void beforeMouseDown(NSView*);
147         static void afterMouseDown(NSView*);
148
149         void addToSuperview(NSView* superview);
150         void removeFromSuperview();
151
152         static void setDeferFirstResponderChanges(bool);
153 #endif
154
155     private:
156         WidgetPrivate* data;
157     };
158
159 }
160
161 using WebCore::IntPoint; // FIXME: remove when we move everything into the WebCore namespace
162 using WebCore::IntRect; // FIXME: remove when we move everything into the WebCore namespace
163 using WebCore::IntSize; // FIXME: remove when we move everything into the WebCore namespace
164 using WebCore::Widget; // FIXME: remove when we move everything into the WebCore namespace
165
166 #endif