Extensive documentation typo patch (closes #13063).

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

diff --git a/include/wx/osx/carbon/private.h b/include/wx/osx/carbon/private.h
index 3e35afa471611133f4b941c3e767956ca27ff3a4..071ddbe384a754d5dfd0de9f6cb1cd117a55bb5c 100644 (file)
--- a/include/wx/osx/carbon/private.h
+++ b/include/wx/osx/carbon/private.h
@@ -14,10 +14,6 @@
 #ifndef _WX_PRIVATE_H_
 #define _WX_PRIVATE_H_
 
 #ifndef _WX_PRIVATE_H_
 #define _WX_PRIVATE_H_
 

-#include "wx/osx/core/private.h"
-
-#include <Carbon/Carbon.h>
-

 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
 typedef UInt32 URefCon;
 typedef SInt32 SRefCon;
 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
 typedef UInt32 URefCon;
 typedef SInt32 SRefCon;


@@ -28,9 +24,9 @@ typedef SInt32 SRefCon;
 #include "wx/osx/uma.h"
 
 #include "wx/listbox.h"
 #include "wx/osx/uma.h"
 
 #include "wx/listbox.h"

-#include "wx/osx/carbon/dc.h"
-#include "wx/osx/carbon/dcclient.h"
-#include "wx/osx/carbon/dcmemory.h"
+#include "wx/osx/dc.h"
+#include "wx/osx/dcclient.h"
+#include "wx/osx/dcmemory.h"

 
 // app.h
 
 
 // app.h
 


@@ -38,9 +34,6 @@ typedef SInt32 SRefCon;
 bool wxMacConvertEventToRecord( EventRef event , EventRecord *rec);
 #endif
 
 bool wxMacConvertEventToRecord( EventRef event , EventRecord *rec);
 #endif
 

-WXDLLIMPEXP_CORE wxWindowMac * wxFindWindowFromWXWidget(WXWidget inControl );
-// TODO REMOVE WXDLLIMPEXP_CORE wxNonOwnedWindow* wxFindWindowFromWXWindow( WXWindow inWindow );
-

 #endif // wxUSE_GUI
 
 // filefn.h
 #endif // wxUSE_GUI
 
 // filefn.h


@@ -56,6 +49,7 @@ WXDLLIMPEXP_BASE wxString wxMacFindFolder(short vRefNum,
                                           Boolean createFolder);
 
 template<typename T> EventParamType wxMacGetEventParamType() { wxFAIL_MSG( wxT("Unknown Param Type") ); return 0; }
                                           Boolean createFolder);
 
 template<typename T> EventParamType wxMacGetEventParamType() { wxFAIL_MSG( wxT("Unknown Param Type") ); return 0; }

+template<> inline EventParamType wxMacGetEventParamType<HIShapeRef>() { return typeHIShapeRef; }

 template<> inline EventParamType wxMacGetEventParamType<RgnHandle>() { return typeQDRgnHandle; }
 template<> inline EventParamType wxMacGetEventParamType<ControlRef>() { return typeControlRef; }
 template<> inline EventParamType wxMacGetEventParamType<WindowRef>() { return typeWindowRef; }
 template<> inline EventParamType wxMacGetEventParamType<RgnHandle>() { return typeQDRgnHandle; }
 template<> inline EventParamType wxMacGetEventParamType<ControlRef>() { return typeControlRef; }
 template<> inline EventParamType wxMacGetEventParamType<WindowRef>() { return typeWindowRef; }


