typo fix

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

diff --git a/include/wx/osx/carbon/dataview.h b/include/wx/osx/carbon/dataview.h
index 9c5aa166ebd13c34186b94646e7bc03a8485382c..19546e2a6da609c5c77b08396f9019f6026a1530 100644 (file)
--- a/include/wx/osx/carbon/dataview.h
+++ b/include/wx/osx/carbon/dataview.h
@@ -1,7 +1,7 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/mac/carbon/dataview.h
 // Purpose:     wxDataViewCtrl native implementation header
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/mac/carbon/dataview.h
 // Purpose:     wxDataViewCtrl native implementation header

-// Author:      
+// Author:

 // Id:          $Id$
 // Copyright:   (c) 2007
 // Licence:     wxWindows licence
 // Id:          $Id$
 // Copyright:   (c) 2007
 // Licence:     wxWindows licence


@@ -108,7 +108,7 @@ public:
 // constructors / destructor
 //
   wxDataViewCustomRenderer(wxString const& varianttype=wxT("string"), wxDataViewCellMode mode=wxDATAVIEW_CELL_INERT, int align=wxDVR_DEFAULT_ALIGNMENT);
 // constructors / destructor
 //
   wxDataViewCustomRenderer(wxString const& varianttype=wxT("string"), wxDataViewCellMode mode=wxDATAVIEW_CELL_INERT, int align=wxDVR_DEFAULT_ALIGNMENT);

-  
+

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


@@ -120,29 +120,29 @@ public:
 
 //
 // methods handling user actions
 
 //
 // methods handling user actions

-// 
+//

   virtual bool Render(wxRect cell, wxDC* dc, int state) = 0;
 
   virtual bool Activate( wxRect WXUNUSED(cell),
                          wxDataViewModel *WXUNUSED(model),
   virtual bool Render(wxRect cell, wxDC* dc, int state) = 0;
 
   virtual bool Activate( wxRect WXUNUSED(cell),
                          wxDataViewModel *WXUNUSED(model),

-                         const wxDataViewItem & WXUNUSED(item), 
+                         const wxDataViewItem & WXUNUSED(item),

                          unsigned int WXUNUSED(col) )
                          { return false; }
 
   virtual bool LeftClick( wxPoint WXUNUSED(cursor),
                           wxRect WXUNUSED(cell),
                           wxDataViewModel *WXUNUSED(model),
                          unsigned int WXUNUSED(col) )
                          { return false; }
 
   virtual bool LeftClick( wxPoint WXUNUSED(cursor),
                           wxRect WXUNUSED(cell),
                           wxDataViewModel *WXUNUSED(model),

-                          const wxDataViewItem & WXUNUSED(item), 
+                          const wxDataViewItem & WXUNUSED(item),

                           unsigned int WXUNUSED(col) )
                           { return false; }
                           unsigned int WXUNUSED(col) )
                           { return false; }

-  
+

   virtual bool StartDrag( wxPoint WXUNUSED(cursor),
                           wxRect WXUNUSED(cell),
                           wxDataViewModel *WXUNUSED(model),
   virtual bool StartDrag( wxPoint WXUNUSED(cursor),
                           wxRect WXUNUSED(cell),
                           wxDataViewModel *WXUNUSED(model),

-                          const wxDataViewItem & WXUNUSED(item), 
+                          const wxDataViewItem & WXUNUSED(item),

                           unsigned int WXUNUSED(col) )
                           { return false; }
                           unsigned int WXUNUSED(col) )
                           { return false; }

-    
+

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


