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 WXDLLEXPORT wxString
wxMacFSSpec2MacFilename( const FSSpec
*spec
);
206 WXDLLEXPORT
void wxMacFilename2FSSpec( const wxString
&path
, FSSpec
*spec
);
209 WXDLLEXPORT wxString
wxMacFindFolderNoSeparator(short vRefNum
,
211 Boolean createFolder
);
212 WXDLLEXPORT 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();
493 wxMacControl( wxWindow
* peer
, bool isRootControl
= false );
494 wxMacControl( wxWindow
* peer
, ControlRef control
);
495 wxMacControl( wxWindow
* peer
, WXWidget control
);
496 virtual ~wxMacControl();
500 virtual void Dispose();
502 bool Ok() const { return IsOk(); }
503 bool IsOk() const { return GetControlRef() != NULL
; }
505 void SetReferenceInNativeControl();
506 static wxMacControl
* GetReferenceFromNativeControl(ControlRef control
);
508 virtual ControlRef
* GetControlRefAddr() { return &m_controlRef
; }
509 virtual ControlRef
GetControlRef() const { return m_controlRef
; }
511 virtual void SetReference( URefCon data
);
513 void operator= (ControlRef c) { m_controlRef = c; }
514 operator ControlRef () { return m_controlRef; }
515 operator ControlRef * () { return &m_controlRef; }
517 // accessing data and values
519 virtual OSStatus
SetData( ControlPartCode inPartCode
, ResType inTag
, Size inSize
, const void * inData
);
520 virtual OSStatus
GetData( ControlPartCode inPartCode
, ResType inTag
, Size inBufferSize
, void * inOutBuffer
, Size
* outActualSize
) const;
521 virtual OSStatus
GetDataSize( ControlPartCode inPartCode
, ResType inTag
, Size
* outActualSize
) const;
522 virtual OSStatus
SendEvent( EventRef ref
, OptionBits inOptions
= 0 );
523 virtual OSStatus
SendHICommand( HICommand
&command
, OptionBits inOptions
= 0 );
525 virtual OSStatus
SendHICommand( UInt32 commandID
, OptionBits inOptions
= 0 );
527 virtual SInt32
GetValue() const;
528 virtual SInt32
GetMaximum() const;
529 virtual SInt32
GetMinimum() const;
531 virtual void SetValue( SInt32 v
);
532 virtual void SetMinimum( SInt32 v
);
533 virtual void SetMaximum( SInt32 v
);
535 virtual void SetValueAndRange( SInt32 value
, SInt32 minimum
, SInt32 maximum
);
536 virtual void SetRange( SInt32 minimum
, SInt32 maximum
);
538 virtual OSStatus
SetFocus( ControlFocusPart focusPart
);
539 virtual bool HasFocus() const;
540 virtual bool NeedsFocusRect() const;
541 virtual void SetNeedsFocusRect( bool needs
);
545 Size
GetDataSize( ControlPartCode inPartCode
, ResType inTag
) const
548 verify_noerr( GetDataSize( inPartCode
, inTag
, &sz
) );
551 template <typename T
> OSStatus
SetData( ControlPartCode inPartCode
, ResType inTag
, const T
*data
)
553 return SetData( inPartCode
, inTag
, sizeof( T
) , data
);
555 template <typename T
> OSStatus
SetData( ControlPartCode inPartCode
, ResType inTag
, const T
& data
)
557 return SetData( inPartCode
, inTag
, sizeof( T
) , &data
);
559 template <typename T
> OSStatus
SetData( ResType inTag
, const T
*data
)
561 return SetData( kControlEntireControl
, inTag
, sizeof( T
) , data
);
563 template <typename T
> OSStatus
SetData( ResType inTag
, const T
& data
)
565 return SetData( kControlEntireControl
, inTag
, sizeof( T
) , &data
);
567 template <typename T
> OSStatus
GetData( ControlPartCode inPartCode
, ResType inTag
, T
*data
) const
570 return GetData( inPartCode
, inTag
, sizeof( T
) , data
, &dummy
);
572 template <typename T
> T
GetData( ControlPartCode inPartCode
, ResType inTag
) const
575 OSStatus err
= GetData
<T
>( inPartCode
, inTag
, &value
);
577 wxASSERT_MSG( err
== noErr
,
578 wxString::Format(wxT("GetData Failed for Part [%i] and Tag [%i]"),
579 inPartCode
, (int)inTag
) );
582 template <typename T
> OSStatus
GetData( ResType inTag
, T
*data
) const
585 return GetData( kControlEntireControl
, inTag
, sizeof( T
) , data
, &dummy
);
587 template <typename T
> T
GetData( ResType inTag
) const
589 return GetData
<T
>( kControlEntireControl
, inTag
);
592 // Flash the control for the specified amount of time
593 virtual void Flash( ControlPartCode part
, UInt32 ticks
= 8 );
595 virtual void VisibilityChanged( bool shown
);
596 virtual void SuperChangedPosition();
599 virtual void SetFont( const wxFont
& font
, const wxColour
& foreground
, long windowStyle
);
600 virtual void SetBackground( const wxBrush
&brush
);
601 virtual ControlPartCode
HandleKey( SInt16 keyCode
, SInt16 charCode
, EventModifiers modifiers
);
602 void SetActionProc( ControlActionUPP actionProc
);
603 void SetViewSize( SInt32 viewSize
);
604 SInt32
GetViewSize() const;
606 virtual bool IsVisible() const;
607 virtual void SetVisibility( bool visible
, bool redraw
);
608 virtual bool IsEnabled() const;
609 virtual bool IsActive() const;
610 virtual void Enable( bool enable
);
612 // invalidates this control and all children
613 virtual void InvalidateWithChildren();
614 virtual void SetDrawingEnabled( bool enable
);
616 virtual bool GetNeedsDisplay() const;
618 // where is in native window relative coordinates
619 virtual void SetNeedsDisplay( RgnHandle where
);
620 // where is in native window relative coordinates
621 virtual void SetNeedsDisplay( Rect
* where
= NULL
);
623 // if rect = NULL, entire view
624 virtual void ScrollRect( wxRect
*rect
, int dx
, int dy
);
626 // in native parent window relative coordinates
627 virtual void GetRect( Rect
*r
);
629 // in native parent window relative coordinates
630 virtual void SetRect( Rect
*r
);
632 virtual void GetRectInWindowCoords( Rect
*r
);
633 virtual void GetBestRect( Rect
*r
);
634 virtual void SetLabel( const wxString
&title
);
635 // converts from Toplevel-Content relative to local
636 static void Convert( wxPoint
*pt
, wxMacControl
*convert
, wxMacControl
*to
);
638 virtual void GetFeatures( UInt32
*features
);
639 virtual OSStatus
GetRegion( ControlPartCode partCode
, RgnHandle region
);
640 virtual OSStatus
SetZOrder( bool above
, wxMacControl
* other
);
642 bool IsRootControl() { return m_isRootControl
; }
644 wxWindow
* GetPeer() const
649 // to be moved into a tab control class
651 virtual OSStatus
SetTabEnabled( SInt16 tabNo
, bool enable
);
653 ControlRef m_controlRef
;
657 bool m_needsFocusRect
;
658 bool m_isRootControl
;
661 // ============================================================================
662 // DataBrowser Wrapper
663 // ============================================================================
665 // basing on DataBrowserItemIDs
668 class wxMacDataBrowserControl
: public wxMacControl
671 wxMacDataBrowserControl( wxWindow
* peer
, const wxPoint
& pos
, const wxSize
& size
, long style
);
673 OSStatus
SetCallbacks( const DataBrowserCallbacks
*callbacks
);
675 OSStatus
GetItemCount( DataBrowserItemID container
,
677 DataBrowserItemState state
,
678 ItemCount
*numItems
) const;
680 OSStatus
GetItems( DataBrowserItemID container
,
682 DataBrowserItemState state
,
686 OSStatus
AddColumn( DataBrowserListViewColumnDesc
*columnDesc
,
687 DataBrowserTableViewColumnIndex position
);
689 OSStatus
RemoveColumn( DataBrowserTableViewColumnIndex position
);
691 OSStatus
AutoSizeColumns();
693 OSStatus
SetHasScrollBars( bool horiz
, bool vert
);
694 OSStatus
SetHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle
);
696 OSStatus
SetHeaderButtonHeight( UInt16 height
);
697 OSStatus
GetHeaderButtonHeight( UInt16
*height
);
699 OSStatus
UpdateItems( DataBrowserItemID container
, UInt32 numItems
,
700 const DataBrowserItemID
*items
,
701 DataBrowserPropertyID preSortProperty
,
702 DataBrowserPropertyID propertyID
) const;
704 OSStatus
AddItems( DataBrowserItemID container
, UInt32 numItems
,
705 const DataBrowserItemID
*items
,
706 DataBrowserPropertyID preSortProperty
);
707 OSStatus
RemoveItems( DataBrowserItemID container
, UInt32 numItems
,
708 const DataBrowserItemID
*items
,
709 DataBrowserPropertyID preSortProperty
);
710 OSStatus
RevealItem( DataBrowserItemID item
,
711 DataBrowserPropertyID propertyID
,
712 DataBrowserRevealOptions options
) const;
714 OSStatus
SetSelectionFlags( DataBrowserSelectionFlags
);
715 OSStatus
GetSelectionAnchor( DataBrowserItemID
*first
, DataBrowserItemID
*last
) const;
716 bool IsItemSelected( DataBrowserItemID item
) const;
717 OSStatus
SetSelectedItems( UInt32 numItems
,
718 const DataBrowserItemID
*items
,
719 DataBrowserSetOption operation
);
721 OSStatus
GetItemID( DataBrowserTableViewRowIndex row
,
722 DataBrowserItemID
* item
) const;
723 OSStatus
GetItemRow( DataBrowserItemID item
,
724 DataBrowserTableViewRowIndex
* row
) const;
726 OSStatus
SetDefaultRowHeight( UInt16 height
);
727 OSStatus
GetDefaultRowHeight( UInt16
* height
) const;
729 OSStatus
SetRowHeight( DataBrowserItemID item
, UInt16 height
);
730 OSStatus
GetRowHeight( DataBrowserItemID item
, UInt16
*height
) const;
732 OSStatus
GetColumnWidth( DataBrowserPropertyID column
, UInt16
*width
) const;
733 OSStatus
SetColumnWidth( DataBrowserPropertyID column
, UInt16 width
);
735 OSStatus
GetDefaultColumnWidth( UInt16
*width
) const;
736 OSStatus
SetDefaultColumnWidth( UInt16 width
);
738 OSStatus
GetColumnCount( UInt32
* numColumns
) const;
740 OSStatus
GetColumnIDFromIndex( DataBrowserTableViewColumnIndex position
, DataBrowserTableViewColumnID
* id
);
742 OSStatus
GetColumnPosition( DataBrowserPropertyID column
, DataBrowserTableViewColumnIndex
*position
) const;
743 OSStatus
SetColumnPosition( DataBrowserPropertyID column
, DataBrowserTableViewColumnIndex position
);
745 OSStatus
GetScrollPosition( UInt32
*top
, UInt32
*left
) const;
746 OSStatus
SetScrollPosition( UInt32 top
, UInt32 left
);
748 OSStatus
GetSortProperty( DataBrowserPropertyID
*column
) const;
749 OSStatus
SetSortProperty( DataBrowserPropertyID column
);
751 OSStatus
GetSortOrder( DataBrowserSortOrder
*order
) const;
752 OSStatus
SetSortOrder( DataBrowserSortOrder order
);
754 OSStatus
GetPropertyFlags( DataBrowserPropertyID property
, DataBrowserPropertyFlags
*flags
) const;
755 OSStatus
SetPropertyFlags( DataBrowserPropertyID property
, DataBrowserPropertyFlags flags
);
757 OSStatus
GetHeaderDesc( DataBrowserPropertyID property
, DataBrowserListViewHeaderDesc
*desc
) const;
758 OSStatus
SetHeaderDesc( DataBrowserPropertyID property
, DataBrowserListViewHeaderDesc
*desc
);
760 OSStatus
SetDisclosureColumn( DataBrowserPropertyID property
, Boolean expandableRows
);
763 static pascal void DataBrowserItemNotificationProc(
765 DataBrowserItemID itemID
,
766 DataBrowserItemNotification message
,
767 DataBrowserItemDataRef itemData
);
769 virtual void ItemNotification(
770 DataBrowserItemID itemID
,
771 DataBrowserItemNotification message
,
772 DataBrowserItemDataRef itemData
) = 0;
774 static pascal OSStatus
DataBrowserGetSetItemDataProc(
776 DataBrowserItemID itemID
,
777 DataBrowserPropertyID property
,
778 DataBrowserItemDataRef itemData
,
779 Boolean changeValue
);
781 virtual OSStatus
GetSetItemData(
782 DataBrowserItemID itemID
,
783 DataBrowserPropertyID property
,
784 DataBrowserItemDataRef itemData
,
785 Boolean changeValue
) = 0;
787 static pascal Boolean
DataBrowserCompareProc(
789 DataBrowserItemID itemOneID
,
790 DataBrowserItemID itemTwoID
,
791 DataBrowserPropertyID sortProperty
);
793 virtual Boolean
CompareItems(DataBrowserItemID itemOneID
,
794 DataBrowserItemID itemTwoID
,
795 DataBrowserPropertyID sortProperty
) = 0;
798 // ============================================================================
799 // Higher-level Databrowser
800 // ============================================================================
802 // basing on data item objects
807 class wxMacDataItemBrowserControl
;
808 class wxMacListBoxItem
;
810 const DataBrowserPropertyID kTextColumnId
= 1024;
811 const DataBrowserPropertyID kNumericOrderColumnId
= 1025;
813 // for multi-column controls, we will use this + the column ID to identify the
814 // column. We don't use kTextColumnId there, and ideally the two should merge.
815 const DataBrowserPropertyID kMinColumnId
= 1050;
817 // base API for high-level databrowser operations
819 class wxMacListControl
822 virtual void MacDelete( unsigned int n
) = 0;
823 virtual void MacInsert( unsigned int n
, const wxString
& item
, int column
= -1 ) = 0;
824 virtual void MacInsert( unsigned int n
, const wxArrayString
& items
, int column
= -1 ) = 0;
825 // returns index of newly created line
826 virtual int MacAppend( const wxString
& item
) = 0;
827 virtual void MacSetString( unsigned int n
, const wxString
& item
) = 0;
828 virtual void MacClear() = 0;
829 virtual void MacDeselectAll() = 0;
830 virtual void MacSetSelection( unsigned int n
, bool select
, bool multi
) = 0;
831 virtual int MacGetSelection() const = 0;
832 virtual int MacGetSelections( wxArrayInt
& aSelections
) const = 0;
833 virtual bool MacIsSelected( unsigned int n
) const = 0;
834 virtual void MacScrollTo( unsigned int n
) = 0;
835 virtual wxString
MacGetString( unsigned int n
) const = 0;
836 virtual unsigned int MacGetCount() const = 0;
838 virtual void MacSetClientData( unsigned int n
, void * data
) = 0;
839 virtual void * MacGetClientData( unsigned int) const = 0;
841 virtual ~wxMacListControl() { }
844 // base class for databrowser items
854 virtual ~wxMacDataItem();
856 virtual bool IsLessThan(wxMacDataItemBrowserControl
*owner
,
857 const wxMacDataItem
*,
858 DataBrowserPropertyID property
) const;
860 // returns true if access was successful, otherwise false
861 virtual OSStatus
GetSetData(wxMacDataItemBrowserControl
*owner
,
862 DataBrowserPropertyID property
,
863 DataBrowserItemDataRef itemData
,
866 virtual void Notification(wxMacDataItemBrowserControl
*owner
,
867 DataBrowserItemNotification message
,
868 DataBrowserItemDataRef itemData
) const;
870 void SetLabel( const wxString
& str
);
871 const wxString
& GetLabel() const;
873 void SetOrder( SInt32 order
);
874 SInt32
GetOrder() const;
876 void SetData( void* data
);
877 void* GetData() const;
879 void SetColumn( short col
);
884 wxMacCFStringHolder m_cfLabel
;
887 DataBrowserPropertyID m_colId
;
893 SortOrder_Text_Ascending
,
894 SortOrder_Text_Descending
897 typedef wxMacDataItem
* wxMacDataItemPtr
;
898 const wxMacDataItemPtr wxMacDataBrowserRootContainer
= NULL
;
900 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxMacDataItemPtr
, wxArrayMacDataItemPtr
, class WXDLLIMPEXP_CORE
);
902 class wxMacDataItemBrowserControl
: public wxMacDataBrowserControl
, public wxMacListControl
905 wxMacDataItemBrowserControl( wxWindow
* peer
, const wxPoint
& pos
, const wxSize
& size
, long style
);
907 // create a list item (can be a subclass of wxMacListBoxItem)
909 virtual wxMacDataItem
* CreateItem();
911 unsigned int GetItemCount(const wxMacDataItem
* container
, bool recurse
, DataBrowserItemState state
) const;
912 void GetItems(const wxMacDataItem
* container
, bool recurse
,
913 DataBrowserItemState state
, wxArrayMacDataItemPtr
&items
) const;
915 unsigned int GetSelectedItemCount( const wxMacDataItem
* container
, bool recurse
) const;
917 unsigned int GetLineFromItem(const wxMacDataItem
*item
) const;
918 wxMacDataItem
* GetItemFromLine(unsigned int n
) const;
920 void UpdateItem(const wxMacDataItem
*container
, const wxMacDataItem
*item
,
921 DataBrowserPropertyID property
) const;
922 void UpdateItems(const wxMacDataItem
*container
, wxArrayMacDataItemPtr
&items
,
923 DataBrowserPropertyID property
) const;
925 void InsertColumn(int colId
, DataBrowserPropertyType colType
,
926 const wxString
& title
, SInt16 just
= teFlushDefault
, int defaultWidth
= -1);
928 int GetColumnWidth(int colId
);
929 void SetColumnWidth(int colId
, int width
);
931 void AddItem(wxMacDataItem
*container
, wxMacDataItem
*item
);
932 void AddItems(wxMacDataItem
*container
, wxArrayMacDataItemPtr
&items
);
934 void RemoveAllItems(wxMacDataItem
*container
);
935 void RemoveItem(wxMacDataItem
*container
, wxMacDataItem
* item
);
936 void RemoveItems(wxMacDataItem
*container
, wxArrayMacDataItemPtr
&items
);
938 void SetSelectedItem( wxMacDataItem
* item
, DataBrowserSetOption option
);
939 void SetSelectedItems( wxArrayMacDataItemPtr
&items
, DataBrowserSetOption option
);
940 void SetSelectedAllItems( DataBrowserSetOption option
);
941 Boolean
IsItemSelected( const wxMacDataItem
* item
) const;
943 void RevealItem( wxMacDataItem
* item
, DataBrowserRevealOptions options
);
945 void GetSelectionAnchor( wxMacDataItemPtr
* first
, wxMacDataItemPtr
* last
) const;
947 // item aware methods, to be used in subclasses
949 virtual Boolean
CompareItems(const wxMacDataItem
* itemOneID
,
950 const wxMacDataItem
* itemTwoID
,
951 DataBrowserPropertyID sortProperty
);
953 virtual OSStatus
GetSetItemData(wxMacDataItem
* itemID
,
954 DataBrowserPropertyID property
,
955 DataBrowserItemDataRef itemData
,
956 Boolean changeValue
);
958 virtual void ItemNotification(
959 const wxMacDataItem
* itemID
,
960 DataBrowserItemNotification message
,
961 DataBrowserItemDataRef itemData
);
963 // as we are getting the same events for human and API selection we have to suppress
964 // events in the latter case, since this will be used from many subclasses we keep it here
966 bool IsSelectionSuppressed() const { return m_suppressSelection
; }
967 bool SuppressSelection( bool suppress
);
970 // wxMacListControl Methods
973 virtual void MacDelete( unsigned int n
);
974 virtual void MacInsert( unsigned int n
, const wxString
& item
, int column
= -1 );
975 virtual void MacInsert( unsigned int n
, const wxArrayString
& items
, int column
= -1 );
976 virtual int MacAppend( const wxString
& item
);
977 virtual void MacClear();
981 virtual void MacDeselectAll();
982 virtual void MacSetSelection( unsigned int n
, bool select
, bool multi
= false );
983 virtual int MacGetSelection() const;
984 virtual int MacGetSelections( wxArrayInt
& aSelections
) const;
985 virtual bool MacIsSelected( unsigned int n
) const;
989 virtual void MacScrollTo( unsigned int n
);
993 virtual void MacSetString( unsigned int n
, const wxString
& item
);
994 virtual void MacSetClientData( unsigned int n
, void * data
);
995 virtual wxString
MacGetString( unsigned int n
) const;
996 virtual void * MacGetClientData( unsigned int) const;
997 virtual unsigned int MacGetCount() const;
1001 virtual wxClientDataType
GetClientDataType() const;
1002 virtual void SetClientDataType(wxClientDataType clientDataItemsType
);
1003 //virtual ListSortOrder GetSortOrder() const;
1004 //virtual void SetSortOrder(const ListSortOrder sort);
1010 ListSortOrder m_sortOrder
;
1011 wxClientDataType m_clientDataItemsType
;
1013 // ID aware base methods, should be 'final' ie not changed in subclasses
1015 virtual Boolean
CompareItems(DataBrowserItemID itemOneID
,
1016 DataBrowserItemID itemTwoID
,
1017 DataBrowserPropertyID sortProperty
);
1019 virtual OSStatus
GetSetItemData(DataBrowserItemID itemID
,
1020 DataBrowserPropertyID property
,
1021 DataBrowserItemDataRef itemData
,
1022 Boolean changeValue
);
1024 virtual void ItemNotification(
1025 DataBrowserItemID itemID
,
1026 DataBrowserItemNotification message
,
1027 DataBrowserItemDataRef itemData
);
1032 bool m_suppressSelection
;
1035 class wxMacDataItemBrowserSelectionSuppressor
1038 wxMacDataItemBrowserSelectionSuppressor(wxMacDataItemBrowserControl
*browser
);
1039 ~wxMacDataItemBrowserSelectionSuppressor();
1044 wxMacDataItemBrowserControl
* m_browser
;
1047 // ============================================================================
1048 // platform listbox implementation
1049 // ============================================================================
1051 // exposed for reuse in wxCheckListBox
1053 class wxMacListBoxItem
: public wxMacDataItem
1058 virtual ~wxMacListBoxItem();
1060 virtual void Notification(wxMacDataItemBrowserControl
*owner
,
1061 DataBrowserItemNotification message
,
1062 DataBrowserItemDataRef itemData
) const;
1065 class wxMacDataBrowserListControl
: public wxMacDataItemBrowserControl
1068 wxMacDataBrowserListControl( wxWindow
*peer
, const wxPoint
& pos
, const wxSize
& size
, long style
);
1069 virtual ~wxMacDataBrowserListControl();
1071 virtual wxMacDataItem
* CreateItem();
1075 wxWindow
* GetPeer() const;
1079 // ============================================================================
1080 // graphics implementation
1081 // ============================================================================
1083 #if wxMAC_USE_CORE_GRAPHICS && !wxUSE_GRAPHICS_CONTEXT
1085 class WXDLLEXPORT wxMacCGPath
: public wxGraphicPath
1087 DECLARE_NO_COPY_CLASS(wxMacCGPath
)
1092 // Starts a new subpath at
1093 void MoveToPoint( wxCoord x1
, wxCoord y1
);
1094 void AddLineToPoint( wxCoord x1
, wxCoord y1
);
1095 void AddQuadCurveToPoint( wxCoord cx1
, wxCoord cy1
, wxCoord x1
, wxCoord y1
);
1096 void AddRectangle( wxCoord x
, wxCoord y
, wxCoord w
, wxCoord h
);
1097 void AddCircle( wxCoord x
, wxCoord y
, wxCoord r
);
1099 // draws a an arc to two tangents connecting (current) to (x1,y1) and (x1,y1) to (x2,y2)
1100 virtual void AddArcToPoint( wxCoord x1
, wxCoord y1
, wxCoord x2
, wxCoord y2
, wxCoord r
) ;
1101 virtual void AddArc( wxCoord x
, wxCoord y
, wxCoord r
, double startAngle
, double endAngle
, bool clockwise
) ;
1103 // closes the current subpath
1104 void CloseSubpath();
1106 CGPathRef
GetPath() const;
1108 CGMutablePathRef m_path
;
1111 class WXDLLEXPORT wxMacCGContext
: public wxGraphicContext
1113 DECLARE_NO_COPY_CLASS(wxMacCGContext
)
1116 wxMacCGContext( CGrafPtr port
);
1117 wxMacCGContext( CGContextRef cgcontext
);
1119 virtual ~wxMacCGContext();
1121 virtual void Clip( const wxRegion
®ion
);
1122 virtual void StrokePath( const wxGraphicPath
*p
);
1123 virtual void DrawPath( const wxGraphicPath
*p
, int fillStyle
= wxWINDING_RULE
);
1124 virtual void FillPath( const wxGraphicPath
*p
, const wxColor
&fillColor
, int fillStyle
= wxWINDING_RULE
);
1126 virtual wxGraphicPath
* CreatePath();
1127 virtual void SetPen( const wxPen
&pen
) ;
1128 virtual void SetBrush( const wxBrush
&brush
);
1129 CGContextRef
GetNativeContext();
1130 void SetNativeContext( CGContextRef cg
);
1131 CGPathDrawingMode
GetDrawingMode() const { return m_mode
; }
1133 virtual void Translate( wxCoord dx
, wxCoord dy
);
1134 virtual void Scale( wxCoord xScale
, wxCoord yScale
);
1135 virtual void DrawBitmap( const wxBitmap
&bmp
, wxCoord x
, wxCoord y
, wxCoord w
, wxCoord h
);
1136 virtual void DrawIcon( const wxIcon
&icon
, wxCoord x
, wxCoord y
, wxCoord w
, wxCoord h
);
1137 virtual void PushState();
1138 virtual void PopState();
1140 virtual void DrawText( const wxString
&str
, wxCoord x
, wxCoord y
, double angle
) ;
1142 virtual void GetTextExtent( const wxString
&str
, wxCoord
*width
, wxCoord
*height
,
1143 wxCoord
*descent
, wxCoord
*externalLeading
) const ;
1145 virtual void GetPartialTextExtents(const wxString
& text
, wxArrayInt
& widths
) const ;
1147 virtual void SetFont( const wxFont
&font
) ;
1149 virtual void SetTextColor( const wxColour
&col
) ;
1151 CGContextRef m_cgContext
;
1153 CGPathDrawingMode m_mode
;
1154 ATSUStyle m_macATSUIStyle
;
1157 wxColor m_textForegroundColor
;
1160 #endif // wxMAC_USE_CORE_GRAPHICS
1162 #ifdef __WXMAC_OSX__
1164 CGColorSpaceRef
wxMacGetGenericRGBColorSpace(void);
1165 void wxMacMemoryBufferReleaseProc(void *info
, const void *data
, size_t size
);
1169 class WXDLLEXPORT wxBitmapRefData
: public wxGDIRefData
1171 friend class WXDLLEXPORT wxIcon
;
1172 friend class WXDLLEXPORT wxCursor
;
1174 wxBitmapRefData(int width
, int height
, int depth
);
1176 wxBitmapRefData(const wxBitmapRefData
&tocopy
);
1178 virtual ~wxBitmapRefData();
1181 bool Ok() const { return IsOk(); }
1182 bool IsOk() const { return m_ok
; }
1183 void SetOk( bool isOk
) { m_ok
= isOk
; }
1185 void SetWidth( int width
) { m_width
= width
; }
1186 void SetHeight( int height
) { m_height
= height
; }
1187 void SetDepth( int depth
) { m_depth
= depth
; }
1189 int GetWidth() const { return m_width
; }
1190 int GetHeight() const { return m_height
; }
1191 int GetDepth() const { return m_depth
; }
1193 void *GetRawAccess() const;
1194 void *BeginRawAccess();
1195 void EndRawAccess();
1197 bool HasAlpha() const { return m_hasAlpha
; }
1198 void UseAlpha( bool useAlpha
);
1202 wxPalette m_bitmapPalette
;
1203 #endif // wxUSE_PALETTE
1205 wxMask
* m_bitmapMask
; // Optional mask
1206 #ifdef __WXMAC_OSX__
1207 CGImageRef
CGImageCreate() const;
1210 // returns true if the bitmap has a size that
1211 // can be natively transferred into a true icon
1212 // if no is returned GetIconRef will still produce
1213 // an icon but it will be generated via a PICT and
1214 // rescaled to 16 x 16
1215 bool HasNativeSize();
1217 // caller should increase ref count if needed longer
1218 // than the bitmap exists
1219 IconRef
GetIconRef();
1221 // returns a Pict from the bitmap content
1222 PicHandle
GetPictHandle();
1223 GWorldPtr
GetHBITMAP(GWorldPtr
* mask
= NULL
) const;
1224 void UpdateAlphaMask() const;
1227 bool Create(int width
, int height
, int depth
);
1235 wxMemoryBuffer m_memBuf
;
1236 int m_rawAccessCount
;
1238 #ifdef __WXMAC_OSX__
1239 mutable CGImageRef m_cgImageRef
;
1242 PicHandle m_pictHandle
;
1243 GWorldPtr m_hBitmap
;
1244 GWorldPtr m_hMaskBitmap
;
1245 wxMemoryBuffer m_maskMemBuf
;
1246 int m_maskBytesPerRow
;
1249 class WXDLLEXPORT wxIconRefData
: public wxGDIRefData
1253 wxIconRefData( WXHICON
);
1254 virtual ~wxIconRefData() { Free(); }
1257 virtual void Free();
1259 void SetWidth( int width
) { m_width
= width
; }
1260 void SetHeight( int height
) { m_height
= height
; }
1262 int GetWidth() const { return m_width
; }
1263 int GetHeight() const { return m_height
; }
1265 WXHICON
GetHICON() const { return (WXHICON
) m_iconRef
; }
1274 ControlRef
wxMacFindControlUnderMouse( wxTopLevelWindowMac
* toplevelWindow
, const Point
& location
, WindowRef window
, ControlPartCode
*outPart
);
1278 #ifdef WORDS_BIGENDIAN
1279 inline Rect
* wxMacGetPictureBounds( PicHandle pict
, Rect
* rect
)
1281 *rect
= (**pict
).picFrame
;
1285 inline Rect
* wxMacGetPictureBounds( PicHandle pict
, Rect
* rect
)
1287 return QDGetPictureBounds( pict
, rect
);
1295 #define wxMAC_DEFINE_PROC_GETTER( UPP , x ) \
1298 static UPP sHandler = NULL; \
1299 if ( sHandler == NULL ) \
1300 sHandler = New##UPP( x ); \
1304 //---------------------------------------------------------------------------
1305 // wxMac string conversions
1306 //---------------------------------------------------------------------------
1308 void wxMacSetupConverters();
1309 void wxMacCleanupConverters();
1311 void wxMacStringToPascal( const wxString
&from
, StringPtr to
);
1312 wxString
wxMacMakeStringFromPascal( ConstStringPtr from
);
1316 wxString
wxMacFSRefToPath( const FSRef
*fsRef
, CFStringRef additionalPathComponent
= NULL
);
1317 OSStatus
wxMacPathToFSRef( const wxString
&path
, FSRef
*fsRef
);
1318 wxString
wxMacHFSUniStrToString( ConstHFSUniStr255Param uniname
);
1324 void wxMacLocalToGlobal( WindowRef window
, Point
*pt
);
1325 void wxMacGlobalToLocal( WindowRef window
, Point
*pt
);