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

/////////////////////////////////////////////////////////////////////////////
// Name:        include/mac/carbon/databrow.h
// Purpose:     Classes and functions for the Carbon data browser
// Author:      
// Modified by:
// Created:     2007-05-18
// RCS-ID:      $Id$
// Copyright:   (c)
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_DATABROW_H_
#define _WX_DATABROW_H_

#include "wx/defs.h"

#ifdef __DARWIN__
#    include <Carbon/Carbon.h>
#else
#    include <Debugging.h>
#    include <Appearance.h>
#    include <Controls.h>
#    include <ControlDefinitions.h>
#    include <LowMem.h>
#    include <Gestalt.h>
#    include <CoreServices.h>
#endif

#if UNIVERSAL_INTERFACES_VERSION < 0x0342
    #error "please update to Apple's latest universal headers from http://developer.apple.com/sdk/"
#endif

#ifndef MAC_OS_X_VERSION_10_3
    #define MAC_OS_X_VERSION_10_3 1030
#endif

#ifndef MAC_OS_X_VERSION_10_4
    #define MAC_OS_X_VERSION_10_4 1040
#endif

#ifndef MAC_OS_X_VERSION_10_5
    #define MAC_OS_X_VERSION_10_5 1050
#endif

#ifdef __WXMAC_CARBON__
#  include "wx/mac/corefoundation/cfstring.h"
#endif

#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
typedef UInt32 URefCon;
typedef SInt32 SRefCon;
#endif

#if wxUSE_GUI

#include "wx/mac/private.h"

WX_DEFINE_ARRAY_SIZE_T(size_t,wxArrayDataBrowserItemID);

// ============================================================================
// wxMacDataBrowserTableViewControl
// ============================================================================
//
// this is a wrapper class for the Mac OS X data browser environment,
// it covers all general data brower functionality,
//

// data browser's property IDs have a reserved ID range from 0 - 1023
// therefore, the first usable property ID is 'kMinPropertyID'
DataBrowserPropertyID const kMinPropertyID = 1024;

class wxMacDataBrowserTableViewControl : public wxMacControl
{
public:
//
// constructors / destructor
//
  wxMacDataBrowserTableViewControl(wxWindow* peer, const wxPoint& pos, const wxSize& size, long style);
  wxMacDataBrowserTableViewControl(void)
  {
  }

//
// callback handling
//
  OSStatus SetCallbacks      (DataBrowserCallbacks const*       callbacks);
  OSStatus SetCustomCallbacks(DataBrowserCustomCallbacks const* customCallbacks);

//
// header handling
//
  OSStatus GetHeaderDesc(DataBrowserPropertyID property, DataBrowserListViewHeaderDesc* desc) const;

  OSStatus SetHeaderDesc(DataBrowserPropertyID property, DataBrowserListViewHeaderDesc* desc);

//
// layout handling
//
  OSStatus AutoSizeColumns();

  OSStatus EnableCellSizeModification(bool enableHeight=true, bool enableWidth=true); // enables or disables the column width and row height modification (default: false)

#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
  OSStatus GetAttributes        (OptionBits* attributes);
#endif
  OSStatus GetColumnWidth       (DataBrowserPropertyID column, UInt16 *width ) const; // returns the column width in pixels
  OSStatus GetDefaultColumnWidth(UInt16 *width ) const; // returns the default column width in pixels
  OSStatus GetDefaultRowHeight  (UInt16 * height ) const;
  OSStatus GetHeaderButtonHeight(UInt16 *height );
  OSStatus GetPartBounds        (DataBrowserItemID item, DataBrowserPropertyID property, DataBrowserPropertyPart part, Rect* bounds);
  OSStatus GetRowHeight         (DataBrowserItemID item , UInt16 *height) const;
  OSStatus GetScrollPosition    (UInt32* top, UInt32 *left) const;

#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
  OSStatus SetAttributes (OptionBits attributes);
#endif
  OSStatus SetColumnWidth(DataBrowserPropertyID column, UInt16 width); // sets the column width in pixels
  OSStatus SetDefaultColumnWidth( UInt16 width );
  OSStatus SetDefaultRowHeight( UInt16 height );
  OSStatus SetHasScrollBars( bool horiz, bool vert );
  OSStatus SetHeaderButtonHeight( UInt16 height );
  OSStatus SetHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle );
  OSStatus SetIndent(float Indent);
  OSStatus SetRowHeight( DataBrowserItemID item , UInt16 height);
  OSStatus SetScrollPosition( UInt32 top , UInt32 left );

