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 #if wxOSX_USE_COCOA_OR_CARBON
26 WXDLLIMPEXP_BASE
long UMAGetSystemVersion() ;
28 void WXDLLIMPEXP_CORE
wxMacStringToPascal( const wxString
&from
, unsigned char * to
);
29 wxString WXDLLIMPEXP_CORE
wxMacMakeStringFromPascal( const unsigned char * from
);
36 #include <CoreGraphics/CoreGraphics.h>
38 #include <ApplicationServices/ApplicationServices.h>
41 #include "wx/bitmap.h"
42 #include "wx/window.h"
44 class WXDLLIMPEXP_CORE wxMacCGContextStateSaver
46 DECLARE_NO_COPY_CLASS(wxMacCGContextStateSaver
)
49 wxMacCGContextStateSaver( CGContextRef cg
)
52 CGContextSaveGState( cg
);
54 ~wxMacCGContextStateSaver()
56 CGContextRestoreGState( m_cg
);
62 class WXDLLIMPEXP_CORE wxDeferredObjectDeleter
: public wxObject
65 wxDeferredObjectDeleter( wxObject
* obj
) : m_obj(obj
)
68 virtual ~wxDeferredObjectDeleter()
78 WXDLLIMPEXP_CORE CGImageRef
wxMacCreateCGImageFromBitmap( const wxBitmap
& bitmap
);
80 WXDLLIMPEXP_CORE CGDataProviderRef
wxMacCGDataProviderCreateWithCFData( CFDataRef data
);
81 WXDLLIMPEXP_CORE CGDataConsumerRef
wxMacCGDataConsumerCreateWithCFData( CFMutableDataRef data
);
82 WXDLLIMPEXP_CORE CGDataProviderRef
wxMacCGDataProviderCreateWithMemoryBuffer( const wxMemoryBuffer
& buf
);
84 CGColorSpaceRef WXDLLIMPEXP_CORE
wxMacGetGenericRGBColorSpace(void);
88 extern wxWindow
* g_MacLastWindow
;
89 class wxNonOwnedWindow
;
91 // temporary typedef so that no additional casts are necessary within carbon code at the moment
99 typedef wxMacControl wxWidgetImplType
;
101 typedef wxWidgetImpl wxWidgetImplType
;
104 class wxMenuItemImpl
: public wxObject
107 wxMenuItemImpl( wxMenuItem
* peer
) : m_peer(peer
)
111 virtual ~wxMenuItemImpl() ;
112 virtual void SetBitmap( const wxBitmap
& bitmap
) = 0;
113 virtual void Enable( bool enable
) = 0;
114 virtual void Check( bool check
) = 0;
115 virtual void SetLabel( const wxString
& text
, wxAcceleratorEntry
*entry
) = 0;
116 virtual void Hide( bool hide
= true ) = 0;
118 virtual void * GetHMenuItem() = 0;
120 wxMenuItem
* GetWXPeer() { return m_peer
; }
122 static wxMenuItemImpl
* Create( wxMenuItem
* peer
, wxMenu
*pParentMenu
,
124 const wxString
& text
,
125 wxAcceleratorEntry
*entry
,
126 const wxString
& strHelp
,
133 DECLARE_ABSTRACT_CLASS(wxMenuItemImpl
);
136 class wxMenuImpl
: public wxObject
139 wxMenuImpl( wxMenu
* peer
) : m_peer(peer
)
143 virtual ~wxMenuImpl() ;
144 virtual void InsertOrAppend(wxMenuItem
*pItem
, size_t pos
) = 0;
145 virtual void Remove( wxMenuItem
*pItem
) = 0;
147 virtual void MakeRoot() = 0;
149 virtual void SetTitle( const wxString
& text
) = 0;
151 virtual WXHMENU
GetHMenu() = 0;
153 wxMenu
* GetWXPeer() { return m_peer
; }
155 virtual void PopUp( wxWindow
*win
, int x
, int y
) = 0;
157 static wxMenuImpl
* Create( wxMenu
* peer
, const wxString
& title
);
158 static wxMenuImpl
* CreateRootMenu( wxMenu
* peer
);
162 DECLARE_ABSTRACT_CLASS(wxMenuItemImpl
);
167 class WXDLLIMPEXP_CORE wxWidgetImpl
: public wxObject
170 wxWidgetImpl( wxWindowMac
* peer
, bool isRootControl
= false );
172 virtual ~wxWidgetImpl();
176 bool IsRootControl() const { return m_isRootControl
; }
178 wxWindowMac
* GetWXPeer() const { return m_wxPeer
; }
180 bool IsOk() const { return GetWXWidget() != NULL
; }
182 // not only the control itself, but also all its parents must be visible
183 // in order for this function to return true
184 virtual bool IsVisible() const = 0;
185 // set the visibility of this widget (maybe latent)
186 virtual void SetVisibility( bool visible
) = 0;
188 virtual void Raise() = 0;
190 virtual void Lower() = 0;
192 virtual void ScrollRect( const wxRect
*rect
, int dx
, int dy
) = 0;
194 virtual WXWidget
GetWXWidget() const = 0;
196 virtual void SetBackgroundColour( const wxColour
& col
) = 0;
198 // all coordinates in native parent widget relative coordinates
199 virtual void GetContentArea( int &left
, int &top
, int &width
, int &height
) const = 0;
200 virtual void Move(int x
, int y
, int width
, int height
) = 0;
201 virtual void GetPosition( int &x
, int &y
) const = 0;
202 virtual void GetSize( int &width
, int &height
) const = 0;
203 virtual void SetControlSize( wxWindowVariant variant
) = 0;
205 virtual void SetNeedsDisplay( const wxRect
* where
= NULL
) = 0;
206 virtual bool GetNeedsDisplay() const = 0;
208 virtual bool NeedsFocusRect() const;
209 virtual void SetNeedsFocusRect( bool needs
);
211 virtual bool CanFocus() const = 0;
212 // return true if successful
213 virtual bool SetFocus() = 0;
214 virtual bool HasFocus() const = 0;
216 virtual void RemoveFromParent() = 0;
217 virtual void Embed( wxWidgetImpl
*parent
) = 0;
219 virtual void SetDefaultButton( bool isDefault
) = 0;
220 virtual void PerformClick() = 0;
221 virtual void SetLabel( const wxString
& title
, wxFontEncoding encoding
) = 0;
223 virtual wxInt32
GetValue() const = 0;
224 virtual void SetValue( wxInt32 v
) = 0;
225 virtual void SetBitmap( const wxBitmap
& bitmap
) = 0;
226 virtual void SetupTabs( const wxNotebook
¬ebook
) =0;
227 virtual void GetBestRect( wxRect
*r
) const = 0;
228 virtual bool IsEnabled() const = 0;
229 virtual void Enable( bool enable
) = 0;
230 virtual void SetMinimum( wxInt32 v
) = 0;
231 virtual void SetMaximum( wxInt32 v
) = 0;
232 virtual void PulseGauge() = 0;
233 virtual void SetScrollThumb( wxInt32 value
, wxInt32 thumbSize
) = 0;
235 virtual void SetFont( const wxFont
& font
, const wxColour
& foreground
, long windowStyle
, bool ignoreBlack
= true ) = 0;
237 // is the clicked event sent AFTER the state already changed, so no additional
238 // state changing logic is required from the outside
239 virtual bool ButtonClickDidStateChange() = 0;
241 virtual void InstallEventHandler( WXWidget control
= NULL
) = 0;
243 // static methods for associating native controls and their implementations
246 FindFromWXWidget(WXWidget control
);
248 static void RemoveAssociations( wxWidgetImpl
* impl
);
250 static void Associate( WXWidget control
, wxWidgetImpl
*impl
);
252 // static creation methods, must be implemented by all toolkits
254 static wxWidgetImplType
* CreateUserPane( wxWindowMac
* wxpeer
,
261 static wxWidgetImplType
* CreateContentView( wxNonOwnedWindow
* now
) ;
263 static wxWidgetImplType
* CreateButton( wxWindowMac
* wxpeer
,
266 const wxString
& label
,
272 static wxWidgetImplType
* CreateDisclosureTriangle( wxWindowMac
* wxpeer
,
275 const wxString
& label
,
281 static wxWidgetImplType
* CreateStaticLine( wxWindowMac
* wxpeer
,
289 static wxWidgetImplType
* CreateGroupBox( wxWindowMac
* wxpeer
,
292 const wxString
& label
,
298 static wxWidgetImplType
* CreateStaticText( wxWindowMac
* wxpeer
,
301 const wxString
& label
,
307 static wxWidgetImplType
* CreateTextControl( wxTextCtrl
* wxpeer
,
310 const wxString
& content
,
316 static wxWidgetImplType
* CreateSearchControl( wxTextCtrl
* wxpeer
,
319 const wxString
& content
,
325 static wxWidgetImplType
* CreateCheckBox( wxWindowMac
* wxpeer
,
328 const wxString
& label
,
334 static wxWidgetImplType
* CreateRadioButton( wxWindowMac
* wxpeer
,
337 const wxString
& label
,
343 static wxWidgetImplType
* CreateToggleButton( wxWindowMac
* wxpeer
,
346 const wxString
& label
,
352 static wxWidgetImplType
* CreateBitmapToggleButton( wxWindowMac
* wxpeer
,
355 const wxBitmap
& bitmap
,
361 static wxWidgetImplType
* CreateBitmapButton( wxWindowMac
* wxpeer
,
364 const wxBitmap
& bitmap
,
370 static wxWidgetImplType
* CreateTabView( wxWindowMac
* wxpeer
,
378 static wxWidgetImplType
* CreateGauge( wxWindowMac
* wxpeer
,
389 static wxWidgetImplType
* CreateSlider( wxWindowMac
* wxpeer
,
400 static wxWidgetImplType
* CreateSpinButton( wxWindowMac
* wxpeer
,
411 static wxWidgetImplType
* CreateScrollBar( wxWindowMac
* wxpeer
,
419 static wxWidgetImplType
* CreateChoice( wxWindowMac
* wxpeer
,
428 static wxWidgetImplType
* CreateListBox( wxWindowMac
* wxpeer
,
436 // converts from Toplevel-Content relative to local
437 static void Convert( wxPoint
*pt
, wxWidgetImpl
*from
, wxWidgetImpl
*to
);
439 bool m_isRootControl
;
440 wxWindowMac
* m_wxPeer
;
441 bool m_needsFocusRect
;
443 DECLARE_ABSTRACT_CLASS(wxWidgetImpl
)
447 // the interface to be implemented eg by a listbox
450 class WXDLLIMPEXP_CORE wxListWidgetColumn
453 virtual ~wxListWidgetColumn() {}
456 class WXDLLIMPEXP_CORE wxListWidgetCellValue
459 wxListWidgetCellValue() {}
460 virtual ~wxListWidgetCellValue() {}
462 virtual void Set( CFStringRef value
) = 0;
463 virtual void Set( const wxString
& value
) = 0;
464 virtual void Set( int value
) = 0;
466 virtual int GetIntValue() const = 0;
467 virtual wxString
GetStringValue() const = 0;
470 class WXDLLIMPEXP_CORE wxListWidgetImpl
473 wxListWidgetImpl() {}
474 virtual ~wxListWidgetImpl() { }
476 virtual wxListWidgetColumn
* InsertTextColumn( unsigned pos
, const wxString
& title
, bool editable
= false,
477 wxAlignment just
= wxALIGN_LEFT
, int defaultWidth
= -1) = 0 ;
478 virtual wxListWidgetColumn
* InsertCheckColumn( unsigned pos
, const wxString
& title
, bool editable
= false,
479 wxAlignment just
= wxALIGN_LEFT
, int defaultWidth
= -1) = 0 ;
483 // TODO will be replaced
484 virtual void ListDelete( unsigned int n
) = 0;
485 virtual void ListInsert( unsigned int n
) = 0;
486 virtual void ListClear() = 0;
490 virtual void ListDeselectAll() = 0;
491 virtual void ListSetSelection( unsigned int n
, bool select
, bool multi
) = 0;
492 virtual int ListGetSelection() const = 0;
493 virtual int ListGetSelections( wxArrayInt
& aSelections
) const = 0;
494 virtual bool ListIsSelected( unsigned int n
) const = 0;
498 virtual void ListScrollTo( unsigned int n
) = 0;
499 virtual void UpdateLine( unsigned int n
, wxListWidgetColumn
* col
= NULL
) = 0;
500 virtual void UpdateLineToEnd( unsigned int n
) = 0;
504 virtual unsigned int ListGetCount() const = 0;
508 // interface to be implemented by a textcontrol
511 class WXDLLIMPEXP_FWD_CORE wxTextAttr
;
513 // common interface for all implementations
514 class WXDLLIMPEXP_CORE wxTextWidgetImpl
518 wxTextWidgetImpl() {}
520 virtual ~wxTextWidgetImpl() {}
522 virtual bool CanFocus() const { return true; }
524 virtual wxString
GetStringValue() const = 0 ;
525 virtual void SetStringValue( const wxString
&val
) = 0 ;
526 virtual void SetSelection( long from
, long to
) = 0 ;
527 virtual void GetSelection( long* from
, long* to
) const = 0 ;
528 virtual void WriteText( const wxString
& str
) = 0 ;
530 virtual void SetStyle( long start
, long end
, const wxTextAttr
& style
) ;
531 virtual void Copy() ;
533 virtual void Paste() ;
534 virtual bool CanPaste() const ;
535 virtual void SetEditable( bool editable
) ;
536 virtual long GetLastPosition() const ;
537 virtual void Replace( long from
, long to
, const wxString
&str
) ;
538 virtual void Remove( long from
, long to
) ;
541 virtual bool HasOwnContextMenu() const
544 virtual bool SetupCursor( const wxPoint
& WXUNUSED(pt
) )
547 virtual void Clear() ;
548 virtual bool CanUndo() const;
549 virtual void Undo() ;
550 virtual bool CanRedo() const;
551 virtual void Redo() ;
552 virtual int GetNumberOfLines() const ;
553 virtual long XYToPosition(long x
, long y
) const;
554 virtual bool PositionToXY(long pos
, long *x
, long *y
) const ;
555 virtual void ShowPosition(long WXUNUSED(pos
)) ;
556 virtual int GetLineLength(long lineNo
) const ;
557 virtual wxString
GetLineText(long lineNo
) const ;
558 virtual void CheckSpelling(bool WXUNUSED(check
)) { }
562 // common interface for search controls
565 class wxSearchWidgetImpl
568 wxSearchWidgetImpl(){}
569 virtual ~wxSearchWidgetImpl(){}
571 // search field options
572 virtual void ShowSearchButton( bool show
) = 0;
573 virtual bool IsSearchButtonVisible() const = 0;
575 virtual void ShowCancelButton( bool show
) = 0;
576 virtual bool IsCancelButtonVisible() const = 0;
578 virtual void SetSearchMenu( wxMenu
* menu
) = 0;
580 virtual void SetDescriptiveText(const wxString
& text
) = 0;
584 // toplevel window implementation class
587 class wxNonOwnedWindowImpl
: public wxObject
590 wxNonOwnedWindowImpl( wxNonOwnedWindow
* nonownedwnd
) : m_wxPeer(nonownedwnd
)
593 wxNonOwnedWindowImpl()
596 virtual ~wxNonOwnedWindowImpl()
600 virtual void Destroy()
604 virtual void Create( wxWindow
* parent
, const wxPoint
& pos
, const wxSize
& size
,
605 long style
, long extraStyle
, const wxString
& name
) = 0;
608 virtual WXWindow
GetWXWindow() const = 0;
618 virtual bool Show(bool WXUNUSED(show
))
623 virtual bool ShowWithEffect(bool show
, wxShowEffect
WXUNUSED(effect
), unsigned WXUNUSED(timeout
))
628 virtual void Update()
632 virtual bool SetTransparent(wxByte
WXUNUSED(alpha
))
637 virtual bool SetBackgroundColour(const wxColour
& WXUNUSED(col
) )
642 virtual void SetExtraStyle( long WXUNUSED(exStyle
) )
646 virtual bool SetBackgroundStyle(wxBackgroundStyle
WXUNUSED(style
))
651 bool CanSetTransparent()
656 virtual void GetContentArea( int &left
, int &top
, int &width
, int &height
) const = 0;
657 virtual void MoveWindow(int x
, int y
, int width
, int height
) = 0;
658 virtual void GetPosition( int &x
, int &y
) const = 0;
659 virtual void GetSize( int &width
, int &height
) const = 0;
661 virtual bool SetShape(const wxRegion
& WXUNUSED(region
))
666 virtual void SetTitle( const wxString
& title
, wxFontEncoding encoding
) = 0;
668 virtual bool IsMaximized() const = 0;
670 virtual bool IsIconized() const= 0;
672 virtual void Iconize( bool iconize
)= 0;
674 virtual void Maximize(bool maximize
) = 0;
676 virtual bool IsFullScreen() const= 0;
678 virtual bool ShowFullScreen(bool show
, long style
)= 0;
680 virtual void RequestUserAttention(int flags
) = 0;
682 virtual void ScreenToWindow( int *x
, int *y
) = 0;
684 virtual void WindowToScreen( int *x
, int *y
) = 0;
686 wxNonOwnedWindow
* GetWXPeer() { return m_wxPeer
; }
688 // static creation methods, must be implemented by all toolkits
690 static wxNonOwnedWindowImpl
* CreateNonOwnedWindow( wxNonOwnedWindow
* wxpeer
, wxWindow
* parent
, const wxPoint
& pos
, const wxSize
& size
,
691 long style
, long extraStyle
, const wxString
& name
) ;
694 wxNonOwnedWindow
* m_wxPeer
;
695 DECLARE_ABSTRACT_CLASS(wxNonOwnedWindowImpl
)
700 //---------------------------------------------------------------------------
701 // cocoa bridging utilities
702 //---------------------------------------------------------------------------
704 bool wxMacInitCocoa();
706 class WXDLLIMPEXP_CORE wxMacAutoreleasePool
709 wxMacAutoreleasePool();
710 ~wxMacAutoreleasePool();
717 void wxMacCocoaRelease( void* obj
);
718 void wxMacCocoaAutorelease( void* obj
);
719 void wxMacCocoaRetain( void* obj
);
723 // _WX_PRIVATE_CORE_H_