]> git.saurik.com Git - wxWidgets.git/blame - include/wx/mac/window.h
doc view code inteprets wxSTREAM_EOF as correct,
[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
89 virtual bool Reparent( wxWindow *newParent );
90
91 virtual void WarpPointer(int x, int y);
92 virtual void CaptureMouse();
93 virtual void ReleaseMouse();
94
95 virtual void Refresh( bool eraseBackground = TRUE,
96 const wxRect *rect = (const wxRect *) NULL );
97 virtual void Clear();
98
99 virtual bool SetCursor( const wxCursor &cursor );
100 virtual bool SetFont( const wxFont &font );
101
102 virtual int GetCharHeight() const;
103 virtual int GetCharWidth() const;
104 virtual void GetTextExtent(const wxString& string,
105 int *x, int *y,
106 int *descent = (int *) NULL,
107 int *externalLeading = (int *) NULL,
108 const wxFont *theFont = (const wxFont *) NULL)
109 const;
110
111 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
112
113 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
114 int range, bool refresh = TRUE );
115 virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
116 virtual int GetScrollPos( int orient ) const;
117 virtual int GetScrollThumb( int orient ) const;
118 virtual int GetScrollRange( int orient ) const;
119 virtual void ScrollWindow( int dx, int dy,
120 const wxRect* rect = (wxRect *) NULL );
0dbd6262
SC
121
122#if wxUSE_DRAG_AND_DROP
519cb848
SC
123 virtual void SetDropTarget( wxDropTarget *dropTarget );
124#endif // wxUSE_DRAG_AND_DROP
125
126 // Accept files for dragging
127 virtual void DragAcceptFiles(bool accept);
128
129#if WXWIN_COMPATIBILITY
130 // Set/get scroll attributes
131 virtual void SetScrollRange(int orient, int range, bool refresh = TRUE);
132 virtual void SetScrollPage(int orient, int page, bool refresh = TRUE);
133 virtual int OldGetScrollRange(int orient) const;
134 virtual int GetScrollPage(int orient) const;
135
136 // event handlers
137 // Handle a control command
138 virtual void OnCommand(wxWindow& win, wxCommandEvent& event);
139
140 // Override to define new behaviour for default action (e.g. double
141 // clicking on a listbox)
142 virtual void OnDefaultAction(wxControl * WXUNUSED(initiatingItem)) { }
143#endif // WXWIN_COMPATIBILITY
144
145#if wxUSE_CARET && WXWIN_COMPATIBILITY
146 // caret manipulation (old MSW only functions, see wxCaret class for the
147 // new API)
148 void CreateCaret(int w, int h);
149 void CreateCaret(const wxBitmap *bitmap);
150 void DestroyCaret();
151 void ShowCaret(bool show);
152 void SetCaretPos(int x, int y);
153 void GetCaretPos(int *x, int *y) const;
154#endif // wxUSE_CARET
155
156 // Native resource loading (implemented in src/msw/nativdlg.cpp)
157 // FIXME: should they really be all virtual?
519cb848
SC
158 wxWindow* GetWindowChild1(wxWindowID id);
159 wxWindow* GetWindowChild(wxWindowID id);
160
161 // implementation from now on
162 // --------------------------
163
164 void MacClientToRootWindow( int *x , int *y ) const ;
165 void MacRootWindowToClient( int *x , int *y ) const ;
166
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 // --------------
181 void OnEraseBackground(wxEraseEvent& event);
182 void OnIdle(wxIdleEvent& event);
7c74e7fe 183 void MacOnScroll(wxScrollEvent&event ) ;
0dbd6262 184
519cb848
SC
185public:
186 // For implementation purposes - sometimes decorations make the client area
187 // smaller
188 virtual wxPoint GetClientAreaOrigin() const;
0dbd6262 189
519cb848
SC
190 // Makes an adjustment to the window position (for example, a frame that has
191 // a toolbar that it manages itself).
192 virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
0dbd6262 193
519cb848
SC
194 wxWindow *FindItem(long id) const;
195 wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const;
0dbd6262 196
519cb848
SC
197 // Make a Windows extended style from the given wxWindows window style
198 static WXDWORD MakeExtendedStyle(long style,
199 bool eliminateBorders = TRUE);
200 // Determine whether 3D effects are wanted
201 WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D) const;
0dbd6262 202
519cb848
SC
203 // MSW only: TRUE if this control is part of the main control
204 virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
0dbd6262 205
519cb848
SC
206 #if WXWIN_COMPATIBILITY
207 wxObject *GetChild(int number) const;
208 virtual void MSWDeviceToLogical(float *x, float *y) const;
209#endif // WXWIN_COMPATIBILITY
0dbd6262 210
519cb848
SC
211 // Setup background and foreground colours correctly
212 virtual void SetupColours();
0dbd6262 213
0dbd6262 214
519cb848
SC
215#if WXWIN_COMPATIBILITY
216 void SetShowing(bool show) { (void)Show(show); }
217 bool IsUserEnabled() const { return IsEnabled(); }
218#endif // WXWIN_COMPATIBILITY
0dbd6262 219
519cb848
SC
220 // Responds to colour changes: passes event on to children.
221 void OnSysColourChanged(wxSysColourChangedEvent& event);
0dbd6262 222
e7549107
SC
223public :
224 static bool MacGetWindowFromPoint( const wxPoint &point , wxWindow** outWin ) ;
225 virtual void MacActivate( EventRecord *ev , bool inIsActivating ) ;
226 virtual void MacUpdate( EventRecord *ev ) ;
227 virtual void MacUpdateImmediately() ;
228 virtual void MacRedraw( RgnHandle updatergn , long time) ;
229 virtual void MacMouseDown( EventRecord *ev , short windowPart ) ;
230 virtual void MacMouseUp( EventRecord *ev , short windowPart ) ;
231 virtual void MacMouseMoved( EventRecord *ev , short windowPart ) ;
232 virtual void MacKeyDown( EventRecord *ev ) ;
233 virtual bool MacCanFocus() const { return true ; }
234
235 virtual void MacFireMouseEvent( EventRecord *ev ) ;
236 virtual bool MacDispatchMouseEvent(wxMouseEvent& event ) ;
237 virtual void MacEraseBackground( Rect *rect ) ;
238 WindowRef GetMacRootWindow() const ;
239
240 virtual ControlHandle MacGetContainerForEmbedding() ;
241 virtual void MacSuperChangedPosition() ;
242
243 bool MacSetupFocusPort() ;
244 bool MacSetupDrawingPort() ;
245 bool MacSetupFocusClientPort() ;
246 bool MacSetupDrawingClientPort() ;
247
248 virtual bool MacSetPortFocusParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindow* rootwin ) ;
249 virtual bool MacSetPortDrawingParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindow* rootwin ) ;
250
251 virtual void MacGetPortParams(Point* localOrigin, Rect* clipRect, WindowRef *window , wxWindow** rootwin ) ;
252 virtual void MacGetPortClientParams(Point* localOrigin, Rect* clipRect, WindowRef *window , wxWindow** rootwin) ;
253 MacWindowData* MacGetWindowData() { return m_macWindowData ; }
254 static WindowRef MacGetWindowInUpdate() { return s_macWindowInUpdate ; }
7c74e7fe 255 bool MacIsWindowScrollbar( const wxScrollBar* sb ) { return (m_hScrollBar == sb || m_vScrollBar == sb) ; }
e7549107
SC
256 static wxWindow* s_lastMouseWindow ;
257private:
258 virtual bool MacGetWindowFromPointSub( const wxPoint &point , wxWindow** outWin ) ;
0dbd6262 259protected:
519cb848 260
e7549107
SC
261 MacWindowData* m_macWindowData ;
262 static WindowRef s_macWindowInUpdate ;
263
264 int m_x ;
265 int m_y ;
266 int m_width ;
267 int m_height ;
268
269 wxScrollBar* m_hScrollBar ;
270 wxScrollBar* m_vScrollBar ;
271 wxString m_label ;
272
273 void MacCreateScrollBars( long style ) ;
274 void MacRepositionScrollBars() ;
519cb848
SC
275
276 // additional (MSW specific) flags
277 bool m_useCtl3D:1; // Using CTL3D for this control
278 bool m_backgroundTransparent:1;
279 bool m_mouseInWindow:1;
280 bool m_doubleClickAllowed:1;
281 bool m_winCaptured:1;
282
283 // the size of one page for scrolling
284 int m_xThumbSize;
285 int m_yThumbSize;
286
e7549107 287// WXHMENU m_hMenu; // Menu, if any
519cb848
SC
288
289 // implement the base class pure virtuals
290 virtual void DoClientToScreen( int *x, int *y ) const;
291 virtual void DoScreenToClient( int *x, int *y ) const;
292 virtual void DoGetPosition( int *x, int *y ) const;
293 virtual void DoGetSize( int *width, int *height ) const;
294 virtual void DoGetClientSize( int *width, int *height ) const;
295 virtual void DoSetSize(int x, int y,
296 int width, int height,
297 int sizeFlags = wxSIZE_AUTO);
298 virtual void DoSetClientSize(int width, int height);
299
300 // get the size which best suits the window: e.g., for a static text it
301 // will be the width and height of the text
302 virtual wxSize DoGetBestSize();
303
304 // move the window to the specified location and resize it: this is called
305 // from both DoSetSize() and DoSetClientSize() and would usually just call
306 // ::MoveWindow() except for composite controls which will want to arrange
307 // themselves inside the given rectangle
308 virtual void DoMoveWindow(int x, int y, int width, int height);
309
310#if wxUSE_TOOLTIPS
311 virtual void DoSetToolTip( wxToolTip *tip );
312#endif // wxUSE_TOOLTIPS
0dbd6262 313
519cb848
SC
314private:
315 // common part of all ctors
316 void Init();
0dbd6262 317
519cb848
SC
318 DECLARE_NO_COPY_CLASS(wxWindow);
319 DECLARE_EVENT_TABLE()
0dbd6262
SC
320};
321
519cb848
SC
322// associate mac windows with wx counterparts
323
324wxWindow* wxFindWinFromMacWindow( WindowRef inWindow ) ;
325void wxAssociateWinWithMacWindow(WindowRef inWindow, wxWindow *win) ;
326void wxRemoveMacWindowAssociation(wxWindow *win) ;
327
328class wxMacFocusHelper
329{
330public :
331 wxMacFocusHelper( wxWindow * theWindow ) ;
332 ~wxMacFocusHelper() ;
333 bool Ok() { return m_ok ; }
334
335private :
336 GrafPtr m_formerPort ;
337 GrafPtr m_currentPort ;
338 bool m_ok ;
339} ;
340
341class wxMacDrawingHelper
342{
343public :
344 wxMacDrawingHelper( wxWindow * theWindow ) ;
345 ~wxMacDrawingHelper() ;
346 bool Ok() { return m_ok ; }
347
348private :
349 GrafPtr m_formerPort ;
350 GrafPtr m_currentPort ;
351 PenState m_savedPenState ;
352 bool m_ok ;
353} ;
354
355class wxMacFocusClientHelper
356{
357public :
358 wxMacFocusClientHelper( wxWindow * theWindow ) ;
359 ~wxMacFocusClientHelper() ;
360 bool Ok() { return m_ok ; }
361
362private :
363 GrafPtr m_formerPort ;
364 GrafPtr m_currentPort ;
365 bool m_ok ;
366} ;
367
368class wxMacDrawingClientHelper
369{
370public :
371 wxMacDrawingClientHelper( wxWindow * theWindow ) ;
372 ~wxMacDrawingClientHelper() ;
373 bool Ok() { return m_ok ; }
374
375private :
376 GrafPtr m_formerPort ;
377 GrafPtr m_currentPort ;
378 PenState m_savedPenState ;
379 bool m_ok ;
380} ;
0dbd6262
SC
381
382#endif
383 // _WX_WINDOW_H_