X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/52e750fc75020aa412fc85623d2b3cf91f9b0b33..ea6cbf486a3be57fd10283b3cd65a34e193d3d6c:/include/wx/mac/carbon/dataview.h

diff --git a/include/wx/mac/carbon/dataview.h b/include/wx/mac/carbon/dataview.h
index ac0ca36952..2b3eeded38 100644
--- a/include/wx/mac/carbon/dataview.h
+++ b/include/wx/mac/carbon/dataview.h
@@ -7,29 +7,22 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __MACCARBONDATAVIEWCTRL_H__
-#define __MACCARBONDATAVIEWCTRL_H__
+#ifndef _WX_MACCARBONDATAVIEWCTRL_H_
+#define _WX_MACCARBONDATAVIEWCTRL_H_
 
-#include <Carbon/carbon.h>
+// --------------------------------------------------------
+// Type definitions to mask native types
+// --------------------------------------------------------
 
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/control.h"
-#include "wx/scrolwin.h"
-#include "wx/icon.h"
-
-// ---------------------------------------------------------
-// classes
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
+typedef void*         WXDataBrowserItemDataRef;
+typedef unsigned long WXDataBrowserPropertyType;
+typedef wxUint32      WXDataBrowserPropertyID;
 
 // ---------------------------------------------------------
 // wxDataViewRenderer
 // ---------------------------------------------------------
 
