Avoid unrealizing a frozen window

[wxWidgets.git] / include / wx / osx / core / private.h

diff --git a/include/wx/osx/core/private.h b/include/wx/osx/core/private.h
index b6df304840f44bf76e8f3292f1f47556b3866798..9961aaab05fa62d52c8a6ec5fe411e3d0c3241f3 100644 (file)
--- a/include/wx/osx/core/private.h
+++ b/include/wx/osx/core/private.h
@@ -6,7 +6,7 @@
 // Author:      Stefan Csomor
 // Modified by:
 // Created:     1998-01-01
 // Author:      Stefan Csomor
 // Modified by:
 // Created:     1998-01-01

-// RCS-ID:      $Id: private.h 53819 2008-05-29 14:11:45Z SC $
+// RCS-ID:      $Id$

 // Copyright:   (c) Stefan Csomor
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) Stefan Csomor
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////


@@ -21,13 +21,54 @@
 #include "wx/osx/core/cfstring.h"
 #include "wx/osx/core/cfdataref.h"
 
 #include "wx/osx/core/cfstring.h"
 #include "wx/osx/core/cfdataref.h"
 

-#if wxOSX_USE_COCOA_OR_CARBON
+// Define helper macros allowing to insert small snippets of code to be
+// compiled for high enough OS X version only: this shouldn't be abused for
+// anything big but it's handy for e.g. specifying OS X 10.6-only protocols in
+// the Objective C classes declarations when they're not supported under the
+// previous versions
+#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
+    #define wxOSX_10_6_AND_LATER(x) x
+#else
+    #define wxOSX_10_6_AND_LATER(x)
+#endif
+
+// platform specific Clang analyzer support
+#ifndef NS_RETURNS_RETAINED
+#   if WX_HAS_CLANG_FEATURE(attribute_ns_returns_retained)
+#       define NS_RETURNS_RETAINED __attribute__((ns_returns_retained))
+#   else
+#       define NS_RETURNS_RETAINED
+#   endif
+#endif
+
+#ifndef CF_RETURNS_RETAINED
+#   if WX_HAS_CLANG_FEATURE(attribute_cf_returns_retained)
+#       define CF_RETURNS_RETAINED __attribute__((cf_returns_retained))
+#   else
+#       define CF_RETURNS_RETAINED
+#   endif
+#endif
+
+#if ( !wxUSE_GUI && !wxOSX_USE_IPHONE ) || wxOSX_USE_COCOA_OR_CARBON
+
+// Carbon functions are currently still used in wxOSX/Cocoa too (including
+// wxBase part of it).
+#include <Carbon/Carbon.h>

 
 WXDLLIMPEXP_BASE long UMAGetSystemVersion() ;
 
 void WXDLLIMPEXP_CORE wxMacStringToPascal( const wxString&from , unsigned char * to );
 wxString WXDLLIMPEXP_CORE wxMacMakeStringFromPascal( const unsigned char * from );
 
 
 WXDLLIMPEXP_BASE long UMAGetSystemVersion() ;
 
 void WXDLLIMPEXP_CORE wxMacStringToPascal( const wxString&from , unsigned char * to );
 wxString WXDLLIMPEXP_CORE wxMacMakeStringFromPascal( const unsigned char * from );
 

+WXDLLIMPEXP_BASE wxString wxMacFSRefToPath( const FSRef *fsRef , CFStringRef additionalPathComponent = NULL );
+WXDLLIMPEXP_BASE OSStatus wxMacPathToFSRef( const wxString&path , FSRef *fsRef );
+WXDLLIMPEXP_BASE wxString wxMacHFSUniStrToString( ConstHFSUniStr255Param uniname );
+
+// keycode utils from app.cpp
+
+WXDLLIMPEXP_BASE CGKeyCode wxCharCodeWXToOSX(wxKeyCode code);
+WXDLLIMPEXP_BASE long wxMacTranslateKey(unsigned char key, unsigned char code);
+

 #endif
 
 #if wxUSE_GUI
 #endif
 
 #if wxUSE_GUI


@@ -92,8 +133,10 @@ class wxNonOwnedWindow;
 
 class wxMacControl;
 class wxWidgetImpl;
 
 class wxMacControl;
 class wxWidgetImpl;

+class wxComboBox;

 class wxNotebook;
 class wxTextCtrl;
 class wxNotebook;
 class wxTextCtrl;

