Fixed typos in comments (patch #1515724)

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

diff --git a/include/wx/mac/carbon/private.h b/include/wx/mac/carbon/private.h
index 9302752b23cdab704b4a8a9291b38e1d5be2df15..41e936264a13a4101eeb12e3e1cce7fface22025 100644 (file)
--- a/include/wx/mac/carbon/private.h
+++ b/include/wx/mac/carbon/private.h
@@ -15,7 +15,6 @@
 #define _WX_PRIVATE_H_
 
 #include "wx/defs.h"
 #define _WX_PRIVATE_H_
 
 #include "wx/defs.h"

-#include "wx/app.h"

 
 #ifdef __DARWIN__
 #    include <Carbon/Carbon.h>
 
 #ifdef __DARWIN__
 #    include <Carbon/Carbon.h>


@@ -33,7 +32,7 @@
 #endif
 
 #if UNIVERSAL_INTERFACES_VERSION < 0x0342
 #endif
 
 #if UNIVERSAL_INTERFACES_VERSION < 0x0342

-    #error "please update to Apple's lastest universal headers from http://developer.apple.com/sdk/"
+    #error "please update to Apple's latest universal headers from http://developer.apple.com/sdk/"

 #endif
 
 #ifndef MAC_OS_X_VERSION_10_3
 #endif
 
 #ifndef MAC_OS_X_VERSION_10_3


@@ -63,9 +62,7 @@ inline int    FixedToInt( Fixed inFixed )
 
 #if wxUSE_GUI
 
 
 #if wxUSE_GUI
 

-#include "wx/dc.h"
-#include "wx/window.h"
-#include "wx/toplevel.h"
+#include "wx/listbox.h"

 
 class wxMacPortStateHelper
 {
 
 class wxMacPortStateHelper
 {


@@ -428,8 +425,6 @@ private :
 
 #if wxUSE_GUI
 
 
 #if wxUSE_GUI
 

-#include "wx/listbox.h"
-

 /*
 GWorldPtr         wxMacCreateGWorld( int width , int height , int depth );
 void                 wxMacDestroyGWorld( GWorldPtr gw );
 /*
 GWorldPtr         wxMacCreateGWorld( int width , int height , int depth );
 void                 wxMacDestroyGWorld( GWorldPtr gw );


@@ -564,9 +559,10 @@ public :
     {
         T value;
         OSStatus err = GetData<T>( inPartCode , inTag , &value );
     {
         T value;
         OSStatus err = GetData<T>( inPartCode , inTag , &value );

-        
-        wxASSERT_MSG(err == noErr, wxString::Format(wxT("GetData Failed for Part [%i] and Tag [%i]"),
-            inPartCode, inTag));
+
+        wxASSERT_MSG( err == noErr,
+                      wxString::Format(wxT("GetData Failed for Part [%i] and Tag [%i]"),
+                                       inPartCode, (int)inTag) );

         return value;
     }
     template <typename T> OSStatus GetData( ResType inTag , T *data ) const
         return value;
     }
     template <typename T> OSStatus GetData( ResType inTag , T *data ) const


@@ -578,7 +574,7 @@ public :
     {
         return GetData<T>( kControlEntireControl , inTag );
     }
     {
         return GetData<T>( kControlEntireControl , inTag );
     }

-    
+

     // Flash the control for the specified amount of time
     virtual void Flash( ControlPartCode part , UInt32 ticks = 8 );
 
     // Flash the control for the specified amount of time
     virtual void Flash( ControlPartCode part , UInt32 ticks = 8 );
 


@@ -628,10 +624,10 @@ public :
     virtual void GetFeatures( UInt32 *features );
     virtual OSStatus GetRegion( ControlPartCode partCode , RgnHandle region );
     virtual OSStatus SetZOrder( bool above , wxMacControl* other );
     virtual void GetFeatures( UInt32 *features );
     virtual OSStatus GetRegion( ControlPartCode partCode , RgnHandle region );
     virtual OSStatus SetZOrder( bool above , wxMacControl* other );

-            
+

     bool    IsCompositing() { return m_isCompositing; }
     bool    IsRootControl() { return m_isRootControl; }
     bool    IsCompositing() { return m_isCompositing; }
     bool    IsRootControl() { return m_isRootControl; }

-    
+

     wxWindow* GetPeer() const
     {
          return m_peer;
     wxWindow* GetPeer() const
     {
          return m_peer;


@@ -663,26 +659,26 @@ public :
     wxMacDataBrowserControl( wxWindow* peer, const wxPoint& pos, const wxSize& size, long style);
 
     OSStatus SetCallbacks( const DataBrowserCallbacks *callbacks );
     wxMacDataBrowserControl( wxWindow* peer, const wxPoint& pos, const wxSize& size, long style);
 
     OSStatus SetCallbacks( const DataBrowserCallbacks *callbacks );

-    
+

     OSStatus GetItemCount( DataBrowserItemID container,
             Boolean recurse,
             DataBrowserItemState state,
             UInt32 *numItems) const;
     OSStatus GetItemCount( DataBrowserItemID container,
             Boolean recurse,
             DataBrowserItemState state,
             UInt32 *numItems) const;

-    
+

     OSStatus GetItems( DataBrowserItemID container,
             Boolean recurse,
             DataBrowserItemState state,
             Handle items) const;
     OSStatus GetItems( DataBrowserItemID container,
             Boolean recurse,
             DataBrowserItemState state,
             Handle items) const;

-    
+

 
     OSStatus AddColumn( DataBrowserListViewColumnDesc *columnDesc,
         DataBrowserTableViewColumnIndex position );
 
     OSStatus AddColumn( DataBrowserListViewColumnDesc *columnDesc,
         DataBrowserTableViewColumnIndex position );

-        
+

     OSStatus AutoSizeColumns();
     OSStatus AutoSizeColumns();

-    
+

     OSStatus SetHasScrollBars( bool horiz, bool vert );
     OSStatus SetHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle );
     OSStatus SetHasScrollBars( bool horiz, bool vert );
     OSStatus SetHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle );

-    
+

     OSStatus SetHeaderButtonHeight( UInt16 height );
     OSStatus GetHeaderButtonHeight( UInt16 *height );
 
     OSStatus SetHeaderButtonHeight( UInt16 height );
     OSStatus GetHeaderButtonHeight( UInt16 *height );
 


@@ -690,7 +686,7 @@ public :
             const DataBrowserItemID *items,
             DataBrowserPropertyID preSortProperty,
             DataBrowserPropertyID propertyID ) const;
             const DataBrowserItemID *items,
             DataBrowserPropertyID preSortProperty,
             DataBrowserPropertyID propertyID ) const;

-            
+

     OSStatus AddItems( DataBrowserItemID container, UInt32 numItems,
             const DataBrowserItemID *items,
             DataBrowserPropertyID preSortProperty );
     OSStatus AddItems( DataBrowserItemID container, UInt32 numItems,
             const DataBrowserItemID *items,
             DataBrowserPropertyID preSortProperty );


@@ -708,46 +704,46 @@ public :
             const DataBrowserItemID *items,
             DataBrowserSetOption operation );
 
             const DataBrowserItemID *items,
             DataBrowserSetOption operation );
 

-    OSStatus GetItemID( DataBrowserTableViewRowIndex row, 
+    OSStatus GetItemID( DataBrowserTableViewRowIndex row,

             DataBrowserItemID * item ) const;
             DataBrowserItemID * item ) const;

-    OSStatus GetItemRow( DataBrowserItemID item, 
+    OSStatus GetItemRow( DataBrowserItemID item,

             DataBrowserTableViewRowIndex * row ) const;
             DataBrowserTableViewRowIndex * row ) const;

-            
+

     OSStatus SetDefaultRowHeight( UInt16 height );
     OSStatus GetDefaultRowHeight( UInt16 * height ) const;
     OSStatus SetDefaultRowHeight( UInt16 height );
     OSStatus GetDefaultRowHeight( UInt16 * height ) const;

-    
+

     OSStatus SetRowHeight( DataBrowserItemID item , UInt16 height);
     OSStatus GetRowHeight( DataBrowserItemID item , UInt16 *height) const;
     OSStatus SetRowHeight( DataBrowserItemID item , UInt16 height);
     OSStatus GetRowHeight( DataBrowserItemID item , UInt16 *height) const;

-    
+

     OSStatus GetColumnWidth( DataBrowserPropertyID column , UInt16 *width ) const;
     OSStatus SetColumnWidth( DataBrowserPropertyID column , UInt16 width );
     OSStatus GetColumnWidth( DataBrowserPropertyID column , UInt16 *width ) const;
     OSStatus SetColumnWidth( DataBrowserPropertyID column , UInt16 width );

-     
+

     OSStatus GetDefaultColumnWidth( UInt16 *width ) const;
     OSStatus SetDefaultColumnWidth( UInt16 width );
     OSStatus GetDefaultColumnWidth( UInt16 *width ) const;
     OSStatus SetDefaultColumnWidth( UInt16 width );

-    
+

     OSStatus GetColumnCount( UInt32* numColumns) const;
 
     OSStatus GetColumnPosition( DataBrowserPropertyID column, UInt32 *position) const;
     OSStatus SetColumnPosition( DataBrowserPropertyID column, UInt32 position);
     OSStatus GetColumnCount( UInt32* numColumns) const;
 
     OSStatus GetColumnPosition( DataBrowserPropertyID column, UInt32 *position) const;
     OSStatus SetColumnPosition( DataBrowserPropertyID column, UInt32 position);

-    
+

     OSStatus GetScrollPosition( UInt32 *top , UInt32 *left ) const;
     OSStatus SetScrollPosition( UInt32 top , UInt32 left );
     OSStatus GetScrollPosition( UInt32 *top , UInt32 *left ) const;
     OSStatus SetScrollPosition( UInt32 top , UInt32 left );

-    
+

     OSStatus GetSortProperty( DataBrowserPropertyID *column ) const;
     OSStatus SetSortProperty( DataBrowserPropertyID column );
     OSStatus GetSortProperty( DataBrowserPropertyID *column ) const;
     OSStatus SetSortProperty( DataBrowserPropertyID column );

-     
+

     OSStatus GetSortOrder( DataBrowserSortOrder *order ) const;
     OSStatus SetSortOrder( DataBrowserSortOrder order );
     OSStatus GetSortOrder( DataBrowserSortOrder *order ) const;
     OSStatus SetSortOrder( DataBrowserSortOrder order );

-     
+

     OSStatus GetPropertyFlags( DataBrowserPropertyID property, DataBrowserPropertyFlags *flags ) const;
     OSStatus SetPropertyFlags( DataBrowserPropertyID property, DataBrowserPropertyFlags flags );
     OSStatus GetPropertyFlags( DataBrowserPropertyID property, DataBrowserPropertyFlags *flags ) const;
     OSStatus SetPropertyFlags( DataBrowserPropertyID property, DataBrowserPropertyFlags flags );

-    
+

     OSStatus GetHeaderDesc( DataBrowserPropertyID property, DataBrowserListViewHeaderDesc *desc ) const;
     OSStatus SetHeaderDesc( DataBrowserPropertyID property, DataBrowserListViewHeaderDesc *desc );
     OSStatus GetHeaderDesc( DataBrowserPropertyID property, DataBrowserListViewHeaderDesc *desc ) const;
     OSStatus SetHeaderDesc( DataBrowserPropertyID property, DataBrowserListViewHeaderDesc *desc );

-    
+

     OSStatus SetDisclosureColumn( DataBrowserPropertyID property , Boolean expandableRows );
 protected :
     OSStatus SetDisclosureColumn( DataBrowserPropertyID property , Boolean expandableRows );
 protected :

-    
+

     static pascal void DataBrowserItemNotificationProc(
         ControlRef browser,
         DataBrowserItemID itemID,
     static pascal void DataBrowserItemNotificationProc(
         ControlRef browser,
         DataBrowserItemID itemID,


@@ -773,18 +769,18 @@ protected :
         Boolean changeValue ) = 0;
 
     static pascal Boolean DataBrowserCompareProc(
         Boolean changeValue ) = 0;
 
     static pascal Boolean DataBrowserCompareProc(

-           ControlRef browser, 
-           DataBrowserItemID itemOneID, 
-           DataBrowserItemID itemTwoID, 
+           ControlRef browser,
+           DataBrowserItemID itemOneID,
+           DataBrowserItemID itemTwoID,

            DataBrowserPropertyID sortProperty);
            DataBrowserPropertyID sortProperty);

-           
-       virtual Boolean CompareItems(DataBrowserItemID itemOneID, 
-           DataBrowserItemID itemTwoID, 
+
+       virtual Boolean CompareItems(DataBrowserItemID itemOneID,
+           DataBrowserItemID itemTwoID,

            DataBrowserPropertyID sortProperty) = 0;
 };
 
 // ============================================================================
            DataBrowserPropertyID sortProperty) = 0;
 };
 
 // ============================================================================

-// Higher-level Databrowser 
+// Higher-level Databrowser

 // ============================================================================
 //
 // basing on data item objects
 // ============================================================================
 //
 // basing on data item objects


@@ -801,18 +797,18 @@ class wxMacDataItem
 public :
     wxMacDataItem();
     virtual ~wxMacDataItem();
 public :
     wxMacDataItem();
     virtual ~wxMacDataItem();

-    
-    virtual bool IsLessThan(wxMacDataItemBrowserControl *owner , 
-        const wxMacDataItem*, 
+
+    virtual bool IsLessThan(wxMacDataItemBrowserControl *owner ,
+        const wxMacDataItem*,

         DataBrowserPropertyID property) const;
         DataBrowserPropertyID property) const;

-    
+

     // returns true if access was successful, otherwise false
     // returns true if access was successful, otherwise false

-    virtual OSStatus GetSetData(wxMacDataItemBrowserControl *owner , 
+    virtual OSStatus GetSetData(wxMacDataItemBrowserControl *owner ,

         DataBrowserPropertyID property,
         DataBrowserItemDataRef itemData,
         bool changeValue );
 
         DataBrowserPropertyID property,
         DataBrowserItemDataRef itemData,
         bool changeValue );
 

-    virtual void Notification(wxMacDataItemBrowserControl *owner , 
+    virtual void Notification(wxMacDataItemBrowserControl *owner ,

         DataBrowserItemNotification message,
         DataBrowserItemDataRef itemData ) const;
 };
         DataBrowserItemNotification message,
         DataBrowserItemDataRef itemData ) const;
 };


@@ -826,39 +822,39 @@ class wxMacDataItemBrowserControl : public wxMacDataBrowserControl
 {
 public :
     wxMacDataItemBrowserControl( wxWindow* peer , const wxPoint& pos, const wxSize& size, long style);
 {
 public :
     wxMacDataItemBrowserControl( wxWindow* peer , const wxPoint& pos, const wxSize& size, long style);

-    
+

     unsigned int    GetItemCount(const wxMacDataItem* container, bool recurse , DataBrowserItemState state) const;
     unsigned int    GetItemCount(const wxMacDataItem* container, bool recurse , DataBrowserItemState state) const;

-    void            GetItems(const wxMacDataItem* container, bool recurse , 
+    void            GetItems(const wxMacDataItem* container, bool recurse ,

                         DataBrowserItemState state, wxArrayMacDataItemPtr &items ) const;
                         DataBrowserItemState state, wxArrayMacDataItemPtr &items ) const;

-                        
+

     unsigned int    GetLineFromItem(const wxMacDataItem *item) const;
     wxMacDataItem * GetItemFromLine(unsigned int n) const;
     unsigned int    GetLineFromItem(const wxMacDataItem *item) const;
     wxMacDataItem * GetItemFromLine(unsigned int n) const;

-    
-    void            UpdateItem(const wxMacDataItem *container, const wxMacDataItem *item, 
+
+    void            UpdateItem(const wxMacDataItem *container, const wxMacDataItem *item,

                         DataBrowserPropertyID property) const;
                         DataBrowserPropertyID property) const;

-    void            UpdateItems(const wxMacDataItem *container, wxArrayMacDataItemPtr &items, 
+    void            UpdateItems(const wxMacDataItem *container, wxArrayMacDataItemPtr &items,

                         DataBrowserPropertyID property) const;
                         DataBrowserPropertyID property) const;

-    
+

     void            AddItem(wxMacDataItem *container, wxMacDataItem *item);
     void            AddItems(wxMacDataItem *container, wxArrayMacDataItemPtr &items );
 
     void            RemoveAllItems(wxMacDataItem *container);
     void            RemoveItem(wxMacDataItem *container, wxMacDataItem* item);
     void            RemoveItems(wxMacDataItem *container, wxArrayMacDataItemPtr &items);
     void            AddItem(wxMacDataItem *container, wxMacDataItem *item);
     void            AddItems(wxMacDataItem *container, wxArrayMacDataItemPtr &items );
 
     void            RemoveAllItems(wxMacDataItem *container);
     void            RemoveItem(wxMacDataItem *container, wxMacDataItem* item);
     void            RemoveItems(wxMacDataItem *container, wxArrayMacDataItemPtr &items);

-    
+

     void            SetSelectedItem( wxMacDataItem* item , DataBrowserSetOption option);
     void            SetSelectedItems( wxArrayMacDataItemPtr &items , DataBrowserSetOption option);
     void            SetSelectedAllItems( DataBrowserSetOption option);
     Boolean         IsItemSelected( const wxMacDataItem* item) const;
     void            SetSelectedItem( wxMacDataItem* item , DataBrowserSetOption option);
     void            SetSelectedItems( wxArrayMacDataItemPtr &items , DataBrowserSetOption option);
     void            SetSelectedAllItems( DataBrowserSetOption option);
     Boolean         IsItemSelected( const wxMacDataItem* item) const;

-    
+

     void            RevealItem( wxMacDataItem* item, DataBrowserRevealOptions options);
     void            RevealItem( wxMacDataItem* item, DataBrowserRevealOptions options);

-    
+

     void            GetSelectionAnchor( wxMacDataItemPtr* first , wxMacDataItemPtr* last) const;
     void            GetSelectionAnchor( wxMacDataItemPtr* first , wxMacDataItemPtr* last) const;

-    
+

     // item aware methods, to be used in subclasses
     // item aware methods, to be used in subclasses

-    
-    virtual Boolean CompareItems(const wxMacDataItem* itemOneID, 
-                        const wxMacDataItem* itemTwoID, 
+
+    virtual Boolean CompareItems(const wxMacDataItem* itemOneID,
+                        const wxMacDataItem* itemTwoID,

                         DataBrowserPropertyID sortProperty);
 
     virtual OSStatus GetSetItemData(wxMacDataItem* itemID,
                         DataBrowserPropertyID sortProperty);
 
     virtual OSStatus GetSetItemData(wxMacDataItem* itemID,


@@ -879,9 +875,9 @@ public :
 
 protected:
     // ID aware base methods, should be 'final' ie not changed in subclasses
 
 protected:
     // ID aware base methods, should be 'final' ie not changed in subclasses

-    
-    virtual Boolean CompareItems(DataBrowserItemID itemOneID, 
-                        DataBrowserItemID itemTwoID, 
+
+    virtual Boolean CompareItems(DataBrowserItemID itemOneID,
+                        DataBrowserItemID itemTwoID,

                         DataBrowserPropertyID sortProperty);
 
     virtual OSStatus GetSetItemData(DataBrowserItemID itemID,
                         DataBrowserPropertyID sortProperty);
 
     virtual OSStatus GetSetItemData(DataBrowserItemID itemID,


@@ -904,7 +900,7 @@ class wxMacDataItemBrowserSelectionSuppressor
 public :
     wxMacDataItemBrowserSelectionSuppressor(wxMacDataItemBrowserControl *browser);
     ~wxMacDataItemBrowserSelectionSuppressor();
 public :
     wxMacDataItemBrowserSelectionSuppressor(wxMacDataItemBrowserControl *browser);
     ~wxMacDataItemBrowserSelectionSuppressor();

-    
+

 private :
 
     bool m_former;
 private :
 
     bool m_former;


@@ -921,14 +917,14 @@ class wxMacListBoxItem : public wxMacDataItem
 {
 public :
     wxMacListBoxItem();
 {
 public :
     wxMacListBoxItem();

-    
+

     virtual ~wxMacListBoxItem();
     virtual ~wxMacListBoxItem();

-    
+

     void SetLabel( const wxString& str);
     const wxString& GetLabel() const;
     void SetLabel( const wxString& str);
     const wxString& GetLabel() const;

-    
-    virtual bool IsLessThan(wxMacDataItemBrowserControl *owner , 
-        const wxMacDataItem* rhs, 
+
+    virtual bool IsLessThan(wxMacDataItemBrowserControl *owner ,
+        const wxMacDataItem* rhs,

         DataBrowserPropertyID sortProperty) const;
 
     virtual OSStatus GetSetData( wxMacDataItemBrowserControl *owner ,
         DataBrowserPropertyID sortProperty) const;
 
     virtual OSStatus GetSetData( wxMacDataItemBrowserControl *owner ,


@@ -936,13 +932,13 @@ public :
         DataBrowserItemDataRef itemData,
         bool changeValue );
 
         DataBrowserItemDataRef itemData,
         bool changeValue );
 

-    virtual void Notification(wxMacDataItemBrowserControl *owner , 
+    virtual void Notification(wxMacDataItemBrowserControl *owner ,

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

-        
+

     void SetOrder( SInt32 order );
     SInt32 GetOrder() const;
     void SetOrder( SInt32 order );
     SInt32 GetOrder() const;

-    
+

     void SetData( void* data);
     void* GetData() const;
 
     void SetData( void* data);
     void* GetData() const;
 


@@ -964,7 +960,7 @@ public:
     virtual wxMacListBoxItem* CreateItem();
 
     // add and remove
     virtual wxMacListBoxItem* CreateItem();
 
     // add and remove

-    
+

     void            MacDelete( unsigned int n );
     void            MacInsert( unsigned int n, const wxString& item );
     void            MacInsert( unsigned int n, const wxArrayString& items );
     void            MacDelete( unsigned int n );
     void            MacInsert( unsigned int n, const wxString& item );
     void            MacInsert( unsigned int n, const wxArrayString& items );


@@ -972,7 +968,7 @@ public:
     void            MacClear();
 
     // selecting
     void            MacClear();
 
     // selecting

-    
+

     void            MacDeselectAll();
     void            MacSetSelection( unsigned int n, bool select );
     int             MacGetSelection() const;
     void            MacDeselectAll();
     void            MacSetSelection( unsigned int n, bool select );
     int             MacGetSelection() const;


@@ -984,7 +980,7 @@ public:
     void            MacScrollTo( unsigned int n );
 
     // accessing content
     void            MacScrollTo( unsigned int n );
 
     // accessing content

-    
+

     void            MacSetString( unsigned int n, const wxString& item );
     void            MacSetClientData( unsigned int n, void * data);
     wxString        MacGetString( unsigned int n) const;
     void            MacSetString( unsigned int n, const wxString& item );
     void            MacSetClientData( unsigned int n, void * data);
     wxString        MacGetString( unsigned int n) const;


@@ -1177,14 +1173,14 @@ private :
 ControlRef wxMacFindControlUnderMouse( wxTopLevelWindowMac* toplevelWindow, const Point& location , WindowRef window , ControlPartCode *outPart );
 
 #ifdef WORDS_BIGENDIAN
 ControlRef wxMacFindControlUnderMouse( wxTopLevelWindowMac* toplevelWindow, const Point& location , WindowRef window , ControlPartCode *outPart );
 
 #ifdef WORDS_BIGENDIAN

-    inline Rect* wxMacGetPictureBounds( PicHandle pict , Rect* rect ) 
-    { 
-       *rect = (**pict).picFrame; 
+    inline Rect* wxMacGetPictureBounds( PicHandle pict , Rect* rect )
+    {
+       *rect = (**pict).picFrame;

         return rect;
     }
 #else
         return rect;
     }
 #else

-    inline Rect* wxMacGetPictureBounds( PicHandle pict , Rect* rect ) 
-    {   
+    inline Rect* wxMacGetPictureBounds( PicHandle pict , Rect* rect )
+    {

         return QDGetPictureBounds( pict , rect );
     }
 #endif
         return QDGetPictureBounds( pict , rect );
     }
 #endif