No changes, just attempts to make the code more readable.

Reformat/reindent, use more wx coding style, wrap some extremely long lines.
Use shorter and less Carbon-ish variable names. Clarify some comments.

Also use static_cast<> because there is no need to use reinterpret_cast<> when
a static_cast<> will do.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62435 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/osx/cocoa/dataview.h

@@ -12,11 +12,7 @@
 
 #include "wx/defs.h"
 
-#if wxUSE_GUI
-
-#ifdef __OBJC__
 #import <Cocoa/Cocoa.h>
-#endif
 
 #include "wx/osx/core/dataview.h"
 #include "wx/osx/private.h"
@@ -24,40 +20,47 @@
 // Forward declaration
 class wxCocoaDataViewControl;
 
+/*
+    Dramatis personae:
+
+    [vertical arrows indicate inheritance, horizontal -- aggregation]
+
+
+        wxWindow ---> wxWidgetCocoaImpl  wxDataViewWidgetImpl   NSOutlineView
+            |                 \                  /                   |
+            |                  \                /                    |
+            |                   \              /                     |
+            v                   \/            \/                     v
+     wxDataViewCtrl -------> wxCocoaDataViewControl <-------> wxCocoaOutlineView
+
+
+     The right most classes are Objective-C only and can't be used from (pure)
+     C++ code.
+ */
+
 // ============================================================================
-// wxPointerObject
+// wxPointerObject: simply stores a pointer, without taking its ownership
 // ============================================================================
-//
+
-// This is a helper class to store a pointer in an object. This object just
+// Two pointer objects are equal if the containing pointers are equal. This
-// stores the pointer but does not take any ownership.
-// To pointer objects are equal if the containing pointers are equal. This
 // means also that the hash value of a pointer object depends only on the
 // stored pointer.
-//
+
 @interface wxPointerObject : NSObject
 {
     void* pointer;
 }
 
- //
- // object initialization
- //
     -(id) initWithPointer:(void*)initPointer;
 
- //
- // access to pointer
- //
     -(void*) pointer;
     -(void)  setPointer:(void*)newPointer;
-
 @end
 
 // ============================================================================
-// wxSortDescriptorObject
+// wxSortDescriptorObject: helper class to use native sorting facilities
 // ============================================================================
-//
+
-// This is a helper class to use native sorting facilities.
-//
 @interface wxSortDescriptorObject : NSSortDescriptor<NSCopying>
 {
     wxDataViewColumn* columnPtr; // pointer to the sorting column
@@ -65,41 +68,34 @@ class wxCocoaDataViewControl;
     wxDataViewModel* modelPtr; // pointer to model
 }
 
- //
+    -(id)
- // initialization
+    initWithModelPtr:(wxDataViewModel*)initModelPtr
- //
+        sortingColumnPtr:(wxDataViewColumn*)initColumnPtr
-  -(id) initWithModelPtr:(wxDataViewModel*)initModelPtr sortingColumnPtr:(wxDataViewColumn*)initColumnPtr ascending:(BOOL)sortAscending;
+        ascending:(BOOL)sortAscending;
 
- //
- // access to variables
- //
     -(wxDataViewColumn*) columnPtr;
     -(wxDataViewModel*) modelPtr;
 
     -(void) setColumnPtr:(wxDataViewColumn*)newColumnPtr;
     -(void) setModelPtr:(wxDataViewModel*)newModelPtr;
-
 @end
 
 // ============================================================================
-// wxDataViewColumnNativeData
+// wxDataViewColumnNativeData: extra data for wxDataViewColumn
 // ============================================================================
+
 class wxDataViewColumnNativeData
 {
 public:
-//
+    wxDataViewColumnNativeData() : m_NativeColumnPtr(NULL)
-// constructors / destructor
+    {
-//
+    }
-  wxDataViewColumnNativeData(void) : m_NativeColumnPtr(NULL)
+
-  {
+    wxDataViewColumnNativeData(NSTableColumn* initNativeColumnPtr)
-  }
+        : m_NativeColumnPtr(initNativeColumnPtr)
-  wxDataViewColumnNativeData(NSTableColumn* initNativeColumnPtr) : m_NativeColumnPtr(initNativeColumnPtr)
     {
     }
 
-//
-// data access methods
-//
     NSTableColumn* GetNativeColumnPtr() const
     {
         return m_NativeColumnPtr;
@@ -110,32 +106,32 @@ public:
         m_NativeColumnPtr = newNativeColumnPtr;
     }
 
-protected:
 private:
-//
+    // not owned by us
-// variables
+    NSTableColumn* m_NativeColumnPtr;
-//
-  NSTableColumn* m_NativeColumnPtr; // this class does not take over ownership of the pointer nor retains it
 };
 
 // ============================================================================
