include/wx/osx/carbon/private.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/osx/carbon/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/osx/core/private.h"
  18
  19 #include <Carbon/Carbon.h>
  20
  21 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
  22 typedef UInt32 URefCon;
  23 typedef SInt32 SRefCon;
  24 #endif
  25
  26 #if wxUSE_GUI
  27
  28 #include "wx/osx/uma.h"
  29
  30 #include "wx/listbox.h"
  31 #include "wx/osx/dc.h"
  32 #include "wx/osx/dcclient.h"
  33 #include "wx/osx/dcmemory.h"
  34
  35 // app.h
  36
  37 #if MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_5
  38 bool wxMacConvertEventToRecord( EventRef event , EventRecord *rec);
  39 #endif
  40
  41 WXDLLIMPEXP_CORE wxWindowMac * wxFindWindowFromWXWidget(WXWidget inControl );
  42 // TODO REMOVE WXDLLIMPEXP_CORE wxNonOwnedWindow* wxFindWindowFromWXWindow( WXWindow inWindow );
  43
  44 #endif // wxUSE_GUI
  45
  46 // filefn.h
  47 WXDLLIMPEXP_BASE wxString wxMacFSSpec2MacFilename( const FSSpec *spec );
  48 WXDLLIMPEXP_BASE void wxMacFilename2FSSpec( const wxString &path , FSSpec *spec );
  49
  50 // utils.h
  51 WXDLLIMPEXP_BASE wxString wxMacFindFolderNoSeparator(short vRefNum,
  52                                                      OSType folderType,
  53                                                      Boolean createFolder);
  54 WXDLLIMPEXP_BASE wxString wxMacFindFolder(short vRefNum,
  55                                           OSType folderType,
  56                                           Boolean createFolder);
  57
  58 template<typename T> EventParamType wxMacGetEventParamType() { wxFAIL_MSG( wxT("Unknown Param Type") ); return 0; }
  59 template<> inline EventParamType wxMacGetEventParamType<RgnHandle>() { return typeQDRgnHandle; }
  60 template<> inline EventParamType wxMacGetEventParamType<ControlRef>() { return typeControlRef; }
  61 template<> inline EventParamType wxMacGetEventParamType<WindowRef>() { return typeWindowRef; }
  62 template<> inline EventParamType wxMacGetEventParamType<MenuRef>() { return typeMenuRef; }
  63 template<> inline EventParamType wxMacGetEventParamType<EventRef>() { return typeEventRef; }
  64 template<> inline EventParamType wxMacGetEventParamType<Point>() { return typeQDPoint; }
  65 template<> inline EventParamType wxMacGetEventParamType<Rect>() { return typeQDRectangle; }
  66 template<> inline EventParamType wxMacGetEventParamType<Boolean>() { return typeBoolean; }
  67 template<> inline EventParamType wxMacGetEventParamType<SInt16>() { return typeSInt16; }
  68 template<> inline EventParamType wxMacGetEventParamType<SInt32>() { return typeSInt32; }
  69 template<> inline EventParamType wxMacGetEventParamType<UInt32>() { return typeUInt32; }
  70 template<> inline EventParamType wxMacGetEventParamType<RGBColor>() { return typeRGBColor; }
  71 template<> inline EventParamType wxMacGetEventParamType<HICommand>() { return typeHICommand; }
  72 template<> inline EventParamType wxMacGetEventParamType<HIPoint>() { return typeHIPoint; }
  73 template<> inline EventParamType wxMacGetEventParamType<HISize>() { return typeHISize; }
  74 template<> inline EventParamType wxMacGetEventParamType<HIRect>() { return typeHIRect; }
  75 template<> inline EventParamType wxMacGetEventParamType<void*>() { return typeVoidPtr; }
  76 template<> inline EventParamType wxMacGetEventParamType<CFDictionaryRef>() { return typeCFDictionaryRef; }
  77 template<> inline EventParamType wxMacGetEventParamType<Collection>() { return typeCollection; }
  78 template<> inline EventParamType wxMacGetEventParamType<CGContextRef>() { return typeCGContextRef; }
  79 /*
  80  These are ambiguous
  81  template<> EventParamType wxMacGetEventParamType<GrafPtr>() { return typeGrafPtr; }
  82  template<> EventParamType wxMacGetEventParamType<OSStatus>() { return typeOSStatus; }
  83  template<> EventParamType wxMacGetEventParamType<CFIndex>() { return typeCFIndex; }
  84  template<> EventParamType wxMacGetEventParamType<GWorldPtr>() { return typeGWorldPtr; }
  85  */
  86
  87 class WXDLLIMPEXP_CORE wxMacCarbonEvent
  88 {
  89
  90 public :
  91     wxMacCarbonEvent()
  92     {
  93         m_eventRef = 0;
  94         m_release = false;
  95     }
  96
  97     wxMacCarbonEvent( EventRef event , bool release = false )
  98     {
  99         m_eventRef = event;
 100         m_release = release;
 101     }
 102
 103     wxMacCarbonEvent(UInt32 inClassID,UInt32 inKind,EventTime inWhen = 0 /*now*/,EventAttributes inAttributes=kEventAttributeNone)
 104     {
 105         m_eventRef = NULL;
 106         verify_noerr( MacCreateEvent( NULL , inClassID, inKind,inWhen,inAttributes,&m_eventRef) );
 107         m_release = true;
 108     }
 109
 110     ~wxMacCarbonEvent()
 111     {
 112         if ( m_release )
 113             ReleaseEvent( m_eventRef );
 114     }
 115
 116     OSStatus Create(UInt32 inClassID,UInt32 inKind,EventTime inWhen = 0 /*now*/,EventAttributes inAttributes=kEventAttributeNone)
 117     {
 118         verify( (m_eventRef == NULL) || m_release );
 119         if ( m_eventRef && m_release )
 120         {
 121             ReleaseEvent( m_eventRef );
 122             m_release = false;
 123             m_eventRef = NULL;
 124         }
 125         OSStatus err = MacCreateEvent( NULL , inClassID, inKind,inWhen,inAttributes,&m_eventRef);
 126         if ( err == noErr )
 127             m_release = true;
 128         return err;
 129     }
 130
 131     OSStatus GetParameter( EventParamName inName, EventParamType inDesiredType, UInt32 inBufferSize, void * outData);
 132
 133     template <typename T> OSStatus GetParameter( EventParamName inName, EventParamType type , T *data )
 134     {
 135         return GetParameter( inName, type , sizeof( T ) , data );
 136     }
 137     template <typename T> OSStatus GetParameter( EventParamName inName, T *data )
 138     {
 139         return GetParameter<T>( inName, wxMacGetEventParamType<T>() , data );
 140     }
 141
 142     template <typename T> T GetParameter( EventParamName inName )
 143     {
 144         T value;
 145         verify_noerr( GetParameter<T>( inName, &value ) );
 146         return value;
 147     }
 148     template <typename T> T GetParameter( EventParamName inName, EventParamType inDesiredType )
 149     {
 150         T value;
 151         verify_noerr( GetParameter<T>( inName, inDesiredType , &value ) );
 152         return value;
 153     }
 154
 155     OSStatus SetParameter( EventParamName inName, EventParamType inType, UInt32 inSize, const void * inData);
 156     template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , const T *data )
 157     {
 158         return SetParameter( inName, inDesiredType , sizeof( T ) , data );
 159     }
 160     template <typename T> OSStatus SetParameter( EventParamName inName, EventParamType inDesiredType , const T& data )
 161     {
 162         return SetParameter<T>( inName, inDesiredType , &data );
 163     }
 164     template <typename T> OSStatus SetParameter( EventParamName inName, const T *data )
 165     {
 166         return SetParameter<T>( inName, wxMacGetEventParamType<T>() , data );
 167     }
 168     template <typename T> OSStatus SetParameter( EventParamName inName, const T& data )
 169     {
 170         return SetParameter<T>( inName, wxMacGetEventParamType<T>() , &data );
 171     }
 172     UInt32 GetClass()
 173     {
 174         return ::GetEventClass( m_eventRef );
 175     }
 176     UInt32 GetKind()
 177     {
 178         return ::GetEventKind( m_eventRef );
 179     }
 180     EventTime GetTime()
 181     {
 182         return ::GetEventTime( m_eventRef );
 183     }
 184     UInt32 GetTicks()
 185     {
 186         return EventTimeToTicks( GetTime() );
 187     }
 188     OSStatus SetCurrentTime( )
 189     {
 190         return ::SetEventTime( m_eventRef , GetCurrentEventTime() );
 191     }
 192     OSStatus SetTime( EventTime when )
 193     {
 194         return ::SetEventTime( m_eventRef , when );
 195     }
 196     operator EventRef () { return m_eventRef; }
 197
 198     bool IsValid() { return m_eventRef != 0; }
 199 protected :
 200     EventRef m_eventRef;
 201     bool     m_release;
 202 };
 203
 204 #if wxUSE_GUI
 205
 206 class WXDLLIMPEXP_FWD_CORE wxMacToolTipTimer ;
 207
 208 class WXDLLIMPEXP_CORE wxMacToolTip
 209 {
 210 public :
 211     wxMacToolTip() ;
 212     ~wxMacToolTip() ;
 213
 214     void Setup( WindowRef window , const wxString& text , const wxPoint& localPosition ) ;
 215     void Draw() ;
 216     void Clear() ;
 217
 218     long GetMark()
 219     { return m_mark ; }
 220
 221     bool IsShown()
 222     { return m_shown ; }
 223
 224 private :
 225     wxString    m_label ;
 226     wxPoint m_position ;
 227     Rect            m_rect ;
 228     WindowRef    m_window ;
 229     PicHandle    m_backpict ;
 230     bool        m_shown ;
 231     long        m_mark ;
 232 #if wxUSE_TIMER
 233     wxMacToolTipTimer* m_timer ;
 234 #endif
 235     wxCFStringRef m_helpTextRef ;
 236 } ;
 237
 238 // Quartz
 239
 240 WXDLLIMPEXP_CORE void wxMacCreateBitmapButton( ControlButtonContentInfo*info , const wxBitmap& bitmap , int forceType = 0 );
 241 WXDLLIMPEXP_CORE void wxMacReleaseBitmapButton( ControlButtonContentInfo*info );
 242
 243 #define MAC_WXHBITMAP(a) (GWorldPtr(a))
 244 #define MAC_WXHMETAFILE(a) (PicHandle(a))
 245 #define MAC_WXHICON(a) (IconRef(a))
 246 #define MAC_WXHCURSOR(a) (CursHandle(a))
 247 #define MAC_WXHRGN(a) (RgnHandle(a))
 248 #define MAC_WXHWND(a) (WindowPtr(a))
 249 #define MAC_WXRECPTR(a) ((Rect*)a)
 250 #define MAC_WXPOINTPTR(a) ((Point*)a)
 251 #define MAC_WXHMENU(a) ((MenuHandle)a)
 252
 253 struct wxOpaqueWindowRef
 254 {
 255     wxOpaqueWindowRef( WindowRef ref ) { m_data = ref; }
 256     operator WindowRef() { return m_data; }
 257 private :
 258     WindowRef m_data;
 259 };
 260
 261 WXDLLIMPEXP_CORE void wxMacRectToNative( const wxRect *wx , Rect *n );
 262 WXDLLIMPEXP_CORE void wxMacNativeToRect( const Rect *n , wxRect* wx );
 263 WXDLLIMPEXP_CORE void wxMacPointToNative( const wxPoint* wx , Point *n );
 264 WXDLLIMPEXP_CORE void wxMacNativeToPoint( const Point *n , wxPoint* wx );
 265
 266 WXDLLIMPEXP_CORE wxMenu* wxFindMenuFromMacMenu(MenuRef inMenuRef);
 267
 268 WXDLLIMPEXP_CORE int wxMacCommandToId( UInt32 macCommandId );
 269 WXDLLIMPEXP_CORE UInt32 wxIdToMacCommand( int wxId );
 270 WXDLLIMPEXP_CORE wxMenu* wxFindMenuFromMacCommand( const HICommand &macCommandId , wxMenuItem* &item );
 271
 272 WXDLLIMPEXP_CORE pascal OSStatus wxMacTopLevelMouseEventHandler( EventHandlerCallRef handler , EventRef event , void *data );
 273 WXDLLIMPEXP_CORE Rect wxMacGetBoundsForControl( wxWindowMac* window , const wxPoint& pos , const wxSize &size , bool adjustForOrigin = true );
 274
 275 ControlActionUPP GetwxMacLiveScrollbarActionProc();
 276
 277 // additional optional event defines
 278
 279 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
 280 enum {
 281     kEventControlFocusPartChanged = 164
 282 };
 283 #endif
 284
 285 class WXDLLIMPEXP_CORE wxMacControl : public wxWidgetImpl
 286 {
 287 public :
 288     wxMacControl( wxWindowMac* peer , bool isRootControl = false );
 289     wxMacControl() ;
 290     virtual ~wxMacControl();
 291
 292     void Init();
 293
 294     void SetReferenceInNativeControl();
 295     static wxMacControl* GetReferenceFromNativeControl(ControlRef control);
 296
 297     virtual ControlRef * GetControlRefAddr() { return &m_controlRef; }
 298     virtual ControlRef GetControlRef() const { return m_controlRef; }
 299
 300     virtual WXWidget GetWXWidget() const { return (WXWidget) m_controlRef; }
 301
 302     virtual bool        IsVisible() const;
 303
 304     virtual void        Raise();
 305
 306     virtual void        Lower();
 307
 308     virtual void        ScrollRect( const wxRect *rect, int dx, int dy );
 309
 310     virtual void        GetContentArea( int &left , int &top , int &width , int &height ) const;
 311     virtual void        Move(int x, int y, int width, int height);
 312     virtual void        GetPosition( int &x, int &y ) const;
 313     virtual void        GetSize( int &width, int &height ) const;
 314     virtual void        SetControlSize( wxWindowVariant variant ) ;
 315
 316     // where is in native window relative coordinates
 317     virtual void        SetNeedsDisplay( const wxRect* where = NULL );
 318     virtual bool        GetNeedsDisplay() const;
 319
 320     virtual bool        CanFocus() const;
 321     // return true if successful
 322     virtual bool        SetFocus();
 323     virtual bool        HasFocus() const;
 324
 325     void                RemoveFromParent();
 326     void                Embed( wxWidgetImpl *parent );
 327
 328     void                SetDefaultButton( bool isDefault );
 329     void                PerformClick();
 330     void                SetLabel( const wxString& title, wxFontEncoding encoding );
 331
 332     void                SetCursor( const wxCursor & cursor );
 333     void                CaptureMouse();
 334     void                ReleaseMouse();
 335
 336     wxInt32             GetValue() const;
 337     void                SetValue( wxInt32 v );
 338     void                SetBitmap( const wxBitmap& bitmap );
 339     void                SetupTabs( const wxNotebook &notebook );
 340
 341     void                GetBestRect( wxRect *r ) const;
 342     bool                IsEnabled() const;
 343     void                Enable( bool enable );
 344     bool                ButtonClickDidStateChange() { return false ;}
 345     void                SetMinimum( wxInt32 v );
 346     void                SetMaximum( wxInt32 v );
 347     void                PulseGauge() ;
 348     void                SetScrollThumb( wxInt32 value, wxInt32 thumbSize );
 349
 350     // temp convenience methods
 351
 352     void                GetBestRect( Rect *r ) const;
 353     /*
 354     void operator= (ControlRef c) { m_controlRef = c; }
 355     operator ControlRef () { return m_controlRef; }
 356     operator ControlRef * () { return &m_controlRef; }
 357     */
 358     // accessing data and values
 359
 360     virtual OSStatus SetData( ControlPartCode inPartCode , ResType inTag , Size inSize , const void * inData );
 361     virtual OSStatus GetData( ControlPartCode inPartCode , ResType inTag , Size inBufferSize , void * inOutBuffer , Size * outActualSize ) const;
 362     virtual OSStatus GetDataSize( ControlPartCode inPartCode , ResType inTag , Size * outActualSize ) const;
 363     virtual OSStatus SendEvent(  EventRef ref , OptionBits inOptions = 0 );
 364     virtual OSStatus SendHICommand( HICommand &command , OptionBits inOptions = 0 );
 365
 366     virtual OSStatus SendHICommand( UInt32 commandID , OptionBits inOptions = 0 );
 367
 368     virtual SInt32 GetMaximum() const;
 369
 370     virtual void SetValueAndRange( SInt32 value , SInt32 minimum , SInt32 maximum );
 371     virtual void SetRange( SInt32 minimum , SInt32 maximum );
 372
 373     // templated helpers
 374
 375     Size GetDataSize( ControlPartCode inPartCode , ResType inTag ) const
 376     {
 377         Size sz;
 378         verify_noerr( GetDataSize( inPartCode , inTag , &sz ) );
 379         return sz;
 380     }
 381     template <typename T> OSStatus SetData( ControlPartCode inPartCode , ResType inTag , const T *data )
 382     {
 383         return SetData( inPartCode , inTag , sizeof( T ) , data );
 384     }
 385     template <typename T> OSStatus SetData( ControlPartCode inPartCode , ResType inTag , const T& data )
 386     {
 387         return SetData( inPartCode , inTag , sizeof( T ) , &data );
 388     }
 389     template <typename T> OSStatus SetData( ResType inTag , const T *data )
 390     {
 391         return SetData( kControlEntireControl , inTag , sizeof( T ) , data );
 392     }
 393     template <typename T> OSStatus SetData( ResType inTag , const T& data )
 394     {
 395         return SetData( kControlEntireControl , inTag , sizeof( T ) , &data );
 396     }
 397     template <typename T> OSStatus GetData( ControlPartCode inPartCode , ResType inTag , T *data ) const
 398     {
 399         Size dummy;
 400         return GetData( inPartCode , inTag , sizeof( T ) , data , &dummy );
 401     }
 402     template <typename T> T GetData( ControlPartCode inPartCode , ResType inTag ) const
 403     {
 404         T value;
 405         OSStatus err = GetData<T>( inPartCode , inTag , &value );
 406
 407         if ( err != noErr )
 408         {
 409             wxFAIL_MSG( wxString::Format(wxT("GetData Failed for Part [%i] and Tag [%i]"),
 410                                         inPartCode, (int)inTag) );
 411         }
 412
 413         return value;
 414     }
 415     template <typename T> OSStatus GetData( ResType inTag , T *data ) const
 416     {
 417         Size dummy;
 418         return GetData( kControlEntireControl , inTag , sizeof( T ) , data , &dummy );
 419     }
 420     template <typename T> T GetData( ResType inTag ) const
 421     {
 422         return GetData<T>( kControlEntireControl , inTag );
 423     }
 424
 425     // Flash the control for the specified amount of time
 426
 427     virtual void VisibilityChanged( bool shown );
 428     virtual void SuperChangedPosition();
 429
 430
 431     virtual void SetFont( const wxFont & font , const wxColour& foreground , long windowStyle, bool ignoreBlack = true );
 432     virtual void SetBackgroundColour( const wxColour& col );
 433     virtual ControlPartCode HandleKey(  SInt16 keyCode,  SInt16 charCode, EventModifiers modifiers );
 434     void SetActionProc( ControlActionUPP   actionProc );
 435     SInt32 GetViewSize() const;
 436
 437     virtual void SetVisibility( bool visible );
 438
 439     virtual bool IsActive() const;
 440
 441     // invalidates this control and all children
 442     virtual void InvalidateWithChildren();
 443     virtual void SetDrawingEnabled( bool enable );
 444
 445     // in native parent window relative coordinates
 446
 447     virtual void GetRectInWindowCoords( Rect *r );
 448
 449
 450     virtual void GetFeatures( UInt32 *features );
 451     virtual OSStatus GetRegion( ControlPartCode partCode , RgnHandle region );
 452
 453     // to be moved into a tab control class
 454
 455     virtual OSStatus SetTabEnabled( SInt16 tabNo , bool enable );
 456
 457     void InstallEventHandler( WXWidget control = NULL );
 458 protected :
 459     WXEVENTHANDLERREF    m_macControlEventHandler ;
 460     ControlRef  m_controlRef;
 461     wxFont      m_font;
 462     long        m_windowStyle;
 463     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMacControl)
 464 };
 465
 466 // ============================================================================
 467 // DataBrowser Wrapper
 468 // ============================================================================
 469 //
 470 // basing on DataBrowserItemIDs
 471 //
 472
 473 class WXDLLIMPEXP_CORE wxMacDataBrowserControl : public wxMacControl
 474 {
 475 public :
 476     wxMacDataBrowserControl( wxWindow* peer, const wxPoint& pos, const wxSize& size, long style);
 477     wxMacDataBrowserControl() {}
 478
 479     OSStatus SetCallbacks( const DataBrowserCallbacks *callbacks );
 480
 481     OSStatus GetItemCount( DataBrowserItemID container,
 482             Boolean recurse,
 483             DataBrowserItemState state,
 484             ItemCount *numItems) const;
 485
 486     OSStatus GetItems( DataBrowserItemID container,
 487             Boolean recurse,
 488             DataBrowserItemState state,
 489             Handle items) const;
 490
 491
 492     OSStatus AddColumn( DataBrowserListViewColumnDesc *columnDesc,
 493         DataBrowserTableViewColumnIndex position );
 494
 495     OSStatus RemoveColumn( DataBrowserTableViewColumnIndex position );
 496
 497     OSStatus AutoSizeColumns();
 498
 499     OSStatus SetHasScrollBars( bool horiz, bool vert );
 500     OSStatus SetHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle );
 501
 502     OSStatus SetHeaderButtonHeight( UInt16 height );
 503     OSStatus GetHeaderButtonHeight( UInt16 *height );
 504
 505     OSStatus UpdateItems( DataBrowserItemID container, UInt32 numItems,
 506             const DataBrowserItemID *items,
 507             DataBrowserPropertyID preSortProperty,
 508             DataBrowserPropertyID propertyID ) const;
 509
 510     OSStatus AddItems( DataBrowserItemID container, UInt32 numItems,
 511             const DataBrowserItemID *items,
 512             DataBrowserPropertyID preSortProperty );
 513     OSStatus RemoveItems( DataBrowserItemID container, UInt32 numItems,
 514             const DataBrowserItemID *items,
 515             DataBrowserPropertyID preSortProperty );
 516     OSStatus RevealItem( DataBrowserItemID item,
 517             DataBrowserPropertyID propertyID,
 518             DataBrowserRevealOptions options ) const;
 519
 520     OSStatus SetSelectionFlags( DataBrowserSelectionFlags );
 521     OSStatus GetSelectionAnchor( DataBrowserItemID *first, DataBrowserItemID *last ) const;
 522     bool IsItemSelected( DataBrowserItemID item ) const;
 523     OSStatus SetSelectedItems( UInt32 numItems,
 524             const DataBrowserItemID *items,
 525             DataBrowserSetOption operation );
 526
 527     OSStatus GetItemID( DataBrowserTableViewRowIndex row,
 528             DataBrowserItemID * item ) const;
 529     OSStatus GetItemRow( DataBrowserItemID item,
 530             DataBrowserTableViewRowIndex * row ) const;
 531
 532     OSStatus SetDefaultRowHeight( UInt16 height );
 533     OSStatus GetDefaultRowHeight( UInt16 * height ) const;
 534
 535     OSStatus SetRowHeight( DataBrowserItemID item , UInt16 height);
 536     OSStatus GetRowHeight( DataBrowserItemID item , UInt16 *height) const;
 537
 538     OSStatus GetColumnWidth( DataBrowserPropertyID column , UInt16 *width ) const;
 539     OSStatus SetColumnWidth( DataBrowserPropertyID column , UInt16 width );
 540
 541     OSStatus GetDefaultColumnWidth( UInt16 *width ) const;
 542     OSStatus SetDefaultColumnWidth( UInt16 width );
 543
 544     OSStatus GetColumnCount( UInt32* numColumns) const;
 545
 546     OSStatus GetColumnIDFromIndex( DataBrowserTableViewColumnIndex position, DataBrowserTableViewColumnID* id );
 547
 548     OSStatus GetColumnPosition( DataBrowserPropertyID column, DataBrowserTableViewColumnIndex *position) const;
 549     OSStatus SetColumnPosition( DataBrowserPropertyID column, DataBrowserTableViewColumnIndex position);
 550
 551     OSStatus GetScrollPosition( UInt32 *top , UInt32 *left ) const;
 552     OSStatus SetScrollPosition( UInt32 top , UInt32 left );
 553
 554     OSStatus GetSortProperty( DataBrowserPropertyID *column ) const;
 555     OSStatus SetSortProperty( DataBrowserPropertyID column );
 556
 557     OSStatus GetSortOrder( DataBrowserSortOrder *order ) const;
 558     OSStatus SetSortOrder( DataBrowserSortOrder order );
 559
 560     OSStatus GetPropertyFlags( DataBrowserPropertyID property, DataBrowserPropertyFlags *flags ) const;
 561     OSStatus SetPropertyFlags( DataBrowserPropertyID property, DataBrowserPropertyFlags flags );
 562
 563     OSStatus GetHeaderDesc( DataBrowserPropertyID property, DataBrowserListViewHeaderDesc *desc ) const;
 564     OSStatus SetHeaderDesc( DataBrowserPropertyID property, DataBrowserListViewHeaderDesc *desc );
 565
 566     OSStatus SetDisclosureColumn( DataBrowserPropertyID property , Boolean expandableRows );
 567 protected :
 568
 569     static pascal void DataBrowserItemNotificationProc(
 570         ControlRef browser,
 571         DataBrowserItemID itemID,
 572         DataBrowserItemNotification message,
 573         DataBrowserItemDataRef itemData );
 574
 575     virtual void ItemNotification(
 576         DataBrowserItemID itemID,
 577         DataBrowserItemNotification message,
 578         DataBrowserItemDataRef itemData) = 0;
 579
 580     static pascal OSStatus DataBrowserGetSetItemDataProc(
 581         ControlRef browser,
 582         DataBrowserItemID itemID,
 583         DataBrowserPropertyID property,
 584         DataBrowserItemDataRef itemData,
 585         Boolean changeValue );
 586
 587     virtual OSStatus GetSetItemData(
 588         DataBrowserItemID itemID,
 589         DataBrowserPropertyID property,
 590         DataBrowserItemDataRef itemData,
 591         Boolean changeValue ) = 0;
 592
 593     static pascal Boolean DataBrowserCompareProc(
 594         ControlRef browser,
 595         DataBrowserItemID itemOneID,
 596         DataBrowserItemID itemTwoID,
 597         DataBrowserPropertyID sortProperty);
 598
 599     virtual Boolean CompareItems(DataBrowserItemID itemOneID,
 600         DataBrowserItemID itemTwoID,
 601         DataBrowserPropertyID sortProperty) = 0;
 602     DECLARE_ABSTRACT_CLASS(wxMacDataBrowserControl)
 603 };
 604
 605 // ============================================================================
 606 // Higher-level Databrowser
 607 // ============================================================================
 608 //
 609 // basing on data item objects
 610 //
 611
 612 // forward decl
 613
 614 class wxMacDataItemBrowserControl;
 615 class wxMacListBoxItem;
 616
 617 const DataBrowserPropertyID kTextColumnId = 1024;
 618 const DataBrowserPropertyID kNumericOrderColumnId = 1025;
 619
 620 // for multi-column controls, we will use this + the column ID to identify the
 621 // column. We don't use kTextColumnId there, and ideally the two should merge.
 622 const DataBrowserPropertyID kMinColumnId = 1050;
 623
 624 // base API for high-level databrowser operations
 625
 626 // base class for databrowser items
 627
 628 enum DataItemType {
 629     DataItem_Text
 630 };
 631
 632 /*
 633 class WXDLLIMPEXP_CORE wxMacDataItem
 634 {
 635 public :
 636     wxMacDataItem();
 637     virtual ~wxMacDataItem();
 638 } ;
 639 */
 640
 641 class WXDLLIMPEXP_CORE wxMacDataItem
 642 {
 643 public :
 644     wxMacDataItem();
 645     virtual ~wxMacDataItem();
 646
 647     virtual bool IsLessThan(wxMacDataItemBrowserControl *owner ,
 648         const wxMacDataItem*,
 649         DataBrowserPropertyID property) const;
 650
 651     // returns true if access was successful, otherwise false
 652     virtual OSStatus GetSetData(wxMacDataItemBrowserControl *owner ,
 653         DataBrowserPropertyID property,
 654         DataBrowserItemDataRef itemData,
 655         bool changeValue );
 656
 657     virtual void Notification(wxMacDataItemBrowserControl *owner ,
 658         DataBrowserItemNotification message,
 659         DataBrowserItemDataRef itemData ) const;
 660
 661     void SetOrder( SInt32 order );
 662     SInt32 GetOrder() const;
 663
 664 protected :
 665     SInt32      m_order;
 666
 667 };
 668
 669 enum ListSortOrder {
 670     SortOrder_None,
 671     SortOrder_Text_Ascending,
 672     SortOrder_Text_Descending
 673 };
 674
 675 typedef wxMacDataItem* wxMacDataItemPtr;
 676 const wxMacDataItemPtr wxMacDataBrowserRootContainer = NULL;
 677 typedef void * wxListColumnId ;
 678
 679 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxMacDataItemPtr, wxArrayMacDataItemPtr, class WXDLLIMPEXP_CORE);
 680
 681 class WXDLLIMPEXP_CORE wxMacDataItemBrowserControl : public wxMacDataBrowserControl
 682 {
 683 public :
 684     wxMacDataItemBrowserControl( wxWindow* peer , const wxPoint& pos, const wxSize& size, long style);
 685     wxMacDataItemBrowserControl() {}
 686     // create a list item (can be a subclass of wxMacListBoxItem)
 687
 688     unsigned int    GetItemCount(const wxMacDataItem* container, bool recurse , DataBrowserItemState state) const;
 689     void            GetItems(const wxMacDataItem* container, bool recurse ,
 690                         DataBrowserItemState state, wxArrayMacDataItemPtr &items ) const;
 691
 692     unsigned int    GetSelectedItemCount( const wxMacDataItem* container, bool recurse ) const;
 693
 694     unsigned int    GetLineFromItem(const wxMacDataItem *item) const;
 695     wxMacDataItem * GetItemFromLine(unsigned int n) const;
 696
 697     void            UpdateItem(const wxMacDataItem *container, const wxMacDataItem *item,
 698                         DataBrowserPropertyID property) const;
 699     void            UpdateItems(const wxMacDataItem *container, wxArrayMacDataItemPtr &items,
 700                         DataBrowserPropertyID property) const;
 701
 702     void            InsertColumn(int colId, DataBrowserPropertyType colType,
 703                             const wxString& title, SInt16 just = teFlushDefault, int defaultWidth = -1);
 704
 705     int             GetColumnWidth(int colId);
 706     void            SetColumnWidth(int colId, int width);
 707
 708     void            AddItem(wxMacDataItem *container, wxMacDataItem *item);
 709     void            AddItems(wxMacDataItem *container, wxArrayMacDataItemPtr &items );
 710
 711     void            RemoveAllItems(wxMacDataItem *container);
 712     void            RemoveItem(wxMacDataItem *container, wxMacDataItem* item);
 713     void            RemoveItems(wxMacDataItem *container, wxArrayMacDataItemPtr &items);
 714
 715     void            SetSelectedItem( wxMacDataItem* item , DataBrowserSetOption option);
 716     void            SetSelectedItems( wxArrayMacDataItemPtr &items , DataBrowserSetOption option);
 717     void            SetSelectedAllItems( DataBrowserSetOption option);
 718     Boolean         IsItemSelected( const wxMacDataItem* item) const;
 719
 720     void            RevealItem( wxMacDataItem* item, DataBrowserRevealOptions options);
 721
 722     void            GetSelectionAnchor( wxMacDataItemPtr* first , wxMacDataItemPtr* last) const;
 723
 724     // add and remove
 725
 726     virtual void            MacDelete( unsigned int n );
 727     virtual void            MacInsert( unsigned int n, wxMacDataItem* item);
 728     virtual void            MacClear();
 729
 730     // accessing content
 731
 732     virtual unsigned int    MacGetCount() const;
 733
 734 public :
 735
 736     // item aware methods, to be used in subclasses
 737
 738     virtual Boolean CompareItems(const wxMacDataItem* itemOneID,
 739                         const wxMacDataItem* itemTwoID,
 740                         DataBrowserPropertyID sortProperty);
 741
 742     virtual OSStatus GetSetItemData(wxMacDataItem* itemID,
 743                         DataBrowserPropertyID property,
 744                         DataBrowserItemDataRef itemData,
 745                         Boolean changeValue );
 746
 747     virtual void    ItemNotification(
 748                         const wxMacDataItem* itemID,
 749                         DataBrowserItemNotification message,
 750                         DataBrowserItemDataRef itemData);
 751
 752     // as we are getting the same events for human and API selection we have to suppress
 753     // events in the latter case, since this will be used from many subclasses we keep it here
 754
 755     bool            IsSelectionSuppressed() const { return m_suppressSelection; }
 756     bool            SuppressSelection( bool suppress );
 757
 758     // client data
 759
 760     virtual wxClientDataType GetClientDataType() const;
 761     virtual void            SetClientDataType(wxClientDataType clientDataItemsType);
 762     //virtual ListSortOrder   GetSortOrder() const;
 763     //virtual void            SetSortOrder(const ListSortOrder sort);
 764
 765
 766
 767 protected:
 768
 769     ListSortOrder m_sortOrder;
 770     wxClientDataType m_clientDataItemsType;
 771
 772     // ID aware base methods, should be 'final' ie not changed in subclasses
 773
 774     virtual Boolean CompareItems(DataBrowserItemID itemOneID,
 775                         DataBrowserItemID itemTwoID,
 776                         DataBrowserPropertyID sortProperty);
 777
 778     virtual OSStatus GetSetItemData(DataBrowserItemID itemID,
 779                         DataBrowserPropertyID property,
 780                         DataBrowserItemDataRef itemData,
 781                         Boolean changeValue );
 782
 783     virtual void    ItemNotification(
 784                         DataBrowserItemID itemID,
 785                         DataBrowserItemNotification message,
 786                         DataBrowserItemDataRef itemData);
 787
 788
 789 private :
 790
 791     bool m_suppressSelection;
 792     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMacDataItemBrowserControl)
 793 };
 794
 795 class WXDLLIMPEXP_CORE wxMacDataItemBrowserSelectionSuppressor
 796 {
 797 public :
 798     wxMacDataItemBrowserSelectionSuppressor(wxMacDataItemBrowserControl *browser);
 799     ~wxMacDataItemBrowserSelectionSuppressor();
 800
 801 private :
 802
 803     bool m_former;
 804     wxMacDataItemBrowserControl* m_browser;
 805 };
 806
 807 // ============================================================================
 808 // platform listbox implementation
 809 // ============================================================================
 810
 811 // exposed for reuse in wxCheckListBox
 812
 813 class WXDLLIMPEXP_CORE wxMacListBoxItem : public wxMacDataItem
 814 {
 815 public :
 816     wxMacListBoxItem();
 817
 818     virtual ~wxMacListBoxItem();
 819
 820     virtual OSStatus GetSetData(wxMacDataItemBrowserControl *owner ,
 821         DataBrowserPropertyID property,
 822         DataBrowserItemDataRef itemData,
 823         bool changeValue );
 824
 825     virtual void Notification(wxMacDataItemBrowserControl *owner ,
 826         DataBrowserItemNotification message,
 827         DataBrowserItemDataRef itemData ) const;
 828 protected :
 829 };
 830
 831 class WXDLLIMPEXP_CORE wxMacDataBrowserColumn : public wxListWidgetColumn
 832 {
 833 public :
 834     wxMacDataBrowserColumn( DataBrowserPropertyID propertyId, DataBrowserPropertyType colType, bool editable )
 835         : m_property(propertyId), m_editable(editable), m_type( colType )
 836     {
 837     }
 838     ~wxMacDataBrowserColumn()
 839     {
 840     }
 841     DataBrowserPropertyID GetProperty() const { return m_property ; }
 842
 843     bool IsEditable() const { return m_editable; }
 844
 845     DataBrowserPropertyType GetType() const { return m_type; }
 846
 847 protected :
 848     DataBrowserPropertyID m_property;
 849     bool m_editable;
 850     DataBrowserPropertyType m_type;
 851 } ;
 852
 853 WX_DEFINE_ARRAY_PTR(wxMacDataBrowserColumn *, wxArrayMacDataBrowserColumns);
 854
 855
 856 class WXDLLIMPEXP_CORE wxMacDataBrowserCellValue : public wxListWidgetCellValue
 857 {
 858 public :
 859     wxMacDataBrowserCellValue(DataBrowserItemDataRef data) : m_data(data) {}
 860     virtual ~wxMacDataBrowserCellValue() {}
 861
 862    virtual void Set( CFStringRef value );
 863     virtual void Set( const wxString& value );
 864     virtual void Set( int value ) ;
 865
 866     virtual int GetIntValue() const ;
 867     virtual wxString GetStringValue() const ;
 868 protected :
 869     DataBrowserItemDataRef m_data;
 870 } ;
 871
 872
 873 class WXDLLIMPEXP_CORE wxMacDataBrowserListControl : public wxMacDataItemBrowserControl, public wxListWidgetImpl
 874 {
 875 public:
 876     wxMacDataBrowserListControl( wxWindow *peer, const wxPoint& pos, const wxSize& size, long style );
 877     wxMacDataBrowserListControl() {}
 878     virtual ~wxMacDataBrowserListControl();
 879
 880     // wxListWidgetImpl Methods
 881
 882     wxListWidgetColumn*     InsertTextColumn( unsigned int pos, const wxString& title, bool editable = false,
 883                                 wxAlignment just = wxALIGN_LEFT , int defaultWidth = -1) ;
 884     wxListWidgetColumn*     InsertCheckColumn( unsigned int pos , const wxString& title, bool editable = false,
 885                                 wxAlignment just = wxALIGN_LEFT , int defaultWidth = -1) ;
 886
 887     wxMacDataBrowserColumn* DoInsertColumn( unsigned int pos, DataBrowserPropertyID property,
 888                                 const wxString& title, bool editable,
 889                                 DataBrowserPropertyType colType, SInt16 just, int width );
 890     // add and remove
 891
 892     virtual void            ListDelete( unsigned int n );
 893     virtual void            ListInsert( unsigned int n );
 894     virtual void            ListClear();
 895
 896     // selecting
 897
 898     virtual void            ListDeselectAll();
 899     virtual void            ListSetSelection( unsigned int n, bool select, bool multi = false );
 900     virtual int             ListGetSelection() const;
 901     virtual int             ListGetSelections( wxArrayInt& aSelections ) const;
 902     virtual bool            ListIsSelected( unsigned int n ) const;
 903
 904     // display
 905
 906     virtual void            ListScrollTo( unsigned int n );
 907
 908     // accessing content
 909
 910     virtual unsigned int    ListGetCount() const;
 911
 912     virtual void            UpdateLine( unsigned int n, wxListWidgetColumn* col = NULL );
 913     virtual void            UpdateLineToEnd( unsigned int n) ;
 914
 915     virtual void            ItemNotification(
 916                                 const wxMacDataItem* itemID,
 917                                 DataBrowserItemNotification message,
 918                                 DataBrowserItemDataRef itemData);
 919
 920     // pointing back
 921
 922     wxMacDataBrowserColumn*     GetColumnFromProperty( DataBrowserPropertyID );
 923 private:
 924     wxArrayMacDataBrowserColumns m_columns;
 925     int m_nextColumnId ;
 926
 927     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMacDataBrowserListControl)
 928 };
 929
 930 // ============================================================================
 931 // graphics implementation
 932 // ============================================================================
 933
 934 // draw the image 'upside down' corrected as HIViewDrawCGImage does
 935
 936 OSStatus WXDLLIMPEXP_CORE wxMacDrawCGImage(
 937                                CGContextRef    inContext,
 938                                const HIRect *  inBounds,
 939                                CGImageRef      inImage) ;
 940
 941 CGColorRef WXDLLIMPEXP_CORE wxMacCreateCGColorFromHITheme( ThemeBrush brush ) ;
 942
 943 #endif // wxUSE_GUI
 944
 945 #define wxMAC_DEFINE_PROC_GETTER( UPP , x ) \
 946 UPP Get##x()                                \
 947 {                                           \
 948     static UPP sHandler = NULL;             \
 949     if ( sHandler == NULL )                 \
 950         sHandler = New##UPP( x );           \
 951     return sHandler;                        \
 952 }
 953
 954 //---------------------------------------------------------------------------
 955 // wxMac string conversions
 956 //---------------------------------------------------------------------------
 957
 958 void wxMacSetupConverters();
 959 void wxMacCleanupConverters();
 960
 961 // utils.cpp
 962
 963 // filefn.cpp
 964
 965 WXDLLIMPEXP_BASE wxString wxMacFSRefToPath( const FSRef *fsRef , CFStringRef additionalPathComponent = NULL );
 966 WXDLLIMPEXP_BASE OSStatus wxMacPathToFSRef( const wxString&path , FSRef *fsRef );
 967 WXDLLIMPEXP_BASE wxString wxMacHFSUniStrToString( ConstHFSUniStr255Param uniname );
 968
 969 //---------------------------------------------------------------------------
 970 // cocoa bridging utilities
 971 //---------------------------------------------------------------------------
 972
 973 bool wxMacInitCocoa();
 974
 975 typedef Cursor ClassicCursor;
 976
 977 // -------------
 978 // Common to all
 979 // -------------
 980
 981 // Cursor support
 982
 983 const short kwxCursorBullseye = 0;
 984 const short kwxCursorBlank = 1;
 985 const short kwxCursorPencil = 2;
 986 const short kwxCursorMagnifier = 3;
 987 const short kwxCursorNoEntry = 4;
 988 const short kwxCursorPaintBrush = 5;
 989 const short kwxCursorPointRight = 6;
 990 const short kwxCursorPointLeft = 7;
 991 const short kwxCursorQuestionArrow = 8;
 992 const short kwxCursorRightArrow = 9;
 993 const short kwxCursorSizeNS = 10;
 994 const short kwxCursorSize = 11;
 995 const short kwxCursorSizeNESW = 12;
 996 const short kwxCursorSizeNWSE = 13;
 997 const short kwxCursorRoller = 14;
 998 const short kwxCursorLast = kwxCursorRoller;
 999
