1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/osx/core/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
9 // RCS-ID: $Id: private.h 53819 2008-05-29 14:11:45Z SC $
10 // Copyright: (c) Stefan Csomor
11 // Licence: wxWindows licence
12 /////////////////////////////////////////////////////////////////////////////
14 #ifndef _WX_PRIVATE_CORE_H_
15 #define _WX_PRIVATE_CORE_H_
19 #include <CoreFoundation/CoreFoundation.h>
21 #include "wx/osx/core/cfstring.h"
22 #include "wx/osx/core/cfdataref.h"
24 // Define helper macros allowing to insert small snippets of code to be
25 // compiled for high enough OS X version only: this shouldn't be abused for
26 // anything big but it's handy for e.g. specifying OS X 10.6-only protocols in
27 // the Objective C classes declarations when they're not supported under the
29 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
30 #define wxOSX_10_6_AND_LATER(x) x
32 #define wxOSX_10_6_AND_LATER(x)
35 #if !wxUSE_GUI || wxOSX_USE_COCOA_OR_CARBON
37 // Carbon functions are currently still used in wxOSX/Cocoa too (including
38 // wxBase part of it).
39 #include <Carbon/Carbon.h>
41 WXDLLIMPEXP_BASE
long UMAGetSystemVersion() ;
43 void WXDLLIMPEXP_CORE
wxMacStringToPascal( const wxString
&from
, unsigned char * to
);
44 wxString WXDLLIMPEXP_CORE
wxMacMakeStringFromPascal( const unsigned char * from
);
46 WXDLLIMPEXP_BASE wxString
wxMacFSRefToPath( const FSRef
*fsRef
, CFStringRef additionalPathComponent
= NULL
);
47 WXDLLIMPEXP_BASE OSStatus
wxMacPathToFSRef( const wxString
&path
, FSRef
*fsRef
);
48 WXDLLIMPEXP_BASE wxString
wxMacHFSUniStrToString( ConstHFSUniStr255Param uniname
);
55 #include <CoreGraphics/CoreGraphics.h>
57 #include <ApplicationServices/ApplicationServices.h>
60 #include "wx/bitmap.h"
61 #include "wx/window.h"
63 class WXDLLIMPEXP_CORE wxMacCGContextStateSaver
65 wxDECLARE_NO_COPY_CLASS(wxMacCGContextStateSaver
);
68 wxMacCGContextStateSaver( CGContextRef cg
)
71 CGContextSaveGState( cg
);
73 ~wxMacCGContextStateSaver()
75 CGContextRestoreGState( m_cg
);
81 class WXDLLIMPEXP_CORE wxDeferredObjectDeleter
: public wxObject
84 wxDeferredObjectDeleter( wxObject
* obj
) : m_obj(obj
)
87 virtual ~wxDeferredObjectDeleter()
97 WXDLLIMPEXP_CORE CGImageRef
wxMacCreateCGImageFromBitmap( const wxBitmap
& bitmap
);
99 WXDLLIMPEXP_CORE CGDataProviderRef
wxMacCGDataProviderCreateWithCFData( CFDataRef data
);
100 WXDLLIMPEXP_CORE CGDataConsumerRef
wxMacCGDataConsumerCreateWithCFData( CFMutableDataRef data
);
101 WXDLLIMPEXP_CORE CGDataProviderRef
wxMacCGDataProviderCreateWithMemoryBuffer( const wxMemoryBuffer
& buf
);
103 CGColorSpaceRef WXDLLIMPEXP_CORE
wxMacGetGenericRGBColorSpace(void);
107 extern wxWindow
* g_MacLastWindow
;
108 class wxNonOwnedWindow
;
110 // temporary typedef so that no additional casts are necessary within carbon code at the moment
118 WXDLLIMPEXP_CORE wxWindowMac
* wxFindWindowFromWXWidget(WXWidget inControl
);
121 typedef wxMacControl wxWidgetImplType
;
123 typedef wxWidgetImpl wxWidgetImplType
;
127 class wxMenuItemImpl
: public wxObject
130 wxMenuItemImpl( wxMenuItem
* peer
) : m_peer(peer
)
134 virtual ~wxMenuItemImpl() ;
135 virtual void SetBitmap( const wxBitmap
& bitmap
) = 0;
136 virtual void Enable( bool enable
) = 0;
137 virtual void Check( bool check
) = 0;
138 virtual void SetLabel( const wxString
& text
, wxAcceleratorEntry
*entry
) = 0;
139 virtual void Hide( bool hide
= true ) = 0;
141 virtual void * GetHMenuItem() = 0;
143 wxMenuItem
* GetWXPeer() { return m_peer
; }
145 static wxMenuItemImpl
* Create( wxMenuItem
* peer
, wxMenu
*pParentMenu
,
147 const wxString
& text
,
148 wxAcceleratorEntry
*entry
,
149 const wxString
& strHelp
,
156 DECLARE_ABSTRACT_CLASS(wxMenuItemImpl
)
159 class wxMenuImpl
: public wxObject
162 wxMenuImpl( wxMenu
* peer
) : m_peer(peer
)
166 virtual ~wxMenuImpl() ;
167 virtual void InsertOrAppend(wxMenuItem
*pItem
, size_t pos
) = 0;
168 virtual void Remove( wxMenuItem
*pItem
) = 0;
170 virtual void MakeRoot() = 0;
172 virtual void SetTitle( const wxString
& text
) = 0;
174 virtual WXHMENU
GetHMenu() = 0;
176 wxMenu
* GetWXPeer() { return m_peer
; }
178 virtual void PopUp( wxWindow
*win
, int x
, int y
) = 0;
180 static wxMenuImpl
* Create( wxMenu
* peer
, const wxString
& title
);
181 static wxMenuImpl
* CreateRootMenu( wxMenu
* peer
);
185 DECLARE_ABSTRACT_CLASS(wxMenuItemImpl
)
190 class WXDLLIMPEXP_CORE wxWidgetImpl
: public wxObject
193 wxWidgetImpl( wxWindowMac
* peer
, bool isRootControl
= false );
195 virtual ~wxWidgetImpl();
199 bool IsRootControl() const { return m_isRootControl
; }
201 wxWindowMac
* GetWXPeer() const { return m_wxPeer
; }
203 bool IsOk() const { return GetWXWidget() != NULL
; }
205 // not only the control itself, but also all its parents must be visible
206 // in order for this function to return true
207 virtual bool IsVisible() const = 0;
208 // set the visibility of this widget (maybe latent)
209 virtual void SetVisibility( bool visible
) = 0;
211 virtual bool ShowWithEffect(bool WXUNUSED(show
),
212 wxShowEffect
WXUNUSED(effect
),
213 unsigned WXUNUSED(timeout
))
218 virtual void Raise() = 0;
220 virtual void Lower() = 0;
222 virtual void ScrollRect( const wxRect
*rect
, int dx
, int dy
) = 0;
224 virtual WXWidget
GetWXWidget() const = 0;
226 virtual void SetBackgroundColour( const wxColour
& col
) = 0;
227 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) = 0;
229 // all coordinates in native parent widget relative coordinates
230 virtual void GetContentArea( int &left
, int &top
, int &width
, int &height
) const = 0;
231 virtual void Move(int x
, int y
, int width
, int height
) = 0;
232 virtual void GetPosition( int &x
, int &y
) const = 0;
233 virtual void GetSize( int &width
, int &height
) const = 0;
234 virtual void SetControlSize( wxWindowVariant variant
) = 0;
236 // native view coordinates are topleft to bottom right (flipped regarding CoreGraphics origin)
237 virtual bool IsFlipped() const { return true; }
239 virtual void SetNeedsDisplay( const wxRect
* where
= NULL
) = 0;
240 virtual bool GetNeedsDisplay() const = 0;
242 virtual bool NeedsFocusRect() const;
243 virtual void SetNeedsFocusRect( bool needs
);
245 virtual bool NeedsFrame() const;
246 virtual void SetNeedsFrame( bool needs
);
248 virtual bool CanFocus() const = 0;
249 // return true if successful
250 virtual bool SetFocus() = 0;
251 virtual bool HasFocus() const = 0;
253 virtual void RemoveFromParent() = 0;
254 virtual void Embed( wxWidgetImpl
*parent
) = 0;
256 virtual void SetDefaultButton( bool isDefault
) = 0;
257 virtual void PerformClick() = 0;
258 virtual void SetLabel( const wxString
& title
, wxFontEncoding encoding
) = 0;
260 virtual void SetCursor( const wxCursor
& cursor
) = 0;
261 virtual void CaptureMouse() = 0;
262 virtual void ReleaseMouse() = 0;
264 virtual wxInt32
GetValue() const = 0;
265 virtual void SetValue( wxInt32 v
) = 0;
266 virtual wxBitmap
GetBitmap() const = 0;
267 virtual void SetBitmap( const wxBitmap
& bitmap
) = 0;
268 virtual void SetBitmapPosition( wxDirection dir
) = 0;
269 virtual void SetupTabs( const wxNotebook
¬ebook
) =0;
270 virtual void GetBestRect( wxRect
*r
) const = 0;
271 virtual bool IsEnabled() const = 0;
272 virtual void Enable( bool enable
) = 0;
273 virtual void SetMinimum( wxInt32 v
) = 0;
274 virtual void SetMaximum( wxInt32 v
) = 0;
275 virtual wxInt32
GetMinimum() const = 0;
276 virtual wxInt32
GetMaximum() const = 0;
277 virtual void PulseGauge() = 0;
278 virtual void SetScrollThumb( wxInt32 value
, wxInt32 thumbSize
) = 0;
280 virtual void SetFont( const wxFont
& font
, const wxColour
& foreground
, long windowStyle
, bool ignoreBlack
= true ) = 0;
282 virtual void SetToolTip(wxToolTip
* WXUNUSED(tooltip
)) { }
284 // is the clicked event sent AFTER the state already changed, so no additional
285 // state changing logic is required from the outside
286 virtual bool ButtonClickDidStateChange() = 0;
288 virtual void InstallEventHandler( WXWidget control
= NULL
) = 0;
290 // Mechanism used to keep track of whether a change should send an event
291 // Do SendEvents(false) when starting actions that would trigger programmatic events
292 // and SendEvents(true) at the end of the block.
293 virtual void SendEvents(bool shouldSendEvents
) { m_shouldSendEvents
= shouldSendEvents
; }
294 virtual bool ShouldSendEvents() { return m_shouldSendEvents
; }
296 // static methods for associating native controls and their implementations
299 FindFromWXWidget(WXWidget control
);
301 static void RemoveAssociations( wxWidgetImpl
* impl
);
303 static void Associate( WXWidget control
, wxWidgetImpl
*impl
);
305 static WXWidget
FindFocus();
307 // static creation methods, must be implemented by all toolkits
309 static wxWidgetImplType
* CreateUserPane( wxWindowMac
* wxpeer
,
316 static wxWidgetImplType
* CreateContentView( wxNonOwnedWindow
* now
) ;
318 static wxWidgetImplType
* CreateButton( wxWindowMac
* wxpeer
,
321 const wxString
& label
,
327 static wxWidgetImplType
* CreateDisclosureTriangle( wxWindowMac
* wxpeer
,
330 const wxString
& label
,
336 static wxWidgetImplType
* CreateStaticLine( wxWindowMac
* wxpeer
,
344 static wxWidgetImplType
* CreateGroupBox( wxWindowMac
* wxpeer
,
347 const wxString
& label
,
353 static wxWidgetImplType
* CreateStaticText( wxWindowMac
* wxpeer
,
356 const wxString
& label
,
362 static wxWidgetImplType
* CreateTextControl( wxTextCtrl
* wxpeer
,
365 const wxString
& content
,
371 static wxWidgetImplType
* CreateSearchControl( wxTextCtrl
* wxpeer
,
374 const wxString
& content
,
380 static wxWidgetImplType
* CreateCheckBox( wxWindowMac
* wxpeer
,
383 const wxString
& label
,
389 static wxWidgetImplType
* CreateRadioButton( wxWindowMac
* wxpeer
,
392 const wxString
& label
,
398 static wxWidgetImplType
* CreateToggleButton( wxWindowMac
* wxpeer
,
401 const wxString
& label
,
407 static wxWidgetImplType
* CreateBitmapToggleButton( wxWindowMac
* wxpeer
,
410 const wxBitmap
& bitmap
,
416 static wxWidgetImplType
* CreateBitmapButton( wxWindowMac
* wxpeer
,
419 const wxBitmap
& bitmap
,
425 static wxWidgetImplType
* CreateTabView( wxWindowMac
* wxpeer
,
433 static wxWidgetImplType
* CreateGauge( wxWindowMac
* wxpeer
,
444 static wxWidgetImplType
* CreateSlider( wxWindowMac
* wxpeer
,
455 static wxWidgetImplType
* CreateSpinButton( wxWindowMac
* wxpeer
,
466 static wxWidgetImplType
* CreateScrollBar( wxWindowMac
* wxpeer
,
474 static wxWidgetImplType
* CreateChoice( wxWindowMac
* wxpeer
,
483 static wxWidgetImplType
* CreateListBox( wxWindowMac
* wxpeer
,
492 static wxWidgetImplType
* CreateComboBox( wxComboBox
* wxpeer
,
502 // converts from Toplevel-Content relative to local
503 static void Convert( wxPoint
*pt
, wxWidgetImpl
*from
, wxWidgetImpl
*to
);
505 bool m_isRootControl
;
506 wxWindowMac
* m_wxPeer
;
507 bool m_needsFocusRect
;
509 bool m_shouldSendEvents
;
511 DECLARE_ABSTRACT_CLASS(wxWidgetImpl
)
515 // the interface to be implemented eg by a listbox
518 class WXDLLIMPEXP_CORE wxListWidgetColumn
521 virtual ~wxListWidgetColumn() {}
524 class WXDLLIMPEXP_CORE wxListWidgetCellValue
527 wxListWidgetCellValue() {}
528 virtual ~wxListWidgetCellValue() {}
530 virtual void Set( CFStringRef value
) = 0;
531 virtual void Set( const wxString
& value
) = 0;
532 virtual void Set( int value
) = 0;
533 virtual void Check( bool check
);
535 virtual bool IsChecked() const;
536 virtual int GetIntValue() const = 0;
537 virtual wxString
GetStringValue() const = 0;
540 class WXDLLIMPEXP_CORE wxListWidgetImpl
543 wxListWidgetImpl() {}
544 virtual ~wxListWidgetImpl() { }
546 virtual wxListWidgetColumn
* InsertTextColumn( unsigned pos
, const wxString
& title
, bool editable
= false,
547 wxAlignment just
= wxALIGN_LEFT
, int defaultWidth
= -1) = 0 ;
548 virtual wxListWidgetColumn
* InsertCheckColumn( unsigned pos
, const wxString
& title
, bool editable
= false,
549 wxAlignment just
= wxALIGN_LEFT
, int defaultWidth
= -1) = 0 ;
553 // TODO will be replaced
554 virtual void ListDelete( unsigned int n
) = 0;
555 virtual void ListInsert( unsigned int n
) = 0;
556 virtual void ListClear() = 0;
560 virtual void ListDeselectAll() = 0;
561 virtual void ListSetSelection( unsigned int n
, bool select
, bool multi
) = 0;
562 virtual int ListGetSelection() const = 0;
563 virtual int ListGetSelections( wxArrayInt
& aSelections
) const = 0;
564 virtual bool ListIsSelected( unsigned int n
) const = 0;
568 virtual void ListScrollTo( unsigned int n
) = 0;
569 virtual void UpdateLine( unsigned int n
, wxListWidgetColumn
* col
= NULL
) = 0;
570 virtual void UpdateLineToEnd( unsigned int n
) = 0;
574 virtual unsigned int ListGetCount() const = 0;
576 virtual int DoListHitTest( const wxPoint
& inpoint
) const = 0;
580 // interface to be implemented by a textcontrol
583 class WXDLLIMPEXP_FWD_CORE wxTextAttr
;
584 class WXDLLIMPEXP_FWD_CORE wxTextEntry
;
586 // common interface for all implementations
587 class WXDLLIMPEXP_CORE wxTextWidgetImpl
591 // Any widgets implementing this interface must be associated with a
592 // wxTextEntry so instead of requiring the derived classes to implement
593 // another (pure) virtual function, just take the pointer to this entry in
594 // our ctor and implement GetTextEntry() ourselves.
595 wxTextWidgetImpl(wxTextEntry
*entry
) : m_entry(entry
) {}
597 virtual ~wxTextWidgetImpl() {}
599 wxTextEntry
*GetTextEntry() const { return m_entry
; }
601 virtual bool CanFocus() const { return true; }
603 virtual wxString
GetStringValue() const = 0 ;
604 virtual void SetStringValue( const wxString
&val
) = 0 ;
605 virtual void SetSelection( long from
, long to
) = 0 ;
606 virtual void GetSelection( long* from
, long* to
) const = 0 ;
607 virtual void WriteText( const wxString
& str
) = 0 ;
609 virtual bool GetStyle( long position
, wxTextAttr
& style
);
610 virtual void SetStyle( long start
, long end
, const wxTextAttr
& style
) ;
611 virtual void Copy() ;
613 virtual void Paste() ;
614 virtual bool CanPaste() const ;
615 virtual void SetEditable( bool editable
) ;
616 virtual long GetLastPosition() const ;
617 virtual void Replace( long from
, long to
, const wxString
&str
) ;
618 virtual void Remove( long from
, long to
) ;
621 virtual bool HasOwnContextMenu() const
624 virtual bool SetupCursor( const wxPoint
& WXUNUSED(pt
) )
627 virtual void Clear() ;
628 virtual bool CanUndo() const;
629 virtual void Undo() ;
630 virtual bool CanRedo() const;
631 virtual void Redo() ;
632 virtual int GetNumberOfLines() const ;
633 virtual long XYToPosition(long x
, long y
) const;
634 virtual bool PositionToXY(long pos
, long *x
, long *y
) const ;
635 virtual void ShowPosition(long WXUNUSED(pos
)) ;
636 virtual int GetLineLength(long lineNo
) const ;
637 virtual wxString
GetLineText(long lineNo
) const ;
638 virtual void CheckSpelling(bool WXUNUSED(check
)) { }
640 virtual wxSize
GetBestSize() const { return wxDefaultSize
; }
643 wxTextEntry
* const m_entry
;
645 wxDECLARE_NO_COPY_CLASS(wxTextWidgetImpl
);
648 // common interface for all implementations
649 class WXDLLIMPEXP_CORE wxComboWidgetImpl
653 wxComboWidgetImpl() {}
655 virtual ~wxComboWidgetImpl() {}
657 virtual int GetSelectedItem() const { return -1; };
658 virtual void SetSelectedItem(int WXUNUSED(item
)) {};
660 virtual int GetNumberOfItems() const { return -1; };
662 virtual void InsertItem(int WXUNUSED(pos
), const wxString
& WXUNUSED(item
)) {}
664 virtual void RemoveItem(int WXUNUSED(pos
)) {}
666 virtual void Clear() {}
668 virtual wxString
GetStringAtIndex(int WXUNUSED(pos
)) const { return wxEmptyString
; }
670 virtual int FindString(const wxString
& WXUNUSED(text
)) const { return -1; }
674 // common interface for buttons
681 virtual ~wxButtonImpl(){}
683 virtual void SetPressedBitmap( const wxBitmap
& bitmap
) = 0;
687 // common interface for search controls
690 class wxSearchWidgetImpl
693 wxSearchWidgetImpl(){}
694 virtual ~wxSearchWidgetImpl(){}
696 // search field options
697 virtual void ShowSearchButton( bool show
) = 0;
698 virtual bool IsSearchButtonVisible() const = 0;
700 virtual void ShowCancelButton( bool show
) = 0;
701 virtual bool IsCancelButtonVisible() const = 0;
703 virtual void SetSearchMenu( wxMenu
* menu
) = 0;
705 virtual void SetDescriptiveText(const wxString
& text
) = 0;
709 // toplevel window implementation class
712 class wxNonOwnedWindowImpl
: public wxObject
715 wxNonOwnedWindowImpl( wxNonOwnedWindow
* nonownedwnd
) : m_wxPeer(nonownedwnd
)
718 wxNonOwnedWindowImpl()
721 virtual ~wxNonOwnedWindowImpl()
725 virtual void WillBeDestroyed()
729 virtual void Create( wxWindow
* parent
, const wxPoint
& pos
, const wxSize
& size
,
730 long style
, long extraStyle
, const wxString
& name
) = 0;
733 virtual WXWindow
GetWXWindow() const = 0;
743 virtual bool Show(bool WXUNUSED(show
))
748 virtual bool ShowWithEffect(bool show
, wxShowEffect
WXUNUSED(effect
), unsigned WXUNUSED(timeout
))
753 virtual void Update()
757 virtual bool SetTransparent(wxByte
WXUNUSED(alpha
))
762 virtual bool SetBackgroundColour(const wxColour
& WXUNUSED(col
) )
767 virtual void SetExtraStyle( long WXUNUSED(exStyle
) )
771 virtual void SetWindowStyleFlag( long WXUNUSED(style
) )
775 virtual bool SetBackgroundStyle(wxBackgroundStyle
WXUNUSED(style
))
780 virtual bool CanSetTransparent()
785 virtual void GetContentArea( int &left
, int &top
, int &width
, int &height
) const = 0;
786 virtual void MoveWindow(int x
, int y
, int width
, int height
) = 0;
787 virtual void GetPosition( int &x
, int &y
) const = 0;
788 virtual void GetSize( int &width
, int &height
) const = 0;
790 virtual bool SetShape(const wxRegion
& WXUNUSED(region
))
795 virtual void SetTitle( const wxString
& title
, wxFontEncoding encoding
) = 0;
797 virtual bool IsMaximized() const = 0;
799 virtual bool IsIconized() const= 0;
801 virtual void Iconize( bool iconize
)= 0;
803 virtual void Maximize(bool maximize
) = 0;
805 virtual bool IsFullScreen() const= 0;
807 virtual void ShowWithoutActivating() { Show(true); }
809 virtual bool ShowFullScreen(bool show
, long style
)= 0;
811 virtual void RequestUserAttention(int flags
) = 0;
813 virtual void ScreenToWindow( int *x
, int *y
) = 0;
815 virtual void WindowToScreen( int *x
, int *y
) = 0;
817 virtual bool IsActive() = 0;
819 wxNonOwnedWindow
* GetWXPeer() { return m_wxPeer
; }
821 static wxNonOwnedWindowImpl
*
822 FindFromWXWindow(WXWindow window
);
824 static void RemoveAssociations( wxNonOwnedWindowImpl
* impl
);
826 static void Associate( WXWindow window
, wxNonOwnedWindowImpl
*impl
);
828 // static creation methods, must be implemented by all toolkits
830 static wxNonOwnedWindowImpl
* CreateNonOwnedWindow( wxNonOwnedWindow
* wxpeer
, wxWindow
* parent
, WXWindow native
) ;
832 static wxNonOwnedWindowImpl
* CreateNonOwnedWindow( wxNonOwnedWindow
* wxpeer
, wxWindow
* parent
, const wxPoint
& pos
, const wxSize
& size
,
833 long style
, long extraStyle
, const wxString
& name
) ;
835 virtual void SetModified(bool WXUNUSED(modified
)) { }
836 virtual bool IsModified() const { return false; }
839 wxNonOwnedWindow
* m_wxPeer
;
840 DECLARE_ABSTRACT_CLASS(wxNonOwnedWindowImpl
)
845 //---------------------------------------------------------------------------
846 // cocoa bridging utilities
847 //---------------------------------------------------------------------------
849 bool wxMacInitCocoa();
851 class WXDLLIMPEXP_CORE wxMacAutoreleasePool
854 wxMacAutoreleasePool();
855 ~wxMacAutoreleasePool();
862 void wxMacCocoaRelease( void* obj
);
863 void wxMacCocoaAutorelease( void* obj
);
864 void* wxMacCocoaRetain( void* obj
);
868 // _WX_PRIVATE_CORE_H_