//
// column handling
//
  OSStatus GetColumnCount   (UInt32* numColumns) const;
  OSStatus GetColumnIndex   (DataBrowserPropertyID propertyID, DataBrowserTableViewColumnIndex* index) const; // returns for the passed property the corresponding column index
  OSStatus GetFreePropertyID(DataBrowserPropertyID* propertyID) const; // this method returns a property id that is valid and currently not used; if it cannot be found 'errDataBrowerPropertyNotSupported' is returned
  OSStatus GetPropertyFlags (DataBrowserPropertyID propertyID, DataBrowserPropertyFlags *flags ) const;
  OSStatus GetPropertyID    (DataBrowserItemDataRef itemData, DataBrowserPropertyID* propertyID); // returns for the passed item data reference the corresponding property ID
  OSStatus GetPropertyID    (DataBrowserTableViewColumnIndex index, DataBrowserPropertyID* propertyID); // returns for the passed column index the corresponding property ID
  
  OSStatus IsUsedPropertyID(DataBrowserPropertyID propertyID) const; // checks if passed property id is used by the control; no error is returned if the id exists

  OSStatus RemoveColumnByProperty(DataBrowserTableViewColumnID propertyID);
  OSStatus RemoveColumnByIndex   (DataBrowserTableViewColumnIndex index);

  OSStatus SetColumnIndex     (DataBrowserPropertyID propertyID, DataBrowserTableViewColumnIndex index);
  OSStatus SetDisclosureColumn(DataBrowserPropertyID propertyID, Boolean expandableRows=false);
  OSStatus SetPropertyFlags   (DataBrowserPropertyID propertyID, DataBrowserPropertyFlags flags);

//
// item handling
//
  OSStatus AddItem(DataBrowserItemID container, DataBrowserItemID const* itemID) // adds a single item
  {
    return this->AddItems(container,1,itemID,kDataBrowserItemNoProperty);
  }
  OSStatus AddItems(DataBrowserItemID container, UInt32 numItems, DataBrowserItemID const* items, DataBrowserPropertyID preSortProperty); // adds items to the data browser

  OSStatus GetFreeItemID(DataBrowserItemID* id) const; // this method returns an item id that is valid and currently not used; if it cannot be found 'errDataBrowserItemNotAdded' is returned
  OSStatus GetItemCount (ItemCount* numItems) const
  {
    return this->GetItemCount(kDataBrowserNoItem,true,kDataBrowserItemAnyState,numItems);
  }
  OSStatus GetItemCount (DataBrowserItemID container, Boolean recurse, DataBrowserItemState state, ItemCount* numItems) const;
  OSStatus GetItemID    (DataBrowserTableViewRowIndex row, DataBrowserItemID* item) const;
  OSStatus GetItems     (DataBrowserItemID container, Boolean recurse, DataBrowserItemState state, Handle items) const;
  OSStatus GetItemRow   (DataBrowserItemID item, DataBrowserTableViewRowIndex* row) const;

  OSStatus IsUsedItemID(DataBrowserItemID itemID) const; // checks if the passed id is in use

  OSStatus RevealItem(DataBrowserItemID item, DataBrowserPropertyID propertyID, DataBrowserRevealOptions options) const;

  OSStatus RemoveItem(DataBrowserItemID container, DataBrowserItemID const* itemID) // removes a single item
  {
    return this->RemoveItems(container,1,itemID,kDataBrowserItemNoProperty);
  }
  OSStatus RemoveItems(void) // removes all items
  {
    return this->RemoveItems(kDataBrowserNoItem,0,NULL,kDataBrowserItemNoProperty);
  }
  OSStatus RemoveItems(DataBrowserItemID container, UInt32 numItems, DataBrowserItemID const* items, DataBrowserPropertyID preSortProperty);

  OSStatus UpdateItems(void) // updates all items
  {
    return this->UpdateItems(kDataBrowserNoItem,0,NULL,kDataBrowserItemNoProperty,kDataBrowserItemNoProperty);
  }
  OSStatus UpdateItems(DataBrowserItemID const* item) // updates all columns of item
  {
    return this->UpdateItems(kDataBrowserNoItem,1,item,kDataBrowserItemNoProperty,kDataBrowserItemNoProperty);
  }
  OSStatus UpdateItems(DataBrowserItemID container, UInt32 numItems, DataBrowserItemID const* items, DataBrowserPropertyID preSortProperty, DataBrowserPropertyID propertyID) const;

