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