avoid GCC warning about type-punned pointer breaking strict aliasing rules

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

diff --git a/include/wx/mac/carbon/dataview.h b/include/wx/mac/carbon/dataview.h
index 960a17618242b4e693a418824a2fe75402e71a57..7a8fbeffaae04b450d1ba7d8ff367236d4a00afb 100644 (file)
--- a/include/wx/mac/carbon/dataview.h
+++ b/include/wx/mac/carbon/dataview.h
@@ -7,29 +7,22 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // 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
 // ---------------------------------------------------------
 
 
 // ---------------------------------------------------------
 // wxDataViewRenderer
 // ---------------------------------------------------------
 

-class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
+class WXDLLIMPEXP_ADV wxDataViewRenderer : public wxDataViewRendererBase

 {
 public:
 //
 {
 public:
 //


@@ -67,7 +60,7 @@ public:
 //
 // implementation
 //
 //
 // implementation
 //

-  DataBrowserItemDataRef GetDataReference(void) const
+  WXDataBrowserItemDataRef GetDataReference(void) const

   {
     return this->m_dataReference;
   }
   {
     return this->m_dataReference;
   }


@@ -76,12 +69,12 @@ public:
     return this->m_value;
   }
 
     return this->m_value;
   }
 

-  virtual DataBrowserPropertyType GetPropertyType(void) const = 0;
+  virtual WXDataBrowserPropertyType GetPropertyType(void) const = 0;

 
   virtual bool Render(void) = 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
 
 
   virtual bool Render(void) = 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;
   }
   {
     this->m_dataReference = newDataReference;
   }


@@ -90,7 +83,7 @@ private:
 //
 // variables
 //
 //
 // 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
 
 
   int m_alignment; // contains the alignment flags
 


@@ -118,6 +111,8 @@ public:
   
   virtual ~wxDataViewCustomRenderer(void);
 
   
   virtual ~wxDataViewCustomRenderer(void);
 

+  void RenderText( const wxString &text, int xoffset, wxRect cell, wxDC *dc, int state );
+

 //
 // methods handling render space
 //
 //
 // methods handling render space
 //


@@ -148,42 +143,6 @@ public:
     return false;
   }
 
     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(unsigned int WXUNUSED(row), wxRect WXUNUSED(labelRect)) 
-  {
-    return false;
-  }
-  

 //
 // device context handling
 //
 //
 // device context handling
 //


@@ -193,12 +152,9 @@ public:
 // implementation
 //
   virtual bool Render(void); // declared in wxDataViewRenderer but will not be used here, therefore calling this function will
 // implementation
 //
   virtual bool Render(void); // declared in wxDataViewRenderer but will not be used here, therefore calling this function will

-                             // return 'false' without having done anything
+                             // return 'true' without having done anything

 
 

-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserCustomType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType(void) const;

 
   void SetDC(wxDC* newDCPtr); // this method takes ownership of the pointer
 
 
   void SetDC(wxDC* newDCPtr); // this method takes ownership of the pointer
 


@@ -237,16 +193,29 @@ public:
 //
 // implementation
 //
 //
 // implementation
 //

-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserTextType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType(void) const;

 
 protected:
 private:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
 };
 
 
 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
 // ---------------------------------------------------------
 // ---------------------------------------------------------
 // wxDataViewBitmapRenderer
 // ---------------------------------------------------------


@@ -267,10 +236,7 @@ public:
 //
 // implementation
 //
 //
 // implementation
 //

-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserIconType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType(void) const;

 
 protected:
 private:
 
 protected:
 private:


@@ -281,6 +247,30 @@ private:
 // wxDataViewToggleRenderer
 // ---------------------------------------------------------
 
 // wxDataViewToggleRenderer
 // ---------------------------------------------------------
 

