]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/mac/carbon/private.h
Simple wxBatteryPower API for the support in wxWinCE, wxPalmOS and any other mobile...
[wxWidgets.git] / include / wx / mac / carbon / private.h
index acbf5273fd72bd8324d8ab8aadd9440df148a7c4..191fbd8cb8884bf0741596c812bdf65804013590 100644 (file)
     #define MAC_OS_X_VERSION_10_3 1030
 #endif
 
+#ifdef __WXMAC_CARBON__
+#include "wx/mac/corefoundation/cfstring.h"
+#endif
+
 #if wxUSE_GUI
 
 #include "wx/window.h"
@@ -155,58 +159,13 @@ bool wxMacConvertEventToRecord( EventRef event , EventRecord *rec) ;
 
 // filefn.h
 WXDLLEXPORT wxString wxMacFSSpec2MacFilename( const FSSpec *spec ) ;
-WXDLLEXPORT void wxMacFilename2FSSpec( const char *path , FSSpec *spec ) ;
-WXDLLEXPORT void wxMacFilename2FSSpec( const wxChar *path , FSSpec *spec ) ;
-#  ifndef __DARWIN__
-// Mac file names are POSIX (Unix style) under Darwin, so these are not needed
-WXDLLEXPORT wxString wxMacFSSpec2UnixFilename( const FSSpec *spec ) ;
-WXDLLEXPORT void wxUnixFilename2FSSpec( const char *path , FSSpec *spec ) ;
-WXDLLEXPORT wxString wxMac2UnixFilename( const char *s) ;
-WXDLLEXPORT wxString wxUnix2MacFilename( const char *s);
-#  endif
+WXDLLEXPORT void wxMacFilename2FSSpec( const wxString &path , FSSpec *spec ) ;
 
 // utils.h
 WXDLLEXPORT wxString wxMacFindFolder(short vRefNum,
                                      OSType folderType,
                                      Boolean createFolder);
 
-#if wxUSE_GUI
-
-GWorldPtr         wxMacCreateGWorld( int width , int height , int depth ) ;
-void                 wxMacDestroyGWorld( GWorldPtr gw ) ;
-PicHandle         wxMacCreatePict( GWorldPtr gw , GWorldPtr mask = NULL ) ;
-CIconHandle     wxMacCreateCIcon(GWorldPtr image , GWorldPtr mask , short dstDepth , short iconSize  ) ;
-void                 wxMacSetColorTableEntry( CTabHandle newColors , int index , int red , int green ,  int blue ) ;
-CTabHandle         wxMacCreateColorTable( int numColors ) ;
-void wxMacCreateBitmapButton( ControlButtonContentInfo*info , const wxBitmap& bitmap , int forceType = 0 ) ;
-
-#define MAC_WXCOLORREF(a) (*((RGBColor*)&(a)))
-#define MAC_WXHBITMAP(a) (GWorldPtr(a))
-#define MAC_WXHMETAFILE(a) (PicHandle(a))
-#define MAC_WXHICON(a) (CIconHandle(a))
-#define MAC_WXHCURSOR(a) (CursHandle(a))
-#define MAC_WXHRGN(a) (RgnHandle(a))
-#define MAC_WXHWND(a) (WindowPtr(a))
-#define MAC_WXRECPTR(a) ((Rect*)a)
-#define MAC_WXPOINTPTR(a) ((Point*)a)
-#define MAC_WXHMENU(a) ((MenuHandle)a)
-
-struct wxOpaqueWindowRef
-{
-    wxOpaqueWindowRef( WindowRef ref ) { m_data = ref ; }
-    operator WindowRef() { return m_data ; } 
-private :
-    WindowRef m_data ;
-} ;
-
-wxWindow *              wxFindControlFromMacControl(ControlRef inControl ) ;
-wxTopLevelWindowMac*    wxFindWinFromMacWindow( WindowRef inWindow ) ;
-wxMenu*                 wxFindMenuFromMacMenu(MenuRef inMenuRef) ;
-
-extern wxWindow* g_MacLastWindow ;
-pascal OSStatus wxMacTopLevelMouseEventHandler( EventHandlerCallRef handler , EventRef event , void *data ) ;
-Rect wxMacGetBoundsForControl( wxWindow* window , const wxPoint& pos , const wxSize &size , bool adjustForOrigin = true ) ;
-
 template<typename T> EventParamType wxMacGetEventParamType() { wxFAIL_MSG( wxT("Unknown Param Type") ) ; return 0 ; }
 template<> inline EventParamType wxMacGetEventParamType<RgnHandle>() { return typeQDRgnHandle ; }
 template<> inline EventParamType wxMacGetEventParamType<ControlRef>() { return typeControlRef ; }
