include/wx/mac/carbon/private.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        private.h
   3 // Purpose:     Private declarations: as this header is only included by
   4 //              wxWindows 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 extern wxWindow* g_MacLastWindow ;
 205 pascal OSStatus wxMacTopLevelMouseEventHandler( EventHandlerCallRef handler , EventRef event , void *data ) ;
 206 Rect wxMacGetBoundsForControl( wxWindow* window , const wxPoint& pos , const wxSize &size , bool adjustForOrigin = true ) ;
 207
 208 template<typename T> EventParamType wxMacGetEventParamType() { wxFAIL_MSG( wxT("Unknown Param Type") ) ; return 0 ; }
 209 template<> inline EventParamType wxMacGetEventParamType<RgnHandle>() { return typeQDRgnHandle ; }
 210 template<> inline EventParamType wxMacGetEventParamType<ControlRef>() { return typeControlRef ; }
 211 template<> inline EventParamType wxMacGetEventParamType<WindowRef>() { return typeWindowRef ; }
 212 template<> inline EventParamType wxMacGetEventParamType<MenuRef>() { return typeMenuRef ; }
 213 template<> inline EventParamType wxMacGetEventParamType<EventRef>() { return typeEventRef ; }
 214 template<> inline EventParamType wxMacGetEventParamType<Point>() { return typeQDPoint ; }
 215 template<> inline EventParamType wxMacGetEventParamType<Rect>() { return typeQDRectangle ; }
 216 template<> inline EventParamType wxMacGetEventParamType<Boolean>() { return typeBoolean ; }
 217 #if TARGET_API_MAC_OSX
 218 template<> inline EventParamType wxMacGetEventParamType<HIPoint>() { return typeHIPoint ; }
 219 template<> inline EventParamType wxMacGetEventParamType<HISize>() { return typeHISize ; }
 220 template<> inline EventParamType wxMacGetEventParamType<HIRect>() { return typeHIRect ; }
 221 template<> inline EventParamType wxMacGetEventParamType<void*>() { return typeVoidPtr ; }
 222 #endif
 223 template<> inline EventParamType wxMacGetEventParamType<Collection>() { return typeCollection ; }
 224 template<> inline EventParamType wxMacGetEventParamType<CGContextRef>() { return typeCGContextRef ; }
 225 /*
 226 These are ambiguous
 227 template<> EventParamType wxMacGetEventParamType<GrafPtr>() { return typeGrafPtr ; }
 228 template<> EventParamType wxMacGetEventParamType<OSStatus>() { return typeOSStatus ; }
 229 template<> EventParamType wxMacGetEventParamType<CFIndex>() { return typeCFIndex ; }
 230 template<> EventParamType wxMacGetEventParamType<GWorldPtr>() { return typeGWorldPtr ; }
 231 */
 232
 233 class wxMacCarbonEvent
 234 {
 235
 236 public :
 237     wxMacCarbonEvent( EventRef event )
 238     {
 239         m_eventRef = event ;
 240     }
 241
 242     OSStatus GetParameter( EventParamName inName, EventParamType inDesiredType, UInt32 inBufferSize, void * outData) ;
 243
 244     template <typename T> OSStatus GetParameter( EventParamName inName, EventParamType type , T *data )
 245     {
 246         return GetParameter( inName, type , sizeof( T ) , data ) ;
 247     }
 248     template <typename T> OSStatus GetParameter( EventParamName inName, T *data )
 249     {
 250         return GetParameter<T>( inName, wxMacGetEventParamType<T>() , data ) ;
 251     }
 252
 253     template <typename T> T GetParameter( EventParamName inName )
 254     {
 255         T value ;
 256         verify_noerr( GetParameter<T>( inName, &value ) ) ;
 257         return value ;
 258     }
 259     template <typename T> T GetParameter( EventParamName inName, EventParamType inDesiredType )
 260     {
 261         T value ;
 262         verify_noerr( GetParameter<T>( inName, inDesiredType , &value ) ) ;
 263         return value ;
 264     }
 265
 266
 267     OSStatus SetParameter( EventParamName inName, EventParamType inType, UInt32 inSize, void * inData) ;
 268     template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , T *data )
 269     {
 270         return SetParameter( inName, inDesiredType , sizeof( T ) , data ) ;
 271     }
 272     template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , T data )
 273     {
 274         return SetParameter<T>( inName, inDesiredType , &data ) ;
 275     }
 276     template <typename T> OSStatus SetParameter( EventParamName inName, T *data )
 277     {
 278         return SetParameter<T>( inName, wxMacGetEventParamType<T>() , data ) ;
 279     }
 280     template <typename T> OSStatus SetParameter( EventParamName inName, T data )
 281     {
 282         return SetParameter<T>( inName, wxMacGetEventParamType<T>() , &data ) ;
 283     }
 284
 285     EventKind GetKind()
 286     {
 287         return ::GetEventKind( m_eventRef ) ;
 288     }
 289     EventTime GetTime()
 290     {
 291         return ::GetEventTime( m_eventRef ) ;
 292     }
 293     UInt32 GetTicks()
 294     {
 295         return EventTimeToTicks( GetTime() ) ;
 296     }
 297 protected :
 298     EventRef m_eventRef ;
 299 } ;
 300
 301 #endif // wxUSE_GUI
 302
 303 //---------------------------------------------------------------------------
 304 // wxMac string conversions
 305 //---------------------------------------------------------------------------
 306
 307 void wxMacSetupConverters() ;
 308 void wxMacCleanupConverters() ;
 309
 310 void wxMacStringToPascal( const wxString&from , StringPtr to ) ;
 311 wxString wxMacMakeStringFromPascal( ConstStringPtr from ) ;
 312
 313 void wxMacConvertNewlines13To10( char * data ) ;
 314 void wxMacConvertNewlines10To13( char * data ) ;
 315 void wxMacConvertNewlines13To10( wxString *data ) ;
 316 void wxMacConvertNewlines10To13( wxString *data ) ;
 317
 318 #if wxUSE_UNICODE
 319 void wxMacConvertNewlines13To10( wxChar * data ) ;
 320 void wxMacConvertNewlines10To13( wxChar * data ) ;
 321 #endif
 322
 323 #if TARGET_CARBON
 324
 325 class wxMacCFStringHolder
 326 {
 327 public:
 328         wxMacCFStringHolder()
 329         {
 330         m_cfs = NULL ;
 331         m_release = false ;
 332         }
 333
 334     wxMacCFStringHolder(const wxString &str , wxFontEncoding encoding )
 335     {
 336         m_cfs = NULL ;
 337         m_release = false ;
 338         Assign( str , encoding ) ;
 339     }
 340
 341     wxMacCFStringHolder(CFStringRef ref , bool release = true )
 342     {
 343         m_cfs = ref ;
 344         m_release = release ;
 345     }
 346
 347     ~wxMacCFStringHolder()
 348     {
 349         Release() ;
 350     }
 351
 352     CFStringRef Detach()
 353     {
 354         CFStringRef retval = m_cfs ;
 355         m_release = false ;
 356         m_cfs = NULL ;
 357         return retval ;
 358     }
 359
 360     void Release()
 361     {
 362         if ( m_release && m_cfs)
 363                 CFRelease( m_cfs ) ;
 364         m_cfs = NULL ;
 365     }
 366
 367         void Assign( const wxString &str , wxFontEncoding encoding ) ;
 368
 369     operator CFStringRef () { return m_cfs; }
 370     wxString AsString( wxFontEncoding encoding = wxFONTENCODING_DEFAULT ) ;
 371
 372 private:
 373
 374     CFStringRef m_cfs;
 375     bool m_release ;
 376 } ;
 377
 378 #endif
 379
 380 // utils.cpp
 381
 382 wxUint32 wxMacGetSystemEncFromFontEnc(wxFontEncoding encoding) ;
 383 wxFontEncoding wxMacGetFontEncFromSystemEnc(wxUint32 encoding) ;
 384 void wxMacWakeUp() ;
 385
 386 // toplevel.cpp
 387
 388 ControlRef wxMacFindControlUnderMouse( Point location , WindowRef window , ControlPartCode *outPart ) ;
 389
 390 #endif
 391     // _WX_PRIVATE_H_