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