-class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
+class WXDLLIMPEXP_ADV wxDataViewRenderer : public wxDataViewRendererBase
 {
 public:
 //
@@ -40,11 +33,11 @@ public:
 //
 // inherited methods from wxDataViewRendererBase
 //
-  virtual int GetAlignment(void) const
+  virtual int GetAlignment() const
   {
     return this->m_alignment;
   }
-  virtual wxDataViewCellMode GetMode(void) const
+  virtual wxDataViewCellMode GetMode() const
   {
     return this->m_mode;
   }
@@ -67,21 +60,21 @@ public:
 //
 // implementation
 //
-  DataBrowserItemDataRef GetDataReference(void) const
+  WXDataBrowserItemDataRef GetDataReference() const
   {
     return this->m_dataReference;
   }
-  wxVariant const& GetValue(void) const
+  wxVariant const& GetValue() const
   {
     return this->m_value;
   }
 
-  virtual DataBrowserPropertyType GetPropertyType(void) const = 0;
+  virtual WXDataBrowserPropertyType GetPropertyType() const = 0;
 
-  virtual bool Render(void) = 0; // a call to the appropriate data browser function filling the data reference with the stored datum;
+  virtual bool Render() = 0; // a call to the appropriate data browser function filling the data reference with the stored datum;
                                  // returns 'true' if the data value could be rendered, 'false' otherwise
 
-  void SetDataReference(DataBrowserItemDataRef const& newDataReference)
+  void SetDataReference(WXDataBrowserItemDataRef const& newDataReference)
   {
     this->m_dataReference = newDataReference;
   }
@@ -90,7 +83,7 @@ private:
 //
 // variables
 //
-  DataBrowserItemDataRef m_dataReference; // data reference of the data browser; the data will be assigned to this reference during rendering
+  WXDataBrowserItemDataRef m_dataReference; // data reference of the data browser; the data will be assigned to this reference during rendering
 
   int m_alignment; // contains the alignment flags
 
@@ -116,7 +109,7 @@ public:
 //
   wxDataViewCustomRenderer(wxString const& varianttype=wxT("string"), wxDataViewCellMode mode=wxDATAVIEW_CELL_INERT, int align=wxDVR_DEFAULT_ALIGNMENT);
   
-  virtual ~wxDataViewCustomRenderer(void);
+  virtual ~wxDataViewCustomRenderer();
 
   void RenderText( const wxString &text, int xoffset, wxRect cell, wxDC *dc, int state );
 
@@ -130,77 +123,38 @@ public:
 // 
   virtual bool Render(wxRect cell, wxDC* dc, int state) = 0;
 
-  virtual bool Activate(wxRect WXUNUSED(cell), wxDataViewModel *WXUNUSED(model), unsigned int WXUNUSED(col), unsigned int WXUNUSED(row))
-  {
-    return false;
-  }
-
-  virtual bool LeftClick(wxPoint WXUNUSED(cursor), wxRect WXUNUSED(cell), wxDataViewModel *WXUNUSED(model), unsigned int WXUNUSED(col), unsigned int WXUNUSED(row))
-  {
-    return false;
-  }
-
-  virtual bool RightClick(wxPoint WXUNUSED(cursor), wxRect WXUNUSED(cell), wxDataViewModel *WXUNUSED(model), unsigned int WXUNUSED(col), unsigned int WXUNUSED(row))
-  {
-    return false;
-  }
-
-  virtual bool StartDrag(wxPoint WXUNUSED(cursor), wxRect WXUNUSED(cell), wxDataViewModel *WXUNUSED(model), unsigned int WXUNUSED(col), unsigned int WXUNUSED(row))
-  {
-    return false;
-  }
-
-//
-// in-place editing
-//
-  virtual void CancelEditing()
-  {
-  }
-
-  virtual wxControl* CreateEditorCtrl(wxWindow * WXUNUSED(parent), wxRect WXUNUSED(labelRect), const wxVariant& WXUNUSED(value))
-  {
-    return NULL;
-  }
-
-  virtual bool FinishEditing()
-  {
-    return false;
-  }
-
-  wxControl* GetEditorCtrl(void) const
-  {
-    return this->m_editorCtrlPtr;
-  }
-  virtual bool GetValueFromEditorCtrl(wxControl* WXUNUSED(editor), wxVariant& WXUNUSED(value))
-  {
-    return false;
-  }
-
-  virtual bool HasEditorCtrl(void)
-  {
-    return false;
-  }
-
-  virtual bool StartEditing(wxDataViewItem const& WXUNUSED(item), wxRect WXUNUSED(labelRect)) 
-  {
-    return false;
-  }
+  virtual bool Activate( wxRect WXUNUSED(cell),
+                         wxDataViewModel *WXUNUSED(model),
+                         const wxDataViewItem & WXUNUSED(item), 
+                         unsigned int WXUNUSED(col) )
+                         { return false; }
+
+  virtual bool LeftClick( wxPoint WXUNUSED(cursor),
+                          wxRect WXUNUSED(cell),
+                          wxDataViewModel *WXUNUSED(model),
+                          const wxDataViewItem & WXUNUSED(item), 
+                          unsigned int WXUNUSED(col) )
+                          { return false; }
   
+  virtual bool StartDrag( wxPoint WXUNUSED(cursor),
+                          wxRect WXUNUSED(cell),
+                          wxDataViewModel *WXUNUSED(model),
+                          const wxDataViewItem & WXUNUSED(item), 
+                          unsigned int WXUNUSED(col) )
+                          { return false; }
+    
 //
 // device context handling
 //
-  virtual wxDC* GetDC(void); // creates a device context and keeps it
+  virtual wxDC* GetDC(); // creates a device context and keeps it
 
 //
 // implementation
 //
-  virtual bool Render(void); // declared in wxDataViewRenderer but will not be used here, therefore calling this function will
+  virtual bool Render(); // declared in wxDataViewRenderer but will not be used here, therefore calling this function will
                              // return 'true' without having done anything
 
-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserCustomType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType() const;
 
   void SetDC(wxDC* newDCPtr); // this method takes ownership of the pointer
 
@@ -234,21 +188,34 @@ public:
 //
 // inherited functions from wxDataViewRenderer
 //
-  virtual bool Render(void);
+  virtual bool Render();
 
 //
 // implementation
 //
-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserTextType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType() const;
 
 protected:
 private:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
 };
 