@@ -285,7 +279,7 @@ enum {
 class WXDLLIMPEXP_CORE wxMacControl : public wxWidgetImpl
 {
 public :
 class WXDLLIMPEXP_CORE wxMacControl : public wxWidgetImpl
 {
 public :

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

     wxMacControl() ;
     virtual ~wxMacControl();
 
     wxMacControl() ;
     virtual ~wxMacControl();
 


@@ -302,12 +296,12 @@ public :
     virtual bool        IsVisible() const;
 
     virtual void        Raise();
     virtual bool        IsVisible() const;
 
     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 );
 

-    virtual void        GetContentArea( int &left , int &top , int &width , int &height ) const;    
+    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        GetPosition( int &x, int &y ) const;
     virtual void        GetSize( int &width, int &height ) const;
     virtual void        Move(int x, int y, int width, int height);
     virtual void        GetPosition( int &x, int &y ) const;
     virtual void        GetSize( int &width, int &height ) const;


@@ -316,7 +310,7 @@ public :
     // where is in native window relative coordinates
     virtual void        SetNeedsDisplay( const wxRect* where = NULL );
     virtual bool        GetNeedsDisplay() const;
     // where is in native window relative coordinates
     virtual void        SetNeedsDisplay( const wxRect* where = NULL );
     virtual bool        GetNeedsDisplay() const;

- 
+

     virtual bool        CanFocus() const;
     // return true if successful
     virtual bool        SetFocus();
     virtual bool        CanFocus() const;
     // return true if successful
     virtual bool        SetFocus();


@@ -324,14 +318,20 @@ public :
 
     void                RemoveFromParent();
     void                Embed( wxWidgetImpl *parent );
 
     void                RemoveFromParent();
     void                Embed( wxWidgetImpl *parent );

-    
+

     void                SetDefaultButton( bool isDefault );
     void                PerformClick();
     void                SetLabel( const wxString& title, wxFontEncoding encoding );
 
     void                SetDefaultButton( bool isDefault );
     void                PerformClick();
     void                SetLabel( const wxString& title, wxFontEncoding encoding );
 

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

     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;
     void                SetupTabs( const wxNotebook &notebook );
 
     void                GetBestRect( wxRect *r ) const;


@@ -361,8 +361,9 @@ public :
 
     virtual OSStatus SendHICommand( UInt32 commandID , OptionBits inOptions = 0 );
 
 
     virtual OSStatus SendHICommand( UInt32 commandID , OptionBits inOptions = 0 );
 

-    virtual SInt32 GetMaximum() const;
- 
+    virtual wxInt32 GetMaximum() const;
+    virtual wxInt32 GetMinimum() const;
+

     virtual void SetValueAndRange( SInt32 value , SInt32 minimum , SInt32 maximum );
     virtual void SetRange( SInt32 minimum , SInt32 maximum );
 
     virtual void SetValueAndRange( SInt32 value , SInt32 minimum , SInt32 maximum );
     virtual void SetRange( SInt32 minimum , SInt32 maximum );
 


@@ -426,6 +427,7 @@ public :
 
     virtual void SetFont( const wxFont & font , const wxColour& foreground , long windowStyle, bool ignoreBlack = true );
     virtual void SetBackgroundColour( const wxColour& col );
 
     virtual void SetFont( const wxFont & font , const wxColour& foreground , long windowStyle, bool ignoreBlack = true );
     virtual void SetBackgroundColour( const wxColour& col );

+    virtual bool SetBackgroundStyle(wxBackgroundStyle style);

     virtual ControlPartCode HandleKey(  SInt16 keyCode,  SInt16 charCode, EventModifiers modifiers );
     void SetActionProc( ControlActionUPP   actionProc );
     SInt32 GetViewSize() const;
     virtual ControlPartCode HandleKey(  SInt16 keyCode,  SInt16 charCode, EventModifiers modifiers );
     void SetActionProc( ControlActionUPP   actionProc );
     SInt32 GetViewSize() const;


@@ -444,13 +446,12 @@ public :
 
 
     virtual void GetFeatures( UInt32 *features );
 
 
     virtual void GetFeatures( UInt32 *features );

-    virtual OSStatus GetRegion( ControlPartCode partCode , RgnHandle region );
-    
+

     // to be moved into a tab control class
 
     virtual OSStatus SetTabEnabled( SInt16 tabNo , bool enable );
 
     // to be moved into a tab control class
 
     virtual OSStatus SetTabEnabled( SInt16 tabNo , bool enable );
 

-    void InstallEventHandler( WXWidget control = NULL );
+    virtual void InstallEventHandler( WXWidget control = NULL );

 protected :
     WXEVENTHANDLERREF    m_macControlEventHandler ;
     ControlRef  m_controlRef;
 protected :
     WXEVENTHANDLERREF    m_macControlEventHandler ;
     ControlRef  m_controlRef;


@@ -560,6 +561,8 @@ public :
     OSStatus SetHeaderDesc( DataBrowserPropertyID property, DataBrowserListViewHeaderDesc *desc );
 
     OSStatus SetDisclosureColumn( DataBrowserPropertyID property , Boolean expandableRows );
     OSStatus SetHeaderDesc( DataBrowserPropertyID property, DataBrowserListViewHeaderDesc *desc );
 
     OSStatus SetDisclosureColumn( DataBrowserPropertyID property , Boolean expandableRows );

+
+    OSStatus GetItemPartBounds( DataBrowserItemID item, DataBrowserPropertyID property, DataBrowserPropertyPart part, Rect * bounds );

 protected :
 
     static pascal void DataBrowserItemNotificationProc(
 protected :
 
     static pascal void DataBrowserItemNotificationProc(


@@ -634,7 +637,7 @@ public :
 } ;
 */
 
 } ;
 */
 

-class WXDLLIMPEXP_CORE wxMacDataItem 
+class WXDLLIMPEXP_CORE wxMacDataItem

 {
 public :
     wxMacDataItem();
 {
 public :
     wxMacDataItem();


@@ -729,22 +732,6 @@ public :
 
 public :
 
 
 public :
 

-    // item aware methods, to be used in subclasses
-
-    virtual Boolean CompareItems(const wxMacDataItem* itemOneID,
-                        const wxMacDataItem* itemTwoID,
-                        DataBrowserPropertyID sortProperty);
-
-    virtual OSStatus GetSetItemData(wxMacDataItem* itemID,
-                        DataBrowserPropertyID property,
-                        DataBrowserItemDataRef itemData,
-                        Boolean changeValue );
-
-    virtual void    ItemNotification(
-                        const wxMacDataItem* itemID,
-                        DataBrowserItemNotification message,
-                        DataBrowserItemDataRef itemData);
-

     // as we are getting the same events for human and API selection we have to suppress
     // events in the latter case, since this will be used from many subclasses we keep it here
 
     // as we are getting the same events for human and API selection we have to suppress
     // events in the latter case, since this will be used from many subclasses we keep it here
 


@@ -827,7 +814,7 @@ protected :
 class WXDLLIMPEXP_CORE wxMacDataBrowserColumn : public wxListWidgetColumn
 {
 public :
 class WXDLLIMPEXP_CORE wxMacDataBrowserColumn : public wxListWidgetColumn
 {
 public :

-    wxMacDataBrowserColumn( DataBrowserPropertyID propertyId, DataBrowserPropertyType colType, bool editable ) 
+    wxMacDataBrowserColumn( DataBrowserPropertyID propertyId, DataBrowserPropertyType colType, bool editable )

         : m_property(propertyId), m_editable(editable), m_type( colType )
     {
     }
         : m_property(propertyId), m_editable(editable), m_type( colType )
     {
     }


@@ -835,9 +822,9 @@ public :
     {
     }
     DataBrowserPropertyID GetProperty() const { return m_property ; }
     {
     }
     DataBrowserPropertyID GetProperty() const { return m_property ; }

-    
+

     bool IsEditable() const { return m_editable; }
     bool IsEditable() const { return m_editable; }

-    
+

     DataBrowserPropertyType GetType() const { return m_type; }
 
 protected :
     DataBrowserPropertyType GetType() const { return m_type; }
 
 protected :


@@ -854,11 +841,12 @@ class WXDLLIMPEXP_CORE wxMacDataBrowserCellValue : public wxListWidgetCellValue
 public :
     wxMacDataBrowserCellValue(DataBrowserItemDataRef data) : m_data(data) {}
     virtual ~wxMacDataBrowserCellValue() {}
 public :
     wxMacDataBrowserCellValue(DataBrowserItemDataRef data) : m_data(data) {}
     virtual ~wxMacDataBrowserCellValue() {}

-    
-   virtual void Set( CFStringRef value );
+
+    virtual void Set( CFStringRef value );

     virtual void Set( const wxString& value );
     virtual void Set( int value ) ;
     virtual void Set( const wxString& value );
     virtual void Set( int value ) ;

-    
+    virtual void Check( bool check );
+

     virtual int GetIntValue() const ;
     virtual wxString GetStringValue() const ;
 protected :
     virtual int GetIntValue() const ;
     virtual wxString GetStringValue() const ;
 protected :


@@ -877,10 +865,10 @@ public:
 
     wxListWidgetColumn*     InsertTextColumn( unsigned int pos, const wxString& title, bool editable = false,
                                 wxAlignment just = wxALIGN_LEFT , int defaultWidth = -1) ;
 
     wxListWidgetColumn*     InsertTextColumn( unsigned int pos, const wxString& title, bool editable = false,
                                 wxAlignment just = wxALIGN_LEFT , int defaultWidth = -1) ;

-    wxListWidgetColumn*     InsertCheckColumn( unsigned int pos , const wxString& title, bool editable = false, 
+    wxListWidgetColumn*     InsertCheckColumn( unsigned int pos , const wxString& title, bool editable = false,

                                 wxAlignment just = wxALIGN_LEFT , int defaultWidth = -1) ;
 
                                 wxAlignment just = wxALIGN_LEFT , int defaultWidth = -1) ;
 

-    wxMacDataBrowserColumn* DoInsertColumn( unsigned int pos, DataBrowserPropertyID property, 
+    wxMacDataBrowserColumn* DoInsertColumn( unsigned int pos, DataBrowserPropertyID property,

                                 const wxString& title, bool editable,
                                 DataBrowserPropertyType colType, SInt16 just, int width );
     // add and remove
                                 const wxString& title, bool editable,
                                 DataBrowserPropertyType colType, SInt16 just, int width );
     // add and remove


@@ -904,18 +892,21 @@ public:
     // accessing content
 
     virtual unsigned int    ListGetCount() const;
     // accessing content
 
     virtual unsigned int    ListGetCount() const;

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

 
     virtual void            UpdateLine( unsigned int n, wxListWidgetColumn* col = NULL );
     virtual void            UpdateLineToEnd( unsigned int n) ;
 
 
     virtual void            UpdateLine( unsigned int n, wxListWidgetColumn* col = NULL );
     virtual void            UpdateLineToEnd( unsigned int n) ;
 

+    // pointing back
+
+    wxMacDataBrowserColumn*     GetColumnFromProperty( DataBrowserPropertyID );
+
+protected:

     virtual void            ItemNotification(
     virtual void            ItemNotification(

-                                const wxMacDataItem* itemID,
+                                DataBrowserItemID itemID,

                                 DataBrowserItemNotification message,
                                 DataBrowserItemDataRef itemData);
 
                                 DataBrowserItemNotification message,
                                 DataBrowserItemDataRef itemData);
 

-    // pointing back
-
-    wxMacDataBrowserColumn*     GetColumnFromProperty( DataBrowserPropertyID );

 private:
     wxArrayMacDataBrowserColumns m_columns;
     int m_nextColumnId ;
 private:
     wxArrayMacDataBrowserColumns m_columns;
     int m_nextColumnId ;


@@ -947,21 +938,6 @@ UPP Get##x()                                \
     return sHandler;                        \
 }
 
     return sHandler;                        \
 }
 

-//---------------------------------------------------------------------------
-// wxMac string conversions
-//---------------------------------------------------------------------------
-
-void wxMacSetupConverters();
-void wxMacCleanupConverters();
-
-// utils.cpp
-
-// filefn.cpp
-
-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 );
-

 //---------------------------------------------------------------------------
 // cocoa bridging utilities
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 // cocoa bridging utilities
 //---------------------------------------------------------------------------


@@ -991,7 +967,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
 


@@ -1007,53 +984,58 @@ class wxNonOwnedWindowCarbonImpl : public wxNonOwnedWindowImpl
 {
 public :
     wxNonOwnedWindowCarbonImpl( wxNonOwnedWindow* nonownedwnd) ;
 {
 public :
     wxNonOwnedWindowCarbonImpl( wxNonOwnedWindow* nonownedwnd) ;

+

     wxNonOwnedWindowCarbonImpl();
     virtual ~wxNonOwnedWindowCarbonImpl();
     wxNonOwnedWindowCarbonImpl();
     virtual ~wxNonOwnedWindowCarbonImpl();

-    
-    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 Show(bool show);

     bool ShowWithEffect(bool show, wxShowEffect effect, unsigned timeout);
     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 );
+    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);
 
     virtual void SetTitle( const wxString& title, wxFontEncoding encoding ) ;
 
     bool SetShape(const wxRegion& region);
 
     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();
+

 
     bool MacGetUnifiedAppearance() const ;
     void MacChangeWindowAttributes( wxUint32 attributesToSet , wxUint32 attributesToClear ) ;
 
     bool MacGetUnifiedAppearance() const ;
     void MacChangeWindowAttributes( wxUint32 attributesToSet , wxUint32 attributesToClear ) ;


@@ -1061,18 +1043,18 @@ public :
     void MacSetMetalAppearance( bool set ) ;
     bool MacGetMetalAppearance() const ;
     void MacSetUnifiedAppearance( bool set );
     void MacSetMetalAppearance( bool set ) ;
     bool MacGetMetalAppearance() const ;
     void MacSetUnifiedAppearance( bool set );

-    
+

     WXEVENTHANDLERREF    MacGetEventHandler() { return m_macEventHandler ; }
 
     wxNonOwnedWindow*   GetWXPeer() { return m_wxPeer; }
 protected :
     void                MacInstallTopLevelWindowEventHandler();
     WXEVENTHANDLERREF    MacGetEventHandler() { return m_macEventHandler ; }
 
     wxNonOwnedWindow*   GetWXPeer() { return m_wxPeer; }
 protected :
     void                MacInstallTopLevelWindowEventHandler();

-    
+

     WXEVENTHANDLERREF   m_macEventHandler ;
     WindowRef           m_macWindow;
     void *              m_macFullScreenData ;
     WXEVENTHANDLERREF   m_macEventHandler ;
     WindowRef           m_macWindow;
     void *              m_macFullScreenData ;

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxNonOwnedWindowCarbonImpl)    
-};    
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxNonOwnedWindowCarbonImpl)
+};

 
 #endif // wxUSE_GUI
 
 
 #endif // wxUSE_GUI