]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/mac/carbon/private.h
adding support for listctrl editable columns
[wxWidgets.git] / include / wx / mac / carbon / private.h
index 7e97116a902b0dad5c66cc2077eecd6191cecac4..675feea1f68598e92d3ec54db4c98cc5004170df 100644 (file)
@@ -15,7 +15,6 @@
 #define _WX_PRIVATE_H_
 
 #include "wx/defs.h"
-#include "wx/app.h"
 
 #ifdef __DARWIN__
 #    include <Carbon/Carbon.h>
@@ -33,7 +32,7 @@
 #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
@@ -63,9 +62,7 @@ inline int    FixedToInt( Fixed inFixed )
 
 #if wxUSE_GUI
 
-#include "wx/dc.h"
-#include "wx/window.h"
-#include "wx/toplevel.h"
+#include "wx/listbox.h"
 
 class wxMacPortStateHelper
 {
@@ -428,8 +425,6 @@ private :
 
 #if wxUSE_GUI
 
-#include "wx/listbox.h"
-
 /*
 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 );
-        
-        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
@@ -578,7 +574,7 @@ public :
     {
         return GetData<T>( kControlEntireControl , inTag );
     }
-    
+
     // Flash the control for the specified amount of time
     virtual void Flash( ControlPartCode part , UInt32 ticks = 8 );
 
@@ -628,10 +624,9 @@ public :
     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; }
-    
+
     wxWindow* GetPeer() const
     {
          return m_peer;
@@ -646,7 +641,6 @@ protected :
     long        m_windowStyle;
     wxWindow*   m_peer;
     bool        m_needsFocusRect;
-    bool        m_isCompositing;
     bool        m_isRootControl;
 };
 
@@ -663,26 +657,28 @@ public :
     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 GetItems( DataBrowserItemID container,
             Boolean recurse,
             DataBrowserItemState state,
             Handle items) const;
-    
+
 
     OSStatus AddColumn( DataBrowserListViewColumnDesc *columnDesc,
         DataBrowserTableViewColumnIndex position );
         
+    OSStatus RemoveColumn( DataBrowserTableViewColumnIndex position );
+
     OSStatus AutoSizeColumns();
-    
+
     OSStatus SetHasScrollBars( bool horiz, bool vert );
     OSStatus SetHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle );
-    
+
     OSStatus SetHeaderButtonHeight( UInt16 height );
     OSStatus GetHeaderButtonHeight( UInt16 *height );
 
@@ -690,7 +686,7 @@ public :
             const DataBrowserItemID *items,
             DataBrowserPropertyID preSortProperty,
             DataBrowserPropertyID propertyID ) const;
-            
+
     OSStatus AddItems( DataBrowserItemID container, UInt32 numItems,
             const DataBrowserItemID *items,
             DataBrowserPropertyID preSortProperty );
@@ -708,46 +704,48 @@ public :
             const DataBrowserItemID *items,
             DataBrowserSetOption operation );
 
-    OSStatus GetItemID( DataBrowserTableViewRowIndex row, 
+    OSStatus GetItemID( DataBrowserTableViewRowIndex row,
             DataBrowserItemID * item ) const;
-    OSStatus GetItemRow( DataBrowserItemID item, 
+    OSStatus GetItemRow( DataBrowserItemID item,
             DataBrowserTableViewRowIndex * row ) const;
-            
+
     OSStatus SetDefaultRowHeight( UInt16 height );
     OSStatus GetDefaultRowHeight( 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 GetDefaultColumnWidth( UInt16 *width ) const;
     OSStatus SetDefaultColumnWidth( UInt16 width );
-    
+
     OSStatus GetColumnCount( UInt32* numColumns) const;
 
+    OSStatus GetColumnIDFromIndex( DataBrowserTableViewColumnIndex position, DataBrowserTableViewColumnID* id );
+
     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 GetSortProperty( DataBrowserPropertyID *column ) const;
     OSStatus SetSortProperty( DataBrowserPropertyID column );
-     
+
     OSStatus GetSortOrder( DataBrowserSortOrder *order ) const;
     OSStatus SetSortOrder( DataBrowserSortOrder order );
-     
+
     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 SetDisclosureColumn( DataBrowserPropertyID property , Boolean expandableRows );
 protected :
-    
+
     static pascal void DataBrowserItemNotificationProc(
         ControlRef browser,
         DataBrowserItemID itemID,
@@ -773,18 +771,18 @@ protected :
         Boolean changeValue ) = 0;
 
     static pascal Boolean DataBrowserCompareProc(
-           ControlRef browser, 
-           DataBrowserItemID itemOneID, 
-           DataBrowserItemID itemTwoID, 
+           ControlRef browser,
+           DataBrowserItemID itemOneID,
+           DataBrowserItemID itemTwoID,
            DataBrowserPropertyID sortProperty);
-           
-       virtual Boolean CompareItems(DataBrowserItemID itemOneID, 
-           DataBrowserItemID itemTwoID, 
+
+       virtual Boolean CompareItems(DataBrowserItemID itemOneID,
+           DataBrowserItemID itemTwoID,
            DataBrowserPropertyID sortProperty) = 0;
 };
 
 // ============================================================================
-// Higher-level Databrowser 
+// Higher-level Databrowser
 // ============================================================================
 //
 // basing on data item objects
@@ -793,28 +791,93 @@ protected :
 // forward decl
 
 class wxMacDataItemBrowserControl;
+class wxMacListBoxItem;
+
+const DataBrowserPropertyID kTextColumnId = 1024;
+const DataBrowserPropertyID kNumericOrderColumnId = 1025;
+
+// for multi-column controls, we will use this + the column ID to identify the 
+// column. We don't use kTextColumnId there, and ideally the two should merge.
+const DataBrowserPropertyID kMinColumnId = 1050;
+
+// base API for high-level databrowser operations
+
+class wxMacListControl
+{
+public:
+    virtual void            MacDelete( unsigned int n ) = 0;
+    virtual void            MacInsert( unsigned int n, const wxString& item, int column = -1 ) = 0;
+    virtual void            MacInsert( unsigned int n, const wxArrayString& items, int column = -1 ) = 0;
+    // returns index of newly created line
+    virtual int             MacAppend( const wxString& item ) = 0;
+    virtual void            MacSetString( unsigned int n, const wxString& item ) = 0;
+    virtual void            MacClear() = 0;
+    virtual void            MacDeselectAll() = 0;
+    virtual void            MacSetSelection( unsigned int n, bool select, bool multi ) = 0;
+    virtual int             MacGetSelection() const = 0;
+    virtual int             MacGetSelections( wxArrayInt& aSelections ) const = 0;
+    virtual bool            MacIsSelected( unsigned int n ) const = 0;
+    virtual void            MacScrollTo( unsigned int n ) = 0;
+    virtual wxString        MacGetString( unsigned int n) const = 0;
+    virtual unsigned int    MacGetCount() const = 0;
+
+    virtual void            MacSetClientData( unsigned int n, void * data) = 0;
+    virtual void *          MacGetClientData( unsigned int) const = 0;
+
+    virtual ~wxMacListControl() { }
+}; 
 
 // base class for databrowser items
 
+enum DataItemType {
+    DataItem_Text
+};
+
 class wxMacDataItem
 {
 public :
     wxMacDataItem();
     virtual ~wxMacDataItem();
-    
-    virtual bool IsLessThan(wxMacDataItemBrowserControl *owner , 
-        const wxMacDataItem*, 
+
+    virtual bool IsLessThan(wxMacDataItemBrowserControl *owner ,
+        const wxMacDataItem*,
         DataBrowserPropertyID property) const;
-    
+
     // returns true if access was successful, otherwise false
-    virtual OSStatus GetSetData(wxMacDataItemBrowserControl *owner , 
+    virtual OSStatus GetSetData(wxMacDataItemBrowserControl *owner ,
         DataBrowserPropertyID property,
         DataBrowserItemDataRef itemData,
         bool changeValue );
 
-    virtual void Notification(wxMacDataItemBrowserControl *owner , 
+    virtual void Notification(wxMacDataItemBrowserControl *owner ,
         DataBrowserItemNotification message,
         DataBrowserItemDataRef itemData ) const;
+        
+    void SetLabel( const wxString& str);
+    const wxString& GetLabel() const; 
+
+    void SetOrder( SInt32 order );
+    SInt32 GetOrder() const;
+
+    void SetData( void* data);
+    void* GetData() const;
+    
+    void SetColumn( short col );
+    short GetColumn(); 
+    
+protected :
+    wxString    m_label;
+    wxMacCFStringHolder m_cfLabel;
+    void *      m_data;
+    SInt32      m_order;
+    short       m_colId;
+    
+};
+
+enum ListSortOrder {
+    SortOrder_None,
+    SortOrder_Text_Ascending,
+    SortOrder_Text_Descending
 };
 
 typedef wxMacDataItem* wxMacDataItemPtr;
@@ -822,43 +885,55 @@ const wxMacDataItemPtr wxMacDataBrowserRootContainer = NULL;
 
 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxMacDataItemPtr, wxArrayMacDataItemPtr, class WXDLLIMPEXP_CORE);
 
-class wxMacDataItemBrowserControl : public wxMacDataBrowserControl
+class wxMacDataItemBrowserControl : public wxMacDataBrowserControl, public wxMacListControl
 {
 public :
     wxMacDataItemBrowserControl( wxWindow* peer , const wxPoint& pos, const wxSize& size, long style);
-    
+
+    // create a list item (can be a subclass of wxMacListBoxItem)
+
+    virtual wxMacDataItem* CreateItem();
+
     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;
                         
+    unsigned int    GetSelectedItemCount( const wxMacDataItem* container, bool recurse ) 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;
-    void            UpdateItems(const wxMacDataItem *container, wxArrayMacDataItemPtr &items, 
+    void            UpdateItems(const wxMacDataItem *container, wxArrayMacDataItemPtr &items,
                         DataBrowserPropertyID property) const;
-    
+
+    void            InsertColumn(int colId, DataBrowserPropertyType colType, DataBrowserPropertyFlags flags ,
+                            const wxString& title, SInt16 just = teFlushDefault, int minWidth = -1, int maxWidth = -1);
+                            
+    int             GetColumnWidth(int colId);
+    void            SetColumnWidth(int colId, int width);
+
     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            RevealItem( wxMacDataItem* item, DataBrowserRevealOptions options);
-    
+
     void            GetSelectionAnchor( wxMacDataItemPtr* first , wxMacDataItemPtr* last) const;
-    
+
     // 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,
@@ -870,11 +945,61 @@ public :
                         const wxMacDataItem* itemID,
                         DataBrowserItemNotification message,
                         DataBrowserItemDataRef itemData);
+
+    // as we are getting the same events for human and API selection we have to suppress
+    // events in the latter case, since this will be used from many subclasses we keep it here
+
+    bool            IsSelectionSuppressed() const { return m_suppressSelection; }
+    bool            SuppressSelection( bool suppress );
     
-    // ID aware base methods, should be 'final' ie not changed in subclasses
     
-    virtual Boolean CompareItems(DataBrowserItemID itemOneID, 
-                        DataBrowserItemID itemTwoID, 
+    // wxMacListControl Methods
+    // add and remove
+
+    virtual void            MacDelete( unsigned int n );
+    virtual void            MacInsert( unsigned int n, const wxString& item, int column = -1 );
+    virtual void            MacInsert( unsigned int n, const wxArrayString& items, int column = -1 );
+    virtual int             MacAppend( const wxString& item );
+    virtual void            MacClear();
+
+    // selecting
+
+    virtual void            MacDeselectAll();
+    virtual void            MacSetSelection( unsigned int n, bool select, bool multi = false );
+    virtual int             MacGetSelection() const;
+    virtual int             MacGetSelections( wxArrayInt& aSelections ) const;
+    virtual bool            MacIsSelected( unsigned int n ) const;
+
+    // display
+
+    virtual void            MacScrollTo( unsigned int n );
+
+    // accessing content
+
+    virtual void            MacSetString( unsigned int n, const wxString& item );
+    virtual void            MacSetClientData( unsigned int n, void * data);
+    virtual wxString        MacGetString( unsigned int n) const;
+    virtual void *          MacGetClientData( unsigned int) const;
+    virtual unsigned int    MacGetCount() const;
+
+    // client data
+
+    virtual wxClientDataType GetClientDataType() const;
+    virtual void            SetClientDataType(wxClientDataType clientDataItemsType);
+    virtual ListSortOrder   GetSortOrder() const;
+    virtual void            SetSortOrder(const ListSortOrder sort);
+
+    
+
+protected:
+
+    ListSortOrder m_sortOrder;
+    wxClientDataType m_clientDataItemsType;
+
+    // ID aware base methods, should be 'final' ie not changed in subclasses
+
+    virtual Boolean CompareItems(DataBrowserItemID itemOneID,
+                        DataBrowserItemID itemTwoID,
                         DataBrowserPropertyID sortProperty);
 
     virtual OSStatus GetSetItemData(DataBrowserItemID itemID,
@@ -887,12 +1012,7 @@ public :
                         DataBrowserItemNotification message,
                         DataBrowserItemDataRef itemData);
 
-    // as we are getting the same events for human and API selection we have to suppress
-    // events in the latter case, since this will be used from many subclasses we keep it here
-    
-    bool            IsSelectionSuppressed() const { return m_suppressSelection; }
-    bool            SuppressSelection( bool suppress );
-    
+
 private :
 
     bool m_suppressSelection;
@@ -903,7 +1023,7 @@ class wxMacDataItemBrowserSelectionSuppressor
 public :
     wxMacDataItemBrowserSelectionSuppressor(wxMacDataItemBrowserControl *browser);
     ~wxMacDataItemBrowserSelectionSuppressor();
-    
+
 private :
 
     bool m_former;
@@ -913,94 +1033,31 @@ private :
 // ============================================================================
 // platform listbox implementation
 // ============================================================================
-//
+
 // exposed for reuse in wxCheckListBox
 
 class wxMacListBoxItem : public wxMacDataItem
 {
 public :
     wxMacListBoxItem();
-    
-    virtual ~wxMacListBoxItem();
-    
-    void SetLabel( const wxString& str);
-    const wxString& GetLabel() const;
-    
-    virtual bool IsLessThan(wxMacDataItemBrowserControl *owner , 
-        const wxMacDataItem* rhs, 
-        DataBrowserPropertyID sortProperty) const;
 
-    virtual OSStatus GetSetData( wxMacDataItemBrowserControl *owner ,
-        DataBrowserPropertyID property,
-        DataBrowserItemDataRef itemData,
-        bool changeValue );
+    virtual ~wxMacListBoxItem();
 
-    virtual void Notification(wxMacDataItemBrowserControl *owner , 
+    virtual void Notification(wxMacDataItemBrowserControl *owner ,
         DataBrowserItemNotification message,
         DataBrowserItemDataRef itemData ) const;
-        
-    void SetOrder( SInt32 order );
-    SInt32 GetOrder() const;
-    
-    void SetData( void* data);
-    void* GetData() const;
-
-private :
-    wxString    m_label;
-    wxMacCFStringHolder m_cfLabel;
-    void *      m_data;
-    SInt32      m_order;
 };
 
-class wxMacDataBrowserListControl : public wxMacDataItemBrowserControl , public wxMacListControl
+class wxMacDataBrowserListControl : public wxMacDataItemBrowserControl
 {
 public:
-    wxMacDataBrowserListControl( wxListBox *peer, const wxPoint& pos, const wxSize& size, long style );
-    ~wxMacDataBrowserListControl();
-
-    // create a list item (can be a subclass of wxMacListBoxItem)
-
-    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 );
-    int             MacAppend( const wxString& item );
-    void            MacClear();
-
-    // selecting
-    
-    void            MacDeselectAll();
-    void            MacSetSelection( unsigned int n, bool select );
-    int             MacGetSelection() const;
-    int             MacGetSelections( wxArrayInt& aSelections ) const;
-    bool            MacIsSelected( unsigned int n ) const;
-
-    // display
-
-    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 *          MacGetClientData( unsigned int) const;
-    unsigned int    MacGetCount() const;
-
-    // client data
-
-    wxClientDataType GetClientDataType() const;
-    void            SetClientDataType(wxClientDataType clientDataItemsType);
+    wxMacDataBrowserListControl( wxWindow *peer, const wxPoint& pos, const wxSize& size, long style );
+    virtual ~wxMacDataBrowserListControl();
 
     // pointing back
 
-    wxListBox * GetPeer() const;
-private :
-    bool            m_stringSorted;
-    wxClientDataType m_clientDataItemsType;
+    wxWindow * GetPeer() const;
+
 };
 
 // ============================================================================
@@ -1039,7 +1096,7 @@ public:
     wxMacCGContext( CGrafPtr port );
     wxMacCGContext( CGContextRef cgcontext );
     wxMacCGContext();
-    ~wxMacCGContext();
+    virtual ~wxMacCGContext();
 
     virtual void Clip( const wxRegion &region );
     virtual void StrokePath( const wxGraphicPath *p );
@@ -1078,7 +1135,7 @@ class WXDLLEXPORT wxBitmapRefData: public wxGDIRefData
 public:
     wxBitmapRefData(int width , int height , int depth);
     wxBitmapRefData();
-    ~wxBitmapRefData();
+    virtual ~wxBitmapRefData();
 
     void Free();
     bool Ok() const { return m_ok; }
@@ -1176,14 +1233,14 @@ private :
 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
-    inline Rect* wxMacGetPictureBounds( PicHandle pict , Rect* rect ) 
-    {   
+    inline Rect* wxMacGetPictureBounds( PicHandle pict , Rect* rect )
+    {
         return QDGetPictureBounds( pict , rect );
     }
 #endif