+// ---------------------------------------------------------
+// wxDataViewTextRendererAttr
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewTextRendererAttr: public wxDataViewTextRenderer
+{
+public:
+//
+// constructors / destructor
+//
+    wxDataViewTextRendererAttr(wxString const& varianttype=wxT("string"), wxDataViewCellMode mode=wxDATAVIEW_CELL_INERT, int align=wxDVR_DEFAULT_ALIGNMENT);
+
+private:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRendererAttr)
+};
+
 // ---------------------------------------------------------
 // wxDataViewBitmapRenderer
 // ---------------------------------------------------------
@@ -264,15 +231,12 @@ public:
 //
 // inherited functions from wxDataViewRenderer
 //
-  virtual bool Render(void);
+  virtual bool Render();
 
 //
 // implementation
 //
-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserIconType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType() const;
 
 protected:
 private:
@@ -291,15 +255,12 @@ public:
 //
 // inherited functions from wxDataViewRenderer
 //
-  virtual bool Render(void);
+  virtual bool Render();
   
 //
 // implementation
 //
-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserIconAndTextType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType() const;
   
 protected:
 private:
@@ -318,15 +279,12 @@ public:
 //
 // inherited functions from wxDataViewRenderer
 //
-  virtual bool Render(void);
+  virtual bool Render();
 
 //
 // implementation
 //
-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserCheckboxType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType() const;
 
 protected:
 private:
@@ -346,15 +304,12 @@ public:
 //
 // inherited functions from wxDataViewRenderer
 //
-  virtual bool Render(void);
+  virtual bool Render();
 
 //
 // implementation
 //
-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserProgressBarType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType() const;
 
 protected:
 private:
@@ -373,15 +328,12 @@ public:
 //
 // inherited functions from wxDataViewRenderer
 //
-  virtual bool Render(void);
+  virtual bool Render();
 
 //
 // implementation
 //
-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserDateTimeType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType() const;
 
 protected:
 private:
@@ -406,44 +358,48 @@ public:
 //
 // inherited methods from wxDataViewColumnBase
 //
-  virtual wxAlignment GetAlignment(void) const
+  virtual wxAlignment GetAlignment() const
   {
     return this->m_alignment;
   }
-  virtual int GetFlags(void) const
+  virtual int GetFlags() const
   {
     return this->m_flags;
   }
-  virtual int GetMaxWidth(void) const
+  virtual int GetMaxWidth() const
   {
     return this->m_maxWidth;
   }
-  virtual int GetMinWidth(void) const
+  virtual int GetMinWidth() const
   {
     return this->m_minWidth;
   }
-  virtual wxString GetTitle(void) const
+  virtual wxString GetTitle() const
   {
     return this->m_title;
   }
-  virtual int GetWidth(void) const
+  virtual int GetWidth() const
   {
     return this->m_width;
   }
 
-  virtual bool IsHidden(void) const
+  virtual bool IsHidden() const
   {
     return false; // not implemented
   }
-  virtual bool IsResizeable(void) const
+  virtual bool IsReorderable() const
+  {
+    return ((this->m_flags & wxDATAVIEW_COL_REORDERABLE) != 0);
+  }
+  virtual bool IsResizeable() const
   {
     return ((this->m_flags & wxDATAVIEW_COL_RESIZABLE) != 0);
   }
-  virtual bool IsSortable(void) const
+  virtual bool IsSortable() const
   {
     return ((this->m_flags & wxDATAVIEW_COL_SORTABLE) != 0);
   }
-  virtual bool IsSortOrderAscending(void) const
+  virtual bool IsSortOrderAscending() const
   {
     return this->m_ascending;
   }
@@ -454,23 +410,24 @@ public:
   virtual void SetHidden(bool WXUNUSED(hidden))
   {
   }