+class wxSearchCtrl;

 
 WXDLLIMPEXP_CORE wxWindowMac * wxFindWindowFromWXWidget(WXWidget inControl );
 
 
 WXDLLIMPEXP_CORE wxWindowMac * wxFindWindowFromWXWidget(WXWidget inControl );
 


@@ -129,7 +172,9 @@ public :
                        const wxString& strHelp,
                        wxItemKind kind,
                        wxMenu *pSubMenu );
                        const wxString& strHelp,
                        wxItemKind kind,
                        wxMenu *pSubMenu );

-
+    
+    // handle OS specific menu items if they weren't handled during normal processing
+    virtual bool DoDefault() { return false; }

 protected :
     wxMenuItem* m_peer;
 
 protected :
     wxMenuItem* m_peer;
 


@@ -170,13 +215,15 @@ protected :
 class WXDLLIMPEXP_CORE wxWidgetImpl : public wxObject
 {
 public :
 class WXDLLIMPEXP_CORE wxWidgetImpl : public wxObject
 {
 public :

-    wxWidgetImpl( wxWindowMac* peer , bool isRootControl = false );
+    wxWidgetImpl( wxWindowMac* peer , bool isRootControl = false, bool isUserPane = false );

     wxWidgetImpl();
     virtual ~wxWidgetImpl();
 
     void Init();
 
     bool                IsRootControl() const { return m_isRootControl; }
     wxWidgetImpl();
     virtual ~wxWidgetImpl();
 
     void Init();
 
     bool                IsRootControl() const { return m_isRootControl; }

+    
+    bool                IsUserPane() const { return m_isUserPane; }

 
     wxWindowMac*        GetWXPeer() const { return m_wxPeer; }
 
 
     wxWindowMac*        GetWXPeer() const { return m_wxPeer; }
 


@@ -188,6 +235,13 @@ public :
     // set the visibility of this widget (maybe latent)
     virtual void        SetVisibility( bool visible ) = 0;
 
     // set the visibility of this widget (maybe latent)
     virtual void        SetVisibility( bool visible ) = 0;
 

+    virtual bool ShowWithEffect(bool WXUNUSED(show),
+                                wxShowEffect WXUNUSED(effect),
+                                unsigned WXUNUSED(timeout))
+    {
+        return false;
+    }
+

     virtual void        Raise() = 0;
 
     virtual void        Lower() = 0;
     virtual void        Raise() = 0;
 
     virtual void        Lower() = 0;


@@ -197,6 +251,7 @@ public :
     virtual WXWidget    GetWXWidget() const = 0;
 
     virtual void        SetBackgroundColour( const wxColour& col ) = 0;
     virtual WXWidget    GetWXWidget() const = 0;
 
     virtual void        SetBackgroundColour( const wxColour& col ) = 0;

+    virtual bool        SetBackgroundStyle(wxBackgroundStyle style) = 0;

 
     // all coordinates in native parent widget relative coordinates
     virtual void        GetContentArea( int &left , int &top , int &width , int &height ) const = 0;
 
     // all coordinates in native parent widget relative coordinates
     virtual void        GetContentArea( int &left , int &top , int &width , int &height ) const = 0;


@@ -204,6 +259,17 @@ public :
     virtual void        GetPosition( int &x, int &y ) const = 0;
     virtual void        GetSize( int &width, int &height ) const = 0;
     virtual void        SetControlSize( wxWindowVariant variant ) = 0;
     virtual void        GetPosition( int &x, int &y ) const = 0;
     virtual void        GetSize( int &width, int &height ) const = 0;
     virtual void        SetControlSize( wxWindowVariant variant ) = 0;

+    virtual float       GetContentScaleFactor() const 
+    {
+        return 1.0;
+    }
+    
+    // the native coordinates may have an 'aura' for shadows etc, if this is the case the layout
+    // inset indicates on which insets the real control is drawn
+    virtual void        GetLayoutInset(int &left , int &top , int &right, int &bottom) const
+    {
+        left = top = right = bottom = 0;
+    }

 
     // native view coordinates are topleft to bottom right (flipped regarding CoreGraphics origin)
     virtual bool        IsFlipped() const { return true; }
 
     // native view coordinates are topleft to bottom right (flipped regarding CoreGraphics origin)
     virtual bool        IsFlipped() const { return true; }


@@ -228,10 +294,15 @@ public :
     virtual void        SetDefaultButton( bool isDefault ) = 0;
     virtual void        PerformClick() = 0;
     virtual void        SetLabel( const wxString& title, wxFontEncoding encoding ) = 0;
     virtual void        SetDefaultButton( bool isDefault ) = 0;
     virtual void        PerformClick() = 0;
     virtual void        SetLabel( const wxString& title, wxFontEncoding encoding ) = 0;

+#if wxUSE_MARKUP && wxOSX_USE_COCOA
+    virtual void        SetLabelMarkup( const wxString& WXUNUSED(markup) ) { }
+#endif

 
     virtual void        SetCursor( const wxCursor & cursor ) = 0;
     virtual void        CaptureMouse() = 0;
     virtual void        ReleaseMouse() = 0;
 
     virtual void        SetCursor( const wxCursor & cursor ) = 0;
     virtual void        CaptureMouse() = 0;
     virtual void        ReleaseMouse() = 0;

+    
+    virtual void        SetDropTarget( wxDropTarget * WXUNUSED(dropTarget) ) {}

 
     virtual wxInt32     GetValue() const = 0;
     virtual void        SetValue( wxInt32 v ) = 0;
 
     virtual wxInt32     GetValue() const = 0;
     virtual void        SetValue( wxInt32 v ) = 0;


@@ -251,12 +322,20 @@ public :
 
     virtual void        SetFont( const wxFont & font , const wxColour& foreground , long windowStyle, bool ignoreBlack = true ) = 0;
 
 
     virtual void        SetFont( const wxFont & font , const wxColour& foreground , long windowStyle, bool ignoreBlack = true ) = 0;
 

+    virtual void        SetToolTip(wxToolTip* WXUNUSED(tooltip)) { }
+

     // is the clicked event sent AFTER the state already changed, so no additional
     // state changing logic is required from the outside
     virtual bool        ButtonClickDidStateChange() = 0;
 
     virtual void        InstallEventHandler( WXWidget control = NULL ) = 0;
 
     // is the clicked event sent AFTER the state already changed, so no additional
     // state changing logic is required from the outside
     virtual bool        ButtonClickDidStateChange() = 0;
 
     virtual void        InstallEventHandler( WXWidget control = NULL ) = 0;
 

+    // Mechanism used to keep track of whether a change should send an event
+    // Do SendEvents(false) when starting actions that would trigger programmatic events
+    // and SendEvents(true) at the end of the block.
+    virtual void        SendEvents(bool shouldSendEvents) { m_shouldSendEvents = shouldSendEvents; }
+    virtual bool        ShouldSendEvents() { return m_shouldSendEvents; }
+

     // static methods for associating native controls and their implementations
 
     static wxWidgetImpl*
     // static methods for associating native controls and their implementations
 
     static wxWidgetImpl*


@@ -332,7 +411,7 @@ public :
                                     long style,
                                     long extraStyle) ;
 
                                     long style,
                                     long extraStyle) ;
 

