]> git.saurik.com Git - wxWidgets.git/blame - include/wx/mac/carbon/window.h
fixed Context_Current spelling
[wxWidgets.git] / include / wx / mac / carbon / window.h
CommitLineData
8cf73271
SC
1/////////////////////////////////////////////////////////////////////////////
2// Name: window.h
3// Purpose: wxWindowMac class
4// Author: Stefan Csomor
5// Modified by:
6// Created: 1998-01-01
7// RCS-ID: $Id$
8// Copyright: (c) Stefan Csomor
65571936 9// Licence: wxWindows licence
8cf73271
SC
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_WINDOW_H_
13#define _WX_WINDOW_H_
14
15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16#pragma interface "window.h"
17#endif
18
19#include "wx/brush.h"
20b69855 20#include "wx/dc.h"
8cf73271
SC
21
22// ---------------------------------------------------------------------------
23// forward declarations
24// ---------------------------------------------------------------------------
25
26class WXDLLEXPORT wxButton;
27class WXDLLEXPORT wxScrollBar;
28class WXDLLEXPORT wxTopLevelWindowMac;
29
6d4c54a7
SC
30// internal implementation classes
31
32class wxMacControl ;
33
8cf73271
SC
34// ---------------------------------------------------------------------------
35// constants
36// ---------------------------------------------------------------------------
37
38class WXDLLEXPORT wxWindowMac: public wxWindowBase
39{
40 DECLARE_DYNAMIC_CLASS(wxWindowMac)
41
42 friend class wxDC;
43 friend class wxPaintDC;
44
45public:
46
997e843d 47 wxWindowMac() ;
8cf73271
SC
48
49 wxWindowMac(wxWindowMac *parent,
50 wxWindowID id,
51 const wxPoint& pos = wxDefaultPosition,
52 const wxSize& size = wxDefaultSize,
53 long style = 0,
997e843d 54 const wxString& name = wxPanelNameStr) ;
8cf73271
SC
55
56 virtual ~wxWindowMac();
57
58 bool Create(wxWindowMac *parent,
59 wxWindowID id,
60 const wxPoint& pos = wxDefaultPosition,
61 const wxSize& size = wxDefaultSize,
62 long style = 0,
63 const wxString& name = wxPanelNameStr);
64
65
66 // implement base class pure virtuals
67 virtual void SetTitle( const wxString& title);
68 virtual wxString GetTitle() const;
69
70 virtual void Raise();
71 virtual void Lower();
72
73 virtual bool Show( bool show = TRUE );
74 virtual bool Enable( bool enable = TRUE );
75
76 virtual void SetFocus();
77
78 virtual void WarpPointer(int x, int y);
79
80 virtual void Refresh( bool eraseBackground = TRUE,
81 const wxRect *rect = (const wxRect *) NULL );
79392158
SC
82 virtual void Freeze() ;
83 virtual void Thaw() ;
8cf73271 84
cb4b0966
SC
85 virtual void Update() ;
86 virtual void ClearBackground() ;
87
8cf73271 88 virtual bool SetCursor( const wxCursor &cursor );
4f305456
SC
89 virtual bool SetFont( const wxFont &font ) ;
90 virtual bool SetBackgroundColour( const wxColour &colour );
91 virtual bool SetForegroundColour( const wxColour &colour );
92
8cf73271
SC
93 virtual int GetCharHeight() const;
94 virtual int GetCharWidth() const;
95 virtual void GetTextExtent(const wxString& string,
96 int *x, int *y,
97 int *descent = (int *) NULL,
98 int *externalLeading = (int *) NULL,
99 const wxFont *theFont = (const wxFont *) NULL)
100 const;
101
102 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
103
104 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
105 int range, bool refresh = TRUE );
106 virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
107 virtual int GetScrollPos( int orient ) const;
108 virtual int GetScrollThumb( int orient ) const;
109 virtual int GetScrollRange( int orient ) const;
110 virtual void ScrollWindow( int dx, int dy,
111 const wxRect* rect = (wxRect *) NULL );
112
113#if wxUSE_DRAG_AND_DROP
114 virtual void SetDropTarget( wxDropTarget *dropTarget );
115#endif // wxUSE_DRAG_AND_DROP
116
117 // Accept files for dragging
118 virtual void DragAcceptFiles(bool accept);
119
8cf73271
SC
120 // implementation from now on
121 // --------------------------
122
123 void MacClientToRootWindow( int *x , int *y ) const ;
124 void MacRootWindowToClient( int *x , int *y ) const ;
4f305456 125
8cf73271 126 void MacWindowToRootWindow( int *x , int *y ) const ;
4f305456
SC
127 void MacWindowToRootWindow( short *x , short *y ) const ;
128
8cf73271 129 void MacRootWindowToWindow( int *x , int *y ) const ;
4f305456 130 void MacRootWindowToWindow( short *x , short *y ) const ;
8cf73271
SC
131
132 virtual wxString MacGetToolTipString( wxPoint &where ) ;
133
134 // simple accessors
135 // ----------------
136
6d4c54a7 137 virtual WXWidget GetHandle() const ;
8cf73271 138
4f305456 139#if WXWIN_COMPATIBILITY_2_4
8cf73271
SC
140 bool GetTransparentBackground() const { return m_backgroundTransparent; }
141 void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; }
4f305456 142#endif
8cf73271
SC
143
144 // event handlers
145 // --------------
146 void OnSetFocus(wxFocusEvent& event) ;
ff3795ee 147 void OnPaint(wxPaintEvent& event);
8cf73271
SC
148 void OnNcPaint(wxNcPaintEvent& event);
149 void OnEraseBackground(wxEraseEvent& event);
150 void OnMouseEvent( wxMouseEvent &event ) ;
151
152 void MacOnScroll(wxScrollEvent&event ) ;
153
154 bool AcceptsFocus() const ;
155
156public:
157 void OnInternalIdle();
158
159 // For implementation purposes - sometimes decorations make the client area
160 // smaller
161 virtual wxPoint GetClientAreaOrigin() const;
162
163 wxWindowMac *FindItem(long id) const;
164 wxWindowMac *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const;
165
8cf73271 166public:
4f305456
SC
167 virtual void MacHandleControlClick( WXWidget control , wxInt16 controlpart , bool mouseStillDown ) ;
168 virtual bool MacDoRedraw( WXHRGN updatergn , long time ) ;
4f305456 169 virtual bool MacCanFocus() const ;
8cf73271 170
8cf73271 171 // this should not be overriden in classes above wxWindowMac because it is called from its destructor via DeleteChildren
4f305456
SC
172 virtual void RemoveChild( wxWindowBase *child );
173 virtual void MacPaintBorders( int left , int top ) ;
e2f865d8
SC
174 // invalidates the borders and focus area around the control
175 // must not be virtual as it will be called during destruction
176 void MacInvalidateBorders() ;
4f305456 177 WXWindow MacGetTopLevelWindowRef() const ;
8cf73271
SC
178 wxTopLevelWindowMac* MacGetTopLevelWindow() const ;
179
4f305456
SC
180 virtual long MacGetLeftBorderSize() const ;
181 virtual long MacGetRightBorderSize() const ;
182 virtual long MacGetTopBorderSize() const ;
183 virtual long MacGetBottomBorderSize() const ;
8cf73271 184
4f305456 185 static long MacRemoveBordersFromStyle( long style ) ;
e2f865d8 186
4f305456 187 virtual void MacSuperChangedPosition() ;
8cf73271 188 // the absolute coortinates of this window's root have changed
4f305456
SC
189 virtual void MacTopLevelWindowChangedPosition() ;
190
08422003 191 virtual void MacChildAdded() ;
4f305456
SC
192 virtual void MacVisibilityChanged() ;
193 virtual void MacEnabledStateChanged() ;
8ab50549 194 virtual void MacHiliteChanged() ;
336a6aba 195 virtual wxInt32 MacControlHit( WXEVENTHANDLERREF handler , WXEVENTREF event ) ;
4f305456
SC
196
197 bool MacIsReallyShown() ;
198 bool MacIsReallyEnabled() ;
8ab50549 199 bool MacIsReallyHilited() ;
4f305456
SC
200
201 bool MacIsUserPane() { return m_macIsUserPane; }
202
4f305456 203 virtual bool MacSetupCursor( const wxPoint& pt ) ;
8cf73271 204
7ea087b7 205 virtual void MacSetBackgroundBrush( const wxBrush &brush ) ;
4f305456
SC
206 const wxBrush& MacGetBackgroundBrush() const { return m_macBackgroundBrush ; }
207
208 // returns the visible region of this control in window ie non-client coordinates
209
210 wxRegion MacGetVisibleRegion( bool includeOuterStructures = false ) ;
53409666
SC
211 // returns true if children have to clipped to the content area (eg scrolled window)
212 virtual bool MacClipChildren() const { return false ; }
213 // returns true if the grandchildren have to be clipped to the children's content area (eg
214 // splitter window)
215 virtual bool MacClipGrandChildren() const { return false ; }
4f305456 216 bool MacIsWindowScrollbar( const wxScrollBar* sb )
8cf73271 217 { return (m_hScrollBar == sb || m_vScrollBar == sb) ; }
4f305456
SC
218
219 wxList& GetSubcontrols() { return m_subControls; }
5ca0d812 220 virtual void MacInstallEventHandler(WXWidget native) ;
4f305456
SC
221 WXEVENTHANDLERREF MacGetControlEventHandler() { return m_macControlEventHandler ; }
222 void MacPostControlCreate(const wxPoint& pos, const wxSize& size) ;
20b69855 223#ifndef __WXMAC_OSX__
4f305456
SC
224 virtual void MacControlUserPaneDrawProc(wxInt16 part) ;
225 virtual wxInt16 MacControlUserPaneHitTestProc(wxInt16 x, wxInt16 y) ;
226 virtual wxInt16 MacControlUserPaneTrackingProc(wxInt16 x, wxInt16 y, void* actionProc) ;
227 virtual void MacControlUserPaneIdleProc() ;
228 virtual wxInt16 MacControlUserPaneKeyDownProc(wxInt16 keyCode, wxInt16 charCode, wxInt16 modifiers) ;
229 virtual void MacControlUserPaneActivateProc(bool activating) ;
230 virtual wxInt16 MacControlUserPaneFocusProc(wxInt16 action) ;
231 virtual void MacControlUserPaneBackgroundProc(void* info) ;
20b69855 232#endif
77ffb593 233 // translate wxWidgets coords into ones suitable to be passed to
4f305456
SC
234 // the CreateControl calls
235 //
236 // returns TRUE if non default coords are returned, FALSE otherwise
237 bool MacGetBoundsForControl(const wxPoint& pos,
238 const wxSize& size,
239 int& x, int& y,
79392158 240 int& w, int& h , bool adjustForOrigin ) const ;
4f305456
SC
241 // calculates the real window position and size from the native control
242 void MacGetPositionAndSizeFromControl(int& x, int& y,
243 int& w, int& h) const ;
f5ea731f
SC
244 // gets the inset from every part
245 virtual void MacGetContentAreaInset( int &left , int &top , int &right , int &bottom ) ;
246
8d4c4868
SC
247 // flash the current invalid area, useful for debugging in OSX double buffered situation
248 void MacFlashInvalidAreas() ;
e2f865d8
SC
249
250 // the 'true' OS level control for this wxWindow
251 wxMacControl* GetPeer() const { return m_peer ; }
20b69855
SC
252#if wxMAC_USE_CORE_GRAPHICS
253 void * MacGetCGContextRef() { return m_cgContextRef ; }
254 void MacSetCGContextRef(void * cg) { m_cgContextRef = cg ; }
255#endif
8cf73271 256protected:
4f305456
SC
257 // For controls like radiobuttons which are really composite
258 wxList m_subControls;
79392158
SC
259 // number of calls to Freeze() minus number of calls to Thaw()
260 unsigned int m_frozenness;
6d4c54a7
SC
261 // the peer object, allowing for cleaner API support
262 wxMacControl* m_peer ;
20b69855
SC
263#if wxMAC_USE_CORE_GRAPHICS
264 void * m_cgContextRef ;
265#endif
ed8a0852 266 // true if is is not a native control but a wxWindow control
4f305456
SC
267 bool m_macIsUserPane ;
268 wxBrush m_macBackgroundBrush ;
ed8a0852
SC
269 // topleft inset of the mac control from the wx top left corner
270 wxPoint m_macTopLeftInset ;
271 // bottom right inset of the mac control from the wx bottom right corner
272 wxPoint m_macBottomRightInset ;
8cf73271 273
4f305456
SC
274 wxScrollBar* m_hScrollBar ;
275 wxScrollBar* m_vScrollBar ;
276 wxString m_label ;
8cf73271 277
4f305456
SC
278 void MacCreateScrollBars( long style ) ;
279 void MacRepositionScrollBars() ;
280 void MacUpdateControlFont() ;
8ab50549 281
4f305456
SC
282 void MacPropagateVisibilityChanged() ;
283 void MacPropagateEnabledStateChanged() ;
8ab50549 284 void MacPropagateHiliteChanged() ;
4f305456 285
8d4c4868 286
4f305456 287#if WXWIN_COMPATIBILITY_2_4
8cf73271 288 bool m_backgroundTransparent ;
4f305456 289#endif
8cf73271
SC
290
291 // implement the base class pure virtuals
4f305456
SC
292 virtual wxSize DoGetBestSize() const;
293 virtual wxSize DoGetSizeFromClientSize( const wxSize & size ) const;
8cf73271
SC
294 virtual void DoClientToScreen( int *x, int *y ) const;
295 virtual void DoScreenToClient( int *x, int *y ) const;
296 virtual void DoGetPosition( int *x, int *y ) const;
297 virtual void DoGetSize( int *width, int *height ) const;
298 virtual void DoGetClientSize( int *width, int *height ) const;
299 virtual void DoSetSize(int x, int y,
300 int width, int height,
301 int sizeFlags = wxSIZE_AUTO);
302 virtual void DoSetClientSize(int width, int height);
303
304 virtual void DoCaptureMouse();
305 virtual void DoReleaseMouse();
306
307 // move the window to the specified location and resize it: this is called
308 // from both DoSetSize() and DoSetClientSize() and would usually just call
309 // ::MoveWindow() except for composite controls which will want to arrange
310 // themselves inside the given rectangle
311 virtual void DoMoveWindow(int x, int y, int width, int height);
4f305456
SC
312 virtual void DoSetWindowVariant( wxWindowVariant variant ) ;
313
8cf73271
SC
314
315#if wxUSE_TOOLTIPS
316 virtual void DoSetToolTip( wxToolTip *tip );
317#endif // wxUSE_TOOLTIPS
318
4f305456
SC
319private :
320
8cf73271
SC
321private:
322 // common part of all ctors
323 void Init();
324
4f305456
SC
325 WXEVENTHANDLERREF m_macControlEventHandler ;
326
327
8cf73271
SC
328 DECLARE_NO_COPY_CLASS(wxWindowMac)
329 DECLARE_EVENT_TABLE()
330};
331
332#endif
333 // _WX_WINDOW_H_