-// wxDataViewRendererNativeData
+// wxDataViewRendererNativeData: extra data for wxDataViewRenderer
 // ============================================================================
+
 class wxDataViewRendererNativeData
 {
 public:
-//
+    wxDataViewRendererNativeData()
-// constructors / destructor
+        : m_Object(NULL), m_ColumnCell(NULL)
-//
-  wxDataViewRendererNativeData(void) : m_Object(NULL), m_ColumnCell(NULL)
     {
         Init();
     }
-  wxDataViewRendererNativeData(NSCell* initColumnCell) : m_Object(NULL), m_ColumnCell([initColumnCell retain])
+
+    wxDataViewRendererNativeData(NSCell* initColumnCell)
+        : m_Object(NULL), m_ColumnCell([initColumnCell retain])
     {
         Init();
     }
-  wxDataViewRendererNativeData(NSCell* initColumnCell, id initObject) : m_Object([initObject retain]), m_ColumnCell([initColumnCell retain])
+
+    wxDataViewRendererNativeData(NSCell* initColumnCell, id initObject)
+        : m_Object([initObject retain]), m_ColumnCell([initColumnCell retain])
     {
         Init();
     }
@@ -149,29 +145,11 @@ public:
         [m_origTextColour release];
     }
 
- //
+    NSCell* GetColumnCell() const { return m_ColumnCell; }
- // data access methods
+    NSTableColumn* GetColumnPtr() const { return m_TableColumnPtr; }
- //
+    id GetItem() const { return m_Item; }
-  NSCell* GetColumnCell() const
+    NSCell* GetItemCell() const { return m_ItemCell; }
-  {
+    id GetObject() const { return m_Object; }
-    return m_ColumnCell;
-  }
-  NSTableColumn* GetColumnPtr() const
-  {
-    return m_TableColumnPtr;
-  }
-  id GetItem() const
-  {
-    return m_Item;
-  }
-  NSCell* GetItemCell() const
-  {
-    return m_ItemCell;
-  }
-  id GetObject() const
-  {
-    return m_Object;
-  }
 
     void SetColumnCell(NSCell* newCell)
     {
@@ -198,10 +176,11 @@ public:
         m_Object = newObject;
     }
 
-  // The original cell font and text colour stored here are NULL by default and
+    // The original cell font and text colour stored here are NULL by default
-  // are only initialized to the values retrieved from the cell when we change
+    // and are only initialized to the values retrieved from the cell when we
-  // them from wxCocoaOutlineView:willDisplayCell:forTableColumn:item: which
+    // change them from wxCocoaOutlineView:willDisplayCell:forTableColumn:item:
-  // calls our SaveOriginalXXX() methods before changing the cell attributes.
+    // which calls our SaveOriginalXXX() methods before changing the cell
+    // attributes.
     //
     // This allows us to avoid doing anything for the columns without any
     // attributes but still be able to restore the correct attributes for the
@@ -231,7 +210,10 @@ private:
     void Init();
 
     id m_Item;   // item NOT owned by renderer
-  id m_Object; // object that can be used by renderer for storing special data (owned by renderer)
+
+    // object that can be used by renderer for storing special data (owned by
+    // renderer)
+    id m_Object;
 
     NSCell* m_ColumnCell; // column's cell is owned by renderer
     NSCell* m_ItemCell;   // item's cell is NOT owned by renderer
@@ -248,7 +230,7 @@ private:
 // ============================================================================
 // wxCocoaOutlineDataSource
 // ============================================================================
-//
+
 // This class implements the data source delegate for the outline view.
 // As only an informal protocol exists this class inherits from NSObject only.
 //
@@ -270,7 +252,9 @@ private:
 //
 @interface wxCocoaOutlineDataSource : NSObject
 {
-  NSArray* sortDescriptors; // descriptors specifying the sorting (currently the array only holds one object only)
+    // descriptors specifying the sorting (currently the array only holds one
+    // object only)
+    NSArray* sortDescriptors;
 
     NSMutableArray* children; // buffered children
 
@@ -280,53 +264,71 @@ private:
 
     wxDataViewModel* model;
 
-  wxPointerObject* currentParentItem; // parent of the buffered children; the object is owned
+    // parent of the buffered children; the object is owned
+    wxPointerObject* currentParentItem;
 }
 