-    static wxWidgetImplType*    CreateSearchControl( wxTextCtrl* wxpeer,
+    static wxWidgetImplType*    CreateSearchControl( wxSearchCtrl* wxpeer,

                                     wxWindowMac* parent,
                                     wxWindowID id,
                                     const wxString& content,
                                     wxWindowMac* parent,
                                     wxWindowID id,
                                     const wxString& content,


@@ -452,13 +531,26 @@ public :
                                     long style,
                                     long extraStyle);
 
                                     long style,
                                     long extraStyle);
 

+#if wxOSX_USE_COCOA
+    static wxWidgetImplType*    CreateComboBox( wxComboBox* wxpeer,
+                                    wxWindowMac* parent,
+                                    wxWindowID id,
+                                    wxMenu* menu,
+                                    const wxPoint& pos,
+                                    const wxSize& size,
+                                    long style,
+                                    long extraStyle);
+#endif
+

     // converts from Toplevel-Content relative to local
     static void Convert( wxPoint *pt , wxWidgetImpl *from , wxWidgetImpl *to );
 protected :
     bool                m_isRootControl;
     // converts from Toplevel-Content relative to local
     static void Convert( wxPoint *pt , wxWidgetImpl *from , wxWidgetImpl *to );
 protected :
     bool                m_isRootControl;

