indicating the memory ownership of our c-method for the clang analyzer

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

diff --git a/include/wx/osx/cocoa/private.h b/include/wx/osx/cocoa/private.h
index d8ab5394384d7daf311b2d712100b272f08bbeb0..36fcb7f13514681eddfda7dc31466d0fffead471 100644 (file)
--- a/include/wx/osx/cocoa/private.h
+++ b/include/wx/osx/cocoa/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
 /////////////////////////////////////////////////////////////////////////////


@@ -14,26 +14,23 @@
 #ifndef _WX_PRIVATE_COCOA_H_
 #define _WX_PRIVATE_COCOA_H_
 
 #ifndef _WX_PRIVATE_COCOA_H_
 #define _WX_PRIVATE_COCOA_H_
 

-#include "wx/osx/core/private.h"
-
-#include "wx/defs.h"
-

 #include <ApplicationServices/ApplicationServices.h>
 
 #include <ApplicationServices/ApplicationServices.h>
 

-#if wxOSX_USE_ATSU_TEXT
-    // we need theming and atsu
-    #include <Carbon/Carbon.h>
-#endif
-

 #ifdef __OBJC__
     #import <Cocoa/Cocoa.h>
 #endif
 
 #ifdef __OBJC__
     #import <Cocoa/Cocoa.h>
 #endif
 

+#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
+// available in 10.4 but not in the headers
+enum {
+    kEventMouseScroll             = 11
+};
+#endif

 //
 // shared between Cocoa and Carbon
 //
 
 //
 // shared between Cocoa and Carbon
 //
 

-// bring in themeing types without pulling in the headers
+// bring in theming types without pulling in the headers

 
 #if wxUSE_GUI
 typedef SInt16 ThemeBrush;
 
 #if wxUSE_GUI
 typedef SInt16 ThemeBrush;


@@ -42,35 +39,37 @@ OSStatus WXDLLIMPEXP_CORE wxMacDrawCGImage(
                                CGContextRef    inContext,
                                const CGRect *  inBounds,
                                CGImageRef      inImage) ;
                                CGContextRef    inContext,
                                const CGRect *  inBounds,
                                CGImageRef      inImage) ;

-WX_NSImage WXDLLIMPEXP_CORE wxOSXCreateNSImageFromCGImage( CGImageRef image );
-#endif
+WX_NSImage WXDLLIMPEXP_CORE wxOSXGetNSImageFromCGImage( CGImageRef image );
+CGImageRef WXDLLIMPEXP_CORE wxOSXCreateCGImageFromNSImage( WX_NSImage nsimage );
+wxBitmap WXDLLIMPEXP_CORE wxOSXCreateSystemBitmap(const wxString& id, const wxString &client, const wxSize& size);

 
 