- //
     // methods of informal protocol:
- //
+    -(BOOL)
-  -(BOOL)            outlineView:(NSOutlineView*)outlineView acceptDrop:(id<NSDraggingInfo>)info item:(id)item childIndex:(NSInteger)index;
+    outlineView:(NSOutlineView*)outlineView
-  -(id)              outlineView:(NSOutlineView*)outlineView child:(NSInteger)index ofItem:(id)item;
+        acceptDrop:(id<NSDraggingInfo>)info
-  -(id)              outlineView:(NSOutlineView*)outlineView objectValueForTableColumn:(NSTableColumn*)tableColumn byItem:(id)item;
+        item:(id)item
-  -(BOOL)            outlineView:(NSOutlineView*)outlineView isItemExpandable:(id)item;
+        childIndex:(NSInteger)index;
-  -(NSInteger)       outlineView:(NSOutlineView*)outlineView numberOfChildrenOfItem:(id)item;
+
-  -(NSDragOperation) outlineView:(NSOutlineView*)outlineView validateDrop:(id<NSDraggingInfo>)info proposedItem:(id)item proposedChildIndex:(NSInteger)index;
+    -(id)
-  -(BOOL)            outlineView:(NSOutlineView*)outlineView writeItems:(NSArray*)items toPasteboard:(NSPasteboard*)pasteboard;
+    outlineView:(NSOutlineView*)outlineView
+        child:(NSInteger)index
+        ofItem:(id)item;
+
+    -(id)
+    outlineView:(NSOutlineView*)outlineView 
+        objectValueForTableColumn:(NSTableColumn*)tableColumn
+        byItem:(id)item;
+
+    -(BOOL)
+    outlineView:(NSOutlineView*)outlineView
+        isItemExpandable:(id)item;
+
+    -(NSInteger)
+    outlineView:(NSOutlineView*)outlineView
+        numberOfChildrenOfItem:(id)item;
+
+    -(NSDragOperation)
+    outlineView:(NSOutlineView*)outlineView
+        validateDrop:(id<NSDraggingInfo>)info
+        proposedItem:(id)item
+        proposedChildIndex:(NSInteger)index;
+
+    -(BOOL)
+    outlineView:(NSOutlineView*)outlineView
+        writeItems:(NSArray*)items
+        toPasteboard:(NSPasteboard*)pasteboard;
 
- //
     // buffer for items handling
- //
     -(void)             addToBuffer:(wxPointerObject*)item;
     -(void)             clearBuffer;
-  -(wxPointerObject*) getDataViewItemFromBuffer:(wxDataViewItem const&)item;  // returns the item in the buffer that has got the same pointer as "item",
+    // returns the item in the buffer that has got the same pointer as "item",
-  -(wxPointerObject*) getItemFromBuffer:(wxPointerObject*)item;               // if such an item does not exist nil is returned
+    // if such an item does not exist nil is returned
+    -(wxPointerObject*) getDataViewItemFromBuffer:(const wxDataViewItem&)item;
+    -(wxPointerObject*) getItemFromBuffer:(wxPointerObject*)item;
     -(BOOL)             isInBuffer:(wxPointerObject*)item;
     -(void)             removeFromBuffer:(wxPointerObject*)item;
 
- //
     // buffered children handling
- //
     -(void)             appendChild:(wxPointerObject*)item;
     -(void)             clearChildren;
     -(wxPointerObject*) getChild:(NSUInteger)index;
     -(NSUInteger)       getChildCount;
     -(void)             removeChild:(NSUInteger)index;
 
- //
     // buffer handling
- //
     -(void) clearBuffers;
 
- //
     // sorting
- //
     -(NSArray*) sortDescriptors;
     -(void)     setSortDescriptors:(NSArray*)newSortDescriptors;
 
- //
+    // access to wxWidgets variables
- // access to wxWidget's variables
- //
     -(wxPointerObject*) currentParentItem;
     -(wxCocoaDataViewControl*) implementation;
     -(wxDataViewModel*) model;