//
// item selection
//
  size_t   GetSelectedItemIDs(wxArrayDataBrowserItemID& itemIDs) const; // returns the number of selected item and the item IDs in the array
  OSStatus GetSelectionAnchor(DataBrowserItemID *first, DataBrowserItemID *last) const;
  OSStatus GetSelectionFlags (DataBrowserSelectionFlags* flags) const;

  bool IsItemSelected(DataBrowserItemID item) const;

  OSStatus SetSelectionFlags(DataBrowserSelectionFlags flags);
  OSStatus SetSelectedItems (UInt32 numItems, DataBrowserItemID const* itemIDs, DataBrowserSetOption operation);

//
// item sorting
//
  OSStatus GetSortOrder   (DataBrowserSortOrder* order) const;
  OSStatus GetSortProperty(DataBrowserPropertyID* propertyID) const;

  OSStatus Resort(DataBrowserItemID container=kDataBrowserNoItem, Boolean sortChildren=true);

  OSStatus SetSortOrder   (DataBrowserSortOrder  order);
  OSStatus SetSortProperty(DataBrowserPropertyID propertyID);

//
// container handling
//
  OSStatus CloseContainer(DataBrowserItemID containerID);
  
  OSStatus OpenContainer(DataBrowserItemID containerID);

protected :
//
// standard callback functions
//
  static pascal Boolean  DataBrowserCompareProc          (ControlRef browser, DataBrowserItemID itemOneID, DataBrowserItemID itemTwoID, DataBrowserPropertyID sortProperty);
  static pascal void     DataBrowserGetContextualMenuProc(ControlRef browser, MenuRef* menu, UInt32* helpType, CFStringRef* helpItemString, AEDesc* selection);
  static pascal OSStatus DataBrowserGetSetItemDataProc   (ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID property, DataBrowserItemDataRef itemData, Boolean getValue);
  static pascal void     DataBrowserItemNotificationProc (ControlRef browser, DataBrowserItemID itemID, DataBrowserItemNotification message, DataBrowserItemDataRef itemData);

  virtual Boolean  DataBrowserCompareProc          (DataBrowserItemID itemOneID, DataBrowserItemID itemTwoID, DataBrowserPropertyID sortProperty) = 0;
  virtual void     DataBrowserGetContextualMenuProc(MenuRef* menu, UInt32* helpType, CFStringRef* helpItemString, AEDesc* selection) = 0;
  virtual OSStatus DataBrowserGetSetItemDataProc   (DataBrowserItemID itemID, DataBrowserPropertyID property, DataBrowserItemDataRef itemData, Boolean getValue) = 0;
  virtual void     DataBrowserItemNotificationProc (DataBrowserItemID itemID, DataBrowserItemNotification message, DataBrowserItemDataRef itemData) = 0;

//
// callback functions for customized types
//
  static pascal void                      DataBrowserDrawItemProc(ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID propertyID, DataBrowserItemState state, Rect const* rectangle, SInt16 bitDepth, Boolean colorDevice);
  static pascal Boolean                   DataBrowserEditItemProc(ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID propertyID, CFStringRef theString, Rect* maxEditTextRect, Boolean* shrinkToFit);
  static pascal Boolean                   DataBrowserHitTestProc (ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Rect const* mouseRect);
  static pascal DataBrowserTrackingResult DataBrowserTrackingProc(ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Point startPt, EventModifiers modifiers);

  virtual void                      DataBrowserDrawItemProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, DataBrowserItemState state, Rect const* rectangle, SInt16 bitDepth, Boolean colorDevice) = 0;
  virtual Boolean                   DataBrowserEditItemProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, CFStringRef theString, Rect* maxEditTextRect, Boolean* shrinkToFit) = 0;
  virtual Boolean                   DataBrowserHitTestProc (DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Rect const* mouseRect) = 0;
  virtual DataBrowserTrackingResult DataBrowserTrackingProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Point startPt, EventModifiers modifiers) = 0;

private:
//
// wxWidget internal stuff
//
    DECLARE_ABSTRACT_CLASS(wxMacDataBrowserTableViewControl)
};