@@ -217,6 +176,7 @@ template<> inline EventParamType wxMacGetEventParamType<Point>() { return typeQD
 template<> inline EventParamType wxMacGetEventParamType<Rect>() { return typeQDRectangle ; }
 template<> inline EventParamType wxMacGetEventParamType<Boolean>() { return typeBoolean ; }
 #if TARGET_API_MAC_OSX
+template<> inline EventParamType wxMacGetEventParamType<HICommand>() { return typeHICommand ; }
 template<> inline EventParamType wxMacGetEventParamType<HIPoint>() { return typeHIPoint ; }
 template<> inline EventParamType wxMacGetEventParamType<HISize>() { return typeHISize ; }
 template<> inline EventParamType wxMacGetEventParamType<HIRect>() { return typeHIRect ; }
@@ -225,20 +185,56 @@ template<> inline EventParamType wxMacGetEventParamType<void*>() { return typeVo
 template<> inline EventParamType wxMacGetEventParamType<Collection>() { return typeCollection ; }
 template<> inline EventParamType wxMacGetEventParamType<CGContextRef>() { return typeCGContextRef ; }
 /*
-These are ambiguous
-template<> EventParamType wxMacGetEventParamType<GrafPtr>() { return typeGrafPtr ; }
-template<> EventParamType wxMacGetEventParamType<OSStatus>() { return typeOSStatus ; }
-template<> EventParamType wxMacGetEventParamType<CFIndex>() { return typeCFIndex ; }
-template<> EventParamType wxMacGetEventParamType<GWorldPtr>() { return typeGWorldPtr ; }
-*/
+ These are ambiguous
+ template<> EventParamType wxMacGetEventParamType<GrafPtr>() { return typeGrafPtr ; }
+ template<> EventParamType wxMacGetEventParamType<OSStatus>() { return typeOSStatus ; }
+ template<> EventParamType wxMacGetEventParamType<CFIndex>() { return typeCFIndex ; }
+ template<> EventParamType wxMacGetEventParamType<GWorldPtr>() { return typeGWorldPtr ; }
+ */
 
 class wxMacCarbonEvent
 {
     
 public :
-    wxMacCarbonEvent( EventRef event ) 
+    wxMacCarbonEvent()
+    {
+        m_eventRef = 0 ;
+        m_release = false ;
+    }
+    
+    wxMacCarbonEvent( EventRef event , bool release = false ) 
     {
         m_eventRef = event ;
+        m_release = release ;
+    }
+    
+    wxMacCarbonEvent(UInt32 inClassID,UInt32 inKind,EventTime inWhen = 0 /*now*/,EventAttributes inAttributes=kEventAttributeNone) 
+    {
+        m_eventRef = NULL ;
+        verify_noerr( MacCreateEvent( NULL , inClassID, inKind,inWhen,inAttributes,&m_eventRef) ) ;
+        m_release = true ;
+    }
+    
+    ~wxMacCarbonEvent()
+    {
+        if ( m_release )
+            ReleaseEvent( m_eventRef ) ;
+    }
+    
+    OSStatus Create(UInt32 inClassID,UInt32 inKind,EventTime inWhen = 0 /*now*/,EventAttributes inAttributes=kEventAttributeNone) 
+    {
+        verify( (m_eventRef == NULL) || m_release ) ;
+        if ( m_eventRef && m_release )
+        {
+            ReleaseEvent( m_eventRef ) ;
+            m_release = false ;
+            m_eventRef = NULL ;
+            
+        }
+        OSStatus err = MacCreateEvent( NULL , inClassID, inKind,inWhen,inAttributes,&m_eventRef) ;
+        if ( err == noErr )
+            m_release = true ;
+        return err ;
     }
     
     OSStatus GetParameter( EventParamName inName, EventParamType inDesiredType, UInt32 inBufferSize, void * outData) ;
@@ -264,26 +260,28 @@ public :
         verify_noerr( GetParameter<T>( inName, inDesiredType , &value ) ) ;
         return value ;
     }
-
-
-    OSStatus SetParameter( EventParamName inName, EventParamType inType, UInt32 inSize, void * inData) ;
-    template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , T *data )
+    
+    OSStatus SetParameter( EventParamName inName, EventParamType inType, UInt32 inSize, const void * inData) ;
+    template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , const T *data )
     {
         return SetParameter( inName, inDesiredType , sizeof( T ) , data ) ;
     }