-long UMAGetSystemVersion() ;
-WXDLLIMPEXP_BASE void wxMacStringToPascal( const wxString&from , StringPtr to );
-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 );
-
-//
-//
-//
-
-#if wxUSE_GUI
+class WXDLLIMPEXP_FWD_CORE wxDialog;

 
 class WXDLLIMPEXP_CORE wxWidgetCocoaImpl : public wxWidgetImpl
 {
 public :
 
 class WXDLLIMPEXP_CORE wxWidgetCocoaImpl : public wxWidgetImpl
 {
 public :

-    wxWidgetCocoaImpl( wxWindowMac* peer , WXWidget w, bool isRootControl = false ) ;    
-    wxWidgetCocoaImpl() ;    
-    ~wxWidgetCocoaImpl();    
-    
+    wxWidgetCocoaImpl( wxWindowMac* peer , WXWidget w, bool isRootControl = false, bool isUserPane = false ) ;
+    wxWidgetCocoaImpl() ;
+    ~wxWidgetCocoaImpl();
+

     void Init();
     void Init();

-    
+

     virtual bool        IsVisible() const ;
     virtual void        SetVisibility(bool);
 
     virtual bool        IsVisible() const ;
     virtual void        SetVisibility(bool);
 

+    // we provide a static function which can be reused from
+    // wxNonOwnedWindowCocoaImpl too
+    static bool ShowViewOrWindowWithEffect(wxWindow *win,
+                                           bool show,
+                                           wxShowEffect effect,
+                                           unsigned timeout);
+
+    virtual bool ShowWithEffect(bool show,
+                                wxShowEffect effect,
+                                unsigned timeout);
+

     virtual void        Raise();
     virtual void        Raise();

-    
+

     virtual void        Lower();
 
     virtual void        ScrollRect( const wxRect *rect, int dx, int dy );
     virtual void        Lower();
 
     virtual void        ScrollRect( const wxRect *rect, int dx, int dy );


@@ -78,6 +77,7 @@ public :
     virtual WXWidget    GetWXWidget() const { return m_osxView; }
 
     virtual void        SetBackgroundColour(const wxColour&);
     virtual WXWidget    GetWXWidget() const { return m_osxView; }
 
     virtual void        SetBackgroundColour(const wxColour&);

+    virtual bool        SetBackgroundStyle(wxBackgroundStyle style);

 
     virtual void        GetContentArea( int &left , int &top , int &width , int &height ) const;
     virtual void        Move(int x, int y, int width, int height);
 
     virtual void        GetContentArea( int &left , int &top , int &width , int &height ) const;
     virtual void        Move(int x, int y, int width, int height);


@@ -98,7 +98,7 @@ public :
 
     void                SetDefaultButton( bool isDefault );
     void                PerformClick();
 
     void                SetDefaultButton( bool isDefault );
     void                PerformClick();

-    void                SetLabel(const wxString& title, wxFontEncoding encoding);
+    virtual void        SetLabel(const wxString& title, wxFontEncoding encoding);

 
     void                SetCursor( const wxCursor & cursor );
     void                CaptureMouse();
 
     void                SetCursor( const wxCursor & cursor );
     void                CaptureMouse();


@@ -106,7 +106,9 @@ public :
 
     wxInt32             GetValue() const;
     void                SetValue( wxInt32 v );
 
     wxInt32             GetValue() const;
     void                SetValue( wxInt32 v );

+    wxBitmap            GetBitmap() const;

     void                SetBitmap( const wxBitmap& bitmap );
     void                SetBitmap( const wxBitmap& bitmap );

+    void                SetBitmapPosition( wxDirection dir );

     void                SetupTabs( const wxNotebook &notebook );
     void                GetBestRect( wxRect *r ) const;
     bool                IsEnabled() const;
     void                SetupTabs( const wxNotebook &notebook );
     void                GetBestRect( wxRect *r ) const;
     bool                IsEnabled() const;


@@ -120,16 +122,21 @@ public :
     void                SetScrollThumb( wxInt32 value, wxInt32 thumbSize );
 
     void                SetFont( const wxFont & font , const wxColour& foreground , long windowStyle, bool ignoreBlack = true );
     void                SetScrollThumb( wxInt32 value, wxInt32 thumbSize );
 
     void                SetFont( const wxFont & font , const wxColour& foreground , long windowStyle, bool ignoreBlack = true );

+    void                SetToolTip( wxToolTip* tooltip );

 
     void                InstallEventHandler( WXWidget control = NULL );
 
     void                InstallEventHandler( WXWidget control = NULL );

-    
-    virtual bool        DoHandleMouseEvent(NSEvent *event); 
+
+    virtual bool        DoHandleMouseEvent(NSEvent *event);

     virtual bool        DoHandleKeyEvent(NSEvent *event);
     virtual bool        DoHandleCharEvent(NSEvent *event, NSString *text);
     virtual bool        DoHandleKeyEvent(NSEvent *event);
     virtual bool        DoHandleCharEvent(NSEvent *event, NSString *text);

-    virtual void        DoNotifyFocusEvent(bool receivedFocus, wxWidgetImpl* otherWindow); 
+    virtual void        DoNotifyFocusEvent(bool receivedFocus, wxWidgetImpl* otherWindow);
+
+    virtual void        SetupKeyEvent(wxKeyEvent &wxevent, NSEvent * nsEvent, NSString* charString = NULL);
+    virtual void        SetupMouseEvent(wxMouseEvent &wxevent, NSEvent * nsEvent);
+

 
     void                SetFlipped(bool flipped);
 
     void                SetFlipped(bool flipped);

-    bool                IsFlipped() const { return m_isFlipped; }
+    virtual bool        IsFlipped() const { return m_isFlipped; }

 
     // cocoa thunk connected calls
 
 
     // cocoa thunk connected calls
 


@@ -138,24 +145,31 @@ public :
     virtual unsigned int        draggingUpdated(void* sender, WXWidget slf, void* _cmd);
     virtual bool                performDragOperation(void* sender, WXWidget slf, void* _cmd);
     virtual void                mouseEvent(WX_NSEvent event, WXWidget slf, void* _cmd);
     virtual unsigned int        draggingUpdated(void* sender, WXWidget slf, void* _cmd);
     virtual bool                performDragOperation(void* sender, WXWidget slf, void* _cmd);
     virtual void                mouseEvent(WX_NSEvent event, WXWidget slf, void* _cmd);

+    virtual void                cursorUpdate(WX_NSEvent event, WXWidget slf, void* _cmd);

     virtual void                keyEvent(WX_NSEvent event, WXWidget slf, void* _cmd);
     virtual void                insertText(NSString* text, WXWidget slf, void* _cmd);
     virtual bool                performKeyEquivalent(WX_NSEvent event, WXWidget slf, void* _cmd);
     virtual bool                acceptsFirstResponder(WXWidget slf, void* _cmd);
     virtual bool                becomeFirstResponder(WXWidget slf, void* _cmd);
     virtual bool                resignFirstResponder(WXWidget slf, void* _cmd);
     virtual void                keyEvent(WX_NSEvent event, WXWidget slf, void* _cmd);
     virtual void                insertText(NSString* text, WXWidget slf, void* _cmd);
     virtual bool                performKeyEquivalent(WX_NSEvent event, WXWidget slf, void* _cmd);
     virtual bool                acceptsFirstResponder(WXWidget slf, void* _cmd);
     virtual bool                becomeFirstResponder(WXWidget slf, void* _cmd);
     virtual bool                resignFirstResponder(WXWidget slf, void* _cmd);

-    virtual void                resetCursorRects(WXWidget slf, void* _cmd);

     virtual bool                isFlipped(WXWidget slf, void* _cmd);
     virtual void                drawRect(void* rect, WXWidget slf, void* _cmd);
     virtual bool                isFlipped(WXWidget slf, void* _cmd);
     virtual void                drawRect(void* rect, WXWidget slf, void* _cmd);

-    
+

     virtual void                controlAction(WXWidget slf, void* _cmd, void* sender);
     virtual void                controlDoubleAction(WXWidget slf, void* _cmd, void *sender);
 
     virtual void                controlAction(WXWidget slf, void* _cmd, void* sender);
     virtual void                controlDoubleAction(WXWidget slf, void* _cmd, void *sender);
 

+    // for wxTextCtrl-derived classes, put here since they don't all derive
+    // from the same pimpl class.
+    virtual void                controlTextDidChange();
+

 protected:
     WXWidget m_osxView;
     NSEvent* m_lastKeyDownEvent;
     bool m_isFlipped;
 protected:
     WXWidget m_osxView;
     NSEvent* m_lastKeyDownEvent;
     bool m_isFlipped;

-    
+    // if it the control has an editor, that editor will already send some
+    // events, don't resend them
+    bool m_hasEditor;
+

     DECLARE_DYNAMIC_CLASS_NO_COPY(wxWidgetCocoaImpl)
 };
 
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxWidgetCocoaImpl)
 };
 