// ============================================================================
// wxMacDataBrowserListViewControl
// ============================================================================
//
// this class is a wrapper for a list view which incorporates all general
// data browser functionality of the inherited table view control class;
// the term list view is in this case Mac OS X specific and is not related
// to any wxWidget naming conventions
//
class wxMacDataBrowserListViewControl : public wxMacDataBrowserTableViewControl
{
public:
//
// constructors / destructor
//
  wxMacDataBrowserListViewControl(wxWindow* peer, wxPoint const& pos, wxSize const& size, long style) : wxMacDataBrowserTableViewControl(peer,pos,size,style)
  {
  }

//
// column handling
//
  OSStatus AddColumn(DataBrowserListViewColumnDesc *columnDesc, DataBrowserTableViewColumnIndex position);

protected:
private:
};


// ============================================================================
// wxMacDataViewDataBrowserListViewControl
// ============================================================================
//
// internal interface class between wxDataViewCtrl (wxWidget) and the data
// browser (Mac OS X)
//
class wxMacDataViewDataBrowserListViewControl : public wxMacDataBrowserListViewControl
{
public:
//
// constructors / destructor
//
  wxMacDataViewDataBrowserListViewControl(wxWindow* peer, wxPoint const& pos, wxSize const& size, long style);

protected:
//
// standard callback functions (inherited from wxMacDataBrowserTableViewControl)
//
  virtual Boolean  DataBrowserCompareProc          (DataBrowserItemID itemOneID, DataBrowserItemID itemTwoID, DataBrowserPropertyID sortProperty);
  virtual void     DataBrowserItemNotificationProc (DataBrowserItemID itemID, DataBrowserItemNotification message, DataBrowserItemDataRef itemData);
  virtual void     DataBrowserGetContextualMenuProc(MenuRef* menu, UInt32* helpType, CFStringRef* helpItemString, AEDesc* selection);
  virtual OSStatus DataBrowserGetSetItemDataProc   (DataBrowserItemID itemID, DataBrowserPropertyID propertyID, DataBrowserItemDataRef itemData, Boolean getValue);

//
// callback functions for customized types (inherited from wxMacDataBrowserTableViewControl)
//
  virtual void                      DataBrowserDrawItemProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, DataBrowserItemState state, Rect const* rectangle, SInt16 bitDepth, Boolean colorDevice);
  virtual Boolean                   DataBrowserEditItemProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, CFStringRef theString, Rect* maxEditTextRect, Boolean* shrinkToFit);
  virtual Boolean                   DataBrowserHitTestProc (DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Rect const* mouseRect);
  virtual DataBrowserTrackingResult DataBrowserTrackingProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Point startPt, EventModifiers modifiers);

private:
};

typedef wxMacDataViewDataBrowserListViewControl* wxMacDataViewDataBrowserListViewControlPointer;


#endif // WX_GUI
  
#endif // _WX_DATABROW_H_
Commit	Line	Data
c0a66d92 RR	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: include/mac/carbon/databrow.h
	3	// Purpose: Classes and functions for the Carbon data browser
	4	// Author:
	5	// Modified by:
	6	// Created: 2007-05-18
	7	// RCS-ID: $Id$
	8	// Copyright: (c)
	9	// Licence: wxWindows licence
	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_DATABROW_H_
	13	#define _WX_DATABROW_H_
	14
	15	#include "wx/defs.h"
	16
	17	#ifdef __DARWIN__
	18	# include <Carbon/Carbon.h>
	19	#else
	20	# include <Debugging.h>
	21	# include <Appearance.h>
	22	# include <Controls.h>
	23	# include <ControlDefinitions.h>
	24	# include <LowMem.h>
	25	# include <Gestalt.h>
	26	# include <CoreServices.h>
	27	#endif
	28
	29	#if UNIVERSAL_INTERFACES_VERSION < 0x0342
	30	#error "please update to Apple's latest universal headers from http://developer.apple.com/sdk/"
	31	#endif
	32
	33	#ifndef MAC_OS_X_VERSION_10_3
	34	#define MAC_OS_X_VERSION_10_3 1030
	35	#endif
	36
	37	#ifndef MAC_OS_X_VERSION_10_4
	38	#define MAC_OS_X_VERSION_10_4 1040
	39	#endif
	40
	41	#ifndef MAC_OS_X_VERSION_10_5
	42	#define MAC_OS_X_VERSION_10_5 1050
	43	#endif
	44
	45	#ifdef __WXMAC_CARBON__
	46	# include "wx/mac/corefoundation/cfstring.h"
	47	#endif
	48
	49	#if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
	50	typedef UInt32 URefCon;
	51	typedef SInt32 SRefCon;
	52	#endif
	53
	54	#if wxUSE_GUI
	55
