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