@@ -251,17 +251,17 @@ class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewRenderer
 {
 public:
   wxDataViewIconTextRenderer(wxString const& varianttype = wxT("wxDataViewIconText"), wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int align=wxDVR_DEFAULT_ALIGNMENT);
 {
 public:
   wxDataViewIconTextRenderer(wxString const& varianttype = wxT("wxDataViewIconText"), wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int align=wxDVR_DEFAULT_ALIGNMENT);

-  
+

 //
 // inherited functions from wxDataViewRenderer
 //
   virtual bool Render();
 //
 // inherited functions from wxDataViewRenderer
 //
   virtual bool Render();

-  
+

 //
 // implementation
 //
   virtual WXDataBrowserPropertyType GetPropertyType() const;
 //
 // implementation
 //
   virtual WXDataBrowserPropertyType GetPropertyType() const;

-  
+

 protected:
 private:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
 protected:
 private:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)


@@ -347,115 +347,96 @@ private:
 class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
 {
 public:
 class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
 {
 public:

-//
-// constructors / destructor
-//
-  wxDataViewColumn(wxString const& title, wxDataViewRenderer* renderer, unsigned int model_column, int width=80, wxAlignment align=wxALIGN_CENTER,
-                   int flags=wxDATAVIEW_COL_RESIZABLE);
-  wxDataViewColumn(wxBitmap const& bitmap, wxDataViewRenderer* renderer, unsigned int model_column, int width=80, wxAlignment align=wxALIGN_CENTER,
-                   int flags=wxDATAVIEW_COL_RESIZABLE);
-
-//
-// inherited methods from wxDataViewColumnBase
-//
-  virtual wxAlignment GetAlignment() const
-  {
-    return this->m_alignment;
-  }
-  virtual int GetFlags() const
-  {
-    return this->m_flags;
-  }
-  virtual int GetMaxWidth() const
-  {
-    return this->m_maxWidth;
-  }
-  virtual int GetMinWidth() const
-  {
-    return this->m_minWidth;
-  }
-  virtual wxString GetTitle() const
-  {
-    return this->m_title;
-  }
-  virtual int GetWidth() const
-  {
-    return this->m_width;
-  }
-
-  virtual bool IsHidden() const
-  {
-    return false; // not implemented
-  }
-  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() const
-  {
-    return ((this->m_flags & wxDATAVIEW_COL_SORTABLE) != 0);
-  }
-  virtual bool IsSortOrderAscending() const
-  {
-    return this->m_ascending;
-  }
-
-  virtual void SetAlignment(wxAlignment align);
-  virtual void SetBitmap   (wxBitmap const& bitmap);
-  virtual void SetFlags    (int flags);
-  virtual void SetHidden(bool WXUNUSED(hidden))
-  {
-  }
-  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
-//
-  WXDataBrowserPropertyID GetPropertyID() const
-  {
-    return this->m_propertyID;
-  }
-  
-  void SetPropertyID(WXDataBrowserPropertyID newID)
-  {
-    this->m_propertyID = newID;
-  }
-  void SetWidthVariable(int NewWidth)
-  {
-    this->m_width = NewWidth;
-  }
+    // constructors / destructor
+    wxDataViewColumn(const wxString& title,
+                     wxDataViewRenderer* renderer,
+                     unsigned int model_column,
+                     int width = wxDVC_DEFAULT_WIDTH,
+                     wxAlignment align = wxALIGN_CENTER,
+                     int flags = wxDATAVIEW_COL_RESIZABLE)
+        : wxDataViewColumnBase(renderer, model_column),
+          m_title(title)
+    {
+        Init(width, align, flags);
+    }
+
+    wxDataViewColumn(const wxBitmap& bitmap,
+                     wxDataViewRenderer* renderer,
+                     unsigned int model_column,
+                     int width = wxDVC_DEFAULT_WIDTH,
+                     wxAlignment align = wxALIGN_CENTER,
+                     int flags = wxDATAVIEW_COL_RESIZABLE)
+        : wxDataViewColumnBase(bitmap, renderer, model_column)
+    {
+        Init(width, align, flags);
+    }
+
+    // implement wxHeaderColumnBase pure virtual methods
+    virtual wxAlignment GetAlignment() const { return m_alignment; }
+    virtual int GetFlags() const { return m_flags; }
+    virtual int GetMaxWidth() const { return m_maxWidth; }
+    virtual int GetMinWidth() const { return m_minWidth; }
+    virtual wxString GetTitle() const { return m_title; }
+    virtual int GetWidth() const { return m_width; }
+    virtual bool IsHidden() const { return false; } // TODO
+    virtual bool IsSortOrderAscending() const { return m_ascending; }
+    virtual bool IsSortKey() const;
+
+    virtual void SetAlignment(wxAlignment align);
+    virtual void SetBitmap   (wxBitmap const& bitmap);
+    virtual void SetFlags    (int flags) { SetIndividualFlags(flags); }
+    virtual void SetHidden(bool WXUNUSED(hidden)) { } // TODO
+    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);
+    virtual void SetAsSortKey(bool sort = true);
+
+    // implementation only
+    WXDataBrowserPropertyID GetPropertyID() const
+    {
+        return m_propertyID;
+    }
+
+    void SetPropertyID(WXDataBrowserPropertyID newID)
+    {
+        m_propertyID = newID;
+    }
+    void SetWidthVariable(int NewWidth)
+    {
+        m_width = NewWidth;
+    }

 
 

-protected:

 private:
 private:

-//
-// variables
-//
-  bool m_ascending; // sorting order
-
-  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_minWidth; // minimum width for the column
-  int m_width;    // column width
-
-  wxAlignment m_alignment; // column header alignment
-
-  wxString m_title; // column title
-
- // wxWidget internal stuff:
-  DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
+    // common part of all ctors
+    void Init(int width, wxAlignment align, int flags)
+    {
+        m_ascending = true;
+        m_flags = flags & ~wxDATAVIEW_COL_HIDDEN; // TODO
+        m_maxWidth = 30000;
+        m_minWidth = 0;
+        m_width = width >= 0 ? width : wxDVC_DEFAULT_WIDTH;
+        m_alignment = align;
+    }
+
+    bool m_ascending; // sorting order
+
+    // each column is identified by its unique property ID (NOT by the column
+    // index)
+    WXDataBrowserPropertyID m_propertyID;
+
+    int m_flags;    // flags for the column
+    int m_maxWidth; // maximum width for the column
+    int m_minWidth; // minimum width for the column
+    int m_width;    // column width
+
+    wxAlignment m_alignment; // column header alignment
+
+    wxString m_title; // column title

 };
 
 // ---------------------------------------------------------
 };
 
 // ---------------------------------------------------------