c0a66d92 RR	56	#include "wx/mac/private.h"
	57
	58	WX_DEFINE_ARRAY_SIZE_T(size_t,wxArrayDataBrowserItemID);
	59
	60	// ============================================================================
194027ac	61	// wxMacDataBrowserTableViewControl
c0a66d92 RR	62	// ============================================================================
c0a66d92 RR	63	//
194027ac RR	64	// this is a wrapper class for the Mac OS X data browser environment,
194027ac RR	65	// it covers all general data brower functionality,
c0a66d92 RR	66	//
	67
	68	// data browser's property IDs have a reserved ID range from 0 - 1023
	69	// therefore, the first usable property ID is 'kMinPropertyID'
	70	DataBrowserPropertyID const kMinPropertyID = 1024;
	71
	72	class wxMacDataBrowserTableViewControl : public wxMacControl
	73	{
	74	public:
	75	//
	76	// constructors / destructor
	77	//
	78	wxMacDataBrowserTableViewControl(wxWindow* peer, const wxPoint& pos, const wxSize& size, long style);
	79	wxMacDataBrowserTableViewControl(void)
	80	{
	81	}
	82
	83	//
	84	// callback handling
	85	//
	86	OSStatus SetCallbacks (DataBrowserCallbacks const* callbacks);
	87	OSStatus SetCustomCallbacks(DataBrowserCustomCallbacks const* customCallbacks);
	88
	89	//
	90	// header handling
	91	//
	92	OSStatus GetHeaderDesc(DataBrowserPropertyID property, DataBrowserListViewHeaderDesc* desc) const;
	93
	94	OSStatus SetHeaderDesc(DataBrowserPropertyID property, DataBrowserListViewHeaderDesc* desc);
	95
	96	//
	97	// layout handling
	98	//
	99	OSStatus AutoSizeColumns();
	100
	101	OSStatus EnableCellSizeModification(bool enableHeight=true, bool enableWidth=true); // enables or disables the column width and row height modification (default: false)
	102
	103	#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
	104	OSStatus GetAttributes (OptionBits* attributes);
	105	#endif
	106	OSStatus GetColumnWidth (DataBrowserPropertyID column, UInt16 *width ) const; // returns the column width in pixels
	107	OSStatus GetDefaultColumnWidth(UInt16 *width ) const; // returns the default column width in pixels
	108	OSStatus GetDefaultRowHeight (UInt16 * height ) const;
	109	OSStatus GetHeaderButtonHeight(UInt16 *height );
07c51ff1	110	OSStatus GetPartBounds (DataBrowserItemID item, DataBrowserPropertyID property, DataBrowserPropertyPart part, Rect* bounds);
c0a66d92 RR	111	OSStatus GetRowHeight (DataBrowserItemID item , UInt16 *height) const;
	112	OSStatus GetScrollPosition (UInt32* top, UInt32 *left) const;
	113
	114	#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
	115	OSStatus SetAttributes (OptionBits attributes);
	116	#endif
	117	OSStatus SetColumnWidth(DataBrowserPropertyID column, UInt16 width); // sets the column width in pixels
	118	OSStatus SetDefaultColumnWidth( UInt16 width );
	119	OSStatus SetDefaultRowHeight( UInt16 height );
	120	OSStatus SetHasScrollBars( bool horiz, bool vert );
	121	OSStatus SetHeaderButtonHeight( UInt16 height );
	122	OSStatus SetHiliteStyle( DataBrowserTableViewHiliteStyle hiliteStyle );
c17b2e31	123	OSStatus SetIndent(float Indent);
c0a66d92 RR	124	OSStatus SetRowHeight( DataBrowserItemID item , UInt16 height);
	125	OSStatus SetScrollPosition( UInt32 top , UInt32 left );
	126
	127	//
	128	// column handling
	129	//
	130	OSStatus GetColumnCount (UInt32* numColumns) const;
194027ac RR	131	OSStatus GetColumnIndex (DataBrowserPropertyID propertyID, DataBrowserTableViewColumnIndex* index) const; // returns for the passed property the corresponding column index
194027ac RR	132	OSStatus GetFreePropertyID(DataBrowserPropertyID* propertyID) const; // this method returns a property id that is valid and currently not used; if it cannot be found 'errDataBrowerPropertyNotSupported' is returned
c0a66d92	133	OSStatus GetPropertyFlags (DataBrowserPropertyID propertyID, DataBrowserPropertyFlags *flags ) const;
07c51ff1 RR	134	OSStatus GetPropertyID (DataBrowserItemDataRef itemData, DataBrowserPropertyID* propertyID); // returns for the passed item data reference the corresponding property ID
	135	OSStatus GetPropertyID (DataBrowserTableViewColumnIndex index, DataBrowserPropertyID* propertyID); // returns for the passed column index the corresponding property ID
	136
c0a66d92 RR	137	OSStatus IsUsedPropertyID(DataBrowserPropertyID propertyID) const; // checks if passed property id is used by the control; no error is returned if the id exists
c0a66d92 RR	138
c17b2e31 RR	139	OSStatus RemoveColumnByProperty(DataBrowserTableViewColumnID propertyID);
c17b2e31 RR	140	OSStatus RemoveColumnByIndex (DataBrowserTableViewColumnIndex index);
c0a66d92	141
194027ac	142	OSStatus SetColumnIndex (DataBrowserPropertyID propertyID, DataBrowserTableViewColumnIndex index);
99c75ebc	143	OSStatus SetDisclosureColumn(DataBrowserPropertyID propertyID, Boolean expandableRows=false);
194027ac	144	OSStatus SetPropertyFlags (DataBrowserPropertyID propertyID, DataBrowserPropertyFlags flags);
c0a66d92 RR	145
	146	//
	147	// item handling
	148	//
	149	OSStatus AddItem(DataBrowserItemID container, DataBrowserItemID const* itemID) // adds a single item
	150	{
	151	return this->AddItems(container,1,itemID,kDataBrowserItemNoProperty);
	152	}
	153	OSStatus AddItems(DataBrowserItemID container, UInt32 numItems, DataBrowserItemID const* items, DataBrowserPropertyID preSortProperty); // adds items to the data browser
	154
	155	OSStatus GetFreeItemID(DataBrowserItemID* id) const; // this method returns an item id that is valid and currently not used; if it cannot be found 'errDataBrowserItemNotAdded' is returned
	156	OSStatus GetItemCount (ItemCount* numItems) const
	157	{
	158	return this->GetItemCount(kDataBrowserNoItem,true,kDataBrowserItemAnyState,numItems);
	159	}
	160	OSStatus GetItemCount (DataBrowserItemID container, Boolean recurse, DataBrowserItemState state, ItemCount* numItems) const;
07c51ff1	161	OSStatus GetItemID (DataBrowserTableViewRowIndex row, DataBrowserItemID* item) const;
c0a66d92 RR	162	OSStatus GetItems (DataBrowserItemID container, Boolean recurse, DataBrowserItemState state, Handle items) const;
	163	OSStatus GetItemRow (DataBrowserItemID item, DataBrowserTableViewRowIndex* row) const;
	164
	165	OSStatus IsUsedItemID(DataBrowserItemID itemID) const; // checks if the passed id is in use
	166
	167	OSStatus RevealItem(DataBrowserItemID item, DataBrowserPropertyID propertyID, DataBrowserRevealOptions options) const;
	168
	169	OSStatus RemoveItem(DataBrowserItemID container, DataBrowserItemID const* itemID) // removes a single item
	170	{
	171	return this->RemoveItems(container,1,itemID,kDataBrowserItemNoProperty);
	172	}
	173	OSStatus RemoveItems(void) // removes all items
	174	{
	175	return this->RemoveItems(kDataBrowserNoItem,0,NULL,kDataBrowserItemNoProperty);
	176	}
	177	OSStatus RemoveItems(DataBrowserItemID container, UInt32 numItems, DataBrowserItemID const* items, DataBrowserPropertyID preSortProperty);
	178
	179	OSStatus UpdateItems(void) // updates all items
	180	{
a5fb9253	181	return this->UpdateItems(kDataBrowserNoItem,0,NULL,kDataBrowserItemNoProperty,kDataBrowserItemNoProperty);
c0a66d92 RR	182	}
	183	OSStatus UpdateItems(DataBrowserItemID const* item) // updates all columns of item
	184	{
a5fb9253	185	return this->UpdateItems(kDataBrowserNoItem,1,item,kDataBrowserItemNoProperty,kDataBrowserItemNoProperty);
c0a66d92 RR	186	}
	187	OSStatus UpdateItems(DataBrowserItemID container, UInt32 numItems, DataBrowserItemID const* items, DataBrowserPropertyID preSortProperty, DataBrowserPropertyID propertyID) const;
	188
	189	//
	190	// item selection
	191	//
	192	size_t GetSelectedItemIDs(wxArrayDataBrowserItemID& itemIDs) const; // returns the number of selected item and the item IDs in the array
	193	OSStatus GetSelectionAnchor(DataBrowserItemID first, DataBrowserItemID last) const;
	194	OSStatus GetSelectionFlags (DataBrowserSelectionFlags* flags) const;
	195
	196	bool IsItemSelected(DataBrowserItemID item) const;
	197
	198	OSStatus SetSelectionFlags(DataBrowserSelectionFlags flags);
	199	OSStatus SetSelectedItems (UInt32 numItems, DataBrowserItemID const* itemIDs, DataBrowserSetOption operation);
	200
	201	//
	202	// item sorting
	203	//
	204	OSStatus GetSortOrder (DataBrowserSortOrder* order) const;
194027ac	205	OSStatus GetSortProperty(DataBrowserPropertyID* propertyID) const;
c0a66d92	206
07c51ff1 RR	207	OSStatus Resort(DataBrowserItemID container=kDataBrowserNoItem, Boolean sortChildren=true);
07c51ff1 RR	208
c0a66d92	209	OSStatus SetSortOrder (DataBrowserSortOrder order);
194027ac	210	OSStatus SetSortProperty(DataBrowserPropertyID propertyID);
c0a66d92	211
c17b2e31 RR	212	//
	213	// container handling
	214	//
	215	OSStatus CloseContainer(DataBrowserItemID containerID);
	216
	217	OSStatus OpenContainer(DataBrowserItemID containerID);
	218
c0a66d92 RR	219	protected :
c0a66d92 RR	220	//
99c75ebc	221	// standard callback functions
c0a66d92	222	//
99c75ebc RR	223	static pascal Boolean DataBrowserCompareProc (ControlRef browser, DataBrowserItemID itemOneID, DataBrowserItemID itemTwoID, DataBrowserPropertyID sortProperty);
	224	static pascal void DataBrowserGetContextualMenuProc(ControlRef browser, MenuRef* menu, UInt32* helpType, CFStringRef* helpItemString, AEDesc* selection);
	225	static pascal OSStatus DataBrowserGetSetItemDataProc (ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID property, DataBrowserItemDataRef itemData, Boolean getValue);
	226	static pascal void DataBrowserItemNotificationProc (ControlRef browser, DataBrowserItemID itemID, DataBrowserItemNotification message, DataBrowserItemDataRef itemData);
	227
	228	virtual Boolean DataBrowserCompareProc (DataBrowserItemID itemOneID, DataBrowserItemID itemTwoID, DataBrowserPropertyID sortProperty) = 0;
	229	virtual void DataBrowserGetContextualMenuProc(MenuRef* menu, UInt32* helpType, CFStringRef* helpItemString, AEDesc* selection) = 0;
	230	virtual OSStatus DataBrowserGetSetItemDataProc (DataBrowserItemID itemID, DataBrowserPropertyID property, DataBrowserItemDataRef itemData, Boolean getValue) = 0;
	231	virtual void DataBrowserItemNotificationProc (DataBrowserItemID itemID, DataBrowserItemNotification message, DataBrowserItemDataRef itemData) = 0;
	232
	233	//
	234	// callback functions for customized types
	235	//
	236	static pascal void DataBrowserDrawItemProc(ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID propertyID, DataBrowserItemState state, Rect const* rectangle, SInt16 bitDepth, Boolean colorDevice);
	237	static pascal Boolean DataBrowserEditItemProc(ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID propertyID, CFStringRef theString, Rect* maxEditTextRect, Boolean* shrinkToFit);
	238	static pascal Boolean DataBrowserHitTestProc (ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Rect const* mouseRect);
	239	static pascal DataBrowserTrackingResult DataBrowserTrackingProc(ControlRef browser, DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Point startPt, EventModifiers modifiers);
	240
	241	virtual void DataBrowserDrawItemProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, DataBrowserItemState state, Rect const* rectangle, SInt16 bitDepth, Boolean colorDevice) = 0;
	242	virtual Boolean DataBrowserEditItemProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, CFStringRef theString, Rect* maxEditTextRect, Boolean* shrinkToFit) = 0;
	243	virtual Boolean DataBrowserHitTestProc (DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Rect const* mouseRect) = 0;
	244	virtual DataBrowserTrackingResult DataBrowserTrackingProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Point startPt, EventModifiers modifiers) = 0;