+class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewRenderer
+{
+public:
+  wxDataViewIconTextRenderer(wxString const& varianttype = wxT("wxDataViewIconText"), wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int align=wxDVR_DEFAULT_ALIGNMENT);
+  
+//
+// inherited functions from wxDataViewRenderer
+//
+  virtual bool Render(void);
+  
+//
+// implementation
+//
+  virtual WXDataBrowserPropertyType GetPropertyType(void) const;
+  
+protected:
+private:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
+};
+
+// ---------------------------------------------------------
+// wxDataViewToggleRenderer
+// ---------------------------------------------------------
+

 class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewRenderer
 {
 public:
 class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewRenderer
 {
 public:


@@ -294,10 +284,7 @@ public:
 //
 // implementation
 //
 //
 // implementation
 //

-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserCheckboxType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType(void) const;

 
 protected:
 private:
 
 protected:
 private:


@@ -322,10 +309,7 @@ public:
 //
 // implementation
 //
 //
 // implementation
 //

-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserProgressBarType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType(void) const;

 
 protected:
 private:
 
 protected:
 private:


@@ -349,10 +333,7 @@ public:
 //
 // implementation
 //
 //
 // implementation
 //

-  virtual DataBrowserPropertyType GetPropertyType(void) const
-  {
-    return kDataBrowserDateTimeType;
-  }
+  virtual WXDataBrowserPropertyType GetPropertyType(void) const;

 
 protected:
 private:
 
 protected:
 private:


@@ -406,6 +387,10 @@ public:
   {
     return false; // not implemented
   }
   {
     return false; // not implemented
   }

+  virtual bool IsReorderable(void) const
+  {
+    return ((this->m_flags & wxDATAVIEW_COL_REORDERABLE) != 0);
+  }

   virtual bool IsResizeable(void) const
   {
     return ((this->m_flags & wxDATAVIEW_COL_RESIZABLE) != 0);
   virtual bool IsResizeable(void) const
   {
     return ((this->m_flags & wxDATAVIEW_COL_RESIZABLE) != 0);


@@ -425,26 +410,31 @@ public:
   virtual void SetHidden(bool WXUNUSED(hidden))
   {
   }
   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
 //
 
 //
 // implementation
 //

-  DataBrowserPropertyID GetPropertyID(void) const
+  WXDataBrowserPropertyID GetPropertyID() const

   {
     return this->m_propertyID;
   }
   
   {
     return this->m_propertyID;
   }
   

-  void SetPropertyID(DataBrowserPropertyID newID)
+  void SetPropertyID(WXDataBrowserPropertyID newID)

   {
     this->m_propertyID = newID;
   }
   {
     this->m_propertyID = newID;
   }

+  void SetWidthVariable(int NewWidth)
+  {
+    this->m_width = NewWidth;
+  }

 
 protected:
 private:
 
 protected:
 private:


@@ -453,7 +443,7 @@ private:
 //
   bool m_ascending; // sorting order
 
 //
   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
   
   int m_flags;    // flags for the column
   int m_maxWidth; // maximum width for the column


@@ -475,7 +465,7 @@ class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase
 {
 public:
  // Constructors / destructor:
 {
 public:
  // Constructors / destructor:

-  wxDataViewCtrl()
+  wxDataViewCtrl(void)

   {
     this->Init();
   }
   {
     this->Init();
   }


@@ -490,25 +480,74 @@ public:
   bool Create(wxWindow *parent, wxWindowID id, wxPoint const& pos=wxDefaultPosition, wxSize const& size=wxDefaultSize, long style=0,
               wxValidator const& validator=wxDefaultValidator);
 
   bool Create(wxWindow *parent, wxWindowID id, wxPoint const& pos=wxDefaultPosition, wxSize const& size=wxDefaultSize, long style=0,
               wxValidator const& validator=wxDefaultValidator);
 

- // inherited methods from 'wxDataViewCtrlBase':
-  virtual bool AppendColumn(wxDataViewColumn* columnPtr);
-
-  virtual bool AssociateModel(wxDataViewModel* model);
-

   virtual wxControl* GetMainWindow(void) // should disappear as it is not of any use for the native implementation
   {
     return this;
   }
   
   virtual wxControl* GetMainWindow(void) // should disappear as it is not of any use for the native implementation
   {
     return this;
   }
   

-  virtual wxDataViewItem GetSelection(void);
+ // inherited methods from 'wxDataViewCtrlBase':
+  virtual bool AssociateModel(wxDataViewModel* model);
+
+  virtual bool AppendColumn(wxDataViewColumn* columnPtr);
+  virtual bool ClearColumns(void);
+  virtual bool DeleteColumn(wxDataViewColumn* columnPtr);
+  virtual wxDataViewColumn* GetColumn(unsigned int pos) const;
+  virtual unsigned int GetColumnCount(void) const;
+  virtual int GetColumnPosition(wxDataViewColumn const* columnPtr) const;
+  virtual bool PrependColumn(wxDataViewColumn* columnPtr);
+
+  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 unsigned int GetCount(void) const;
+  virtual wxRect GetItemRect(wxDataViewItem const& item, wxDataViewColumn const* columnPtr) const;
+  virtual wxDataViewItem GetSelection(void) 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 Select(wxDataViewItem const& item);
+  virtual void SetSelections(wxDataViewItemArray const& sel);
+
+  virtual void Unselect(wxDataViewItem const& item);
+  virtual void UnselectAll(void);

 
 //
 // implementation
 //
 
 
 //
 // implementation
 //
 

-  // adds all children of the passed parent to the control; if 'parentItem' is invalid the root(s) is/are added:
+ // 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);
 
   void AddChildrenLevel(wxDataViewItem const& parentItem);
 

+ // finishes editing of custom items; if no custom item is currently edited the method does nothing
+  void FinishCustomItemEditing(void);
+
+ // returns a pointer to a column;
+ // in case the pointer cannot be found NULL is returned:
+  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(void) const
+  {
+    return this->m_CustomRendererItem;
+  }
+ // returns a pointer to a customized renderer (this pointer is only valid during editing)
+  wxDataViewCustomRenderer* GetCustomRendererPtr(void) const
+  {
+    return this->m_CustomRendererPtr;
+  }
+
+ // checks if currently a delete process is running:
+  bool IsDeleting(void) const
+  {
+    return this->m_Deleting;
+  }
+

  // with CG, we need to get the context from an kEventControlDraw event
  // unfortunately, the DataBrowser callbacks don't provide the context
  // and we need it, so we need to set/remove it before and after draw 
  // with CG, we need to get the context from an kEventControlDraw event
  // unfortunately, the DataBrowser callbacks don't provide the context
  // and we need it, so we need to set/remove it before and after draw 


@@ -522,6 +561,22 @@ public:
     return this->m_cgContext;
   }
 
     return this->m_cgContext;
   }
 

+ // 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;
+  }
+

 protected:
  // inherited methods from wxDataViewCtrlBase:
   virtual void DoSetExpanderColumn(void);
 protected:
  // inherited methods from wxDataViewCtrlBase:
   virtual void DoSetExpanderColumn(void);


@@ -531,6 +586,9 @@ protected:
   void OnSize(wxSizeEvent &event);
 
 private:
   void OnSize(wxSizeEvent &event);
 
 private:

+ // type definitions:
+  WX_DECLARE_HASH_MAP(WXDataBrowserPropertyID,wxDataViewColumn*,wxIntegerHash,wxIntegerEqual,ColumnPointerHashMapType);
+

  // initializing of local variables:
   void Init(void);
 
  // initializing of local variables:
   void Init(void);
 


@@ -538,10 +596,18 @@ private:
 // variables
 //
 
 // variables
 //
 

-  wxDataViewModelNotifier* m_NotifierPtr; // the notifier is NOT owned by this class but by the associated model
+  bool m_Deleting; // flag indicating if a delete process is running; this flag is necessary because the notifier indicating an item deletion in the model may be called
+                   // after the actual deletion of the item; then, the callback function "wxMacDataViewDataBrowserListViewControl::DataBrowserGetSetItemDataProc" may
+                   // 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
 
 
   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:
   DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
   DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
  // wxWidget internal stuff:
   DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
   DECLARE_NO_COPY_CLASS(wxDataViewCtrl)


@@ -549,4 +615,4 @@ private:
 };
 
 
 };
 
 

-#endif // __MACDATAVIEWCTRL_H__
+#endif // _WX_MACCARBONDATAVIEWCTRL_H_