-  virtual void SetMaxWidth  (int maxWidth);
-  virtual void SetMinWidth  (int minWidth);
-  virtual void SetResizeable(bool resizeable);
-  virtual void SetSortable  (bool sortable);
-  virtual void SetSortOrder (bool ascending);
-  virtual void SetTitle     (wxString const& title);
-  virtual void SetWidth     (int  width);
+  virtual void SetMaxWidth   (int maxWidth);
+  virtual void SetMinWidth   (int minWidth);
+  virtual void SetReorderable(bool reorderable);
+  virtual void SetResizeable (bool resizeable);
+  virtual void SetSortable   (bool sortable);
+  virtual void SetSortOrder  (bool ascending);
+  virtual void SetTitle      (wxString const& title);
+  virtual void SetWidth      (int  width);
 
 //
 // implementation
 //
-  DataBrowserPropertyID GetPropertyID(void) const
+  WXDataBrowserPropertyID GetPropertyID() const
   {
     return this->m_propertyID;
   }
   
-  void SetPropertyID(DataBrowserPropertyID newID)
+  void SetPropertyID(WXDataBrowserPropertyID newID)
   {
     this->m_propertyID = newID;
   }
@@ -486,7 +443,7 @@ private:
 //
   bool m_ascending; // sorting order
 
-  DataBrowserPropertyID m_propertyID; // each column is identified by its unique property ID (NOT by the column index)
+  WXDataBrowserPropertyID m_propertyID; // each column is identified by its unique property ID (NOT by the column index)
   
   int m_flags;    // flags for the column
   int m_maxWidth; // maximum width for the column
@@ -523,7 +480,7 @@ public:
   bool Create(wxWindow *parent, wxWindowID id, wxPoint const& pos=wxDefaultPosition, wxSize const& size=wxDefaultSize, long style=0,
               wxValidator const& validator=wxDefaultValidator);
 
-  virtual wxControl* GetMainWindow(void) // should disappear as it is not of any use for the native implementation
+  virtual wxControl* GetMainWindow() // should disappear as it is not of any use for the native implementation
   {
     return this;
   }
@@ -532,33 +489,36 @@ public:
   virtual bool AssociateModel(wxDataViewModel* model);
 
   virtual bool AppendColumn(wxDataViewColumn* columnPtr);
-  virtual bool ClearColumns(void);
+  virtual bool PrependColumn(wxDataViewColumn* columnPtr);
+  virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
+  
+  virtual bool ClearColumns();
   virtual bool DeleteColumn(wxDataViewColumn* columnPtr);
   virtual wxDataViewColumn* GetColumn(unsigned int pos) const;
-  virtual unsigned int GetColumnCount(void) const;
+  virtual unsigned int GetColumnCount() const;
   virtual int GetColumnPosition(wxDataViewColumn const* columnPtr) const;
 
   virtual void Collapse(wxDataViewItem const& item);
   virtual void EnsureVisible(wxDataViewItem const& item, wxDataViewColumn const* columnPtr=NULL);
   virtual void Expand(wxDataViewItem const& item);
   
-  virtual wxDataViewColumn* GetSortingColumn(void) const;
+  virtual wxDataViewColumn* GetSortingColumn() const;
 
-  virtual unsigned int GetCount(void) const;
+  virtual unsigned int GetCount() const;
   virtual wxRect GetItemRect(wxDataViewItem const& item, wxDataViewColumn const* columnPtr) const;
-  virtual wxDataViewItem GetSelection(void) const;
+  virtual wxDataViewItem GetSelection() const;
   virtual int GetSelections(wxDataViewItemArray& sel) const;
   
   virtual void HitTest(wxPoint const& point, wxDataViewItem& item, wxDataViewColumn*& columnPtr) const;
 
   virtual bool IsSelected(wxDataViewItem const& item) const;
 
-  virtual void SelectAll(void);
+  virtual void SelectAll();
   virtual void Select(wxDataViewItem const& item);
   virtual void SetSelections(wxDataViewItemArray const& sel);
 
   virtual void Unselect(wxDataViewItem const& item);
-  virtual void UnselectAll(void);
+  virtual void UnselectAll();
 
 //
 // implementation