c0a66d92	245
c0a66d92 RR	246	private:
	247	//
	248	// wxWidget internal stuff
	249	//
	250	DECLARE_ABSTRACT_CLASS(wxMacDataBrowserTableViewControl)
	251	};
	252
	253	// ============================================================================
194027ac	254	// wxMacDataBrowserListViewControl
c0a66d92 RR	255	// ============================================================================
c0a66d92 RR	256	//
194027ac RR	257	// this class is a wrapper for a list view which incorporates all general
	258	// data browser functionality of the inherited table view control class;
	259	// the term list view is in this case Mac OS X specific and is not related
	260	// to any wxWidget naming conventions
	261	//
c0a66d92 RR	262	class wxMacDataBrowserListViewControl : public wxMacDataBrowserTableViewControl
	263	{
	264	public:
	265	//
	266	// constructors / destructor
	267	//
	268	wxMacDataBrowserListViewControl(wxWindow* peer, wxPoint const& pos, wxSize const& size, long style) : wxMacDataBrowserTableViewControl(peer,pos,size,style)
	269	{
	270	}
	271
	272	//
	273	// column handling
	274	//
	275	OSStatus AddColumn(DataBrowserListViewColumnDesc *columnDesc, DataBrowserTableViewColumnIndex position);
	276
	277	protected:
	278	private:
	279	};
	280
	281
	282	// ============================================================================