@@ -166,76 +180,96 @@ class wxNonOwnedWindowCocoaImpl : public wxNonOwnedWindowImpl
 public :
     wxNonOwnedWindowCocoaImpl( wxNonOwnedWindow* nonownedwnd) ;
     wxNonOwnedWindowCocoaImpl();
 public :
     wxNonOwnedWindowCocoaImpl( wxNonOwnedWindow* nonownedwnd) ;
     wxNonOwnedWindowCocoaImpl();

-    
+

     virtual ~wxNonOwnedWindowCocoaImpl();
     virtual ~wxNonOwnedWindowCocoaImpl();

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

     void Create( wxWindow* parent, const wxPoint& pos, const wxSize& size,
     long style, long extraStyle, const wxString& name ) ;
     void Create( wxWindow* parent, const wxPoint& pos, const wxSize& size,
     long style, long extraStyle, const wxString& name ) ;

-    
+    void Create( wxWindow* parent, WXWindow nativeWindow );
+

     WXWindow GetWXWindow() const;
     WXWindow GetWXWindow() const;

-    void Raise();    
+    void Raise();

     void Lower();
     void Lower();

-    bool Show(bool show);    
-    bool ShowWithEffect(bool show, wxShowEffect effect, unsigned timeout);
-        
+    bool Show(bool show);
+
+    virtual bool ShowWithEffect(bool show,
+                                wxShowEffect effect,
+                                unsigned timeout);
+

     void Update();
     bool SetTransparent(wxByte alpha);
     bool SetBackgroundColour(const wxColour& col );
     void Update();
     bool SetTransparent(wxByte alpha);
     bool SetBackgroundColour(const wxColour& col );