@@ -486,14 +467,14 @@ public:
   {
     return this;
   }
   {
     return this;
   }

-  
+

  // inherited methods from 'wxDataViewCtrlBase':
   virtual bool AssociateModel(wxDataViewModel* model);
 
   virtual bool AppendColumn(wxDataViewColumn* columnPtr);
   virtual bool PrependColumn(wxDataViewColumn* columnPtr);
   virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
  // inherited methods from 'wxDataViewCtrlBase':
   virtual bool AssociateModel(wxDataViewModel* model);
 
   virtual bool AppendColumn(wxDataViewColumn* columnPtr);
   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 bool ClearColumns();
   virtual bool DeleteColumn(wxDataViewColumn* columnPtr);
   virtual wxDataViewColumn* GetColumn(unsigned int pos) const;


@@ -503,14 +484,14 @@ public:
   virtual void Collapse(wxDataViewItem const& item);
   virtual void EnsureVisible(wxDataViewItem const& item, wxDataViewColumn const* columnPtr=NULL);
   virtual void Expand(wxDataViewItem const& item);
   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() const;
 
   virtual unsigned int GetCount() const;
   virtual wxRect GetItemRect(wxDataViewItem const& item, wxDataViewColumn const* columnPtr) const;
   virtual wxDataViewItem GetSelection() const;
   virtual int GetSelections(wxDataViewItemArray& sel) const;
   virtual wxDataViewColumn* GetSortingColumn() const;
 
   virtual unsigned int GetCount() const;
   virtual wxRect GetItemRect(wxDataViewItem const& item, wxDataViewColumn const* columnPtr) 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 HitTest(wxPoint const& point, wxDataViewItem& item, wxDataViewColumn*& columnPtr) const;
 
   virtual bool IsSelected(wxDataViewItem const& item) const;


@@ -554,7 +535,7 @@ public:
 
  // with CG, we need to get the context from an kEventControlDraw event
  // unfortunately, the DataBrowser callbacks don't provide the context
 
  // 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 
+ // and we need it, so we need to set/remove it before and after draw

  // events so we can access it in the callbacks.
   void MacSetDrawingContext(void* context)
   {
  // events so we can access it in the callbacks.
   void MacSetDrawingContext(void* context)
   {


@@ -615,7 +596,7 @@ private:
   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
   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
   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