194027ac	283	// wxMacDataViewDataBrowserListViewControl
c0a66d92 RR	284	// ============================================================================
c0a66d92 RR	285	//
194027ac RR	286	// internal interface class between wxDataViewCtrl (wxWidget) and the data
194027ac RR	287	// browser (Mac OS X)
c0a66d92	288	//
c0a66d92 RR	289	class wxMacDataViewDataBrowserListViewControl : public wxMacDataBrowserListViewControl
	290	{
	291	public:
	292	//
	293	// constructors / destructor
c0a66d92	294	//
194027ac	295	wxMacDataViewDataBrowserListViewControl(wxWindow* peer, wxPoint const& pos, wxSize const& size, long style);
c0a66d92 RR	296
	297	protected:
	298	//
99c75ebc RR	299	// standard callback functions (inherited from wxMacDataBrowserTableViewControl)
	300	//
	301	virtual Boolean DataBrowserCompareProc (DataBrowserItemID itemOneID, DataBrowserItemID itemTwoID, DataBrowserPropertyID sortProperty);
	302	virtual void DataBrowserItemNotificationProc (DataBrowserItemID itemID, DataBrowserItemNotification message, DataBrowserItemDataRef itemData);
	303	virtual void DataBrowserGetContextualMenuProc(MenuRef* menu, UInt32* helpType, CFStringRef* helpItemString, AEDesc* selection);
	304	virtual OSStatus DataBrowserGetSetItemDataProc (DataBrowserItemID itemID, DataBrowserPropertyID propertyID, DataBrowserItemDataRef itemData, Boolean getValue);
	305
	306	//
	307	// callback functions for customized types (inherited from wxMacDataBrowserTableViewControl)
c0a66d92	308	//
99c75ebc RR	309	virtual void DataBrowserDrawItemProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, DataBrowserItemState state, Rect const* rectangle, SInt16 bitDepth, Boolean colorDevice);
	310	virtual Boolean DataBrowserEditItemProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, CFStringRef theString, Rect* maxEditTextRect, Boolean* shrinkToFit);
	311	virtual Boolean DataBrowserHitTestProc (DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Rect const* mouseRect);
	312	virtual DataBrowserTrackingResult DataBrowserTrackingProc(DataBrowserItemID itemID, DataBrowserPropertyID propertyID, Rect const* theRect, Point startPt, EventModifiers modifiers);
c0a66d92 RR	313
c0a66d92 RR	314	private:
c0a66d92 RR	315	};
	316
	317	typedef wxMacDataViewDataBrowserListViewControl* wxMacDataViewDataBrowserListViewControlPointer;
	318
	319
	320	#endif // WX_GUI
	321
	322	#endif // _WX_DATABROW_H_