1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/mac/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
6 // Author: Stefan Csomor
10 // Copyright: (c) Stefan Csomor
11 // Licence: wxWindows licence
12 /////////////////////////////////////////////////////////////////////////////
14 #ifndef _WX_PRIVATE_H_
15 #define _WX_PRIVATE_H_
20 # include <Carbon/Carbon.h>
22 # include <Debugging.h>
23 # include <Quickdraw.h>
24 # include <Appearance.h>
26 # include <Controls.h>
27 # include <ControlDefinitions.h>
31 # include <CoreServices.h>
34 #if UNIVERSAL_INTERFACES_VERSION < 0x0342
35 #error "please update to Apple's latest universal headers from http://developer.apple.com/sdk/"
38 #ifndef MAC_OS_X_VERSION_10_3
39 #define MAC_OS_X_VERSION_10_3 1030
42 #ifndef MAC_OS_X_VERSION_10_4
43 #define MAC_OS_X_VERSION_10_4 1040
46 #ifndef MAC_OS_X_VERSION_10_5
47 #define MAC_OS_X_VERSION_10_5 1050
50 #ifdef __WXMAC_CARBON__
51 #include "wx/mac/corefoundation/cfstring.h"
55 // as macro in FixMath.h for 10.3
56 inline Fixed
IntToFixed( int inInt
)
58 return (((SInt32
) inInt
) << 16);
61 inline int FixedToInt( Fixed inFixed
)
63 return (((SInt32
) inFixed
) >> 16);
67 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
68 typedef UInt32 URefCon
;
69 typedef SInt32 SRefCon
;
74 #include "wx/listbox.h"
78 class wxMacPortStateHelper
80 DECLARE_NO_COPY_CLASS(wxMacPortStateHelper
)
83 wxMacPortStateHelper( GrafPtr newport
);
84 wxMacPortStateHelper();
85 ~wxMacPortStateHelper();
87 void Setup( GrafPtr newport
);
89 bool IsCleared() { return m_clip
== NULL
; }
90 GrafPtr
GetCurrentPort() { return m_currentPort
; }
93 GrafPtr m_currentPort
;
96 ThemeDrawingState m_drawingState
;
103 class WXDLLEXPORT wxMacPortSaver
105 DECLARE_NO_COPY_CLASS(wxMacPortSaver
)
108 wxMacPortSaver( GrafPtr port
);
114 class WXDLLEXPORT wxMacPortSetter
116 DECLARE_NO_COPY_CLASS(wxMacPortSetter
)
119 wxMacPortSetter( const wxDC
* dc
);
122 wxMacPortStateHelper m_ph
;
127 Clips to the visible region of a control within the current port
130 class WXDLLEXPORT wxMacWindowClipper
: public wxMacPortSaver
132 DECLARE_NO_COPY_CLASS(wxMacWindowClipper
)
135 wxMacWindowClipper( const wxWindow
* win
);
136 ~wxMacWindowClipper();
139 RgnHandle m_formerClip
;
143 class WXDLLEXPORT wxMacWindowStateSaver
: public wxMacWindowClipper
145 DECLARE_NO_COPY_CLASS(wxMacWindowStateSaver
)
148 wxMacWindowStateSaver( const wxWindow
* win
);
149 ~wxMacWindowStateSaver();
152 ThemeDrawingState m_themeDrawingState
;
156 #if wxMAC_USE_CORE_GRAPHICS
157 class WXDLLEXPORT wxMacCGContextStateSaver
159 DECLARE_NO_COPY_CLASS(wxMacCGContextStateSaver
)
162 wxMacCGContextStateSaver( CGContextRef cg
)
165 CGContextSaveGState( cg
);
167 ~wxMacCGContextStateSaver()
169 CGContextRestoreGState( m_cg
);
177 class wxMacDrawingHelper
179 DECLARE_NO_COPY_CLASS(wxMacDrawingHelper)
182 wxMacDrawingHelper( wxWindowMac * theWindow , bool clientArea = false );
183 ~wxMacDrawingHelper();
184 bool Ok() const { return IsOk(); }
185 bool IsOk() { return m_ok; }
186 void LocalToWindow( Rect *rect) { OffsetRect( rect , m_origin.h , m_origin.v ); }
187 void LocalToWindow( Point *pt ) { AddPt( m_origin , pt ); }
188 void LocalToWindow( RgnHandle rgn ) { OffsetRgn( rgn , m_origin.h , m_origin.v ); }
189 const Point& GetOrigin() { return m_origin; }
192 GrafPtr m_formerPort;
193 GrafPtr m_currentPort;
194 PenState m_savedPenState;
200 bool wxMacConvertEventToRecord( EventRef event
, EventRecord
*rec
);
205 WXDLLIMPEXP_BASE wxString
wxMacFSSpec2MacFilename( const FSSpec
*spec
);
206 WXDLLIMPEXP_BASE
void wxMacFilename2FSSpec( const wxString
&path
, FSSpec
*spec
);
209 WXDLLIMPEXP_BASE wxString
wxMacFindFolderNoSeparator(short vRefNum
,
211 Boolean createFolder
);
212 WXDLLIMPEXP_BASE wxString
wxMacFindFolder(short vRefNum
,
214 Boolean createFolder
);
216 template<typename T
> EventParamType
wxMacGetEventParamType() { wxFAIL_MSG( wxT("Unknown Param Type") ); return 0; }
217 template<> inline EventParamType wxMacGetEventParamType
<RgnHandle
>() { return typeQDRgnHandle
; }
218 template<> inline EventParamType wxMacGetEventParamType
<ControlRef
>() { return typeControlRef
; }
219 template<> inline EventParamType wxMacGetEventParamType
<WindowRef
>() { return typeWindowRef
; }
220 template<> inline EventParamType wxMacGetEventParamType
<MenuRef
>() { return typeMenuRef
; }
221 template<> inline EventParamType wxMacGetEventParamType
<EventRef
>() { return typeEventRef
; }
222 template<> inline EventParamType wxMacGetEventParamType
<Point
>() { return typeQDPoint
; }
223 template<> inline EventParamType wxMacGetEventParamType
<Rect
>() { return typeQDRectangle
; }
224 template<> inline EventParamType wxMacGetEventParamType
<Boolean
>() { return typeBoolean
; }
225 template<> inline EventParamType wxMacGetEventParamType
<SInt16
>() { return typeSInt16
; }
226 template<> inline EventParamType wxMacGetEventParamType
<SInt32
>() { return typeSInt32
; }
227 template<> inline EventParamType wxMacGetEventParamType
<UInt32
>() { return typeUInt32
; }
228 template<> inline EventParamType wxMacGetEventParamType
<RGBColor
>() { return typeRGBColor
; }
229 #if TARGET_API_MAC_OSX
230 template<> inline EventParamType wxMacGetEventParamType
<HICommand
>() { return typeHICommand
; }
231 template<> inline EventParamType wxMacGetEventParamType
<HIPoint
>() { return typeHIPoint
; }
232 template<> inline EventParamType wxMacGetEventParamType
<HISize
>() { return typeHISize
; }
233 template<> inline EventParamType wxMacGetEventParamType
<HIRect
>() { return typeHIRect
; }
234 template<> inline EventParamType wxMacGetEventParamType
<void*>() { return typeVoidPtr
; }
236 #if TARGET_API_MAC_OSX && ( MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_2 )
237 template<> inline EventParamType wxMacGetEventParamType
<CFDictionaryRef
>() { return typeCFDictionaryRef
; }
239 template<> inline EventParamType wxMacGetEventParamType
<Collection
>() { return typeCollection
; }
240 template<> inline EventParamType wxMacGetEventParamType
<CGContextRef
>() { return typeCGContextRef
; }
243 template<> EventParamType wxMacGetEventParamType<GrafPtr>() { return typeGrafPtr; }
244 template<> EventParamType wxMacGetEventParamType<OSStatus>() { return typeOSStatus; }
245 template<> EventParamType wxMacGetEventParamType<CFIndex>() { return typeCFIndex; }
246 template<> EventParamType wxMacGetEventParamType<GWorldPtr>() { return typeGWorldPtr; }
249 class wxMacCarbonEvent
259 wxMacCarbonEvent( EventRef event
, bool release
= false )
265 wxMacCarbonEvent(UInt32 inClassID
,UInt32 inKind
,EventTime inWhen
= 0 /*now*/,EventAttributes inAttributes
=kEventAttributeNone
)
268 verify_noerr( MacCreateEvent( NULL
, inClassID
, inKind
,inWhen
,inAttributes
,&m_eventRef
) );
275 ReleaseEvent( m_eventRef
);
278 OSStatus
Create(UInt32 inClassID
,UInt32 inKind
,EventTime inWhen
= 0 /*now*/,EventAttributes inAttributes
=kEventAttributeNone
)
280 verify( (m_eventRef
== NULL
) || m_release
);
281 if ( m_eventRef
&& m_release
)
283 ReleaseEvent( m_eventRef
);
287 OSStatus err
= MacCreateEvent( NULL
, inClassID
, inKind
,inWhen
,inAttributes
,&m_eventRef
);
293 OSStatus
GetParameter( EventParamName inName
, EventParamType inDesiredType
, UInt32 inBufferSize
, void * outData
);
295 template <typename T
> OSStatus
GetParameter( EventParamName inName
, EventParamType type
, T
*data
)
297 return GetParameter( inName
, type
, sizeof( T
) , data
);
299 template <typename T
> OSStatus
GetParameter( EventParamName inName
, T
*data
)
301 return GetParameter
<T
>( inName
, wxMacGetEventParamType
<T
>() , data
);
304 template <typename T
> T
GetParameter( EventParamName inName
)
307 verify_noerr( GetParameter
<T
>( inName
, &value
) );
310 template <typename T
> T
GetParameter( EventParamName inName
, EventParamType inDesiredType
)
313 verify_noerr( GetParameter
<T
>( inName
, inDesiredType
, &value
) );
317 OSStatus
SetParameter( EventParamName inName
, EventParamType inType
, UInt32 inSize
, const void * inData
);
318 template <typename T
> OSStatus
SetParameter( EventParamName inName
, EventParamType inDesiredType
, const T
*data
)
320 return SetParameter( inName
, inDesiredType
, sizeof( T
) , data
);
322 template <typename T
> OSStatus
SetParameter( EventParamName inName
, EventParamType inDesiredType
, const T
& data
)
324 return SetParameter
<T
>( inName
, inDesiredType
, &data
);
326 template <typename T
> OSStatus
SetParameter( EventParamName inName
, const T
*data
)
328 return SetParameter
<T
>( inName
, wxMacGetEventParamType
<T
>() , data
);
330 template <typename T
> OSStatus
SetParameter( EventParamName inName
, const T
& data
)
332 return SetParameter
<T
>( inName
, wxMacGetEventParamType
<T
>() , &data
);
336 return ::GetEventClass( m_eventRef
);
340 return ::GetEventKind( m_eventRef
);
344 return ::GetEventTime( m_eventRef
);
348 return EventTimeToTicks( GetTime() );
350 OSStatus
SetCurrentTime( )
352 return ::SetEventTime( m_eventRef
, GetCurrentEventTime() );
354 OSStatus
SetTime( EventTime when
)
356 return ::SetEventTime( m_eventRef
, when
);
358 operator EventRef () { return m_eventRef
; }
360 bool IsValid() { return m_eventRef
!= 0; }
367 // helper class for allocating and deallocating Universal Proc Ptrs
370 template <typename procType
, typename uppType
, uppType (*newUPP
)(procType
) , void (*disposeUPP
)(uppType
) > class wxMacUPP
373 wxMacUPP( procType proc
)
376 m_upp
= (*newUPP
)( NULL
);
383 operator uppType() { return m_upp
; }
388 typedef wxMacUPP
<NMProcPtr
,NMUPP
,NewNMUPP
,DisposeNMUPP
> wxMacNMUPP
;
390 template <typename refType
> class wxMacCFRefHolder
394 : m_ref(NULL
) , m_release(false)
398 wxMacCFRefHolder( refType ref
, bool release
= true )
399 : m_ref(ref
) , m_release(release
)
410 if ( m_release
&& m_ref
!= NULL
)
423 void Set( refType ref
, bool release
= true )
430 operator refType () const { return m_ref
; }
436 DECLARE_NO_COPY_CLASS( wxMacCFRefHolder
)
442 GWorldPtr wxMacCreateGWorld( int width , int height , int depth );
443 void wxMacDestroyGWorld( GWorldPtr gw );
444 PicHandle wxMacCreatePict( GWorldPtr gw , GWorldPtr mask = NULL );
445 CIconHandle wxMacCreateCIcon(GWorldPtr image , GWorldPtr mask , short dstDepth , short iconSize );
446 void wxMacSetColorTableEntry( CTabHandle newColors , int index , int red , int green , int blue );
447 CTabHandle wxMacCreateColorTable( int numColors );
449 void wxMacCreateBitmapButton( ControlButtonContentInfo
*info
, const wxBitmap
& bitmap
, int forceType
= 0 );
450 void wxMacReleaseBitmapButton( ControlButtonContentInfo
*info
);
452 #define MAC_WXCOLORREF(a) (*((RGBColor*)&(a)))
453 #define MAC_WXHBITMAP(a) (GWorldPtr(a))
454 #define MAC_WXHMETAFILE(a) (PicHandle(a))
455 #define MAC_WXHICON(a) (IconRef(a))
456 #define MAC_WXHCURSOR(a) (CursHandle(a))
457 #define MAC_WXHRGN(a) (RgnHandle(a))
458 #define MAC_WXHWND(a) (WindowPtr(a))
459 #define MAC_WXRECPTR(a) ((Rect*)a)
460 #define MAC_WXPOINTPTR(a) ((Point*)a)
461 #define MAC_WXHMENU(a) ((MenuHandle)a)
463 struct wxOpaqueWindowRef
465 wxOpaqueWindowRef( WindowRef ref
) { m_data
= ref
; }
466 operator WindowRef() { return m_data
; }
471 void wxMacRectToNative( const wxRect
*wx
, Rect
*n
);
472 void wxMacNativeToRect( const Rect
*n
, wxRect
* wx
);
473 void wxMacPointToNative( const wxPoint
* wx
, Point
*n
);
474 void wxMacNativeToPoint( const Point
*n
, wxPoint
* wx
);
476 wxWindow
* wxFindControlFromMacControl(ControlRef inControl
);
477 wxTopLevelWindowMac
* wxFindWinFromMacWindow( WindowRef inWindow
);
478 wxMenu
* wxFindMenuFromMacMenu(MenuRef inMenuRef
);
480 int wxMacCommandToId( UInt32 macCommandId
);
481 UInt32
wxIdToMacCommand( int wxId
);
482 wxMenu
* wxFindMenuFromMacCommand( const HICommand
&macCommandId
, wxMenuItem
* &item
);
484 extern wxWindow
* g_MacLastWindow
;
485 pascal OSStatus
wxMacTopLevelMouseEventHandler( EventHandlerCallRef handler
, EventRef event
, void *data
);
486 Rect
wxMacGetBoundsForControl( wxWindow
* window
, const wxPoint
& pos
, const wxSize
&size
, bool adjustForOrigin
= true );
488 ControlActionUPP
GetwxMacLiveScrollbarActionProc();
490 class wxMacControl
: public wxObject
493 wxMacControl( wxWindow
* peer
, bool isRootControl
= false );
494 wxMacControl( wxWindow
* peer
, ControlRef control
);
495 wxMacControl( wxWindow
* peer
, WXWidget control
);
497 virtual ~wxMacControl();
501 virtual void Dispose();
503 bool Ok() const { return IsOk(); }
504 bool IsOk() const { return GetControlRef() != NULL
; }
506 void SetReferenceInNativeControl();
507 static wxMacControl
* GetReferenceFromNativeControl(ControlRef control
);
509 virtual ControlRef
* GetControlRefAddr() { return &m_controlRef
; }
510 virtual ControlRef
GetControlRef() const { return m_controlRef
; }
512 virtual void SetReference( URefCon data
);
514 void operator= (ControlRef c) { m_controlRef = c; }
515 operator ControlRef () { return m_controlRef; }
516 operator ControlRef * () { return &m_controlRef; }
518 // accessing data and values
520 virtual OSStatus
SetData( ControlPartCode inPartCode
, ResType inTag
, Size inSize
, const void * inData
);
521 virtual OSStatus
GetData( ControlPartCode inPartCode
, ResType inTag
, Size inBufferSize
, void * inOutBuffer
, Size
* outActualSize
) const;
522 virtual OSStatus
GetDataSize( ControlPartCode inPartCode
, ResType inTag
, Size
* outActualSize
) const;
523 virtual OSStatus
SendEvent( EventRef ref
, OptionBits inOptions
= 0 );
524 virtual OSStatus
SendHICommand( HICommand
&command
, OptionBits inOptions
= 0 );
526 virtual OSStatus
SendHICommand( UInt32 commandID
, OptionBits inOptions
= 0 );
528 virtual SInt32
GetValue() const;
529 virtual SInt32
GetMaximum() const;
530 virtual SInt32
GetMinimum() const;
532 virtual void SetValue( SInt32 v
);
533 virtual void SetMinimum( SInt32 v
);
534 virtual void SetMaximum( SInt32 v
);
536 virtual void SetValueAndRange( SInt32 value
, SInt32 minimum
, SInt32 maximum
);
537 virtual void SetRange( SInt32 minimum
, SInt32 maximum
);
539 virtual OSStatus
SetFocus( ControlFocusPart focusPart
);
540 virtual bool HasFocus() const;
541 virtual bool NeedsFocusRect() const;
542 virtual void SetNeedsFocusRect( bool needs
);
546 Size
GetDataSize( ControlPartCode inPartCode
, ResType inTag
) const
549 verify_noerr( GetDataSize( inPartCode
, inTag
, &sz
) );
552 template <typename T
> OSStatus
SetData( ControlPartCode inPartCode
, ResType inTag
, const T
*data
)
554 return SetData( inPartCode
, inTag
, sizeof( T
) , data
);
556 template <typename T
> OSStatus
SetData( ControlPartCode inPartCode
, ResType inTag
, const T
& data
)
558 return SetData( inPartCode
, inTag
, sizeof( T
) , &data
);
560 template <typename T
> OSStatus
SetData( ResType inTag
, const T
*data
)
562 return SetData( kControlEntireControl
, inTag
, sizeof( T
) , data
);
564 template <typename T
> OSStatus
SetData( ResType inTag
, const T
& data
)
566 return SetData( kControlEntireControl
, inTag
, sizeof( T
) , &data
);
568 template <typename T
> OSStatus
GetData( ControlPartCode inPartCode
, ResType inTag
, T
*data
) const
571 return GetData( inPartCode
, inTag
, sizeof( T
) , data
, &dummy
);
573 template <typename T
> T
GetData( ControlPartCode inPartCode
, ResType inTag
) const
576 OSStatus err
= GetData
<T
>( inPartCode
, inTag
, &value
);
578 wxASSERT_MSG( err
== noErr
,
579 wxString::Format(wxT("GetData Failed for Part [%i] and Tag [%i]"),
580 inPartCode
, (int)inTag
) );
583 template <typename T
> OSStatus
GetData( ResType inTag
, T
*data
) const
586 return GetData( kControlEntireControl
, inTag
, sizeof( T
) , data
, &dummy
);
588 template <typename T
> T
GetData( ResType inTag
) const
590 return GetData
<T
>( kControlEntireControl
, inTag
);
593 // Flash the control for the specified amount of time
594 virtual void Flash( ControlPartCode part
, UInt32 ticks
= 8 );
596 virtual void VisibilityChanged( bool shown
);
597 virtual void SuperChangedPosition();
600 virtual void SetFont( const wxFont
& font
, const wxColour
& foreground
, long windowStyle
);
601 virtual void SetBackground( const wxBrush
&brush
);
602 virtual ControlPartCode
HandleKey( SInt16 keyCode
, SInt16 charCode
, EventModifiers modifiers
);
603 void SetActionProc( ControlActionUPP actionProc
);
604 void SetViewSize( SInt32 viewSize
);
605 SInt32
GetViewSize() const;
607 virtual bool IsVisible() const;
608 virtual void SetVisibility( bool visible
, bool redraw
);
609 virtual bool IsEnabled() const;
610 virtual bool IsActive() const;
611 virtual void Enable( bool enable
);
613 // invalidates this control and all children
614 virtual void InvalidateWithChildren();
615 virtual void SetDrawingEnabled( bool enable
);
617 virtual bool GetNeedsDisplay() const;
619 // where is in native window relative coordinates
620 virtual void SetNeedsDisplay( RgnHandle where
);
621 // where is in native window relative coordinates
622 virtual void SetNeedsDisplay( Rect
* where
= NULL
);
624 // if rect = NULL, entire view
625 virtual void ScrollRect( wxRect
*rect
, int dx
, int dy
);
627 // in native parent window relative coordinates
628 virtual void GetRect( Rect
*r
);
630 // in native parent window relative coordinates
631 virtual void SetRect( Rect
*r
);
633 virtual void GetRectInWindowCoords( Rect
*r
);
634 virtual void GetBestRect( Rect
*r
);
635 virtual void SetLabel( const wxString
&title
);
636 // converts from Toplevel-Content relative to local
637 static void Convert( wxPoint
*pt
, wxMacControl
*convert
, wxMacControl
*to
);
639 virtual void GetFeatures( UInt32
*features
);
640 virtual OSStatus
GetRegion( ControlPartCode partCode
, RgnHandle region
);
641 virtual OSStatus
SetZOrder( bool above
, wxMacControl
* other
);
643 bool IsRootControl() { return m_isRootControl
; }
645 wxWindow
* GetPeer() const
650 // to be moved into a tab control class
652 virtual OSStatus
SetTabEnabled( SInt16 tabNo
, bool enable
);
654 ControlRef m_controlRef
;
658 bool m_needsFocusRect
;
659 bool m_isRootControl
;
660 DECLARE_DYNAMIC_CLASS_NO_COPY(wxMacControl
)
663 // ============================================================================
664 // DataBrowser Wrapper
665 // ============================================================================
667 // basing on DataBrowserItemIDs
670 class wxMacDataBrowserControl
: public wxMacControl
673 wxMacDataBrowserControl( wxWindow
* peer
, const wxPoint
& pos
, const wxSize
& size
, long style
);
674 wxMacDataBrowserControl() {}
676 OSStatus
SetCallbacks( const DataBrowserCallbacks
*callbacks
);
678 OSStatus
GetItemCount( DataBrowserItemID container
,
680 DataBrowserItemState state
,
681 ItemCount
*numItems
) const;
683 OSStatus
GetItems( DataBrowserItemID container
,
685 DataBrowserItemState state
,
689 OSStatus
AddColumn( DataBrowserListViewColumnDesc
*columnDesc
,
690 DataBrowserTableViewColumnIndex position
);
692 OSStatus
RemoveColumn( DataBrowserTableViewColumnIndex position
);
694 OSStatus
AutoSizeColumns();
696 OSStatus
SetHasScrollBars( bool horiz
, bool vert
);
697 OSStatus
SetHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle
);
699 OSStatus
SetHeaderButtonHeight( UInt16 height
);
700 OSStatus
GetHeaderButtonHeight( UInt16
*height
);
702 OSStatus
UpdateItems( DataBrowserItemID container
, UInt32 numItems
,
703 const DataBrowserItemID
*items
,
704 DataBrowserPropertyID preSortProperty
,
705 DataBrowserPropertyID propertyID
) const;
707 OSStatus
AddItems( DataBrowserItemID container
, UInt32 numItems
,
708 const DataBrowserItemID
*items
,
709 DataBrowserPropertyID preSortProperty
);
710 OSStatus
RemoveItems( DataBrowserItemID container
, UInt32 numItems
,
711 const DataBrowserItemID
*items
,
712 DataBrowserPropertyID preSortProperty
);
713 OSStatus
RevealItem( DataBrowserItemID item
,
714 DataBrowserPropertyID propertyID
,
715 DataBrowserRevealOptions options
) const;
717 OSStatus
SetSelectionFlags( DataBrowserSelectionFlags
);
718 OSStatus
GetSelectionAnchor( DataBrowserItemID
*first
, DataBrowserItemID
*last
) const;
719 bool IsItemSelected( DataBrowserItemID item
) const;
720 OSStatus
SetSelectedItems( UInt32 numItems
,
721 const DataBrowserItemID
*items
,
722 DataBrowserSetOption operation
);
724 OSStatus
GetItemID( DataBrowserTableViewRowIndex row
,
725 DataBrowserItemID
* item
) const;
726 OSStatus
GetItemRow( DataBrowserItemID item
,
727 DataBrowserTableViewRowIndex
* row
) const;
729 OSStatus
SetDefaultRowHeight( UInt16 height
);
730 OSStatus
GetDefaultRowHeight( UInt16
* height
) const;
732 OSStatus
SetRowHeight( DataBrowserItemID item
, UInt16 height
);
733 OSStatus
GetRowHeight( DataBrowserItemID item
, UInt16
*height
) const;
735 OSStatus
GetColumnWidth( DataBrowserPropertyID column
, UInt16
*width
) const;
736 OSStatus
SetColumnWidth( DataBrowserPropertyID column
, UInt16 width
);
738 OSStatus
GetDefaultColumnWidth( UInt16
*width
) const;
739 OSStatus
SetDefaultColumnWidth( UInt16 width
);
741 OSStatus
GetColumnCount( UInt32
* numColumns
) const;
743 OSStatus
GetColumnIDFromIndex( DataBrowserTableViewColumnIndex position
, DataBrowserTableViewColumnID
* id
);
745 OSStatus
GetColumnPosition( DataBrowserPropertyID column
, DataBrowserTableViewColumnIndex
*position
) const;
746 OSStatus
SetColumnPosition( DataBrowserPropertyID column
, DataBrowserTableViewColumnIndex position
);
748 OSStatus
GetScrollPosition( UInt32
*top
, UInt32
*left
) const;
749 OSStatus
SetScrollPosition( UInt32 top
, UInt32 left
);
751 OSStatus
GetSortProperty( DataBrowserPropertyID
*column
) const;
752 OSStatus
SetSortProperty( DataBrowserPropertyID column
);
754 OSStatus
GetSortOrder( DataBrowserSortOrder
*order
) const;
755 OSStatus
SetSortOrder( DataBrowserSortOrder order
);
757 OSStatus
GetPropertyFlags( DataBrowserPropertyID property
, DataBrowserPropertyFlags
*flags
) const;
758 OSStatus
SetPropertyFlags( DataBrowserPropertyID property
, DataBrowserPropertyFlags flags
);
760 OSStatus
GetHeaderDesc( DataBrowserPropertyID property
, DataBrowserListViewHeaderDesc
*desc
) const;
761 OSStatus
SetHeaderDesc( DataBrowserPropertyID property
, DataBrowserListViewHeaderDesc
*desc
);
763 OSStatus
SetDisclosureColumn( DataBrowserPropertyID property
, Boolean expandableRows
);
766 static pascal void DataBrowserItemNotificationProc(
768 DataBrowserItemID itemID
,
769 DataBrowserItemNotification message
,
770 DataBrowserItemDataRef itemData
);
772 virtual void ItemNotification(
773 DataBrowserItemID itemID
,
774 DataBrowserItemNotification message
,
775 DataBrowserItemDataRef itemData
) = 0;
777 static pascal OSStatus
DataBrowserGetSetItemDataProc(
779 DataBrowserItemID itemID
,
780 DataBrowserPropertyID property
,
781 DataBrowserItemDataRef itemData
,
782 Boolean changeValue
);
784 virtual OSStatus
GetSetItemData(
785 DataBrowserItemID itemID
,
786 DataBrowserPropertyID property
,
787 DataBrowserItemDataRef itemData
,
788 Boolean changeValue
) = 0;
790 static pascal Boolean
DataBrowserCompareProc(
792 DataBrowserItemID itemOneID
,
793 DataBrowserItemID itemTwoID
,
794 DataBrowserPropertyID sortProperty
);
796 virtual Boolean
CompareItems(DataBrowserItemID itemOneID
,
797 DataBrowserItemID itemTwoID
,
798 DataBrowserPropertyID sortProperty
) = 0;
799 DECLARE_ABSTRACT_CLASS(wxMacDataBrowserControl
)
802 // ============================================================================
803 // Higher-level Databrowser
804 // ============================================================================
806 // basing on data item objects
811 class wxMacDataItemBrowserControl
;
812 class wxMacListBoxItem
;
814 const DataBrowserPropertyID kTextColumnId
= 1024;
815 const DataBrowserPropertyID kNumericOrderColumnId
= 1025;
817 // for multi-column controls, we will use this + the column ID to identify the
818 // column. We don't use kTextColumnId there, and ideally the two should merge.
819 const DataBrowserPropertyID kMinColumnId
= 1050;
821 // base API for high-level databrowser operations
823 class wxMacListControl
826 virtual void MacDelete( unsigned int n
) = 0;
827 virtual void MacInsert( unsigned int n
, const wxArrayStringsAdapter
& items
, int column
= -1 ) = 0;
828 // returns index of newly created line
829 virtual int MacAppend( const wxString
& item
) = 0;
830 virtual void MacSetString( unsigned int n
, const wxString
& item
) = 0;
831 virtual void MacClear() = 0;
832 virtual void MacDeselectAll() = 0;
833 virtual void MacSetSelection( unsigned int n
, bool select
, bool multi
) = 0;
834 virtual int MacGetSelection() const = 0;
835 virtual int MacGetSelections( wxArrayInt
& aSelections
) const = 0;
836 virtual bool MacIsSelected( unsigned int n
) const = 0;
837 virtual void MacScrollTo( unsigned int n
) = 0;
838 virtual wxString
MacGetString( unsigned int n
) const = 0;
839 virtual unsigned int MacGetCount() const = 0;
841 virtual void MacSetClientData( unsigned int n
, void * data
) = 0;
842 virtual void * MacGetClientData( unsigned int) const = 0;
844 virtual ~wxMacListControl() { }
847 // base class for databrowser items
857 virtual ~wxMacDataItem();
859 virtual bool IsLessThan(wxMacDataItemBrowserControl
*owner
,
860 const wxMacDataItem
*,
861 DataBrowserPropertyID property
) const;
863 // returns true if access was successful, otherwise false
864 virtual OSStatus
GetSetData(wxMacDataItemBrowserControl
*owner
,
865 DataBrowserPropertyID property
,
866 DataBrowserItemDataRef itemData
,
869 virtual void Notification(wxMacDataItemBrowserControl
*owner
,
870 DataBrowserItemNotification message
,
871 DataBrowserItemDataRef itemData
) const;
873 void SetLabel( const wxString
& str
);
874 const wxString
& GetLabel() const;
876 void SetOrder( SInt32 order
);
877 SInt32
GetOrder() const;
879 void SetData( void* data
);
880 void* GetData() const;
882 void SetColumn( short col
);
887 wxMacCFStringHolder m_cfLabel
;
890 DataBrowserPropertyID m_colId
;
896 SortOrder_Text_Ascending
,
897 SortOrder_Text_Descending
900 typedef wxMacDataItem
* wxMacDataItemPtr
;
901 const wxMacDataItemPtr wxMacDataBrowserRootContainer
= NULL
;
903 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxMacDataItemPtr
, wxArrayMacDataItemPtr
, class WXDLLIMPEXP_CORE
);
905 class wxMacDataItemBrowserControl
: public wxMacDataBrowserControl
, public wxMacListControl
908 wxMacDataItemBrowserControl( wxWindow
* peer
, const wxPoint
& pos
, const wxSize
& size
, long style
);
909 wxMacDataItemBrowserControl() {}
910 // create a list item (can be a subclass of wxMacListBoxItem)
912 virtual wxMacDataItem
* CreateItem();
914 unsigned int GetItemCount(const wxMacDataItem
* container
, bool recurse
, DataBrowserItemState state
) const;
915 void GetItems(const wxMacDataItem
* container
, bool recurse
,
916 DataBrowserItemState state
, wxArrayMacDataItemPtr
&items
) const;
918 unsigned int GetSelectedItemCount( const wxMacDataItem
* container
, bool recurse
) const;
920 unsigned int GetLineFromItem(const wxMacDataItem
*item
) const;
921 wxMacDataItem
* GetItemFromLine(unsigned int n
) const;
923 void UpdateItem(const wxMacDataItem
*container
, const wxMacDataItem
*item
,
924 DataBrowserPropertyID property
) const;
925 void UpdateItems(const wxMacDataItem
*container
, wxArrayMacDataItemPtr
&items
,
926 DataBrowserPropertyID property
) const;
928 void InsertColumn(int colId
, DataBrowserPropertyType colType
,
929 const wxString
& title
, SInt16 just
= teFlushDefault
, int defaultWidth
= -1);
931 int GetColumnWidth(int colId
);
932 void SetColumnWidth(int colId
, int width
);
934 void AddItem(wxMacDataItem
*container
, wxMacDataItem
*item
);
935 void AddItems(wxMacDataItem
*container
, wxArrayMacDataItemPtr
&items
);
937 void RemoveAllItems(wxMacDataItem
*container
);
938 void RemoveItem(wxMacDataItem
*container
, wxMacDataItem
* item
);
939 void RemoveItems(wxMacDataItem
*container
, wxArrayMacDataItemPtr
&items
);
941 void SetSelectedItem( wxMacDataItem
* item
, DataBrowserSetOption option
);
942 void SetSelectedItems( wxArrayMacDataItemPtr
&items
, DataBrowserSetOption option
);
943 void SetSelectedAllItems( DataBrowserSetOption option
);
944 Boolean
IsItemSelected( const wxMacDataItem
* item
) const;
946 void RevealItem( wxMacDataItem
* item
, DataBrowserRevealOptions options
);
948 void GetSelectionAnchor( wxMacDataItemPtr
* first
, wxMacDataItemPtr
* last
) const;
950 // item aware methods, to be used in subclasses
952 virtual Boolean
CompareItems(const wxMacDataItem
* itemOneID
,
953 const wxMacDataItem
* itemTwoID
,
954 DataBrowserPropertyID sortProperty
);
956 virtual OSStatus
GetSetItemData(wxMacDataItem
* itemID
,
957 DataBrowserPropertyID property
,
958 DataBrowserItemDataRef itemData
,
959 Boolean changeValue
);
961 virtual void ItemNotification(
962 const wxMacDataItem
* itemID
,
963 DataBrowserItemNotification message
,
964 DataBrowserItemDataRef itemData
);
966 // as we are getting the same events for human and API selection we have to suppress
967 // events in the latter case, since this will be used from many subclasses we keep it here
969 bool IsSelectionSuppressed() const { return m_suppressSelection
; }
970 bool SuppressSelection( bool suppress
);
973 // wxMacListControl Methods
976 virtual void MacDelete( unsigned int n
);
977 virtual void MacInsert( unsigned int n
, const wxArrayStringsAdapter
& items
, int column
= -1 );
978 virtual int MacAppend( const wxString
& item
);
979 virtual void MacClear();
983 virtual void MacDeselectAll();
984 virtual void MacSetSelection( unsigned int n
, bool select
, bool multi
= false );
985 virtual int MacGetSelection() const;
986 virtual int MacGetSelections( wxArrayInt
& aSelections
) const;
987 virtual bool MacIsSelected( unsigned int n
) const;
991 virtual void MacScrollTo( unsigned int n
);
995 virtual void MacSetString( unsigned int n
, const wxString
& item
);
996 virtual void MacSetClientData( unsigned int n
, void * data
);
997 virtual wxString
MacGetString( unsigned int n
) const;
998 virtual void * MacGetClientData( unsigned int) const;
999 virtual unsigned int MacGetCount() const;
1003 virtual wxClientDataType
GetClientDataType() const;
1004 virtual void SetClientDataType(wxClientDataType clientDataItemsType
);
1005 //virtual ListSortOrder GetSortOrder() const;
1006 //virtual void SetSortOrder(const ListSortOrder sort);
1012 ListSortOrder m_sortOrder
;
1013 wxClientDataType m_clientDataItemsType
;
1015 // ID aware base methods, should be 'final' ie not changed in subclasses
1017 virtual Boolean
CompareItems(DataBrowserItemID itemOneID
,
1018 DataBrowserItemID itemTwoID
,
1019 DataBrowserPropertyID sortProperty
);
1021 virtual OSStatus
GetSetItemData(DataBrowserItemID itemID
,
1022 DataBrowserPropertyID property
,
1023 DataBrowserItemDataRef itemData
,
1024 Boolean changeValue
);
1026 virtual void ItemNotification(
1027 DataBrowserItemID itemID
,
1028 DataBrowserItemNotification message
,
1029 DataBrowserItemDataRef itemData
);
1034 bool m_suppressSelection
;
1035 DECLARE_DYNAMIC_CLASS_NO_COPY(wxMacDataItemBrowserControl
)
1038 class wxMacDataItemBrowserSelectionSuppressor
1041 wxMacDataItemBrowserSelectionSuppressor(wxMacDataItemBrowserControl
*browser
);
1042 ~wxMacDataItemBrowserSelectionSuppressor();
1047 wxMacDataItemBrowserControl
* m_browser
;
1050 // ============================================================================
1051 // platform listbox implementation
1052 // ============================================================================
1054 // exposed for reuse in wxCheckListBox
1056 class wxMacListBoxItem
: public wxMacDataItem
1061 virtual ~wxMacListBoxItem();
1063 virtual void Notification(wxMacDataItemBrowserControl
*owner
,
1064 DataBrowserItemNotification message
,
1065 DataBrowserItemDataRef itemData
) const;
1068 class wxMacDataBrowserListControl
: public wxMacDataItemBrowserControl
1071 wxMacDataBrowserListControl( wxWindow
*peer
, const wxPoint
& pos
, const wxSize
& size
, long style
);
1072 wxMacDataBrowserListControl() {}
1073 virtual ~wxMacDataBrowserListControl();
1075 virtual wxMacDataItem
* CreateItem();
1079 wxWindow
* GetPeer() const;
1081 DECLARE_DYNAMIC_CLASS_NO_COPY(wxMacDataBrowserListControl
)
1084 // ============================================================================
1085 // graphics implementation
1086 // ============================================================================
1088 #if wxMAC_USE_CORE_GRAPHICS && !wxUSE_GRAPHICS_CONTEXT
1090 class WXDLLEXPORT wxMacCGPath
: public wxGraphicPath
1092 DECLARE_NO_COPY_CLASS(wxMacCGPath
)
1097 // Starts a new subpath at
1098 void MoveToPoint( wxCoord x1
, wxCoord y1
);
1099 void AddLineToPoint( wxCoord x1
, wxCoord y1
);
1100 void AddQuadCurveToPoint( wxCoord cx1
, wxCoord cy1
, wxCoord x1
, wxCoord y1
);
1101 void AddRectangle( wxCoord x
, wxCoord y
, wxCoord w
, wxCoord h
);
1102 void AddCircle( wxCoord x
, wxCoord y
, wxCoord r
);
1104 // draws a an arc to two tangents connecting (current) to (x1,y1) and (x1,y1) to (x2,y2)
1105 virtual void AddArcToPoint( wxCoord x1
, wxCoord y1
, wxCoord x2
, wxCoord y2
, wxCoord r
) ;
1106 virtual void AddArc( wxCoord x
, wxCoord y
, wxCoord r
, double startAngle
, double endAngle
, bool clockwise
) ;
1108 // closes the current subpath
1109 void CloseSubpath();
1111 CGPathRef
GetPath() const;
1113 CGMutablePathRef m_path
;
1116 class WXDLLEXPORT wxMacCGContext
: public wxGraphicContext
1118 DECLARE_NO_COPY_CLASS(wxMacCGContext
)
1121 wxMacCGContext( CGrafPtr port
);
1122 wxMacCGContext( CGContextRef cgcontext
);
1124 virtual ~wxMacCGContext();
1126 virtual void Clip( const wxRegion
®ion
);
1127 virtual void StrokePath( const wxGraphicPath
*p
);
1128 virtual void DrawPath( const wxGraphicPath
*p
, int fillStyle
= wxWINDING_RULE
);
1129 virtual void FillPath( const wxGraphicPath
*p
, const wxColor
&fillColor
, int fillStyle
= wxWINDING_RULE
);
1131 virtual wxGraphicPath
* CreatePath();
1132 virtual void SetPen( const wxPen
&pen
) ;
1133 virtual void SetBrush( const wxBrush
&brush
);
1134 CGContextRef
GetNativeContext();
1135 void SetNativeContext( CGContextRef cg
);
1136 CGPathDrawingMode
GetDrawingMode() const { return m_mode
; }
1138 virtual void Translate( wxCoord dx
, wxCoord dy
);
1139 virtual void Scale( wxCoord xScale
, wxCoord yScale
);
1140 virtual void DrawBitmap( const wxBitmap
&bmp
, wxCoord x
, wxCoord y
, wxCoord w
, wxCoord h
);
1141 virtual void DrawIcon( const wxIcon
&icon
, wxCoord x
, wxCoord y
, wxCoord w
, wxCoord h
);
1142 virtual void PushState();
1143 virtual void PopState();
1145 virtual void DrawText( const wxString
&str
, wxCoord x
, wxCoord y
, double angle
) ;
1147 virtual void GetTextExtent( const wxString
&str
, wxCoord
*width
, wxCoord
*height
,
1148 wxCoord
*descent
, wxCoord
*externalLeading
) const ;
1150 virtual void GetPartialTextExtents(const wxString
& text
, wxArrayInt
& widths
) const ;
1152 virtual void SetFont( const wxFont
&font
) ;
1154 virtual void SetTextColor( const wxColour
&col
) ;
1156 CGContextRef m_cgContext
;
1158 CGPathDrawingMode m_mode
;
1159 ATSUStyle m_macATSUIStyle
;
1162 wxColor m_textForegroundColor
;
1165 #endif // wxMAC_USE_CORE_GRAPHICS
1167 #ifdef __WXMAC_OSX__
1169 CGColorSpaceRef
wxMacGetGenericRGBColorSpace(void);
1170 void wxMacMemoryBufferReleaseProc(void *info
, const void *data
, size_t size
);
1174 class WXDLLEXPORT wxBitmapRefData
: public wxGDIRefData
1176 friend class WXDLLIMPEXP_FWD_CORE wxIcon
;
1177 friend class WXDLLIMPEXP_FWD_CORE wxCursor
;
1179 wxBitmapRefData(int width
, int height
, int depth
);
1181 wxBitmapRefData(const wxBitmapRefData
&tocopy
);
1183 virtual ~wxBitmapRefData();
1186 bool Ok() const { return IsOk(); }
1187 bool IsOk() const { return m_ok
; }
1188 void SetOk( bool isOk
) { m_ok
= isOk
; }
1190 void SetWidth( int width
) { m_width
= width
; }
1191 void SetHeight( int height
) { m_height
= height
; }
1192 void SetDepth( int depth
) { m_depth
= depth
; }
1194 int GetWidth() const { return m_width
; }
1195 int GetHeight() const { return m_height
; }
1196 int GetDepth() const { return m_depth
; }
1198 void *GetRawAccess() const;
1199 void *BeginRawAccess();
1200 void EndRawAccess();
1202 bool HasAlpha() const { return m_hasAlpha
; }
1203 void UseAlpha( bool useAlpha
);
1207 wxPalette m_bitmapPalette
;
1208 #endif // wxUSE_PALETTE
1210 wxMask
* m_bitmapMask
; // Optional mask
1211 #ifdef __WXMAC_OSX__
1212 CGImageRef
CGImageCreate() const;
1215 // returns true if the bitmap has a size that
1216 // can be natively transferred into a true icon
1217 // if no is returned GetIconRef will still produce
1218 // an icon but it will be generated via a PICT and
1219 // rescaled to 16 x 16
1220 bool HasNativeSize();
1222 // caller should increase ref count if needed longer
1223 // than the bitmap exists
1224 IconRef
GetIconRef();
1226 // returns a Pict from the bitmap content
1227 PicHandle
GetPictHandle();
1228 GWorldPtr
GetHBITMAP(GWorldPtr
* mask
= NULL
) const;
1229 void UpdateAlphaMask() const;
1232 bool Create(int width
, int height
, int depth
);
1240 wxMemoryBuffer m_memBuf
;
1241 int m_rawAccessCount
;
1243 #ifdef __WXMAC_OSX__
1244 mutable CGImageRef m_cgImageRef
;
1247 PicHandle m_pictHandle
;
1248 GWorldPtr m_hBitmap
;
1249 GWorldPtr m_hMaskBitmap
;
1250 wxMemoryBuffer m_maskMemBuf
;
1251 int m_maskBytesPerRow
;
1254 class WXDLLEXPORT wxIconRefData
: public wxGDIRefData
1258 wxIconRefData( WXHICON
);
1259 virtual ~wxIconRefData() { Free(); }
1262 virtual void Free();
1264 void SetWidth( int width
) { m_width
= width
; }
1265 void SetHeight( int height
) { m_height
= height
; }
1267 int GetWidth() const { return m_width
; }
1268 int GetHeight() const { return m_height
; }
1270 WXHICON
GetHICON() const { return (WXHICON
) m_iconRef
; }
1279 ControlRef
wxMacFindControlUnderMouse( wxTopLevelWindowMac
* toplevelWindow
, const Point
& location
, WindowRef window
, ControlPartCode
*outPart
);
1283 #ifdef WORDS_BIGENDIAN
1284 inline Rect
* wxMacGetPictureBounds( PicHandle pict
, Rect
* rect
)
1286 *rect
= (**pict
).picFrame
;
1290 inline Rect
* wxMacGetPictureBounds( PicHandle pict
, Rect
* rect
)
1292 return QDGetPictureBounds( pict
, rect
);
1300 #define wxMAC_DEFINE_PROC_GETTER( UPP , x ) \
1303 static UPP sHandler = NULL; \
1304 if ( sHandler == NULL ) \
1305 sHandler = New##UPP( x ); \
1309 //---------------------------------------------------------------------------
1310 // wxMac string conversions
1311 //---------------------------------------------------------------------------
1313 void wxMacSetupConverters();
1314 void wxMacCleanupConverters();
1316 WXDLLIMPEXP_BASE
void wxMacStringToPascal( const wxString
&from
, StringPtr to
);
1317 WXDLLIMPEXP_BASE wxString
wxMacMakeStringFromPascal( ConstStringPtr from
);
1321 WXDLLIMPEXP_BASE wxString
wxMacFSRefToPath( const FSRef
*fsRef
, CFStringRef additionalPathComponent
= NULL
);
1322 WXDLLIMPEXP_BASE OSStatus
wxMacPathToFSRef( const wxString
&path
, FSRef
*fsRef
);
1323 WXDLLIMPEXP_BASE wxString
wxMacHFSUniStrToString( ConstHFSUniStr255Param uniname
);
1329 void wxMacLocalToGlobal( WindowRef window
, Point
*pt
);
1330 void wxMacGlobalToLocal( WindowRef window
, Point
*pt
);