]> git.saurik.com Git - wxWidgets.git/blob - include/wx/mac/carbon/private.h
added stock buttons support
[wxWidgets.git] / include / wx / mac / carbon / private.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: private.h
3 // Purpose: Private declarations: as this header is only included by
4 // wxWidgets itself, it may contain identifiers which don't start
5 // with "wx".
6 // Author: Stefan Csomor
7 // Modified by:
8 // Created: 1998-01-01
9 // RCS-ID: $Id$
10 // Copyright: (c) Stefan Csomor
11 // Licence: wxWindows licence
12 /////////////////////////////////////////////////////////////////////////////
13
14 #ifndef _WX_PRIVATE_H_
15 #define _WX_PRIVATE_H_
16
17 #include "wx/defs.h"
18 #include "wx/app.h"
19
20 #ifdef __DARWIN__
21 # include <Carbon/Carbon.h>
22 #else
23 # include <Debugging.h>
24 # include <Quickdraw.h>
25 # include <Appearance.h>
26 # include <Folders.h>
27 # include <Controls.h>
28 # include <ControlDefinitions.h>
29 # include <LowMem.h>
30 # include <Gestalt.h>
31 #endif
32
33 #if UNIVERSAL_INTERFACES_VERSION < 0x0340
34 #error "please update to Apple's lastest universal headers from http://developer.apple.com/sdk/"
35 #endif
36
37 #ifndef MAC_OS_X_VERSION_10_3
38 #define MAC_OS_X_VERSION_10_3 1030
39 #endif
40
41 #if wxUSE_GUI
42
43 #include "wx/window.h"
44
45 class wxMacPortStateHelper
46 {
47 DECLARE_NO_COPY_CLASS(wxMacPortStateHelper)
48
49 public:
50 wxMacPortStateHelper( GrafPtr newport) ;
51 wxMacPortStateHelper() ;
52 ~wxMacPortStateHelper() ;
53
54 void Setup( GrafPtr newport ) ;
55 void Clear() ;
56 bool IsCleared() { return m_clip == NULL ; }
57 GrafPtr GetCurrentPort() { return m_currentPort ; }
58
59 private:
60 GrafPtr m_currentPort ;
61 GrafPtr m_oldPort ;
62 RgnHandle m_clip ;
63 ThemeDrawingState m_drawingState ;
64 short m_textFont ;
65 short m_textSize ;
66 short m_textStyle ;
67 short m_textMode ;
68 } ;
69
70 class WXDLLEXPORT wxMacPortSaver
71 {
72 DECLARE_NO_COPY_CLASS(wxMacPortSaver)
73
74 public:
75 wxMacPortSaver( GrafPtr port )
76 {
77 ::GetPort( &m_port ) ;
78 ::SetPort( port ) ;
79 }
80 ~wxMacPortSaver()
81 {
82 ::SetPort( m_port ) ;
83 }
84 private :
85 GrafPtr m_port ;
86 } ;
87
88 class WXDLLEXPORT wxMacPortSetter
89 {
90 DECLARE_NO_COPY_CLASS(wxMacPortSetter)
91
92 public:
93 wxMacPortSetter( const wxDC* dc ) ;
94 ~wxMacPortSetter() ;
95 private:
96 wxMacPortStateHelper m_ph ;
97 const wxDC* m_dc ;
98 } ;
99
100 /*
101 Clips to the visible region of a control within the current port
102 */
103
104 class WXDLLEXPORT wxMacWindowClipper : public wxMacPortSaver
105 {
106 DECLARE_NO_COPY_CLASS(wxMacWindowClipper)
107
108 public:
109 wxMacWindowClipper( const wxWindow* win ) ;
110 ~wxMacWindowClipper() ;
111 private:
112 GrafPtr m_newPort ;
113 RgnHandle m_formerClip ;
114 RgnHandle m_newClip ;
115 } ;
116
117 class WXDLLEXPORT wxMacWindowStateSaver : public wxMacWindowClipper
118 {
119 DECLARE_NO_COPY_CLASS(wxMacWindowStateSaver)
120
121 public:
122 wxMacWindowStateSaver( const wxWindow* win ) ;
123 ~wxMacWindowStateSaver() ;
124 private:
125 GrafPtr m_newPort ;
126 ThemeDrawingState m_themeDrawingState ;
127 } ;
128
129 /*
130 class wxMacDrawingHelper
131 {
132 DECLARE_NO_COPY_CLASS(wxMacDrawingHelper)
133
134 public:
135 wxMacDrawingHelper( wxWindowMac * theWindow , bool clientArea = false ) ;
136 ~wxMacDrawingHelper() ;
137 bool Ok() { return m_ok ; }
138 void LocalToWindow( Rect *rect) { OffsetRect( rect , m_origin.h , m_origin.v ) ; }
139 void LocalToWindow( Point *pt ) { AddPt( m_origin , pt ) ; }
140 void LocalToWindow( RgnHandle rgn ) { OffsetRgn( rgn , m_origin.h , m_origin.v ) ; }
141 const Point& GetOrigin() { return m_origin ; }
142 private:
143 Point m_origin ;
144 GrafPtr m_formerPort ;
145 GrafPtr m_currentPort ;
146 PenState m_savedPenState ;
147 bool m_ok ;
148 } ;
149 */
150
151 // app.h
152 bool wxMacConvertEventToRecord( EventRef event , EventRecord *rec) ;
153
154 #endif // wxUSE_GUI
155
156 // filefn.h
157 WXDLLEXPORT wxString wxMacFSSpec2MacFilename( const FSSpec *spec ) ;
158 WXDLLEXPORT void wxMacFilename2FSSpec( const char *path , FSSpec *spec ) ;
159 WXDLLEXPORT void wxMacFilename2FSSpec( const wxChar *path , FSSpec *spec ) ;
160 # ifndef __DARWIN__
161 // Mac file names are POSIX (Unix style) under Darwin, so these are not needed
162 WXDLLEXPORT wxString wxMacFSSpec2UnixFilename( const FSSpec *spec ) ;
163 WXDLLEXPORT void wxUnixFilename2FSSpec( const char *path , FSSpec *spec ) ;
164 WXDLLEXPORT wxString wxMac2UnixFilename( const char *s) ;
165 WXDLLEXPORT wxString wxUnix2MacFilename( const char *s);
166 # endif
167
168 // utils.h
169 WXDLLEXPORT wxString wxMacFindFolder(short vRefNum,
170 OSType folderType,
171 Boolean createFolder);
172
173 #if wxUSE_GUI
174
175 GWorldPtr wxMacCreateGWorld( int width , int height , int depth ) ;
176 void wxMacDestroyGWorld( GWorldPtr gw ) ;
177 PicHandle wxMacCreatePict( GWorldPtr gw , GWorldPtr mask = NULL ) ;
178 CIconHandle wxMacCreateCIcon(GWorldPtr image , GWorldPtr mask , short dstDepth , short iconSize ) ;
179 void wxMacSetColorTableEntry( CTabHandle newColors , int index , int red , int green , int blue ) ;
180 CTabHandle wxMacCreateColorTable( int numColors ) ;
181 void wxMacCreateBitmapButton( ControlButtonContentInfo*info , const wxBitmap& bitmap , int forceType = 0 ) ;
182
183 #define MAC_WXCOLORREF(a) (*((RGBColor*)&(a)))
184 #define MAC_WXHBITMAP(a) (GWorldPtr(a))
185 #define MAC_WXHMETAFILE(a) (PicHandle(a))
186 #define MAC_WXHICON(a) (CIconHandle(a))
187 #define MAC_WXHCURSOR(a) (CursHandle(a))
188 #define MAC_WXHRGN(a) (RgnHandle(a))
189 #define MAC_WXHWND(a) (WindowPtr(a))
190 #define MAC_WXRECPTR(a) ((Rect*)a)
191 #define MAC_WXPOINTPTR(a) ((Point*)a)
192 #define MAC_WXHMENU(a) ((MenuHandle)a)
193
194 struct wxOpaqueWindowRef
195 {
196 wxOpaqueWindowRef( WindowRef ref ) { m_data = ref ; }
197 operator WindowRef() { return m_data ; }
198 private :
199 WindowRef m_data ;
200 } ;
201
202 wxWindow * wxFindControlFromMacControl(ControlRef inControl ) ;
203 wxTopLevelWindowMac* wxFindWinFromMacWindow( WindowRef inWindow ) ;
204 wxMenu* wxFindMenuFromMacMenu(MenuRef inMenuRef) ;
205
206 extern wxWindow* g_MacLastWindow ;
207 pascal OSStatus wxMacTopLevelMouseEventHandler( EventHandlerCallRef handler , EventRef event , void *data ) ;
208 Rect wxMacGetBoundsForControl( wxWindow* window , const wxPoint& pos , const wxSize &size , bool adjustForOrigin = true ) ;
209
210 template<typename T> EventParamType wxMacGetEventParamType() { wxFAIL_MSG( wxT("Unknown Param Type") ) ; return 0 ; }
211 template<> inline EventParamType wxMacGetEventParamType<RgnHandle>() { return typeQDRgnHandle ; }
212 template<> inline EventParamType wxMacGetEventParamType<ControlRef>() { return typeControlRef ; }
213 template<> inline EventParamType wxMacGetEventParamType<WindowRef>() { return typeWindowRef ; }
214 template<> inline EventParamType wxMacGetEventParamType<MenuRef>() { return typeMenuRef ; }
215 template<> inline EventParamType wxMacGetEventParamType<EventRef>() { return typeEventRef ; }
216 template<> inline EventParamType wxMacGetEventParamType<Point>() { return typeQDPoint ; }
217 template<> inline EventParamType wxMacGetEventParamType<Rect>() { return typeQDRectangle ; }
218 template<> inline EventParamType wxMacGetEventParamType<Boolean>() { return typeBoolean ; }
219 #if TARGET_API_MAC_OSX
220 template<> inline EventParamType wxMacGetEventParamType<HICommand>() { return typeHICommand ; }
221 template<> inline EventParamType wxMacGetEventParamType<HIPoint>() { return typeHIPoint ; }
222 template<> inline EventParamType wxMacGetEventParamType<HISize>() { return typeHISize ; }
223 template<> inline EventParamType wxMacGetEventParamType<HIRect>() { return typeHIRect ; }
224 template<> inline EventParamType wxMacGetEventParamType<void*>() { return typeVoidPtr ; }
225 #endif
226 template<> inline EventParamType wxMacGetEventParamType<Collection>() { return typeCollection ; }
227 template<> inline EventParamType wxMacGetEventParamType<CGContextRef>() { return typeCGContextRef ; }
228 /*
229 These are ambiguous
230 template<> EventParamType wxMacGetEventParamType<GrafPtr>() { return typeGrafPtr ; }
231 template<> EventParamType wxMacGetEventParamType<OSStatus>() { return typeOSStatus ; }
232 template<> EventParamType wxMacGetEventParamType<CFIndex>() { return typeCFIndex ; }
233 template<> EventParamType wxMacGetEventParamType<GWorldPtr>() { return typeGWorldPtr ; }
234 */
235
236 class wxMacCarbonEvent
237 {
238
239 public :
240 wxMacCarbonEvent( EventRef event , bool release = false )
241 {
242 m_eventRef = event ;
243 m_release = release ;
244 }
245 wxMacCarbonEvent(UInt32 inClassID,UInt32 inKind,EventTime inWhen = 0 /*now*/,EventAttributes inAttributes=kEventAttributeNone)
246 {
247 m_eventRef = NULL ;
248 verify_noerr( MacCreateEvent( NULL , inClassID, inKind,inWhen,inAttributes,&m_eventRef) ) ;
249 m_release = true ;
250 }
251 ~wxMacCarbonEvent()
252 {
253 if ( m_release )
254 ReleaseEvent( m_eventRef ) ;
255 }
256
257 OSStatus GetParameter( EventParamName inName, EventParamType inDesiredType, UInt32 inBufferSize, void * outData) ;
258
259 template <typename T> OSStatus GetParameter( EventParamName inName, EventParamType type , T *data )
260 {
261 return GetParameter( inName, type , sizeof( T ) , data ) ;
262 }
263 template <typename T> OSStatus GetParameter( EventParamName inName, T *data )
264 {
265 return GetParameter<T>( inName, wxMacGetEventParamType<T>() , data ) ;
266 }
267
268 template <typename T> T GetParameter( EventParamName inName )
269 {
270 T value ;
271 verify_noerr( GetParameter<T>( inName, &value ) ) ;
272 return value ;
273 }
274 template <typename T> T GetParameter( EventParamName inName, EventParamType inDesiredType )
275 {
276 T value ;
277 verify_noerr( GetParameter<T>( inName, inDesiredType , &value ) ) ;
278 return value ;
279 }
280
281 OSStatus SetParameter( EventParamName inName, EventParamType inType, UInt32 inSize, const void * inData) ;
282 template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , const T *data )
283 {
284 return SetParameter( inName, inDesiredType , sizeof( T ) , data ) ;
285 }
286 template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , const T& data )
287 {
288 return SetParameter<T>( inName, inDesiredType , &data ) ;
289 }
290 template <typename T> OSStatus SetParameter( EventParamName inName, const T *data )
291 {
292 return SetParameter<T>( inName, wxMacGetEventParamType<T>() , data ) ;
293 }
294 template <typename T> OSStatus SetParameter( EventParamName inName, const T& data )
295 {
296 return SetParameter<T>( inName, wxMacGetEventParamType<T>() , &data ) ;
297 }
298 UInt32 GetClass()
299 {
300 return ::GetEventClass( m_eventRef ) ;
301 }
302 UInt32 GetKind()
303 {
304 return ::GetEventKind( m_eventRef ) ;
305 }
306 EventTime GetTime()
307 {
308 return ::GetEventTime( m_eventRef ) ;
309 }
310 UInt32 GetTicks()
311 {
312 return EventTimeToTicks( GetTime() ) ;
313 }
314 operator EventRef () { return m_eventRef; }
315 protected :
316 EventRef m_eventRef ;
317 bool m_release ;
318 } ;
319
320 class wxMacControl
321 {
322 public :
323 wxMacControl()
324 {
325 m_controlRef = NULL ;
326 }
327
328 wxMacControl( ControlRef control )
329 {
330 m_controlRef = control ;
331 }
332 wxMacControl( WXWidget control )
333 {
334 m_controlRef = (ControlRef) control ;
335 }
336 virtual ~wxMacControl()
337 {
338 }
339
340 virtual void Dispose() ;
341
342 bool Ok() const { return GetControlRef() != NULL ; }
343
344 virtual ControlRef * GetControlRefAddr() { return &m_controlRef; }
345 virtual ControlRef GetControlRef() const { return m_controlRef ; }
346
347 virtual void SetReference( SInt32 data ) ;
348 /*
349 void operator= (ControlRef c) { m_controlRef = c ; }
350 operator ControlRef () { return m_controlRef; }
351 operator ControlRef * () { return &m_controlRef; }
352 */
353 // accessing data and values
354
355 virtual OSStatus SetData( ControlPartCode inPartCode , ResType inTag , Size inSize , const void * inData ) ;
356 virtual OSStatus GetData( ControlPartCode inPartCode , ResType inTag , Size inBufferSize , void * inOutBuffer , Size * outActualSize ) const ;
357 virtual OSStatus GetDataSize( ControlPartCode inPartCode , ResType inTag , Size * outActualSize ) const ;
358 virtual OSStatus SendEvent( EventRef ref , OptionBits inOptions = 0 ) ;
359 virtual OSStatus SendHICommand( HICommand &command , OptionBits inOptions = 0 ) ;
360
361 virtual OSStatus SendHICommand( UInt32 commandID , OptionBits inOptions = 0 ) ;
362
363 virtual SInt32 GetValue() const ;
364 virtual SInt32 GetMaximum() const ;
365 virtual SInt32 GetMinimum() const ;
366
367 virtual void SetValue( SInt32 v ) ;
368 virtual void SetMinimum( SInt32 v ) ;
369 virtual void SetMaximum( SInt32 v ) ;
370
371 virtual void SetValueAndRange( SInt32 value , SInt32 minimum , SInt32 maximum ) ;
372 virtual void SetRange( SInt32 minimum , SInt32 maximum ) ;
373
374 virtual OSStatus SetFocus( ControlFocusPart focusPart ) ;
375 virtual bool HasFocus() const ;
376 virtual bool NeedsFocusRect() const ;
377
378 // templated helpers
379
380 Size GetDataSize( ControlPartCode inPartCode , ResType inTag ) const
381 {
382 Size sz ;
383 verify_noerr( GetDataSize( inPartCode , inTag , &sz ) ) ;
384 return sz ;
385 }
386 template <typename T> OSStatus SetData( ControlPartCode inPartCode , ResType inTag , const T *data )
387 {
388 return SetData( inPartCode , inTag , sizeof( T ) , data ) ;
389 }
390 template <typename T> OSStatus SetData( ControlPartCode inPartCode , ResType inTag , const T& data )
391 {
392 return SetData( inPartCode , inTag , sizeof( T ) , &data ) ;
393 }
394 template <typename T> OSStatus GetData( ControlPartCode inPartCode , ResType inTag , T *data ) const
395 {
396 Size dummy ;
397 return GetData( inPartCode , inTag , sizeof( T ) , data , &dummy ) ;
398 }
399 template <typename T> T GetData( ControlPartCode inPartCode , ResType inTag ) const
400 {
401 T value ;
402 verify_noerr( GetData<T>( inPartCode , inTag , &value ) ) ;
403 return value ;
404 }
405
406 // Flash the control for the specified amount of time
407 virtual void Flash( ControlPartCode part , UInt32 ticks = 8 ) ;
408 virtual void VisibilityChanged( bool shown ) ;
409 virtual void SetFont( const wxFont & font , const wxColour& foreground , long windowStyle ) ;
410 virtual void SetBackground( const wxBrush &brush ) ;
411 virtual ControlPartCode HandleKey( SInt16 keyCode, SInt16 charCode, EventModifiers modifiers ) ;
412 void SetActionProc( ControlActionUPP actionProc ) ;
413 void SetViewSize( SInt32 viewSize ) ;
414 SInt32 GetViewSize() const ;
415
416 virtual bool IsVisible() const ;
417 virtual void SetVisibility( bool visible , bool redraw ) ;
418 virtual bool IsEnabled() const ;
419 virtual bool IsActive() const ;
420 virtual void Enable( bool enable ) ;
421
422 // invalidates this control and all children
423 virtual void InvalidateWithChildren() ;
424 virtual void SetDrawingEnabled( bool enable ) ;
425 virtual bool GetNeedsDisplay() const ;
426 virtual void SetNeedsDisplay( bool needsDisplay , RgnHandle where = NULL ) ;
427
428 virtual void ScrollRect( const wxRect &rect , int dx , int dy ) ;
429
430 virtual void GetRect( Rect *r ) ;
431 virtual void SetRect( Rect *r ) ;
432 virtual void GetRectInWindowCoords( Rect *r ) ;
433 virtual void GetBestRect( Rect *r ) ;
434 virtual void SetTitle( const wxString &title ) ;
435 // converts from Toplevel-Content relative to local
436 static void Convert( wxPoint *pt , wxMacControl *convert , wxMacControl *to ) ;
437
438 virtual void GetFeatures( UInt32 *features ) ;
439 virtual OSStatus GetRegion( ControlPartCode partCode , RgnHandle region ) ;
440 virtual OSStatus SetZOrder( bool above , wxMacControl* other ) ;
441 // to be moved into a databrowser subclass
442
443 virtual OSStatus SetSelectionFlags( DataBrowserSelectionFlags ) ;
444 virtual OSStatus AddListViewColumn( DataBrowserListViewColumnDesc *columnDesc,
445 DataBrowserTableViewColumnIndex position ) ;
446 virtual OSStatus AutoSizeListViewColumns() ;
447 virtual OSStatus SetHasScrollBars( bool horiz , bool vert ) ;
448 virtual OSStatus SetTableViewHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle ) ;
449 virtual OSStatus SetListViewHeaderBtnHeight(UInt16 height) ;
450 virtual OSStatus SetCallbacks(const DataBrowserCallbacks * callbacks) ;
451 virtual OSStatus UpdateItems( DataBrowserItemID container, UInt32 numItems,
452 const DataBrowserItemID* items,
453 DataBrowserPropertyID preSortProperty,
454 DataBrowserPropertyID propertyID ) ;
455 virtual OSStatus AddItems( DataBrowserItemID container, UInt32 numItems,
456 const DataBrowserItemID* items,
457 DataBrowserPropertyID preSortProperty ) ;
458 virtual OSStatus RemoveItems( DataBrowserItemID container, UInt32 numItems,
459 const DataBrowserItemID* items,
460 DataBrowserPropertyID preSortProperty ) ;
461 virtual OSStatus RevealItem( DataBrowserItemID item,
462 DataBrowserPropertyID propertyID,
463 DataBrowserRevealOptions options ) ;
464 virtual bool IsItemSelected( DataBrowserItemID item ) ;
465 virtual OSStatus SetSelectedItems(UInt32 numItems,
466 const DataBrowserItemID * items,
467 DataBrowserSetOption operation ) ;
468
469 // to be moved into a tab control class
470
471 virtual OSStatus SetTabEnabled( SInt16 tabNo , bool enable ) ;
472 protected :
473 ControlRef m_controlRef ;
474 wxFont m_font ;
475 long m_windowStyle ;
476 } ;
477
478 #endif // wxUSE_GUI
479
480 //---------------------------------------------------------------------------
481 // wxMac string conversions
482 //---------------------------------------------------------------------------
483
484 void wxMacSetupConverters() ;
485 void wxMacCleanupConverters() ;
486
487 void wxMacStringToPascal( const wxString&from , StringPtr to ) ;
488 wxString wxMacMakeStringFromPascal( ConstStringPtr from ) ;
489
490 void wxMacConvertNewlines13To10( char * data ) ;
491 void wxMacConvertNewlines10To13( char * data ) ;
492 void wxMacConvertNewlines13To10( wxString *data ) ;
493 void wxMacConvertNewlines10To13( wxString *data ) ;
494
495 #if wxUSE_UNICODE
496 void wxMacConvertNewlines13To10( wxChar * data ) ;
497 void wxMacConvertNewlines10To13( wxChar * data ) ;
498 #endif
499
500 #if TARGET_CARBON
501
502 class wxMacCFStringHolder
503 {
504 public:
505 wxMacCFStringHolder()
506 {
507 m_cfs = NULL ;
508 m_release = false ;
509 }
510
511 wxMacCFStringHolder(const wxString &str , wxFontEncoding encoding )
512 {
513 m_cfs = NULL ;
514 m_release = false ;
515 Assign( str , encoding ) ;
516 }
517
518 wxMacCFStringHolder(CFStringRef ref , bool release = true )
519 {
520 m_cfs = ref ;
521 m_release = release ;
522 }
523
524 ~wxMacCFStringHolder()
525 {
526 Release() ;
527 }
528
529 CFStringRef Detach()
530 {
531 CFStringRef retval = m_cfs ;
532 m_release = false ;
533 m_cfs = NULL ;
534 return retval ;
535 }
536
537 void Release()
538 {
539 if ( m_release && m_cfs)
540 CFRelease( m_cfs ) ;
541 m_cfs = NULL ;
542 }
543
544 void Assign( const wxString &str , wxFontEncoding encoding ) ;
545
546 operator CFStringRef () { return m_cfs; }
547 wxString AsString( wxFontEncoding encoding = wxFONTENCODING_DEFAULT ) ;
548
549 private:
550
551 CFStringRef m_cfs;
552 bool m_release ;
553 } ;
554
555 #endif
556
557 // utils.cpp
558
559 wxUint32 wxMacGetSystemEncFromFontEnc(wxFontEncoding encoding) ;
560 wxFontEncoding wxMacGetFontEncFromSystemEnc(wxUint32 encoding) ;
561 void wxMacWakeUp() ;
562
563 // toplevel.cpp
564
565 ControlRef wxMacFindControlUnderMouse( Point location , WindowRef window , ControlPartCode *outPart ) ;
566
567 #endif
568 // _WX_PRIVATE_H_