]>
Commit | Line | Data |
---|---|---|
0dbd6262 SC |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: window.h | |
3 | // Purpose: wxWindow class | |
4 | // Author: AUTHOR | |
5 | // Modified by: | |
6 | // Created: ??/??/98 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) AUTHOR | |
9 | // Licence: wxWindows licence | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_WINDOW_H_ | |
13 | #define _WX_WINDOW_H_ | |
14 | ||
15 | #ifdef __GNUG__ | |
16 | #pragma interface "window.h" | |
17 | #endif | |
18 | ||
519cb848 SC |
19 | // --------------------------------------------------------------------------- |
20 | // forward declarations | |
21 | // --------------------------------------------------------------------------- | |
0dbd6262 | 22 | |
519cb848 | 23 | class WXDLLEXPORT wxButton; |
e7549107 | 24 | class WXDLLEXPORT wxScrollBar; |
0dbd6262 | 25 | |
519cb848 SC |
26 | // --------------------------------------------------------------------------- |
27 | // constants | |
28 | // --------------------------------------------------------------------------- | |
0dbd6262 | 29 | |
519cb848 SC |
30 | // FIXME does anybody use those? they're unused by wxWindows... |
31 | enum | |
0dbd6262 | 32 | { |
519cb848 SC |
33 | wxKEY_SHIFT = 1, |
34 | wxKEY_CTRL = 2 | |
0dbd6262 SC |
35 | }; |
36 | ||
519cb848 | 37 | class WXDLLEXPORT wxWindow: public wxWindowBase |
0dbd6262 | 38 | { |
519cb848 | 39 | DECLARE_DYNAMIC_CLASS(wxWindow); |
0dbd6262 SC |
40 | |
41 | friend class wxDC; | |
42 | friend class wxPaintDC; | |
43 | ||
44 | public: | |
519cb848 SC |
45 | typedef struct MacWindowData |
46 | { | |
47 | SInt16 m_macWindowBackgroundTheme ; | |
48 | WindowRef m_macWindow ; | |
49 | ControlHandle m_macRootControl ; | |
50 | wxWindow* m_macFocus ; | |
fdaf613a | 51 | bool m_macHasReceivedFirstActivate ; |
519cb848 SC |
52 | } MacWindowData ; |
53 | ||
54 | ||
55 | wxWindow() { Init(); } | |
56 | ||
57 | wxWindow(wxWindow *parent, | |
58 | wxWindowID id, | |
59 | const wxPoint& pos = wxDefaultPosition, | |
60 | const wxSize& size = wxDefaultSize, | |
61 | long style = 0, | |
62 | const wxString& name = wxPanelNameStr) | |
63 | { | |
64 | Init(); | |
65 | Create(parent, id, pos, size, style, name); | |
66 | } | |
67 | ||
68 | virtual ~wxWindow(); | |
69 | ||
70 | bool Create(wxWindow *parent, | |
71 | wxWindowID id, | |
72 | const wxPoint& pos = wxDefaultPosition, | |
73 | const wxSize& size = wxDefaultSize, | |
74 | long style = 0, | |
75 | const wxString& name = wxPanelNameStr); | |
76 | ||
77 | ||
78 | // implement base class pure virtuals | |
79 | virtual void SetTitle( const wxString& title); | |
80 | virtual wxString GetTitle() const; | |
81 | ||
82 | virtual void Raise(); | |
83 | virtual void Lower(); | |
84 | ||
85 | virtual bool Show( bool show = TRUE ); | |
86 | virtual bool Enable( bool enable = TRUE ); | |
87 | ||
88 | virtual void SetFocus(); | |
89 | ||
519cb848 SC |
90 | virtual void WarpPointer(int x, int y); |
91 | virtual void CaptureMouse(); | |
92 | virtual void ReleaseMouse(); | |
93 | ||
94 | virtual void Refresh( bool eraseBackground = TRUE, | |
95 | const wxRect *rect = (const wxRect *) NULL ); | |
96 | virtual void Clear(); | |
97 | ||
98 | virtual bool SetCursor( const wxCursor &cursor ); | |
99 | virtual bool SetFont( const wxFont &font ); | |
100 | ||
101 | virtual int GetCharHeight() const; | |
102 | virtual int GetCharWidth() const; | |
103 | virtual void GetTextExtent(const wxString& string, | |
104 | int *x, int *y, | |
105 | int *descent = (int *) NULL, | |
106 | int *externalLeading = (int *) NULL, | |
107 | const wxFont *theFont = (const wxFont *) NULL) | |
108 | const; | |
109 | ||
110 | virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); | |
111 | ||
112 | virtual void SetScrollbar( int orient, int pos, int thumbVisible, | |
113 | int range, bool refresh = TRUE ); | |
114 | virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ); | |
115 | virtual int GetScrollPos( int orient ) const; | |
116 | virtual int GetScrollThumb( int orient ) const; | |
117 | virtual int GetScrollRange( int orient ) const; | |
118 | virtual void ScrollWindow( int dx, int dy, | |
119 | const wxRect* rect = (wxRect *) NULL ); | |
0dbd6262 SC |
120 | |
121 | #if wxUSE_DRAG_AND_DROP | |
519cb848 SC |
122 | virtual void SetDropTarget( wxDropTarget *dropTarget ); |
123 | #endif // wxUSE_DRAG_AND_DROP | |
124 | ||
125 | // Accept files for dragging | |
126 | virtual void DragAcceptFiles(bool accept); | |
127 | ||
128 | #if WXWIN_COMPATIBILITY | |
129 | // Set/get scroll attributes | |
130 | virtual void SetScrollRange(int orient, int range, bool refresh = TRUE); | |
131 | virtual void SetScrollPage(int orient, int page, bool refresh = TRUE); | |
132 | virtual int OldGetScrollRange(int orient) const; | |
133 | virtual int GetScrollPage(int orient) const; | |
134 | ||
135 | // event handlers | |
136 | // Handle a control command | |
137 | virtual void OnCommand(wxWindow& win, wxCommandEvent& event); | |
138 | ||
139 | // Override to define new behaviour for default action (e.g. double | |
140 | // clicking on a listbox) | |
141 | virtual void OnDefaultAction(wxControl * WXUNUSED(initiatingItem)) { } | |
142 | #endif // WXWIN_COMPATIBILITY | |
143 | ||
144 | #if wxUSE_CARET && WXWIN_COMPATIBILITY | |
145 | // caret manipulation (old MSW only functions, see wxCaret class for the | |
146 | // new API) | |
147 | void CreateCaret(int w, int h); | |
148 | void CreateCaret(const wxBitmap *bitmap); | |
149 | void DestroyCaret(); | |
150 | void ShowCaret(bool show); | |
151 | void SetCaretPos(int x, int y); | |
152 | void GetCaretPos(int *x, int *y) const; | |
153 | #endif // wxUSE_CARET | |
154 | ||
155 | // Native resource loading (implemented in src/msw/nativdlg.cpp) | |
156 | // FIXME: should they really be all virtual? | |
519cb848 SC |
157 | wxWindow* GetWindowChild1(wxWindowID id); |
158 | wxWindow* GetWindowChild(wxWindowID id); | |
159 | ||
160 | // implementation from now on | |
161 | // -------------------------- | |
162 | ||
163 | void MacClientToRootWindow( int *x , int *y ) const ; | |
164 | void MacRootWindowToClient( int *x , int *y ) const ; | |
05adb9d2 SC |
165 | |
166 | virtual wxString MacGetToolTipString( wxPoint &where ) ; | |
519cb848 SC |
167 | |
168 | // simple accessors | |
169 | // ---------------- | |
170 | ||
e7549107 SC |
171 | // WXHWND GetHWND() const { return m_hWnd; } |
172 | // void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; } | |
173 | virtual WXWidget GetHandle() const { return (WXWidget) NULL ; } | |
519cb848 SC |
174 | |
175 | bool GetUseCtl3D() const { return m_useCtl3D; } | |
176 | bool GetTransparentBackground() const { return m_backgroundTransparent; } | |
177 | void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; } | |
178 | ||
179 | // event handlers | |
180 | // -------------- | |
7810c95b | 181 | void OnSetFocus(wxFocusEvent& event) ; |
519cb848 SC |
182 | void OnEraseBackground(wxEraseEvent& event); |
183 | void OnIdle(wxIdleEvent& event); | |
7c74e7fe | 184 | void MacOnScroll(wxScrollEvent&event ) ; |
4765d335 SC |
185 | |
186 | bool AcceptsFocus() const ; | |
0dbd6262 | 187 | |
519cb848 SC |
188 | public: |
189 | // For implementation purposes - sometimes decorations make the client area | |
190 | // smaller | |
191 | virtual wxPoint GetClientAreaOrigin() const; | |
0dbd6262 | 192 | |
519cb848 SC |
193 | // Makes an adjustment to the window position (for example, a frame that has |
194 | // a toolbar that it manages itself). | |
195 | virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags); | |
0dbd6262 | 196 | |
519cb848 SC |
197 | wxWindow *FindItem(long id) const; |
198 | wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const; | |
0dbd6262 | 199 | |
519cb848 SC |
200 | // Make a Windows extended style from the given wxWindows window style |
201 | static WXDWORD MakeExtendedStyle(long style, | |
202 | bool eliminateBorders = TRUE); | |
203 | // Determine whether 3D effects are wanted | |
204 | WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D) const; | |
0dbd6262 | 205 | |
519cb848 SC |
206 | // MSW only: TRUE if this control is part of the main control |
207 | virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; }; | |
0dbd6262 | 208 | |
519cb848 SC |
209 | #if WXWIN_COMPATIBILITY |
210 | wxObject *GetChild(int number) const; | |
211 | virtual void MSWDeviceToLogical(float *x, float *y) const; | |
212 | #endif // WXWIN_COMPATIBILITY | |
0dbd6262 | 213 | |
519cb848 SC |
214 | // Setup background and foreground colours correctly |
215 | virtual void SetupColours(); | |
0dbd6262 | 216 | |
0dbd6262 | 217 | |
519cb848 SC |
218 | #if WXWIN_COMPATIBILITY |
219 | void SetShowing(bool show) { (void)Show(show); } | |
220 | bool IsUserEnabled() const { return IsEnabled(); } | |
221 | #endif // WXWIN_COMPATIBILITY | |
0dbd6262 | 222 | |
519cb848 SC |
223 | // Responds to colour changes: passes event on to children. |
224 | void OnSysColourChanged(wxSysColourChangedEvent& event); | |
e7549107 | 225 | public : |
05adb9d2 SC |
226 | virtual void MacCreateRealWindow( const wxString& title, |
227 | const wxPoint& pos, | |
228 | const wxSize& size, | |
229 | long style, | |
230 | const wxString& name ) ; | |
e7549107 SC |
231 | static bool MacGetWindowFromPoint( const wxPoint &point , wxWindow** outWin ) ; |
232 | virtual void MacActivate( EventRecord *ev , bool inIsActivating ) ; | |
233 | virtual void MacUpdate( EventRecord *ev ) ; | |
234 | virtual void MacUpdateImmediately() ; | |
235 | virtual void MacRedraw( RgnHandle updatergn , long time) ; | |
236 | virtual void MacMouseDown( EventRecord *ev , short windowPart ) ; | |
237 | virtual void MacMouseUp( EventRecord *ev , short windowPart ) ; | |
238 | virtual void MacMouseMoved( EventRecord *ev , short windowPart ) ; | |
239 | virtual void MacKeyDown( EventRecord *ev ) ; | |
240 | virtual bool MacCanFocus() const { return true ; } | |
241 | ||
242 | virtual void MacFireMouseEvent( EventRecord *ev ) ; | |
243 | virtual bool MacDispatchMouseEvent(wxMouseEvent& event ) ; | |
244 | virtual void MacEraseBackground( Rect *rect ) ; | |
05adb9d2 SC |
245 | virtual void MacPaintBorders() ; |
246 | // obsolete : only for link compatibility | |
8208e181 | 247 | virtual void MacPaint( wxPaintEvent &event ) ; |
05adb9d2 | 248 | WindowRef GetMacRootWindow() const ; |
e7549107 | 249 | |
05adb9d2 | 250 | virtual ControlHandle MacGetContainerForEmbedding() ; |
5b781a67 SC |
251 | |
252 | virtual long MacGetLeftBorderSize() const ; | |
253 | virtual long MacGetRightBorderSize() const ; | |
254 | virtual long MacGetTopBorderSize() const ; | |
255 | virtual long MacGetBottomBorderSize() const ; | |
256 | ||
05adb9d2 | 257 | static long MacRemoveBordersFromStyle( long style ) ; |
e7549107 | 258 | virtual void MacSuperChangedPosition() ; |
8208e181 | 259 | virtual void MacSuperShown( bool show ) ; |
c809f3be | 260 | bool MacIsReallyShown() const ; |
05adb9d2 | 261 | /* |
e7549107 SC |
262 | bool MacSetupFocusPort() ; |
263 | bool MacSetupDrawingPort() ; | |
264 | bool MacSetupFocusClientPort() ; | |
265 | bool MacSetupDrawingClientPort() ; | |
05adb9d2 | 266 | */ |
e7549107 SC |
267 | virtual bool MacSetPortFocusParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindow* rootwin ) ; |
268 | virtual bool MacSetPortDrawingParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindow* rootwin ) ; | |
269 | ||
270 | virtual void MacGetPortParams(Point* localOrigin, Rect* clipRect, WindowRef *window , wxWindow** rootwin ) ; | |
271 | virtual void MacGetPortClientParams(Point* localOrigin, Rect* clipRect, WindowRef *window , wxWindow** rootwin) ; | |
05adb9d2 | 272 | virtual void MacDoGetPortClientParams(Point* localOrigin, Rect* clipRect, WindowRef *window , wxWindow** rootwin) ; |
e7549107 | 273 | MacWindowData* MacGetWindowData() { return m_macWindowData ; } |
0a67a93b | 274 | static WindowRef MacGetWindowInUpdate() { return s_macWindowInUpdate ; } |
7c74e7fe | 275 | bool MacIsWindowScrollbar( const wxScrollBar* sb ) { return (m_hScrollBar == sb || m_vScrollBar == sb) ; } |
e7549107 SC |
276 | static wxWindow* s_lastMouseWindow ; |
277 | private: | |
278 | virtual bool MacGetWindowFromPointSub( const wxPoint &point , wxWindow** outWin ) ; | |
0dbd6262 | 279 | protected: |
e7549107 | 280 | MacWindowData* m_macWindowData ; |
0a67a93b | 281 | static WindowRef s_macWindowInUpdate ; |
05adb9d2 | 282 | RgnHandle m_macUpdateRgn ; |
0a67a93b | 283 | bool m_macEraseOnRedraw ; |
e7549107 SC |
284 | |
285 | int m_x ; | |
286 | int m_y ; | |
287 | int m_width ; | |
288 | int m_height ; | |
289 | ||
290 | wxScrollBar* m_hScrollBar ; | |
291 | wxScrollBar* m_vScrollBar ; | |
292 | wxString m_label ; | |
293 | ||
294 | void MacCreateScrollBars( long style ) ; | |
295 | void MacRepositionScrollBars() ; | |
519cb848 SC |
296 | |
297 | // additional (MSW specific) flags | |
298 | bool m_useCtl3D:1; // Using CTL3D for this control | |
299 | bool m_backgroundTransparent:1; | |
300 | bool m_mouseInWindow:1; | |
301 | bool m_doubleClickAllowed:1; | |
302 | bool m_winCaptured:1; | |
303 | ||
304 | // the size of one page for scrolling | |
305 | int m_xThumbSize; | |
306 | int m_yThumbSize; | |
307 | ||
e7549107 | 308 | // WXHMENU m_hMenu; // Menu, if any |
519cb848 SC |
309 | |
310 | // implement the base class pure virtuals | |
311 | virtual void DoClientToScreen( int *x, int *y ) const; | |
312 | virtual void DoScreenToClient( int *x, int *y ) const; | |
313 | virtual void DoGetPosition( int *x, int *y ) const; | |
314 | virtual void DoGetSize( int *width, int *height ) const; | |
315 | virtual void DoGetClientSize( int *width, int *height ) const; | |
316 | virtual void DoSetSize(int x, int y, | |
317 | int width, int height, | |
318 | int sizeFlags = wxSIZE_AUTO); | |
319 | virtual void DoSetClientSize(int width, int height); | |
320 | ||
519cb848 SC |
321 | // move the window to the specified location and resize it: this is called |
322 | // from both DoSetSize() and DoSetClientSize() and would usually just call | |
323 | // ::MoveWindow() except for composite controls which will want to arrange | |
324 | // themselves inside the given rectangle | |
325 | virtual void DoMoveWindow(int x, int y, int width, int height); | |
326 | ||
327 | #if wxUSE_TOOLTIPS | |
328 | virtual void DoSetToolTip( wxToolTip *tip ); | |
329 | #endif // wxUSE_TOOLTIPS | |
0dbd6262 | 330 | |
519cb848 SC |
331 | private: |
332 | // common part of all ctors | |
333 | void Init(); | |
0dbd6262 | 334 | |
519cb848 SC |
335 | DECLARE_NO_COPY_CLASS(wxWindow); |
336 | DECLARE_EVENT_TABLE() | |
0dbd6262 SC |
337 | }; |
338 | ||
519cb848 SC |
339 | // associate mac windows with wx counterparts |
340 | ||
341 | wxWindow* wxFindWinFromMacWindow( WindowRef inWindow ) ; | |
342 | void wxAssociateWinWithMacWindow(WindowRef inWindow, wxWindow *win) ; | |
343 | void wxRemoveMacWindowAssociation(wxWindow *win) ; | |
344 | ||
05adb9d2 | 345 | /* |
519cb848 SC |
346 | class wxMacFocusHelper |
347 | { | |
348 | public : | |
349 | wxMacFocusHelper( wxWindow * theWindow ) ; | |
350 | ~wxMacFocusHelper() ; | |
351 | bool Ok() { return m_ok ; } | |
352 | ||
353 | private : | |
354 | GrafPtr m_formerPort ; | |
355 | GrafPtr m_currentPort ; | |
356 | bool m_ok ; | |
357 | } ; | |
05adb9d2 | 358 | */ |
519cb848 SC |
359 | |
360 | class wxMacDrawingHelper | |
361 | { | |
362 | public : | |
363 | wxMacDrawingHelper( wxWindow * theWindow ) ; | |
364 | ~wxMacDrawingHelper() ; | |
365 | bool Ok() { return m_ok ; } | |
366 | ||
367 | private : | |
368 | GrafPtr m_formerPort ; | |
369 | GrafPtr m_currentPort ; | |
370 | PenState m_savedPenState ; | |
371 | bool m_ok ; | |
372 | } ; | |
05adb9d2 | 373 | /* |
519cb848 SC |
374 | class wxMacFocusClientHelper |
375 | { | |
376 | public : | |
377 | wxMacFocusClientHelper( wxWindow * theWindow ) ; | |
378 | ~wxMacFocusClientHelper() ; | |
379 | bool Ok() { return m_ok ; } | |
380 | ||
381 | private : | |
382 | GrafPtr m_formerPort ; | |
383 | GrafPtr m_currentPort ; | |
384 | bool m_ok ; | |
385 | } ; | |
05adb9d2 | 386 | */ |
519cb848 SC |
387 | class wxMacDrawingClientHelper |
388 | { | |
389 | public : | |
390 | wxMacDrawingClientHelper( wxWindow * theWindow ) ; | |
391 | ~wxMacDrawingClientHelper() ; | |
392 | bool Ok() { return m_ok ; } | |
393 | ||
394 | private : | |
395 | GrafPtr m_formerPort ; | |
396 | GrafPtr m_currentPort ; | |
397 | PenState m_savedPenState ; | |
398 | bool m_ok ; | |
399 | } ; | |
0dbd6262 SC |
400 | |
401 | #endif | |
402 | // _WX_WINDOW_H_ |