+    bool                m_isUserPane;

     wxWindowMac*        m_wxPeer;
     bool                m_needsFocusRect;
     bool                m_needsFrame;
     wxWindowMac*        m_wxPeer;
     bool                m_needsFocusRect;
     bool                m_needsFrame;

+    bool                m_shouldSendEvents;

 
     DECLARE_ABSTRACT_CLASS(wxWidgetImpl)
 };
 
     DECLARE_ABSTRACT_CLASS(wxWidgetImpl)
 };


@@ -524,6 +616,8 @@ public:
     // accessing content
 
     virtual unsigned int    ListGetCount() const = 0;
     // accessing content
 
     virtual unsigned int    ListGetCount() const = 0;

+
+    virtual int             DoListHitTest( const wxPoint& inpoint ) const = 0;

 };
 
 //
 };
 
 //


@@ -531,16 +625,23 @@ public:
 //
 
 class WXDLLIMPEXP_FWD_CORE wxTextAttr;
 //
 
 class WXDLLIMPEXP_FWD_CORE wxTextAttr;

+class WXDLLIMPEXP_FWD_CORE wxTextEntry;

 
 // common interface for all implementations
 class WXDLLIMPEXP_CORE wxTextWidgetImpl
 
 {
 public :
 
 // common interface for all implementations
 class WXDLLIMPEXP_CORE wxTextWidgetImpl
 
 {
 public :

-    wxTextWidgetImpl() {}
+    // Any widgets implementing this interface must be associated with a
+    // wxTextEntry so instead of requiring the derived classes to implement
+    // another (pure) virtual function, just take the pointer to this entry in
+    // our ctor and implement GetTextEntry() ourselves.
+    wxTextWidgetImpl(wxTextEntry *entry) : m_entry(entry) {}

 
     virtual ~wxTextWidgetImpl() {}
 
 
     virtual ~wxTextWidgetImpl() {}
 

+    wxTextEntry *GetTextEntry() const { return m_entry; }
+

     virtual bool CanFocus() const { return true; }
 
     virtual wxString GetStringValue() const = 0 ;
     virtual bool CanFocus() const { return true; }
 
     virtual wxString GetStringValue() const = 0 ;


@@ -549,6 +650,10 @@ public :
     virtual void GetSelection( long* from, long* to ) const = 0 ;
     virtual void WriteText( const wxString& str ) = 0 ;
 
     virtual void GetSelection( long* from, long* to ) const = 0 ;
     virtual void WriteText( const wxString& str ) = 0 ;
 

+    virtual bool CanClipMaxLength() const { return false; }
+    virtual void SetMaxLength(unsigned long WXUNUSED(len)) {}
+    
+    virtual bool GetStyle( long position, wxTextAttr& style);

     virtual void SetStyle( long start, long end, const wxTextAttr& style ) ;
     virtual void Copy() ;
     virtual void Cut() ;
     virtual void SetStyle( long start, long end, const wxTextAttr& style ) ;
     virtual void Copy() ;
     virtual void Cut() ;


@@ -578,8 +683,56 @@ public :
     virtual int GetLineLength(long lineNo) const ;
     virtual wxString GetLineText(long lineNo) const ;
     virtual void CheckSpelling(bool WXUNUSED(check)) { }
     virtual int GetLineLength(long lineNo) const ;
     virtual wxString GetLineText(long lineNo) const ;
     virtual void CheckSpelling(bool WXUNUSED(check)) { }

+
+    virtual wxSize GetBestSize() const { return wxDefaultSize; }
+
+    virtual bool SetHint(const wxString& WXUNUSED(hint)) { return false; }
+private:
+    wxTextEntry * const m_entry;
+
+    wxDECLARE_NO_COPY_CLASS(wxTextWidgetImpl);
+};
+
+// common interface for all implementations
+class WXDLLIMPEXP_CORE wxComboWidgetImpl
+
+{
+public :
+    wxComboWidgetImpl() {}
+
+    virtual ~wxComboWidgetImpl() {}
+
+    virtual int GetSelectedItem() const { return -1; }
+    virtual void SetSelectedItem(int WXUNUSED(item)) {}
+
+    virtual int GetNumberOfItems() const { return -1; }
+
+    virtual void InsertItem(int WXUNUSED(pos), const wxString& WXUNUSED(item)) {}
+
+    virtual void RemoveItem(int WXUNUSED(pos)) {}
+
+    virtual void Clear() {}
+    virtual void Popup() {}
+    virtual void Dismiss() {}
+
+    virtual wxString GetStringAtIndex(int WXUNUSED(pos)) const { return wxEmptyString; }
+
+    virtual int FindString(const wxString& WXUNUSED(text)) const { return -1; }

 };
 
 };
 