-    void SetExtraStyle( long exStyle );    
-    bool SetBackgroundStyle(wxBackgroundStyle style);    
+    void SetExtraStyle( long exStyle );
+    void SetWindowStyleFlag( long style );
+    bool SetBackgroundStyle(wxBackgroundStyle style);

     bool CanSetTransparent();
 
     void MoveWindow(int x, int y, int width, int height);
     void GetPosition( int &x, int &y ) const;
     void GetSize( int &width, int &height ) const;
 
     bool CanSetTransparent();
 
     void MoveWindow(int x, int y, int width, int height);
     void GetPosition( int &x, int &y ) const;
     void GetSize( int &width, int &height ) const;
 

-    void GetContentArea( int &left , int &top , int &width , int &height ) const;    
+    void GetContentArea( int &left , int &top , int &width , int &height ) const;

     bool SetShape(const wxRegion& region);
     bool SetShape(const wxRegion& region);

-    
+

     virtual void SetTitle( const wxString& title, wxFontEncoding encoding ) ;
     virtual void SetTitle( const wxString& title, wxFontEncoding encoding ) ;

-    
+

     virtual bool IsMaximized() const;
     virtual bool IsMaximized() const;

-    
+

     virtual bool IsIconized() const;
     virtual bool IsIconized() const;

-    
+

     virtual void Iconize( bool iconize );
     virtual void Iconize( bool iconize );

-    
+

     virtual void Maximize(bool maximize);
     virtual void Maximize(bool maximize);

-    
+

     virtual bool IsFullScreen() const;
     virtual bool IsFullScreen() const;

-    
+

     virtual bool ShowFullScreen(bool show, long style);
 
     virtual bool ShowFullScreen(bool show, long style);
 

+    virtual void ShowWithoutActivating();
+

     virtual void RequestUserAttention(int flags);
     virtual void RequestUserAttention(int flags);

-    
+

     virtual void ScreenToWindow( int *x, int *y );
     virtual void ScreenToWindow( int *x, int *y );

-    
+

     virtual void WindowToScreen( int *x, int *y );
     virtual void WindowToScreen( int *x, int *y );

-    
+
+    virtual bool IsActive();
+
+    virtual void SetModified(bool modified);
+    virtual bool IsModified() const;
+
+    virtual void SetRepresentedFilename(const wxString& filename);
+

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

+    
+    CGWindowLevel   GetWindowLevel() const { return m_macWindowLevel; }
+    void            RestoreWindowLevel();

 protected :
 protected :

-    WX_wxNSWindow         m_macWindow;
-    void *              m_macFullScreenData ;
+    CGWindowLevel   m_macWindowLevel;
+    WXWindow        m_macWindow;
+    void *          m_macFullScreenData ;

     DECLARE_DYNAMIC_CLASS_NO_COPY(wxNonOwnedWindowCocoaImpl)
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxNonOwnedWindowCocoaImpl)

-};    
+};

 
 #ifdef __OBJC__
 
 
 #ifdef __OBJC__
 

-    extern NSRect wxToNSRect( NSView* parent, const wxRect& r );
-    extern wxRect wxFromNSRect( NSView* parent, const NSRect& rect );
-    extern NSPoint wxToNSPoint( NSView* parent, const wxPoint& p );
-    extern wxPoint wxFromNSPoint( NSView* parent, const NSPoint& p );
-    
-    NSRect WXDLLIMPEXP_CORE wxOSXGetFrameForControl( wxWindowMac* window , const wxPoint& pos , const wxSize &size , 
+    WXDLLIMPEXP_CORE NSScreen* wxOSXGetMenuScreen();
+    WXDLLIMPEXP_CORE NSRect wxToNSRect( NSView* parent, const wxRect& r );
+    WXDLLIMPEXP_CORE wxRect wxFromNSRect( NSView* parent, const NSRect& rect );
+    WXDLLIMPEXP_CORE NSPoint wxToNSPoint( NSView* parent, const wxPoint& p );
+    WXDLLIMPEXP_CORE wxPoint wxFromNSPoint( NSView* parent, const NSPoint& p );
+
+    NSRect WXDLLIMPEXP_CORE wxOSXGetFrameForControl( wxWindowMac* window , const wxPoint& pos , const wxSize &size ,

         bool adjustForOrigin = true );
         bool adjustForOrigin = true );

-        
+

     // used for many wxControls
     // used for many wxControls

-    
+

     @interface wxNSButton : NSButton
     {
     @interface wxNSButton : NSButton
     {

+        NSTrackingRectTag rectTag;

     }
     }

-    
+

     @end
 
     @interface wxNSBox : NSBox
     @end
 
     @interface wxNSBox : NSBox


@@ -244,13 +278,36 @@ protected :
 
     @end
 
 
     @end
 