1000 // exposing our fallback cursor map
1001
1002 extern ClassicCursor gMacCursors[];
1003
1004 //
1005 //
1006 //
1007
1008 #if wxUSE_GUI
1009
1010 class wxNonOwnedWindowCarbonImpl : public wxNonOwnedWindowImpl
1011 {
1012 public :
1013     wxNonOwnedWindowCarbonImpl( wxNonOwnedWindow* nonownedwnd) ;
1014     wxNonOwnedWindowCarbonImpl();
1015     virtual ~wxNonOwnedWindowCarbonImpl();
1016
1017     virtual void Destroy() ;
1018     void Create( wxWindow* parent, const wxPoint& pos, const wxSize& size,
1019     long style, long extraStyle, const wxString& name ) ;
1020
1021     WXWindow GetWXWindow() const;
1022     void Raise();
1023     void Lower();
1024     bool Show(bool show);
1025     bool ShowWithEffect(bool show, wxShowEffect effect, unsigned timeout);
1026
1027
1028     void Update();
1029     bool SetTransparent(wxByte alpha);
1030     bool SetBackgroundColour(const wxColour& col );
1031     void SetExtraStyle( long exStyle );
1032     bool SetBackgroundStyle(wxBackgroundStyle style);
1033     bool CanSetTransparent();
1034     void MoveWindow(int x, int y, int width, int height);
1035     void GetPosition( int &x, int &y ) const;
1036     void GetSize( int &width, int &height ) const;
1037     void GetContentArea( int &left , int &top , int &width , int &height ) const;
1038
1039     bool SetShape(const wxRegion& region);
1040
1041     virtual void SetTitle( const wxString& title, wxFontEncoding encoding ) ;
1042
1043     virtual bool IsMaximized() const;
1044
1045     virtual bool IsIconized() const;
1046
1047     virtual void Iconize( bool iconize );
1048
1049     virtual void Maximize(bool maximize);
1050
1051     virtual bool IsFullScreen() const;
1052
1053     virtual bool ShowFullScreen(bool show, long style);
1054
1055     virtual void RequestUserAttention(int flags);
1056
1057     virtual void ScreenToWindow( int *x, int *y );
1058
1059     virtual void WindowToScreen( int *x, int *y );
1060
1061
1062     bool MacGetUnifiedAppearance() const ;
1063     void MacChangeWindowAttributes( wxUint32 attributesToSet , wxUint32 attributesToClear ) ;
1064     wxUint32 MacGetWindowAttributes() const ;
1065     void MacSetMetalAppearance( bool set ) ;
1066     bool MacGetMetalAppearance() const ;
1067     void MacSetUnifiedAppearance( bool set );
1068
1069     WXEVENTHANDLERREF    MacGetEventHandler() { return m_macEventHandler ; }
1070
1071     wxNonOwnedWindow*   GetWXPeer() { return m_wxPeer; }
1072 protected :
1073     void                MacInstallTopLevelWindowEventHandler();
1074
1075     WXEVENTHANDLERREF   m_macEventHandler ;
1076     WindowRef           m_macWindow;
1077     void *              m_macFullScreenData ;
1078     DECLARE_DYNAMIC_CLASS_NO_COPY(wxNonOwnedWindowCarbonImpl)
1079 };
1080
1081 #endif // wxUSE_GUI
1082
1083 #endif
1084     // _WX_PRIVATE_H_