-    template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , T data )
+    template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , const T& data )
     {
         return SetParameter<T>( inName, inDesiredType , &data ) ;
     }
-    template <typename T> OSStatus SetParameter( EventParamName inName, T *data )
+    template <typename T> OSStatus SetParameter( EventParamName inName, const T *data )
     {
         return SetParameter<T>( inName, wxMacGetEventParamType<T>() , data ) ;
     }
-    template <typename T> OSStatus SetParameter( EventParamName inName, T data )
+    template <typename T> OSStatus SetParameter( EventParamName inName, const T& data )
     {
         return SetParameter<T>( inName, wxMacGetEventParamType<T>() , &data ) ;
     }
-    
+    UInt32 GetClass()
+    {
+        return ::GetEventClass( m_eventRef ) ;
+    }
     UInt32 GetKind()
     {
         return ::GetEventKind( m_eventRef ) ;
@@ -296,98 +294,259 @@ public :
     {
         return EventTimeToTicks( GetTime() ) ;
     }
+    OSStatus SetTime( EventTime inWhen = 0 /*now*/ ) 
+    {
+        return ::SetEventTime( m_eventRef , inWhen ? inWhen : GetCurrentEventTime() ) ;
+    }
+    operator EventRef () { return m_eventRef; }
+    
+    bool IsValid() { return m_eventRef != 0 ; }  
 protected :
     EventRef m_eventRef ;
+    bool     m_release ;
 } ;
 
-#endif // wxUSE_GUI
+//
+// helper class for allocating and deallocating Universal Proc Ptrs
+//
 
-//---------------------------------------------------------------------------
-// wxMac string conversions
-//---------------------------------------------------------------------------
+template <typename procType, typename uppType , uppType (*newUPP)(procType) , void (*disposeUPP)(uppType) > class wxMacUPP
+{
+public :
+    wxMacUPP( procType proc )
+    {
+        m_upp = NULL ;
+        m_upp = (*newUPP)( NULL ) ;
+    }
+    ~wxMacUPP()
+    {
+        if ( m_upp )
+            disposeUPP( m_upp ) ;
+    }
+    operator uppType() { return m_upp ; }
+private :
+    uppType m_upp ;
+} ;
 
-void wxMacSetupConverters() ;
-void wxMacCleanupConverters() ;
+typedef wxMacUPP<NMProcPtr,NMUPP,NewNMUPP,DisposeNMUPP> wxMacNMUPP ;
 
-void wxMacStringToPascal( const wxString&from , StringPtr to ) ;
-wxString wxMacMakeStringFromPascal( ConstStringPtr from ) ;
+#if wxUSE_GUI
+
+GWorldPtr         wxMacCreateGWorld( int width , int height , int depth ) ;
+void                 wxMacDestroyGWorld( GWorldPtr gw ) ;
+PicHandle         wxMacCreatePict( GWorldPtr gw , GWorldPtr mask = NULL ) ;
+CIconHandle     wxMacCreateCIcon(GWorldPtr image , GWorldPtr mask , short dstDepth , short iconSize  ) ;
+void                 wxMacSetColorTableEntry( CTabHandle newColors , int index , int red , int green ,  int blue ) ;
+CTabHandle         wxMacCreateColorTable( int numColors ) ;
+void wxMacCreateBitmapButton( ControlButtonContentInfo*info , const wxBitmap& bitmap , int forceType = 0 ) ;
 