+//
+// common interface for buttons
+//
+
+class wxButtonImpl
+{
+    public :
+    wxButtonImpl(){}
+    virtual ~wxButtonImpl(){}
+
+    virtual void SetPressedBitmap( const wxBitmap& bitmap ) = 0;
+} ;
+

 //
 // common interface for search controls
 //
 //
 // common interface for search controls
 //


@@ -619,7 +772,7 @@ public :
     {
     }
 
     {
     }
 

-    virtual void Destroy()
+    virtual void WillBeDestroyed()

     {
     }
 
     {
     }
 


@@ -665,12 +818,16 @@ public :
     {
     }
 
     {
     }
 

+    virtual void SetWindowStyleFlag( long WXUNUSED(style) )
+    {
+    }
+

     virtual bool SetBackgroundStyle(wxBackgroundStyle WXUNUSED(style))
     {
         return false ;
     }
 
     virtual bool SetBackgroundStyle(wxBackgroundStyle WXUNUSED(style))
     {
         return false ;
     }
 

-    bool CanSetTransparent()
+    virtual bool CanSetTransparent()

     {
         return false;
     }
     {
         return false;
     }


@@ -697,6 +854,8 @@ public :
 
     virtual bool IsFullScreen() const= 0;
 
 
     virtual bool IsFullScreen() const= 0;
 

+    virtual void ShowWithoutActivating() { Show(true); }
+

     virtual bool ShowFullScreen(bool show, long style)= 0;
 
     virtual void RequestUserAttention(int flags) = 0;
     virtual bool ShowFullScreen(bool show, long style)= 0;
 
     virtual void RequestUserAttention(int flags) = 0;


@@ -705,13 +864,35 @@ public :
 
     virtual void WindowToScreen( int *x, int *y ) = 0;
 
 
     virtual void WindowToScreen( int *x, int *y ) = 0;
 

+    virtual bool IsActive() = 0;
+

     wxNonOwnedWindow*   GetWXPeer() { return m_wxPeer; }
 
     wxNonOwnedWindow*   GetWXPeer() { return m_wxPeer; }
 

+    static wxNonOwnedWindowImpl*
+                FindFromWXWindow(WXWindow window);
+
+    static void  RemoveAssociations( wxNonOwnedWindowImpl* impl);
+
+    static void  Associate( WXWindow window, wxNonOwnedWindowImpl *impl );
+

     // static creation methods, must be implemented by all toolkits
 
     // static creation methods, must be implemented by all toolkits
 

+    static wxNonOwnedWindowImpl* CreateNonOwnedWindow( wxNonOwnedWindow* wxpeer, wxWindow* parent, WXWindow native) ;
+

     static wxNonOwnedWindowImpl* CreateNonOwnedWindow( wxNonOwnedWindow* wxpeer, wxWindow* parent, const wxPoint& pos, const wxSize& size,
     long style, long extraStyle, const wxString& name  ) ;
 
     static wxNonOwnedWindowImpl* CreateNonOwnedWindow( wxNonOwnedWindow* wxpeer, wxWindow* parent, const wxPoint& pos, const wxSize& size,
     long style, long extraStyle, const wxString& name  ) ;
 

+    virtual void SetModified(bool WXUNUSED(modified)) { }
+    virtual bool IsModified() const { return false; }
+
+    virtual void SetRepresentedFilename(const wxString& WXUNUSED(filename)) { }
+
+#if wxOSX_USE_IPHONE
+    virtual CGFloat GetWindowLevel() const { return 0.0; }
+#else
+    virtual CGWindowLevel GetWindowLevel() const { return kCGNormalWindowLevel; }
+#endif
+    virtual void RestoreWindowLevel() {}

 protected :
     wxNonOwnedWindow*   m_wxPeer;
     DECLARE_ABSTRACT_CLASS(wxNonOwnedWindowImpl)
 protected :
     wxNonOwnedWindow*   m_wxPeer;
     DECLARE_ABSTRACT_CLASS(wxNonOwnedWindowImpl)