]> git.saurik.com Git - wxWidgets.git/blame - include/wx/osx/window.h
Use FWD version of DLL export macro in forward declaration.
[wxWidgets.git] / include / wx / osx / window.h
CommitLineData
6762286d
SC
1/////////////////////////////////////////////////////////////////////////////
2// Name: include/wx/mac/carbon/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
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_WINDOW_H_
13#define _WX_WINDOW_H_
14
15#include "wx/brush.h"
16#include "wx/dc.h"
17
18class WXDLLIMPEXP_FWD_CORE wxButton;
19class WXDLLIMPEXP_FWD_CORE wxScrollBar;
20class WXDLLIMPEXP_FWD_CORE wxNonOwnedWindow;
21
c099b533
SC
22#if wxOSX_USE_CARBON
23 class WXDLLIMPEXP_FWD_CORE wxMacControl ;
24 typedef wxMacControl wxOSXWidgetImpl;
ee032c59
SC
25#elif wxOSX_USE_COCOA_OR_IPHONE
26 class WXDLLIMPEXP_FWD_CORE wxWidgetImpl ;
27 typedef wxWidgetImpl wxOSXWidgetImpl;
c099b533
SC
28#endif
29
6762286d
SC
30
31class WXDLLIMPEXP_CORE wxWindowMac: public wxWindowBase
32{
33 DECLARE_DYNAMIC_CLASS(wxWindowMac)
34
35 friend class wxDC;
36 friend class wxPaintDC;
37
38public:
39 wxWindowMac();
40
41 wxWindowMac( wxWindowMac *parent,
42 wxWindowID id,
43 const wxPoint& pos = wxDefaultPosition,
44 const wxSize& size = wxDefaultSize,
45 long style = 0,
46 const wxString& name = wxPanelNameStr );
47
48 virtual ~wxWindowMac();
49
50 bool Create( wxWindowMac *parent,
51 wxWindowID id,
52 const wxPoint& pos = wxDefaultPosition,
53 const wxSize& size = wxDefaultSize,
54 long style = 0,
55 const wxString& name = wxPanelNameStr );
56
57 // implement base class pure virtuals
58 virtual void SetLabel( const wxString& label );
59 virtual wxString GetLabel() const;
60
61 virtual void Raise();
62 virtual void Lower();
63
64 virtual bool Show( bool show = true );
65
66 virtual bool IsShownOnScreen() const;
67
68 virtual void SetFocus();
69
70 virtual void WarpPointer( int x, int y );
71
72 virtual void Refresh( bool eraseBackground = true,
73 const wxRect *rect = NULL );
74
75 virtual void Update() ;
76 virtual void ClearBackground();
77
78 virtual bool SetCursor( const wxCursor &cursor );
79 virtual bool SetFont( const wxFont &font );
80 virtual bool SetBackgroundColour( const wxColour &colour );
81 virtual bool SetForegroundColour( const wxColour &colour );
82
83 virtual int GetCharHeight() const;
84 virtual int GetCharWidth() const;
6762286d
SC
85
86public:
87 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
88 int range, bool refresh = true );
89 virtual void SetScrollPos( int orient, int pos, bool refresh = true );
90 virtual int GetScrollPos( int orient ) const;
91 virtual int GetScrollThumb( int orient ) const;
92 virtual int GetScrollRange( int orient ) const;
93 virtual void ScrollWindow( int dx, int dy,
d3b9f782 94 const wxRect* rect = NULL );
6762286d
SC
95 virtual void AlwaysShowScrollbars(bool horz = true, bool vert = true);
96 virtual bool IsScrollbarAlwaysShown(int orient) const
97 {
98 return orient == wxHORIZONTAL ? m_hScrollBarAlwaysShown
99 : m_vScrollBarAlwaysShown;
100 }
101
102 virtual bool Reparent( wxWindowBase *newParent );
103
104#if wxUSE_DRAG_AND_DROP
105 virtual void SetDropTarget( wxDropTarget *dropTarget );
106#endif
107
108 // Accept files for dragging
109 virtual void DragAcceptFiles( bool accept );
110
111 // implementation from now on
112 // --------------------------
113
114 void MacClientToRootWindow( int *x , int *y ) const;
115
116 void MacWindowToRootWindow( int *x , int *y ) const;
117
118 void MacRootWindowToWindow( int *x , int *y ) const;
119
120 virtual wxString MacGetToolTipString( wxPoint &where );
121
122 // simple accessors
123 // ----------------
124
125 virtual WXWidget GetHandle() const;
126
127 virtual bool SetTransparent(wxByte alpha);
128 virtual bool CanSetTransparent();
129 virtual wxByte GetTransparent() const ;
130
131 // event handlers
132 // --------------
4dd9fdf8 133
6762286d
SC
134 void OnMouseEvent( wxMouseEvent &event );
135
136 void MacOnScroll( wxScrollEvent&event );
137
138 virtual bool AcceptsFocus() const;
139
140 virtual bool IsDoubleBuffered() const { return true; }
141
142public:
143 static long MacRemoveBordersFromStyle( long style ) ;
144
145public:
146 void OnInternalIdle();
147
148 // For implementation purposes:
149 // sometimes decorations make the client area smaller
150 virtual wxPoint GetClientAreaOrigin() const;
151
152 wxWindowMac *FindItem(long id) const;
153 wxWindowMac *FindItemByHWND(WXHWND hWnd, bool controlOnly = false) const;
154
19c7ac3d 155 virtual void TriggerScrollEvent( wxEventType scrollEvent ) ;
6762286d
SC
156 // this should not be overriden in classes above wxWindowMac
157 // because it is called from its destructor via DeleteChildren
158 virtual void RemoveChild( wxWindowBase *child );
03647350 159
5398a2e0
SC
160 virtual bool MacDoRedraw( long time ) ;
161 virtual void MacPaintChildrenBorders();
6762286d
SC
162 virtual void MacPaintBorders( int left , int top ) ;
163 void MacPaintGrowBox();
164
165 // invalidates the borders and focus area around the control;
166 // must not be virtual as it will be called during destruction
167 void MacInvalidateBorders() ;
168
169 WXWindow MacGetTopLevelWindowRef() const ;
170 wxNonOwnedWindow* MacGetTopLevelWindow() const ;
171
172 virtual long MacGetLeftBorderSize() const ;
173 virtual long MacGetRightBorderSize() const ;
174 virtual long MacGetTopBorderSize() const ;
175 virtual long MacGetBottomBorderSize() const ;
176
177 virtual void MacSuperChangedPosition() ;
178
179 // absolute coordinates of this window's root have changed
180 virtual void MacTopLevelWindowChangedPosition() ;
181
182 virtual void MacChildAdded() ;
183 virtual void MacVisibilityChanged() ;
184 virtual void MacEnabledStateChanged() ;
185 virtual void MacHiliteChanged() ;
186 virtual wxInt32 MacControlHit( WXEVENTHANDLERREF handler , WXEVENTREF event ) ;
187
188 bool MacIsReallyEnabled() ;
189 bool MacIsReallyHilited() ;
190
938fbc8f 191#if WXWIN_COMPATIBILITY_2_8
6762286d 192 bool MacIsUserPane() { return m_macIsUserPane; }
938fbc8f
SC
193#endif
194 bool MacIsUserPane() const { return m_macIsUserPane; }
6762286d
SC
195
196 virtual bool MacSetupCursor( const wxPoint& pt ) ;
197
198 // return the rectangle that would be visible of this control,
199 // regardless whether controls are hidden
200 // only taking into account clipping by parent windows
201 const wxRect& MacGetClippedClientRect() const ;
202 const wxRect& MacGetClippedRect() const ;
203 const wxRect& MacGetClippedRectWithOuterStructure() const ;
204
205 // returns the visible region of this control in window ie non-client coordinates
206 const wxRegion& MacGetVisibleRegion( bool includeOuterStructures = false ) ;
207
208 // returns true if children have to clipped to the content area
209 // (e.g., scrolled windows)
210 bool MacClipChildren() const { return m_clipChildren ; }
211 void MacSetClipChildren( bool clip ) { m_clipChildren = clip ; }
212
213 // returns true if the grandchildren need to be clipped to the children's content area
214 // (e.g., splitter windows)
215 virtual bool MacClipGrandChildren() const { return false ; }
216 bool MacIsWindowScrollbar( const wxWindow* sb ) const
217 { return ((wxWindow*)m_hScrollBar == sb || (wxWindow*)m_vScrollBar == sb) ; }
218 virtual bool IsClientAreaChild(const wxWindow *child) const
219 {
220 return !MacIsWindowScrollbar(child) &&
221 wxWindowBase::IsClientAreaChild(child);
222 }
223
224 void MacPostControlCreate(const wxPoint& pos, const wxSize& size) ;
225 wxList& GetSubcontrols() { return m_subControls; }
226
227 // translate wxWidgets coords into ones suitable
228 // to be passed to CreateControl calls
229 //
230 // returns true if non-default coords are returned, false otherwise
231 bool MacGetBoundsForControl(const wxPoint& pos,
232 const wxSize& size,
233 int& x, int& y,
234 int& w, int& h , bool adjustForOrigin ) const ;
235
236 // the 'true' OS level control for this wxWindow
c099b533 237 wxOSXWidgetImpl* GetPeer() const { return m_peer ; }
03647350 238
6762286d
SC
239 void * MacGetCGContextRef() { return m_cgContextRef ; }
240 void MacSetCGContextRef(void * cg) { m_cgContextRef = cg ; }
241
242 // osx specific event handling common for all osx-ports
03647350 243
4eb5a0ec
RR
244 virtual bool OSXHandleClicked( double timestampsec );
245 virtual bool OSXHandleKeyEvent( wxKeyEvent& event );
6762286d
SC
246protected:
247 // For controls like radio buttons which are genuinely composite
248 wxList m_subControls;
249
6762286d 250 // the peer object, allowing for cleaner API support
c099b533
SC
251 wxOSXWidgetImpl * m_peer ;
252
6762286d
SC
253 void * m_cgContextRef ;
254
255 // cache the clipped rectangles within the window hierarchy
256 void MacUpdateClippedRects() const ;
257
258 mutable bool m_cachedClippedRectValid ;
259 mutable wxRect m_cachedClippedRectWithOuterStructure ;
260 mutable wxRect m_cachedClippedRect ;
261 mutable wxRect m_cachedClippedClientRect ;
262 mutable wxRegion m_cachedClippedRegionWithOuterStructure ;
263 mutable wxRegion m_cachedClippedRegion ;
264 mutable wxRegion m_cachedClippedClientRegion ;
265
266 // true if is is not a native control but a wxWindow control
267 bool m_macIsUserPane ;
268
269 // insets of the mac control from the wx top left corner
270 wxPoint m_macTopLeftInset ;
271 wxPoint m_macBottomRightInset ;
272 wxByte m_macAlpha ;
273
274 wxScrollBar* m_hScrollBar ;
275 wxScrollBar* m_vScrollBar ;
276 bool m_hScrollBarAlwaysShown;
277 bool m_vScrollBarAlwaysShown;
278 wxString m_label ;
279
280 // set to true if we do a sharp clip at the content area of this window
281 // must be dynamic as eg a panel normally is not clipping precisely, but if
282 // it becomes the target window of a scrolled window it has to...
283 bool m_clipChildren ;
284
285 virtual bool MacIsChildOfClientArea( const wxWindow* child ) const ;
286
287 bool MacHasScrollBarCorner() const;
288 void MacCreateScrollBars( long style ) ;
289 void MacRepositionScrollBars() ;
290 void MacUpdateControlFont() ;
291
292 // implement the base class pure virtuals
6de70470
VZ
293 virtual void DoGetTextExtent(const wxString& string,
294 int *x, int *y,
295 int *descent = NULL,
296 int *externalLeading = NULL,
297 const wxFont *theFont = NULL ) const;
298
299 virtual void DoEnable( bool enable );
300#if wxUSE_MENUS
301 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
302#endif
303
304 virtual void DoFreeze();
305 virtual void DoThaw();
306
6762286d
SC
307 virtual wxSize DoGetBestSize() const;
308 virtual wxSize DoGetSizeFromClientSize( const wxSize & size ) const;
309 virtual void DoClientToScreen( int *x, int *y ) const;
310 virtual void DoScreenToClient( int *x, int *y ) const;
311 virtual void DoGetPosition( int *x, int *y ) const;
312 virtual void DoGetSize( int *width, int *height ) const;
313 virtual void DoGetClientSize( int *width, int *height ) const;
314 virtual void DoSetSize(int x, int y,
315 int width, int height,
316 int sizeFlags = wxSIZE_AUTO);
317 virtual void DoSetClientSize(int width, int height);
318
319 virtual void DoCaptureMouse();
320 virtual void DoReleaseMouse();
321
322 // move the window to the specified location and resize it: this is called
323 // from both DoSetSize() and DoSetClientSize() and would usually just call
324 // ::MoveWindow() except for composite controls which will want to arrange
325 // themselves inside the given rectangle
326 virtual void DoMoveWindow( int x, int y, int width, int height );
327 virtual void DoSetWindowVariant( wxWindowVariant variant );
328
329#if wxUSE_TOOLTIPS
330 virtual void DoSetToolTip( wxToolTip *tip );
5c6eb3a8 331#endif
6762286d
SC
332
333private:
334 // common part of all ctors
335 void Init();
336
337 // show/hide scrollbars as needed, common part of SetScrollbar() and
338 // AlwaysShowScrollbars()
339 void DoUpdateScrollbarVisibility();
340
341
c0c133e1 342 wxDECLARE_NO_COPY_CLASS(wxWindowMac);
6762286d
SC
343 DECLARE_EVENT_TABLE()
344};
345
346#endif // _WX_WINDOW_H_