-    @interface wxNSTextField : NSTextField
+    @interface wxNSTextFieldEditor : NSTextView
+    {
+        NSEvent* lastKeyDownEvent;
+    }
+
+    @end
+
+    @interface wxNSTextField : NSTextField wxOSX_10_6_AND_LATER(<NSTextFieldDelegate>)
+    {
+        wxNSTextFieldEditor* fieldEditor;
+    }
+
+    - (wxNSTextFieldEditor*) fieldEditor;
+    - (void) setFieldEditor:(wxNSTextFieldEditor*) fieldEditor;
+
+    @end
+
+    @interface wxNSSecureTextField : NSSecureTextField wxOSX_10_6_AND_LATER(<NSTextFieldDelegate>)
+    {
+    }
+
+    @end
+
+
+    @interface wxNSTextView : NSTextView wxOSX_10_6_AND_LATER(<NSTextViewDelegate>)

     {
     {

-        wxWidgetCocoaImpl* impl;

     }
 
     }
 

-    - (void) setImplementation:(wxWidgetCocoaImpl*) item;
-    - (wxWidgetCocoaImpl*) implementation;
+    - (void)textDidChange:(NSNotification *)aNotification;
+

     @end
 
     @interface wxNSMenu : NSMenu
     @end
 
     @interface wxNSMenu : NSMenu


@@ -261,7 +318,7 @@ protected :
     - (void) setImplementation:(wxMenuImpl*) item;
     - (wxMenuImpl*) implementation;
 
     - (void) setImplementation:(wxMenuImpl*) item;
     - (wxMenuImpl*) implementation;
 

-    @end 
+    @end

 
     @interface wxNSMenuItem : NSMenuItem
     {
 
     @interface wxNSMenuItem : NSMenuItem
     {


@@ -274,8 +331,8 @@ protected :
     - (void)clickedAction:(id)sender;
     - (BOOL)validateMenuItem:(NSMenuItem *)menuItem;
 
     - (void)clickedAction:(id)sender;
     - (BOOL)validateMenuItem:(NSMenuItem *)menuItem;
 

-    @end 
-    
+    @end
+

     void WXDLLIMPEXP_CORE wxOSXCocoaClassAddWXMethods(Class c);
 
     /*
     void WXDLLIMPEXP_CORE wxOSXCocoaClassAddWXMethods(Class c);
 
     /*


@@ -287,14 +344,36 @@ protected :
     {
         BOOL sheetFinished;
         int resultCode;
     {
         BOOL sheetFinished;
         int resultCode;

+        wxDialog* impl;

     }
 
     }
 

+    - (void)setImplementation: (wxDialog *)dialog;

     - (BOOL)finished;
     - (int)code;
     - (void)waitForSheetToFinish;
     - (void)sheetDidEnd:(NSWindow *)sheet returnCode:(int)returnCode contextInfo:(void *)contextInfo;
     @end
 
     - (BOOL)finished;
     - (int)code;
     - (void)waitForSheetToFinish;
     - (void)sheetDidEnd:(NSWindow *)sheet returnCode:(int)returnCode contextInfo:(void *)contextInfo;
     @end
 

+    // This interface must be exported in shared 64 bit multilib build but
+    // using WXEXPORT with Objective C interfaces doesn't work with old (4.0.1)
+    // gcc when using 10.4 SDK. It does work with newer gcc even in 32 bit
+    // builds but seems to be unnecessary there so to avoid the expense of a
+    // configure check verifying if this does work or not with the current
+    // compiler we just only use it for 64 bit builds where this is always
+    // supported.
+    //
+    // NB: Currently this is the only place where we need to export an
+    //     interface but if we need to do it elsewhere we should define a
+    //     WXEXPORT_OBJC macro once and reuse it in all places it's needed
+    //     instead of duplicating this preprocessor check.
+#ifdef __LP64__
+    WXEXPORT
+#endif // 64 bit builds
+    @interface wxNSAppController : NSObject wxOSX_10_6_AND_LATER(<NSApplicationDelegate>)
+    {
+    }
+
+    @end

 
 #endif // __OBJC__
 
 
 #endif // __OBJC__
 


@@ -328,7 +407,8 @@ const short kwxCursorSize = 11;
 const short kwxCursorSizeNESW = 12;
 const short kwxCursorSizeNWSE = 13;
 const short kwxCursorRoller = 14;
 const short kwxCursorSizeNESW = 12;
 const short kwxCursorSizeNWSE = 13;
 const short kwxCursorRoller = 14;

-const short kwxCursorLast = kwxCursorRoller;
+const short kwxCursorWatch = 15;
+const short kwxCursorLast = kwxCursorWatch;

 
 // exposing our fallback cursor map
 
 
 // exposing our fallback cursor map