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 void SetCursor( const wxCursor
& cursor
) = 0;
224 virtual void CaptureMouse() = 0;
225 virtual void ReleaseMouse() = 0;
227 virtual wxInt32
GetValue() const = 0;
228 virtual void SetValue( wxInt32 v
) = 0;
229 virtual void SetBitmap( const wxBitmap
& bitmap
) = 0;
230 virtual void SetupTabs( const wxNotebook
¬ebook
) =0;
231 virtual void GetBestRect( wxRect
*r
) const = 0;
232 virtual bool IsEnabled() const = 0;
233 virtual void Enable( bool enable
) = 0;
234 virtual void SetMinimum( wxInt32 v
) = 0;
235 virtual void SetMaximum( wxInt32 v
) = 0;
236 virtual void PulseGauge() = 0;
237 virtual void SetScrollThumb( wxInt32 value
, wxInt32 thumbSize
) = 0;
239 virtual void SetFont( const wxFont
& font
, const wxColour
& foreground
, long windowStyle
, bool ignoreBlack
= true ) = 0;
241 // is the clicked event sent AFTER the state already changed, so no additional
242 // state changing logic is required from the outside
243 virtual bool ButtonClickDidStateChange() = 0;
245 virtual void InstallEventHandler( WXWidget control
= NULL
) = 0;
247 // static methods for associating native controls and their implementations
250 FindFromWXWidget(WXWidget control
);
252 static void RemoveAssociations( wxWidgetImpl
* impl
);
254 static void Associate( WXWidget control
, wxWidgetImpl
*impl
);
256 // static creation methods, must be implemented by all toolkits
258 static wxWidgetImplType
* CreateUserPane( wxWindowMac
* wxpeer
,
265 static wxWidgetImplType
* CreateContentView( wxNonOwnedWindow
* now
) ;
267 static wxWidgetImplType
* CreateButton( wxWindowMac
* wxpeer
,
270 const wxString
& label
,
276 static wxWidgetImplType
* CreateDisclosureTriangle( wxWindowMac
* wxpeer
,
279 const wxString
& label
,
285 static wxWidgetImplType
* CreateStaticLine( wxWindowMac
* wxpeer
,
293 static wxWidgetImplType
* CreateGroupBox( wxWindowMac
* wxpeer
,
296 const wxString
& label
,
302 static wxWidgetImplType
* CreateStaticText( wxWindowMac
* wxpeer
,
305 const wxString
& label
,
311 static wxWidgetImplType
* CreateTextControl( wxTextCtrl
* wxpeer
,
314 const wxString
& content
,
320 static wxWidgetImplType
* CreateSearchControl( wxTextCtrl
* wxpeer
,
323 const wxString
& content
,
329 static wxWidgetImplType
* CreateCheckBox( wxWindowMac
* wxpeer
,
332 const wxString
& label
,
338 static wxWidgetImplType
* CreateRadioButton( wxWindowMac
* wxpeer
,
341 const wxString
& label
,
347 static wxWidgetImplType
* CreateToggleButton( wxWindowMac
* wxpeer
,
350 const wxString
& label
,
356 static wxWidgetImplType
* CreateBitmapToggleButton( wxWindowMac
* wxpeer
,
359 const wxBitmap
& bitmap
,
365 static wxWidgetImplType
* CreateBitmapButton( wxWindowMac
* wxpeer
,
368 const wxBitmap
& bitmap
,
374 static wxWidgetImplType
* CreateTabView( wxWindowMac
* wxpeer
,
382 static wxWidgetImplType
* CreateGauge( wxWindowMac
* wxpeer
,
393 static wxWidgetImplType
* CreateSlider( wxWindowMac
* wxpeer
,
404 static wxWidgetImplType
* CreateSpinButton( wxWindowMac
* wxpeer
,
415 static wxWidgetImplType
* CreateScrollBar( wxWindowMac
* wxpeer
,
423 static wxWidgetImplType
* CreateChoice( wxWindowMac
* wxpeer
,
432 static wxWidgetImplType
* CreateListBox( wxWindowMac
* wxpeer
,
440 // converts from Toplevel-Content relative to local
441 static void Convert( wxPoint
*pt
, wxWidgetImpl
*from
, wxWidgetImpl
*to
);
443 bool m_isRootControl
;
444 wxWindowMac
* m_wxPeer
;
445 bool m_needsFocusRect
;
447 DECLARE_ABSTRACT_CLASS(wxWidgetImpl
)
451 // the interface to be implemented eg by a listbox
454 class WXDLLIMPEXP_CORE wxListWidgetColumn
457 virtual ~wxListWidgetColumn() {}
460 class WXDLLIMPEXP_CORE wxListWidgetCellValue
463 wxListWidgetCellValue() {}
464 virtual ~wxListWidgetCellValue() {}
466 virtual void Set( CFStringRef value
) = 0;
467 virtual void Set( const wxString
& value
) = 0;
468 virtual void Set( int value
) = 0;
470 virtual int GetIntValue() const = 0;
471 virtual wxString
GetStringValue() const = 0;
474 class WXDLLIMPEXP_CORE wxListWidgetImpl
477 wxListWidgetImpl() {}
478 virtual ~wxListWidgetImpl() { }
480 virtual wxListWidgetColumn
* InsertTextColumn( unsigned pos
, const wxString
& title
, bool editable
= false,
481 wxAlignment just
= wxALIGN_LEFT
, int defaultWidth
= -1) = 0 ;
482 virtual wxListWidgetColumn
* InsertCheckColumn( unsigned pos
, const wxString
& title
, bool editable
= false,
483 wxAlignment just
= wxALIGN_LEFT
, int defaultWidth
= -1) = 0 ;
487 // TODO will be replaced
488 virtual void ListDelete( unsigned int n
) = 0;
489 virtual void ListInsert( unsigned int n
) = 0;
490 virtual void ListClear() = 0;
494 virtual void ListDeselectAll() = 0;
495 virtual void ListSetSelection( unsigned int n
, bool select
, bool multi
) = 0;
496 virtual int ListGetSelection() const = 0;
497 virtual int ListGetSelections( wxArrayInt
& aSelections
) const = 0;
498 virtual bool ListIsSelected( unsigned int n
) const = 0;
502 virtual void ListScrollTo( unsigned int n
) = 0;
503 virtual void UpdateLine( unsigned int n
, wxListWidgetColumn
* col
= NULL
) = 0;
504 virtual void UpdateLineToEnd( unsigned int n
) = 0;
508 virtual unsigned int ListGetCount() const = 0;
512 // interface to be implemented by a textcontrol
515 class WXDLLIMPEXP_FWD_CORE wxTextAttr
;
517 // common interface for all implementations
518 class WXDLLIMPEXP_CORE wxTextWidgetImpl
522 wxTextWidgetImpl() {}
524 virtual ~wxTextWidgetImpl() {}
526 virtual bool CanFocus() const { return true; }
528 virtual wxString
GetStringValue() const = 0 ;
529 virtual void SetStringValue( const wxString
&val
) = 0 ;
530 virtual void SetSelection( long from
, long to
) = 0 ;
531 virtual void GetSelection( long* from
, long* to
) const = 0 ;
532 virtual void WriteText( const wxString
& str
) = 0 ;
534 virtual void SetStyle( long start
, long end
, const wxTextAttr
& style
) ;
535 virtual void Copy() ;
537 virtual void Paste() ;
538 virtual bool CanPaste() const ;
539 virtual void SetEditable( bool editable
) ;
540 virtual long GetLastPosition() const ;
541 virtual void Replace( long from
, long to
, const wxString
&str
) ;
542 virtual void Remove( long from
, long to
) ;
545 virtual bool HasOwnContextMenu() const
548 virtual bool SetupCursor( const wxPoint
& WXUNUSED(pt
) )
551 virtual void Clear() ;
552 virtual bool CanUndo() const;
553 virtual void Undo() ;
554 virtual bool CanRedo() const;
555 virtual void Redo() ;
556 virtual int GetNumberOfLines() const ;
557 virtual long XYToPosition(long x
, long y
) const;
558 virtual bool PositionToXY(long pos
, long *x
, long *y
) const ;
559 virtual void ShowPosition(long WXUNUSED(pos
)) ;
560 virtual int GetLineLength(long lineNo
) const ;
561 virtual wxString
GetLineText(long lineNo
) const ;
562 virtual void CheckSpelling(bool WXUNUSED(check
)) { }
566 // common interface for search controls
569 class wxSearchWidgetImpl
572 wxSearchWidgetImpl(){}
573 virtual ~wxSearchWidgetImpl(){}
575 // search field options
576 virtual void ShowSearchButton( bool show
) = 0;
577 virtual bool IsSearchButtonVisible() const = 0;
579 virtual void ShowCancelButton( bool show
) = 0;
580 virtual bool IsCancelButtonVisible() const = 0;
582 virtual void SetSearchMenu( wxMenu
* menu
) = 0;
584 virtual void SetDescriptiveText(const wxString
& text
) = 0;
588 // toplevel window implementation class
591 class wxNonOwnedWindowImpl
: public wxObject
594 wxNonOwnedWindowImpl( wxNonOwnedWindow
* nonownedwnd
) : m_wxPeer(nonownedwnd
)
597 wxNonOwnedWindowImpl()
600 virtual ~wxNonOwnedWindowImpl()
604 virtual void Destroy()
608 virtual void Create( wxWindow
* parent
, const wxPoint
& pos
, const wxSize
& size
,
609 long style
, long extraStyle
, const wxString
& name
) = 0;
612 virtual WXWindow
GetWXWindow() const = 0;
622 virtual bool Show(bool WXUNUSED(show
))
627 virtual bool ShowWithEffect(bool show
, wxShowEffect
WXUNUSED(effect
), unsigned WXUNUSED(timeout
))
632 virtual void Update()
636 virtual bool SetTransparent(wxByte
WXUNUSED(alpha
))
641 virtual bool SetBackgroundColour(const wxColour
& WXUNUSED(col
) )
646 virtual void SetExtraStyle( long WXUNUSED(exStyle
) )
650 virtual bool SetBackgroundStyle(wxBackgroundStyle
WXUNUSED(style
))
655 bool CanSetTransparent()
660 virtual void GetContentArea( int &left
, int &top
, int &width
, int &height
) const = 0;
661 virtual void MoveWindow(int x
, int y
, int width
, int height
) = 0;
662 virtual void GetPosition( int &x
, int &y
) const = 0;
663 virtual void GetSize( int &width
, int &height
) const = 0;
665 virtual bool SetShape(const wxRegion
& WXUNUSED(region
))
670 virtual void SetTitle( const wxString
& title
, wxFontEncoding encoding
) = 0;
672 virtual bool IsMaximized() const = 0;
674 virtual bool IsIconized() const= 0;
676 virtual void Iconize( bool iconize
)= 0;
678 virtual void Maximize(bool maximize
) = 0;
680 virtual bool IsFullScreen() const= 0;
682 virtual bool ShowFullScreen(bool show
, long style
)= 0;
684 virtual void RequestUserAttention(int flags
) = 0;
686 virtual void ScreenToWindow( int *x
, int *y
) = 0;
688 virtual void WindowToScreen( int *x
, int *y
) = 0;
690 wxNonOwnedWindow
* GetWXPeer() { return m_wxPeer
; }
692 // static creation methods, must be implemented by all toolkits
694 static wxNonOwnedWindowImpl
* CreateNonOwnedWindow( wxNonOwnedWindow
* wxpeer
, wxWindow
* parent
, const wxPoint
& pos
, const wxSize
& size
,
695 long style
, long extraStyle
, const wxString
& name
) ;
698 wxNonOwnedWindow
* m_wxPeer
;
699 DECLARE_ABSTRACT_CLASS(wxNonOwnedWindowImpl
)
704 //---------------------------------------------------------------------------
705 // cocoa bridging utilities
706 //---------------------------------------------------------------------------
708 bool wxMacInitCocoa();
710 class WXDLLIMPEXP_CORE wxMacAutoreleasePool
713 wxMacAutoreleasePool();
714 ~wxMacAutoreleasePool();
721 void wxMacCocoaRelease( void* obj
);
722 void wxMacCocoaAutorelease( void* obj
);
723 void wxMacCocoaRetain( void* obj
);
727 // _WX_PRIVATE_CORE_H_