@@ -567,12 +527,25 @@ public:
  // adds all children of the passed parent to the control; if 'parentItem' is invalid the root(s) is/are added:
   void AddChildrenLevel(wxDataViewItem const& parentItem);
 
+ // finishes editing of custom items; if no custom item is currently edited the method does nothing
+  void FinishCustomItemEditing();
+
  // returns a pointer to a column;
  // in case the pointer cannot be found NULL is returned:
-  wxDataViewColumn* GetColumnPtr(DataBrowserPropertyID propertyID) const;
+  wxDataViewColumn* GetColumnPtr(WXDataBrowserPropertyID propertyID) const;
+ // returns the current being rendered item of the customized renderer (this item is only valid during editing)
+  wxDataViewItem const& GetCustomRendererItem() const
+  {
+    return this->m_CustomRendererItem;
+  }
+ // returns a pointer to a customized renderer (this pointer is only valid during editing)
+  wxDataViewCustomRenderer* GetCustomRendererPtr() const
+  {
+    return this->m_CustomRendererPtr;
+  }
 
  // checks if currently a delete process is running:
-  bool IsDeleting(void) const
+  bool IsDeleting() const
   {
     return this->m_Deleting;
   }
@@ -585,31 +558,49 @@ public:
   {
     this->m_cgContext = context;
   }
-  void* MacGetDrawingContext(void) const
+  void* MacGetDrawingContext() const
   {
     return this->m_cgContext;
   }
 
- /// sets the flag indicating a deletion process:
+ // sets the currently being edited item of the custom renderer
+  void SetCustomRendererItem(wxDataViewItem const& NewItem)
+  {
+    this->m_CustomRendererItem = NewItem;
+  }
+ // sets the custom renderer
+  void SetCustomRendererPtr(wxDataViewCustomRenderer* NewCustomRendererPtr)
+  {
+    this->m_CustomRendererPtr = NewCustomRendererPtr;
+  }
+ // sets the flag indicating a deletion process:
   void SetDeleting(bool deleting)
   {
     this->m_Deleting = deleting;
   }
 
+  virtual wxVisualAttributes GetDefaultAttributes() const
+  {
+      return GetClassDefaultAttributes(GetWindowVariant());
+  }
+
+  static wxVisualAttributes
+  GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
 protected:
  // inherited methods from wxDataViewCtrlBase:
-  virtual void DoSetExpanderColumn(void);
-  virtual void DoSetIndent(void);
+  virtual void DoSetExpanderColumn();
+  virtual void DoSetIndent();
 
  // event handling:
   void OnSize(wxSizeEvent &event);
 
 private:
  // type definitions:
-  WX_DECLARE_HASH_MAP(DataBrowserPropertyID,wxDataViewColumn*,wxIntegerHash,wxIntegerEqual,ColumnPointerHashMapType);
+  WX_DECLARE_HASH_MAP(WXDataBrowserPropertyID,wxDataViewColumn*,wxIntegerHash,wxIntegerEqual,ColumnPointerHashMapType);
 
  // initializing of local variables:
-  void Init(void);
+  void Init();
 
 ///
 // variables
@@ -620,7 +611,11 @@ private:
                    // try to update data into variables that are already deleted; this flag will ignore all variable update requests during item deletion
 
   void* m_cgContext; // pointer to core graphics context
+
+  wxDataViewCustomRenderer* m_CustomRendererPtr; // pointer to a valid custom renderer while editing; this class does NOT own the pointer
   
+  wxDataViewItem m_CustomRendererItem; // currently edited item by the customerenderer; it is invalid while not editing
+
   ColumnPointerHashMapType m_ColumnPointers; // all column pointers are stored in a hash map with the property ID as a key
 
  // wxWidget internal stuff:
@@ -630,4 +625,4 @@ private:
 };
 
 
-#endif // __MACDATAVIEWCTRL_H__
+#endif // _WX_MACCARBONDATAVIEWCTRL_H_