@@ -334,28 +336,21 @@ private:
     -(void) setImplementation:(wxCocoaDataViewControl*)newImplementation;
     -(void) setModel:(wxDataViewModel*)newModel;
 
- //
     // other methods
- //
+    -(void)
-  -(void) bufferItem:(wxPointerObject*)parentItem withChildren:(wxDataViewItemArray*)dataViewChildrenPtr;
+    bufferItem:(wxPointerObject*)parentItem
-
+        withChildren:(wxDataViewItemArray*)dataViewChildrenPtr;
 @end
 
 // ============================================================================
-// wxCustomCell
+// wxCustomCell: used for custom renderers
 // ============================================================================
-//
+
-// This is a cell that is used for custom renderers.
-//
 @interface wxCustomCell : NSTextFieldCell
 {
 }
 
- //
- // other methods
- //
     -(NSSize) cellSize;
-
 @end
 
 // ============================================================================
@@ -377,44 +372,32 @@ private:
 {
 @private
     CGFloat xImageShift;    // shift for the image in x-direction from border
-  CGFloat spaceImageText; // space between image and text ("belongs" to the image)
+    CGFloat spaceImageText; // space between image and text
 
     NSImage* image; // the image itself
 
     NSSize imageSize; // largest size of the image; default size is (16, 16)
 
-  NSTextAlignment cellAlignment; // the text alignment is used to align the whole
+    // the text alignment is used to align the whole cell (image and text)
-                                 // cell (image and text)
+    NSTextAlignment cellAlignment;
 }
 
- //
- // alignment
- //
     -(NSTextAlignment) alignment;
     -(void) setAlignment:(NSTextAlignment)newAlignment;
 
- //
- // image access
- //
     -(NSImage*) image;
     -(void) setImage:(NSImage*)newImage;
 
- //
- // size access
- //
     -(NSSize) imageSize;
     -(void) setImageSize:(NSSize) newImageSize;
 
- //
- // other methods
- //
     -(NSSize) cellSize;
-
 @end
 
 // ============================================================================
 // wxCocoaOutlineView
 // ============================================================================
+
 @interface wxCocoaOutlineView : NSOutlineView
 {
 @private
@@ -425,33 +408,33 @@ private:
     wxCocoaDataViewControl* implementation;
 }
 
- //
- // access to wxWidget's implementation
- //
     -(wxCocoaDataViewControl*) implementation;
     -(void) setImplementation:(wxCocoaDataViewControl*) newImplementation;
-
 @end
 
 // ============================================================================
 // wxCocoaDataViewControl
 // ============================================================================
-//
+
 // This is the internal interface class between wxDataViewCtrl (wxWidget) and
 // the native source view (Mac OS X cocoa).