-void wxMacConvertNewlines13To10( char * data ) ;
-void wxMacConvertNewlines10To13( char * data ) ;
-void wxMacConvertNewlines13To10( wxString *data ) ;
-void wxMacConvertNewlines10To13( wxString *data ) ;
+#define MAC_WXCOLORREF(a) (*((RGBColor*)&(a)))
+#define MAC_WXHBITMAP(a) (GWorldPtr(a))
+#define MAC_WXHMETAFILE(a) (PicHandle(a))
+#define MAC_WXHICON(a) (CIconHandle(a))
+#define MAC_WXHCURSOR(a) (CursHandle(a))
+#define MAC_WXHRGN(a) (RgnHandle(a))
+#define MAC_WXHWND(a) (WindowPtr(a))
+#define MAC_WXRECPTR(a) ((Rect*)a)
+#define MAC_WXPOINTPTR(a) ((Point*)a)
+#define MAC_WXHMENU(a) ((MenuHandle)a)
 
-#if wxUSE_UNICODE
-void wxMacConvertNewlines13To10( wxChar * data ) ;
-void wxMacConvertNewlines10To13( wxChar * data ) ;
-#endif
+struct wxOpaqueWindowRef
+{
+    wxOpaqueWindowRef( WindowRef ref ) { m_data = ref ; }
+    operator WindowRef() { return m_data ; } 
+private :
+    WindowRef m_data ;
+} ;
+
+wxWindow *              wxFindControlFromMacControl(ControlRef inControl ) ;
+wxTopLevelWindowMac*    wxFindWinFromMacWindow( WindowRef inWindow ) ;
+wxMenu*                 wxFindMenuFromMacMenu(MenuRef inMenuRef) ;
+
+extern wxWindow* g_MacLastWindow ;
+pascal OSStatus wxMacTopLevelMouseEventHandler( EventHandlerCallRef handler , EventRef event , void *data ) ;
+Rect wxMacGetBoundsForControl( wxWindow* window , const wxPoint& pos , const wxSize &size , bool adjustForOrigin = true ) ;
+
+class wxMacControl
+{
+public :
+    wxMacControl()
+    {
+        m_controlRef = NULL ;
+    }
+    
+    wxMacControl( ControlRef control ) 
+    {
+        m_controlRef = control ;
+    }
+    wxMacControl( WXWidget control )
+    {
+        m_controlRef = (ControlRef) control ;
+    }
+    virtual ~wxMacControl()
+    {
+    }
+    
+    virtual void Dispose() ;
+
+    bool Ok() const { return GetControlRef() != NULL ; }
+    
+    virtual ControlRef * GetControlRefAddr() { return &m_controlRef; } 
+    virtual ControlRef GetControlRef() const { return m_controlRef ; }  
+
+    virtual void SetReference( SInt32 data ) ; 
+    /*
+    void operator= (ControlRef c) { m_controlRef = c ; }
+    operator ControlRef () { return m_controlRef; }   
+    operator ControlRef * () { return &m_controlRef; }   
+    */
+    // accessing data and values
+
+    virtual OSStatus SetData( ControlPartCode inPartCode , ResType inTag , Size inSize , const void * inData ) ;
+    virtual OSStatus GetData( ControlPartCode inPartCode , ResType inTag , Size inBufferSize , void * inOutBuffer , Size * outActualSize ) const ;
+    virtual OSStatus GetDataSize( ControlPartCode inPartCode , ResType inTag , Size * outActualSize ) const ;
+    virtual OSStatus SendEvent(  EventRef ref , OptionBits inOptions = 0 ) ;
+    virtual OSStatus SendHICommand( HICommand &command , OptionBits inOptions = 0 ) ;
+
+    virtual OSStatus SendHICommand( UInt32 commandID , OptionBits inOptions = 0 ) ;
+
+    virtual SInt32 GetValue() const ;
+    virtual SInt32 GetMaximum() const ;
+    virtual SInt32 GetMinimum() const ;
+    
+    virtual void SetValue( SInt32 v ) ;
+    virtual void SetMinimum( SInt32 v ) ;
+    virtual void SetMaximum( SInt32 v ) ;
+
+    virtual void SetValueAndRange( SInt32 value , SInt32 minimum , SInt32 maximum ) ;
+    virtual void SetRange( SInt32 minimum , SInt32 maximum ) ;
+    
+    virtual OSStatus SetFocus( ControlFocusPart focusPart ) ;
+    virtual bool HasFocus() const ;
+    virtual bool NeedsFocusRect() const ;
+    
+    // templated helpers
 
-#if TARGET_CARBON
-
-class wxMacCFStringHolder                                                             
-{                                                                           
-public:      
-       wxMacCFStringHolder()
-       {
-       m_cfs = NULL ;
-       m_release = false ;                                                                 
-       }
-                                                                      
-    wxMacCFStringHolder(const wxString &str , wxFontEncoding encoding )                                          
-    {      
-       m_cfs = NULL ;
-       m_release = false ;  
-       Assign( str , encoding ) ;
-    }                                                                       
-                                                                            
-    wxMacCFStringHolder(CFStringRef ref , bool release = true )                                                   
-    {                                                                       
-        m_cfs = ref ;
-        m_release = release ;                                           
-    }                                                                       
-                                                                            
-    ~wxMacCFStringHolder() 
-    { 
-       Release() ;
-    }                                           
-
-    CFStringRef Detach()
+    Size GetDataSize( ControlPartCode inPartCode , ResType inTag ) const
+    {
+        Size sz ;
+        verify_noerr( GetDataSize( inPartCode , inTag , &sz ) ) ;
+        return sz ;
+    }
+    template <typename T> OSStatus SetData( ControlPartCode inPartCode , ResType inTag , const T *data )
+    {
+        return SetData( inPartCode , inTag , sizeof( T ) , data ) ;
+    }
+    template <typename T> OSStatus SetData( ControlPartCode inPartCode , ResType inTag , const T& data )
     {
-       CFStringRef retval = m_cfs ;
-       m_release = false ;
-       m_cfs = NULL ;
-       return retval ;
-    }         
-                                                                   
-    void Release()
+        return SetData( inPartCode , inTag , sizeof( T ) , &data ) ;
+    }
+    template <typename T> OSStatus GetData( ControlPartCode inPartCode , ResType inTag , T *data ) const
     {
-       if ( m_release && m_cfs)
-               CFRelease( m_cfs ) ;
-       m_cfs = NULL ;
-    }         
-
-       void Assign( const wxString &str , wxFontEncoding encoding ) ;
-
-    operator CFStringRef () { return m_cfs; }   
-    wxString AsString( wxFontEncoding encoding = wxFONTENCODING_DEFAULT ) ;
-             
-private:             
-                                                              
-    CFStringRef m_cfs;
-    bool m_release ;                                                        
+        Size dummy ;
+        return GetData( inPartCode , inTag , sizeof( T ) , data , &dummy ) ;
+    }
+    template <typename T> T GetData( ControlPartCode inPartCode , ResType inTag ) const
+    {
+        T value ;
+        verify_noerr( GetData<T>( inPartCode , inTag , &value ) ) ;
+        return value ;
+    }
+       
+    // Flash the control for the specified amount of time
+    virtual void Flash( ControlPartCode part , UInt32 ticks = 8 ) ;
+    virtual void VisibilityChanged( bool shown ) ;
+    virtual void SetFont( const wxFont & font , const wxColour& foreground , long windowStyle ) ;
+    virtual void SetBackground( const wxBrush &brush ) ;
+    virtual ControlPartCode HandleKey(  SInt16 keyCode,  SInt16 charCode, EventModifiers modifiers ) ;
+    void SetActionProc( ControlActionUPP   actionProc ) ;
+    void SetViewSize( SInt32 viewSize ) ;
+    SInt32 GetViewSize() const ;
+    
+    virtual bool IsVisible() const ;
+    virtual void SetVisibility( bool visible , bool redraw ) ;
+    virtual bool IsEnabled() const ;
+    virtual bool IsActive() const ;
+    virtual void Enable( bool enable ) ;
+    
+    // invalidates this control and all children
+    virtual void InvalidateWithChildren() ;
+    virtual void SetDrawingEnabled( bool enable ) ;
+    virtual bool GetNeedsDisplay() const ;
+    virtual void SetNeedsDisplay( bool needsDisplay , RgnHandle where = NULL ) ;
+
+    virtual void ScrollRect( const wxRect &rect , int dx , int dy ) ;
+
+    virtual void GetRect( Rect *r ) ;
+    virtual void SetRect( Rect *r ) ;
+    virtual void GetRectInWindowCoords( Rect *r ) ;
+    virtual void GetBestRect( Rect *r ) ;
+    virtual void SetTitle( const wxString &title ) ;
+    // converts from Toplevel-Content relative to local
+    static void Convert( wxPoint *pt , wxMacControl *convert , wxMacControl *to ) ;
+    
+    virtual void GetFeatures( UInt32 *features ) ;
+    virtual OSStatus GetRegion( ControlPartCode partCode , RgnHandle region ) ;
+    virtual OSStatus SetZOrder( bool above , wxMacControl* other ) ;
+    // to be moved into a databrowser subclass
+    
+    virtual OSStatus SetSelectionFlags( DataBrowserSelectionFlags ) ;
+    virtual OSStatus AddListViewColumn( DataBrowserListViewColumnDesc *columnDesc,
+        DataBrowserTableViewColumnIndex position ) ;
+    virtual OSStatus AutoSizeListViewColumns() ;
+    virtual OSStatus SetHasScrollBars( bool horiz , bool vert ) ;
+    virtual OSStatus SetTableViewHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle ) ;
+    virtual OSStatus SetListViewHeaderBtnHeight(UInt16 height) ;
+    virtual OSStatus SetCallbacks(const DataBrowserCallbacks *  callbacks) ;
+    virtual OSStatus UpdateItems( DataBrowserItemID container, UInt32 numItems,
+            const DataBrowserItemID* items,                
+            DataBrowserPropertyID preSortProperty,
+            DataBrowserPropertyID propertyID ) ;
+    virtual OSStatus AddItems( DataBrowserItemID container, UInt32 numItems,
+            const DataBrowserItemID* items,                
+            DataBrowserPropertyID preSortProperty ) ;
+    virtual OSStatus RemoveItems( DataBrowserItemID container, UInt32 numItems,
+            const DataBrowserItemID* items,                
+            DataBrowserPropertyID preSortProperty ) ;
+    virtual OSStatus RevealItem( DataBrowserItemID item,
+            DataBrowserPropertyID propertyID,
+            DataBrowserRevealOptions options ) ;
+    virtual OSStatus GetSelectionAnchor( DataBrowserItemID * first, DataBrowserItemID * last ) ;
+    virtual bool IsItemSelected( DataBrowserItemID item ) ;
+    virtual OSStatus SetSelectedItems(UInt32 numItems,
+            const DataBrowserItemID * items,
+            DataBrowserSetOption operation ) ;
+            
+    // to be moved into a tab control class
+    
+    virtual OSStatus SetTabEnabled( SInt16 tabNo , bool enable ) ;
+protected :
+    ControlRef  m_controlRef ;
+    wxFont      m_font ;
+    long        m_windowStyle ; 
 } ;
 
-#endif
+#endif // wxUSE_GUI
 
-// utils.cpp
+//---------------------------------------------------------------------------
+// wxMac string conversions
+//---------------------------------------------------------------------------
+
+void wxMacSetupConverters() ;
+void wxMacCleanupConverters() ;
 
-wxUint32 wxMacGetSystemEncFromFontEnc(wxFontEncoding encoding) ;
-wxFontEncoding wxMacGetFontEncFromSystemEnc(wxUint32 encoding) ;
-void wxMacWakeUp() ;
+void wxMacStringToPascal( const wxString&from , StringPtr to ) ;
+wxString wxMacMakeStringFromPascal( ConstStringPtr from ) ;
 
 // toplevel.cpp
 
 ControlRef wxMacFindControlUnderMouse( Point location , WindowRef window , ControlPartCode *outPart ) ;
 
+// filefn.cpp
+
+wxString wxMacFSRefToPath( const FSRef *fsRef , CFStringRef additionalPathComponent = NULL ) ;
+OSStatus wxMacPathToFSRef( const wxString&path , FSRef *fsRef ) ;
+wxString wxMacHFSUniStrToString( ConstHFSUniStr255Param uniname ) ;
+
 #endif
     // _WX_PRIVATE_H_