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
,
153 // handle OS specific menu items if they weren't handled during normal processing
154 virtual bool DoDefault() { return false; }
158 DECLARE_ABSTRACT_CLASS(wxMenuItemImpl
)
161 class wxMenuImpl
: public wxObject
164 wxMenuImpl( wxMenu
* peer
) : m_peer(peer
)
168 virtual ~wxMenuImpl() ;
169 virtual void InsertOrAppend(wxMenuItem
*pItem
, size_t pos
) = 0;
170 virtual void Remove( wxMenuItem
*pItem
) = 0;
172 virtual void MakeRoot() = 0;
174 virtual void SetTitle( const wxString
& text
) = 0;
176 virtual WXHMENU
GetHMenu() = 0;
178 wxMenu
* GetWXPeer() { return m_peer
; }
180 virtual void PopUp( wxWindow
*win
, int x
, int y
) = 0;
182 static wxMenuImpl
* Create( wxMenu
* peer
, const wxString
& title
);
183 static wxMenuImpl
* CreateRootMenu( wxMenu
* peer
);
187 DECLARE_ABSTRACT_CLASS(wxMenuItemImpl
)
192 class WXDLLIMPEXP_CORE wxWidgetImpl
: public wxObject
195 wxWidgetImpl( wxWindowMac
* peer
, bool isRootControl
= false );
197 virtual ~wxWidgetImpl();
201 bool IsRootControl() const { return m_isRootControl
; }
203 wxWindowMac
* GetWXPeer() const { return m_wxPeer
; }
205 bool IsOk() const { return GetWXWidget() != NULL
; }
207 // not only the control itself, but also all its parents must be visible
208 // in order for this function to return true
209 virtual bool IsVisible() const = 0;
210 // set the visibility of this widget (maybe latent)
211 virtual void SetVisibility( bool visible
) = 0;
213 virtual bool ShowWithEffect(bool WXUNUSED(show
),
214 wxShowEffect
WXUNUSED(effect
),
215 unsigned WXUNUSED(timeout
))
220 virtual void Raise() = 0;
222 virtual void Lower() = 0;
224 virtual void ScrollRect( const wxRect
*rect
, int dx
, int dy
) = 0;
226 virtual WXWidget
GetWXWidget() const = 0;
228 virtual void SetBackgroundColour( const wxColour
& col
) = 0;
229 virtual bool SetBackgroundStyle(wxBackgroundStyle style
) = 0;
231 // all coordinates in native parent widget relative coordinates
232 virtual void GetContentArea( int &left
, int &top
, int &width
, int &height
) const = 0;
233 virtual void Move(int x
, int y
, int width
, int height
) = 0;
234 virtual void GetPosition( int &x
, int &y
) const = 0;
235 virtual void GetSize( int &width
, int &height
) const = 0;
236 virtual void SetControlSize( wxWindowVariant variant
) = 0;
238 // the native coordinates may have an 'aura' for shadows etc, if this is the case the layout
239 // inset indicates on which insets the real control is drawn
240 virtual void GetLayoutInset(int &left
, int &top
, int &right
, int &bottom
) const
242 left
= top
= right
= bottom
= 0;
245 // native view coordinates are topleft to bottom right (flipped regarding CoreGraphics origin)
246 virtual bool IsFlipped() const { return true; }
248 virtual void SetNeedsDisplay( const wxRect
* where
= NULL
) = 0;
249 virtual bool GetNeedsDisplay() const = 0;
251 virtual bool NeedsFocusRect() const;
252 virtual void SetNeedsFocusRect( bool needs
);
254 virtual bool NeedsFrame() const;
255 virtual void SetNeedsFrame( bool needs
);
257 virtual bool CanFocus() const = 0;
258 // return true if successful
259 virtual bool SetFocus() = 0;
260 virtual bool HasFocus() const = 0;
262 virtual void RemoveFromParent() = 0;
263 virtual void Embed( wxWidgetImpl
*parent
) = 0;
265 virtual void SetDefaultButton( bool isDefault
) = 0;
266 virtual void PerformClick() = 0;
267 virtual void SetLabel( const wxString
& title
, wxFontEncoding encoding
) = 0;
269 virtual void SetCursor( const wxCursor
& cursor
) = 0;
270 virtual void CaptureMouse() = 0;
271 virtual void ReleaseMouse() = 0;
273 virtual wxInt32
GetValue() const = 0;
274 virtual void SetValue( wxInt32 v
) = 0;
275 virtual wxBitmap
GetBitmap() const = 0;
276 virtual void SetBitmap( const wxBitmap
& bitmap
) = 0;
277 virtual void SetBitmapPosition( wxDirection dir
) = 0;
278 virtual void SetupTabs( const wxNotebook
¬ebook
) =0;
279 virtual void GetBestRect( wxRect
*r
) const = 0;
280 virtual bool IsEnabled() const = 0;
281 virtual void Enable( bool enable
) = 0;
282 virtual void SetMinimum( wxInt32 v
) = 0;
283 virtual void SetMaximum( wxInt32 v
) = 0;
284 virtual wxInt32
GetMinimum() const = 0;
285 virtual wxInt32
GetMaximum() const = 0;
286 virtual void PulseGauge() = 0;
287 virtual void SetScrollThumb( wxInt32 value
, wxInt32 thumbSize
) = 0;
289 virtual void SetFont( const wxFont
& font
, const wxColour
& foreground
, long windowStyle
, bool ignoreBlack
= true ) = 0;
291 virtual void SetToolTip(wxToolTip
* WXUNUSED(tooltip
)) { }
293 // is the clicked event sent AFTER the state already changed, so no additional
294 // state changing logic is required from the outside
295 virtual bool ButtonClickDidStateChange() = 0;
297 virtual void InstallEventHandler( WXWidget control
= NULL
) = 0;
299 // Mechanism used to keep track of whether a change should send an event
300 // Do SendEvents(false) when starting actions that would trigger programmatic events
301 // and SendEvents(true) at the end of the block.
302 virtual void SendEvents(bool shouldSendEvents
) { m_shouldSendEvents
= shouldSendEvents
; }
303 virtual bool ShouldSendEvents() { return m_shouldSendEvents
; }
305 // static methods for associating native controls and their implementations
308 FindFromWXWidget(WXWidget control
);
310 static void RemoveAssociations( wxWidgetImpl
* impl
);
312 static void Associate( WXWidget control
, wxWidgetImpl
*impl
);
314 static WXWidget
FindFocus();
316 // static creation methods, must be implemented by all toolkits
318 static wxWidgetImplType
* CreateUserPane( wxWindowMac
* wxpeer
,
325 static wxWidgetImplType
* CreateContentView( wxNonOwnedWindow
* now
) ;
327 static wxWidgetImplType
* CreateButton( wxWindowMac
* wxpeer
,
330 const wxString
& label
,
336 static wxWidgetImplType
* CreateDisclosureTriangle( wxWindowMac
* wxpeer
,
339 const wxString
& label
,
345 static wxWidgetImplType
* CreateStaticLine( wxWindowMac
* wxpeer
,
353 static wxWidgetImplType
* CreateGroupBox( wxWindowMac
* wxpeer
,
356 const wxString
& label
,
362 static wxWidgetImplType
* CreateStaticText( wxWindowMac
* wxpeer
,
365 const wxString
& label
,
371 static wxWidgetImplType
* CreateTextControl( wxTextCtrl
* wxpeer
,
374 const wxString
& content
,
380 static wxWidgetImplType
* CreateSearchControl( wxTextCtrl
* wxpeer
,
383 const wxString
& content
,
389 static wxWidgetImplType
* CreateCheckBox( wxWindowMac
* wxpeer
,
392 const wxString
& label
,
398 static wxWidgetImplType
* CreateRadioButton( wxWindowMac
* wxpeer
,
401 const wxString
& label
,
407 static wxWidgetImplType
* CreateToggleButton( wxWindowMac
* wxpeer
,
410 const wxString
& label
,
416 static wxWidgetImplType
* CreateBitmapToggleButton( wxWindowMac
* wxpeer
,
419 const wxBitmap
& bitmap
,
425 static wxWidgetImplType
* CreateBitmapButton( wxWindowMac
* wxpeer
,
428 const wxBitmap
& bitmap
,
434 static wxWidgetImplType
* CreateTabView( wxWindowMac
* wxpeer
,
442 static wxWidgetImplType
* CreateGauge( wxWindowMac
* wxpeer
,
453 static wxWidgetImplType
* CreateSlider( wxWindowMac
* wxpeer
,
464 static wxWidgetImplType
* CreateSpinButton( wxWindowMac
* wxpeer
,
475 static wxWidgetImplType
* CreateScrollBar( wxWindowMac
* wxpeer
,
483 static wxWidgetImplType
* CreateChoice( wxWindowMac
* wxpeer
,
492 static wxWidgetImplType
* CreateListBox( wxWindowMac
* wxpeer
,
501 static wxWidgetImplType
* CreateComboBox( wxComboBox
* wxpeer
,
511 // converts from Toplevel-Content relative to local
512 static void Convert( wxPoint
*pt
, wxWidgetImpl
*from
, wxWidgetImpl
*to
);
514 bool m_isRootControl
;
515 wxWindowMac
* m_wxPeer
;
516 bool m_needsFocusRect
;
518 bool m_shouldSendEvents
;
520 DECLARE_ABSTRACT_CLASS(wxWidgetImpl
)
524 // the interface to be implemented eg by a listbox
527 class WXDLLIMPEXP_CORE wxListWidgetColumn
530 virtual ~wxListWidgetColumn() {}
533 class WXDLLIMPEXP_CORE wxListWidgetCellValue
536 wxListWidgetCellValue() {}
537 virtual ~wxListWidgetCellValue() {}
539 virtual void Set( CFStringRef value
) = 0;
540 virtual void Set( const wxString
& value
) = 0;
541 virtual void Set( int value
) = 0;
542 virtual void Check( bool check
);
544 virtual bool IsChecked() const;
545 virtual int GetIntValue() const = 0;
546 virtual wxString
GetStringValue() const = 0;
549 class WXDLLIMPEXP_CORE wxListWidgetImpl
552 wxListWidgetImpl() {}
553 virtual ~wxListWidgetImpl() { }
555 virtual wxListWidgetColumn
* InsertTextColumn( unsigned pos
, const wxString
& title
, bool editable
= false,
556 wxAlignment just
= wxALIGN_LEFT
, int defaultWidth
= -1) = 0 ;
557 virtual wxListWidgetColumn
* InsertCheckColumn( unsigned pos
, const wxString
& title
, bool editable
= false,
558 wxAlignment just
= wxALIGN_LEFT
, int defaultWidth
= -1) = 0 ;
562 // TODO will be replaced
563 virtual void ListDelete( unsigned int n
) = 0;
564 virtual void ListInsert( unsigned int n
) = 0;
565 virtual void ListClear() = 0;
569 virtual void ListDeselectAll() = 0;
570 virtual void ListSetSelection( unsigned int n
, bool select
, bool multi
) = 0;
571 virtual int ListGetSelection() const = 0;
572 virtual int ListGetSelections( wxArrayInt
& aSelections
) const = 0;
573 virtual bool ListIsSelected( unsigned int n
) const = 0;
577 virtual void ListScrollTo( unsigned int n
) = 0;
578 virtual void UpdateLine( unsigned int n
, wxListWidgetColumn
* col
= NULL
) = 0;
579 virtual void UpdateLineToEnd( unsigned int n
) = 0;
583 virtual unsigned int ListGetCount() const = 0;
585 virtual int DoListHitTest( const wxPoint
& inpoint
) const = 0;
589 // interface to be implemented by a textcontrol
592 class WXDLLIMPEXP_FWD_CORE wxTextAttr
;
593 class WXDLLIMPEXP_FWD_CORE wxTextEntry
;
595 // common interface for all implementations
596 class WXDLLIMPEXP_CORE wxTextWidgetImpl
600 // Any widgets implementing this interface must be associated with a
601 // wxTextEntry so instead of requiring the derived classes to implement
602 // another (pure) virtual function, just take the pointer to this entry in
603 // our ctor and implement GetTextEntry() ourselves.
604 wxTextWidgetImpl(wxTextEntry
*entry
) : m_entry(entry
) {}
606 virtual ~wxTextWidgetImpl() {}
608 wxTextEntry
*GetTextEntry() const { return m_entry
; }
610 virtual bool CanFocus() const { return true; }
612 virtual wxString
GetStringValue() const = 0 ;
613 virtual void SetStringValue( const wxString
&val
) = 0 ;
614 virtual void SetSelection( long from
, long to
) = 0 ;
615 virtual void GetSelection( long* from
, long* to
) const = 0 ;
616 virtual void WriteText( const wxString
& str
) = 0 ;
618 virtual bool GetStyle( long position
, wxTextAttr
& style
);
619 virtual void SetStyle( long start
, long end
, const wxTextAttr
& style
) ;
620 virtual void Copy() ;
622 virtual void Paste() ;
623 virtual bool CanPaste() const ;
624 virtual void SetEditable( bool editable
) ;
625 virtual long GetLastPosition() const ;
626 virtual void Replace( long from
, long to
, const wxString
&str
) ;
627 virtual void Remove( long from
, long to
) ;
630 virtual bool HasOwnContextMenu() const
633 virtual bool SetupCursor( const wxPoint
& WXUNUSED(pt
) )
636 virtual void Clear() ;
637 virtual bool CanUndo() const;
638 virtual void Undo() ;
639 virtual bool CanRedo() const;
640 virtual void Redo() ;
641 virtual int GetNumberOfLines() const ;
642 virtual long XYToPosition(long x
, long y
) const;
643 virtual bool PositionToXY(long pos
, long *x
, long *y
) const ;
644 virtual void ShowPosition(long WXUNUSED(pos
)) ;
645 virtual int GetLineLength(long lineNo
) const ;
646 virtual wxString
GetLineText(long lineNo
) const ;
647 virtual void CheckSpelling(bool WXUNUSED(check
)) { }
649 virtual wxSize
GetBestSize() const { return wxDefaultSize
; }
652 wxTextEntry
* const m_entry
;
654 wxDECLARE_NO_COPY_CLASS(wxTextWidgetImpl
);
657 // common interface for all implementations
658 class WXDLLIMPEXP_CORE wxComboWidgetImpl
662 wxComboWidgetImpl() {}
664 virtual ~wxComboWidgetImpl() {}
666 virtual int GetSelectedItem() const { return -1; };
667 virtual void SetSelectedItem(int WXUNUSED(item
)) {};
669 virtual int GetNumberOfItems() const { return -1; };
671 virtual void InsertItem(int WXUNUSED(pos
), const wxString
& WXUNUSED(item
)) {}
673 virtual void RemoveItem(int WXUNUSED(pos
)) {}
675 virtual void Clear() {}
677 virtual wxString
GetStringAtIndex(int WXUNUSED(pos
)) const { return wxEmptyString
; }
679 virtual int FindString(const wxString
& WXUNUSED(text
)) const { return -1; }
683 // common interface for buttons
690 virtual ~wxButtonImpl(){}
692 virtual void SetPressedBitmap( const wxBitmap
& bitmap
) = 0;
696 // common interface for search controls
699 class wxSearchWidgetImpl
702 wxSearchWidgetImpl(){}
703 virtual ~wxSearchWidgetImpl(){}
705 // search field options
706 virtual void ShowSearchButton( bool show
) = 0;
707 virtual bool IsSearchButtonVisible() const = 0;
709 virtual void ShowCancelButton( bool show
) = 0;
710 virtual bool IsCancelButtonVisible() const = 0;
712 virtual void SetSearchMenu( wxMenu
* menu
) = 0;
714 virtual void SetDescriptiveText(const wxString
& text
) = 0;
718 // toplevel window implementation class
721 class wxNonOwnedWindowImpl
: public wxObject
724 wxNonOwnedWindowImpl( wxNonOwnedWindow
* nonownedwnd
) : m_wxPeer(nonownedwnd
)
727 wxNonOwnedWindowImpl()
730 virtual ~wxNonOwnedWindowImpl()
734 virtual void WillBeDestroyed()
738 virtual void Create( wxWindow
* parent
, const wxPoint
& pos
, const wxSize
& size
,
739 long style
, long extraStyle
, const wxString
& name
) = 0;
742 virtual WXWindow
GetWXWindow() const = 0;
752 virtual bool Show(bool WXUNUSED(show
))
757 virtual bool ShowWithEffect(bool show
, wxShowEffect
WXUNUSED(effect
), unsigned WXUNUSED(timeout
))
762 virtual void Update()
766 virtual bool SetTransparent(wxByte
WXUNUSED(alpha
))
771 virtual bool SetBackgroundColour(const wxColour
& WXUNUSED(col
) )
776 virtual void SetExtraStyle( long WXUNUSED(exStyle
) )
780 virtual void SetWindowStyleFlag( long WXUNUSED(style
) )
784 virtual bool SetBackgroundStyle(wxBackgroundStyle
WXUNUSED(style
))
789 virtual bool CanSetTransparent()
794 virtual void GetContentArea( int &left
, int &top
, int &width
, int &height
) const = 0;
795 virtual void MoveWindow(int x
, int y
, int width
, int height
) = 0;
796 virtual void GetPosition( int &x
, int &y
) const = 0;
797 virtual void GetSize( int &width
, int &height
) const = 0;
799 virtual bool SetShape(const wxRegion
& WXUNUSED(region
))
804 virtual void SetTitle( const wxString
& title
, wxFontEncoding encoding
) = 0;
806 virtual bool IsMaximized() const = 0;
808 virtual bool IsIconized() const= 0;
810 virtual void Iconize( bool iconize
)= 0;
812 virtual void Maximize(bool maximize
) = 0;
814 virtual bool IsFullScreen() const= 0;
816 virtual void ShowWithoutActivating() { Show(true); }
818 virtual bool ShowFullScreen(bool show
, long style
)= 0;
820 virtual void RequestUserAttention(int flags
) = 0;
822 virtual void ScreenToWindow( int *x
, int *y
) = 0;
824 virtual void WindowToScreen( int *x
, int *y
) = 0;
826 virtual bool IsActive() = 0;
828 wxNonOwnedWindow
* GetWXPeer() { return m_wxPeer
; }
830 static wxNonOwnedWindowImpl
*
831 FindFromWXWindow(WXWindow window
);
833 static void RemoveAssociations( wxNonOwnedWindowImpl
* impl
);
835 static void Associate( WXWindow window
, wxNonOwnedWindowImpl
*impl
);
837 // static creation methods, must be implemented by all toolkits
839 static wxNonOwnedWindowImpl
* CreateNonOwnedWindow( wxNonOwnedWindow
* wxpeer
, wxWindow
* parent
, WXWindow native
) ;
841 static wxNonOwnedWindowImpl
* CreateNonOwnedWindow( wxNonOwnedWindow
* wxpeer
, wxWindow
* parent
, const wxPoint
& pos
, const wxSize
& size
,
842 long style
, long extraStyle
, const wxString
& name
) ;
844 virtual void SetModified(bool WXUNUSED(modified
)) { }
845 virtual bool IsModified() const { return false; }
848 wxNonOwnedWindow
* m_wxPeer
;
849 DECLARE_ABSTRACT_CLASS(wxNonOwnedWindowImpl
)
854 //---------------------------------------------------------------------------
855 // cocoa bridging utilities
856 //---------------------------------------------------------------------------
858 bool wxMacInitCocoa();
860 class WXDLLIMPEXP_CORE wxMacAutoreleasePool
863 wxMacAutoreleasePool();
864 ~wxMacAutoreleasePool();
871 void wxMacCocoaRelease( void* obj
);
872 void wxMacCocoaAutorelease( void* obj
);
873 void* wxMacCocoaRetain( void* obj
);
877 // _WX_PRIVATE_CORE_H_