-//
+class wxCocoaDataViewControl : public wxWidgetCocoaImpl,
-class wxCocoaDataViewControl : public wxWidgetCocoaImpl, public wxDataViewWidgetImpl
+                               public wxDataViewWidgetImpl
 {
 public:
- //
     // constructors / destructor
- //
+    wxCocoaDataViewControl(wxWindow* peer,
-  wxCocoaDataViewControl(wxWindow* peer, wxPoint const& pos, wxSize const& size, long style);
+                           const wxPoint& pos,
-  ~wxCocoaDataViewControl();
+                           const wxSize& size,
+                           long style);
+    virtual ~wxCocoaDataViewControl();
+
+    wxDataViewCtrl* GetDataViewCtrl() const
+    {
+        return static_cast<wxDataViewCtrl*>(GetWXPeer());
+    }
 
- //
     // column related methods (inherited from wxDataViewWidgetImpl)
- //
     virtual bool ClearColumns();
     virtual bool DeleteColumn(wxDataViewColumn* columnPtr);
     virtual void DoSetExpanderColumn(wxDataViewColumn const* columnPtr);
@@ -459,37 +442,40 @@ public:
     virtual int GetColumnPosition(wxDataViewColumn const* columnPtr) const;
     virtual bool InsertColumn(unsigned int pos, wxDataViewColumn* columnPtr);
 
- //
     // item related methods (inherited from wxDataViewWidgetImpl)
- //
+    virtual bool Add(const wxDataViewItem& parent, const wxDataViewItem& item);
-  virtual bool         Add          (wxDataViewItem const& parent, wxDataViewItem const& item);
+    virtual bool Add(const wxDataViewItem& parent,
-  virtual bool         Add          (wxDataViewItem const& parent, wxDataViewItemArray const& items);
+                     const wxDataViewItemArray& items);
-  virtual void         Collapse     (wxDataViewItem const& item);
+    virtual void Collapse(const wxDataViewItem& item);
-  virtual void         EnsureVisible(wxDataViewItem const& item, wxDataViewColumn const* columnPtr);
+    virtual void EnsureVisible(const wxDataViewItem& item,
-  virtual void         Expand       (wxDataViewItem const& item);
+                               wxDataViewColumn const* columnPtr);
+    virtual void Expand(const wxDataViewItem& item);
     virtual unsigned int GetCount() const;
-  virtual wxRect       GetRectangle (wxDataViewItem const& item, wxDataViewColumn const* columnPtr);
+    virtual wxRect GetRectangle(const wxDataViewItem& item,
-  virtual bool         IsExpanded   (wxDataViewItem const& item) const;
+                                wxDataViewColumn const* columnPtr);
+    virtual bool IsExpanded(const wxDataViewItem& item) const;
     virtual bool Reload();
-  virtual bool         Remove       (wxDataViewItem const& parent, wxDataViewItem const& item);
+    virtual bool Remove(const wxDataViewItem& parent,
-  virtual bool         Remove       (wxDataViewItem const& parent, wxDataViewItemArray const& item);
+                        const wxDataViewItem& item);
-  virtual bool         Update       (wxDataViewColumn const* columnPtr);
+    virtual bool Remove(const wxDataViewItem& parent,
-  virtual bool         Update       (wxDataViewItem const& parent, wxDataViewItem const& item);
+                        const wxDataViewItemArray& item);
-  virtual bool         Update       (wxDataViewItem const& parent, wxDataViewItemArray const& items);
+    virtual bool Update(const wxDataViewColumn* columnPtr);
+    virtual bool Update(const wxDataViewItem& parent,
+                        const wxDataViewItem& item);
+    virtual bool Update(const wxDataViewItem& parent,
+                        const wxDataViewItemArray& items);
 
- //
     // model related methods
- //
+    virtual bool AssociateModel(wxDataViewModel* model);
-  virtual bool AssociateModel(wxDataViewModel* model); // informs the native control that a model is present
 
     //
     // selection related methods (inherited from wxDataViewWidgetImpl)
     //
     virtual int  GetSelections(wxDataViewItemArray& sel)   const;
-  virtual bool IsSelected   (wxDataViewItem const& item) const;
+    virtual bool IsSelected(const wxDataViewItem& item) const;
-  virtual void Select       (wxDataViewItem const& item);
+    virtual void Select(const wxDataViewItem& item);
     virtual void SelectAll();
-  virtual void Unselect     (wxDataViewItem const& item);
+    virtual void Unselect(const wxDataViewItem& item);
     virtual void UnselectAll();
 
     //
@@ -502,35 +488,20 @@ public:
     // other methods (inherited from wxDataViewWidgetImpl)
     //
     virtual void DoSetIndent(int indent);
-  virtual void HitTest     (wxPoint const& point, wxDataViewItem& item, wxDataViewColumn*& columnPtr) const;
+    virtual void HitTest(const wxPoint& point,
-  virtual void SetRowHeight(wxDataViewItem const& item, unsigned int height);
+                         wxDataViewItem& item,
+                         wxDataViewColumn*& columnPtr) const;
+    virtual void SetRowHeight(const wxDataViewItem& item, unsigned int height);
     virtual void OnSize();
 
- //
- // other methods
- //
-  wxDataViewCtrl* GetDataViewCtrl() const
-  {
-    return dynamic_cast<wxDataViewCtrl*>(GetWXPeer());
-  }
-
-//
     // drag & drop helper methods
-//
     wxDataFormat GetDnDDataFormat(wxDataObjectComposite* dataObjects);
-  wxDataObjectComposite* GetDnDDataObjects(NSData* dataObject) const; // create the data objects from the native dragged object
+    wxDataObjectComposite* GetDnDDataObjects(NSData* dataObject) const;
-protected:
+
 private:
-//
-// variables
-//
     wxCocoaOutlineDataSource* m_DataSource;
 
     wxCocoaOutlineView* m_OutlineView;
 };
 
-typedef wxCocoaDataViewControl* wxCocoaDataViewControlPointer;
-
-
-#endif // wxUSE_GUI
 #endif // _WX_DATAVIEWCTRL_COCOOA_H_