1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/osx/cocoa/dataview.mm
7 // RCS-ID: $Id: dataview.mm$
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #include "wx/wxprec.h"
14 #if (wxUSE_DATAVIEWCTRL == 1) && !defined(wxUSE_GENERICDATAVIEWCTRL)
18 #include "wx/toplevel.h"
20 #include "wx/settings.h"
24 #include "wx/osx/cocoa/dataview.h"
25 #include "wx/osx/private.h"
26 #include "wx/renderer.h"
28 // ============================================================================
29 // Constants used locally
30 // ============================================================================
32 #define DataViewPboardType @"OutlineViewItem"
34 // ============================================================================
35 // Classes used locally in dataview.mm
36 // ============================================================================
38 // ----------------------------------------------------------------------------
39 // wxCustomRendererObject
40 // ----------------------------------------------------------------------------
42 @interface wxCustomRendererObject : NSObject <NSCopying>
45 wxDataViewCustomRenderer* customRenderer; // not owned by the class
49 -(id) initWithRenderer:(wxDataViewCustomRenderer*)renderer;
52 @implementation wxCustomRendererObject
59 customRenderer = NULL;
64 -(id) initWithRenderer:(wxDataViewCustomRenderer*)renderer
69 customRenderer = renderer;
74 -(id) copyWithZone:(NSZone*)zone
76 wxCustomRendererObject* copy;
78 copy = [[[self class] allocWithZone:zone] init];
79 copy->customRenderer = customRenderer;
85 // ----------------------------------------------------------------------------
86 // wxDVCNSTableColumn: exists only to override NSTableColumn:dataCellForRow:
87 // ----------------------------------------------------------------------------
89 @interface wxDVCNSTableColumn : NSTableColumn
93 -(id) dataCellForRow:(NSInteger)row;
96 @implementation wxDVCNSTableColumn
98 -(id) dataCellForRow:(NSInteger)row
100 // what we want to do here is to simply return nil for the cells which
101 // shouldn't show anything as otherwise we would show e.g. empty combo box
102 // or progress cells in the columns using the corresponding types even for
103 // the container rows which is wrong
105 // half of the problem is just finding the objects we need from the column
106 // pointer which is itself stashed inside wxPointerObject which we use as
108 const wxDataViewColumn * const
109 dvCol = static_cast<wxDataViewColumn *>(
110 [(wxPointerObject *)[self identifier] pointer]
113 const wxDataViewCtrl * const dvc = dvCol->GetOwner();
114 const wxCocoaDataViewControl * const
115 peer = static_cast<wxCocoaDataViewControl *>(dvc->GetPeer());
118 // once we do have everything, simply ask NSOutlineView for the item...
119 const id item = peer->GetItemAtRow(row);
122 // ... and if it succeeded, ask the model whether it has any value
123 wxDataViewItem dvItem([((wxPointerObject*) item) pointer]);
125 if ( !dvc->GetModel()->HasValue(dvItem, dvCol->GetModelColumn()) )
129 return [super dataCellForRow:row];
134 // ============================================================================
136 // ============================================================================
141 // convert from NSObject to different C++ types: all these functions check
142 // that the conversion really makes sense and assert if it doesn't
143 wxString ObjectToString(NSObject *object)
145 wxCHECK_MSG( [object isKindOfClass:[NSString class]], "",
148 "string expected but got %s",
149 wxCFStringRef::AsString([object className])
152 return wxCFStringRef([((NSString*) object) retain]).AsString();
155 bool ObjectToBool(NSObject *object)
157 // actually the value must be of NSCFBoolean class but it's private so we
158 // can't check for it directly
159 wxCHECK_MSG( [object isKindOfClass:[NSNumber class]], false,
162 "number expected but got %s",
163 wxCFStringRef::AsString([object className])
166 return [(NSNumber *)object boolValue];
169 long ObjectToLong(NSObject *object)
171 wxCHECK_MSG( [object isKindOfClass:[NSNumber class]], -1,
174 "number expected but got %s",
175 wxCFStringRef::AsString([object className])
178 return [(NSNumber *)object longValue];
181 wxDateTime ObjectToDate(NSObject *object)
183 wxCHECK_MSG( [object isKindOfClass:[NSDate class]], wxInvalidDateTime,
186 "date expected but got %s",
187 wxCFStringRef::AsString([object className])
190 // get the number of seconds since 1970-01-01 UTC and this is the only
191 // way to convert a double to a wxLongLong
192 const wxLongLong seconds = [((NSDate*) object) timeIntervalSince1970];
194 wxDateTime dt(1, wxDateTime::Jan, 1970);
195 dt.Add(wxTimeSpan(0,0,seconds));
197 // the user has entered a date in the local timezone but seconds
198 // contains the number of seconds from date in the local timezone
199 // since 1970-01-01 UTC; therefore, the timezone information has to be
200 // transferred to wxWidgets, too:
201 dt.MakeFromTimezone(wxDateTime::UTC);
206 NSInteger CompareItems(id item1, id item2, void* context)
208 NSArray* const sortDescriptors = (NSArray*) context;
210 NSUInteger const count = [sortDescriptors count];
212 NSInteger result = NSOrderedSame;
213 for ( NSUInteger i = 0; i < count && result == NSOrderedSame; ++i )
215 // constant definition for abbreviational purposes:
216 wxSortDescriptorObject* const
217 sortDescriptor = (wxSortDescriptorObject*)
218 [sortDescriptors objectAtIndex:i];
220 int rc = [sortDescriptor modelPtr]->Compare
222 wxDataViewItem([((wxPointerObject*) item1) pointer]),
223 wxDataViewItem([((wxPointerObject*) item2) pointer]),
224 [sortDescriptor columnPtr]->GetModelColumn(),
225 [sortDescriptor ascending] == YES
229 result = NSOrderedAscending;
231 result = NSOrderedDescending;
237 NSTextAlignment ConvertToNativeHorizontalTextAlignment(int alignment)
239 if (alignment & wxALIGN_CENTER_HORIZONTAL)
240 return NSCenterTextAlignment;
241 else if (alignment & wxALIGN_RIGHT)
242 return NSRightTextAlignment;
244 return NSLeftTextAlignment;
247 NSTableColumn* CreateNativeColumn(const wxDataViewColumn *column)
249 wxDataViewRenderer * const renderer = column->GetRenderer();
251 wxCHECK_MSG( renderer, NULL, "column should have a renderer" );
253 wxDVCNSTableColumn * const nativeColumn(
254 [[wxDVCNSTableColumn alloc] initWithIdentifier:
255 [[[wxPointerObject alloc] initWithPointer:
256 const_cast<wxDataViewColumn*>(column)]
260 // setting the size related parameters:
261 const int width = column->GetWidthVariable();
262 if (column->IsResizeable())
264 [nativeColumn setResizingMask:NSTableColumnUserResizingMask];
265 [nativeColumn setMinWidth:column->GetMinWidth()];
266 [nativeColumn setMaxWidth:column->GetMaxWidth()];
270 [nativeColumn setResizingMask:NSTableColumnNoResizing];
271 [nativeColumn setMinWidth:width];
272 [nativeColumn setMaxWidth:width];
274 [nativeColumn setWidth:width];
276 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
277 // setting the visibility:
278 [nativeColumn setHidden:static_cast<BOOL>(column->IsHidden())];
281 wxDataViewRendererNativeData * const renderData = renderer->GetNativeData();
283 // setting the header:
284 [[nativeColumn headerCell] setAlignment:
285 ConvertToNativeHorizontalTextAlignment(column->GetAlignment())];
286 [[nativeColumn headerCell] setStringValue:
287 [[wxCFStringRef(column->GetTitle()).AsNSString() retain] autorelease]];
288 renderData->ApplyLineBreakMode([nativeColumn headerCell]);
290 // setting data cell's properties:
291 [[nativeColumn dataCell] setWraps:NO];
292 // setting the default data cell:
293 [nativeColumn setDataCell:renderData->GetColumnCell()];
294 // setting the editablility:
295 const bool isEditable = renderer->GetMode() == wxDATAVIEW_CELL_EDITABLE;
297 [nativeColumn setEditable:isEditable];
298 [[nativeColumn dataCell] setEditable:isEditable];
303 } // anonymous namespace
305 // ============================================================================
306 // Public helper functions for dataview implementation on OSX
307 // ============================================================================
309 wxWidgetImplType* CreateDataView(wxWindowMac* wxpeer,
310 wxWindowMac* WXUNUSED(parent),
311 wxWindowID WXUNUSED(id),
315 long WXUNUSED(extraStyle))
317 return new wxCocoaDataViewControl(wxpeer,pos,size,style);
320 // ============================================================================
322 // ============================================================================
324 @implementation wxPointerObject
330 self->pointer = NULL;
334 -(id) initWithPointer:(void*) initPointer
338 self->pointer = initPointer;
343 // inherited methods from NSObject
345 -(BOOL) isEqual:(id)object
347 return (object != nil) &&
348 ([object isKindOfClass:[wxPointerObject class]]) &&
349 (pointer == [((wxPointerObject*) object) pointer]);
354 return (NSUInteger) pointer;
362 -(void) setPointer:(void*) newPointer
364 pointer = newPointer;
369 // ============================================================================
370 // wxSortDescriptorObject
371 // ============================================================================
373 @implementation wxSortDescriptorObject
386 initWithModelPtr:(wxDataViewModel*)initModelPtr
387 sortingColumnPtr:(wxDataViewColumn*)initColumnPtr
388 ascending:(BOOL)sortAscending
390 self = [super initWithKey:@"dummy" ascending:sortAscending];
393 columnPtr = initColumnPtr;
394 modelPtr = initModelPtr;
399 -(id) copyWithZone:(NSZone*)zone
401 wxSortDescriptorObject* copy;
404 copy = [super copyWithZone:zone];
405 copy->columnPtr = columnPtr;
406 copy->modelPtr = modelPtr;
412 // access to model column's index
414 -(wxDataViewColumn*) columnPtr
419 -(wxDataViewModel*) modelPtr
424 -(void) setColumnPtr:(wxDataViewColumn*)newColumnPtr
426 columnPtr = newColumnPtr;
429 -(void) setModelPtr:(wxDataViewModel*)newModelPtr
431 modelPtr = newModelPtr;
436 // ============================================================================
437 // wxCocoaOutlineDataSource
438 // ============================================================================
439 @implementation wxCocoaOutlineDataSource
442 // constructors / destructor
449 implementation = NULL;
452 currentParentItem = nil;
454 children = [[NSMutableArray alloc] init];
455 items = [[NSMutableSet alloc] init];
462 [currentParentItem release];
471 // methods of informal protocol:
474 outlineView:(NSOutlineView*)outlineView
475 acceptDrop:(id<NSDraggingInfo>)info
476 item:(id)item childIndex:(NSInteger)index
478 NSArray* supportedTypes(
479 [NSArray arrayWithObjects:DataViewPboardType,NSStringPboardType,nil]
482 NSPasteboard* pasteboard([info draggingPasteboard]);
484 NSString* bestType([pasteboard availableTypeFromArray:supportedTypes]);
486 if ( bestType == nil )
489 wxDataViewCtrl * const dvc(implementation->GetDataViewCtrl());
491 wxCHECK_MSG( dvc, false,
492 "Pointer to data view control not set correctly." );
493 wxCHECK_MSG( dvc->GetModel(), false,
494 "Pointer to model not set correctly." );
496 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_ITEM_DROP, dvc->GetId());
497 event.SetEventObject(dvc);
498 event.SetItem(wxDataViewItem([((wxPointerObject*) item) pointer]));
499 event.SetModel(dvc->GetModel());
502 if ( [bestType compare:DataViewPboardType] == NSOrderedSame )
504 NSArray* dataArray((NSArray*)[pasteboard propertyListForType:DataViewPboardType]);
505 NSUInteger indexDraggedItem, noOfDraggedItems([dataArray count]);
507 indexDraggedItem = 0;
508 while (indexDraggedItem < noOfDraggedItems)
510 wxDataObjectComposite* dataObjects(implementation->GetDnDDataObjects((NSData*)[dataArray objectAtIndex:indexDraggedItem]));
512 if (dataObjects && (dataObjects->GetFormatCount() > 0))
514 wxMemoryBuffer buffer;
516 // copy data into data object:
517 event.SetDataObject(dataObjects);
518 event.SetDataFormat(implementation->GetDnDDataFormat(dataObjects));
519 // copy data into buffer:
520 dataObjects->GetDataHere(event.GetDataFormat().GetType(),buffer.GetWriteBuf(event.GetDataSize()));
521 buffer.UngetWriteBuf(event.GetDataSize());
522 event.SetDataBuffer(buffer.GetData());
523 // finally, send event:
524 if (dvc->HandleWindowEvent(event) && event.IsAllowed())
526 dragSuccessful = true;
531 dragSuccessful = true;
532 indexDraggedItem = noOfDraggedItems; // stop loop
537 dragSuccessful = false;
538 indexDraggedItem = noOfDraggedItems; // stop loop
546 CFDataRef osxData; // needed to convert internally used UTF-16 representation to a UTF-8 representation
547 wxDataObjectComposite* dataObjects (new wxDataObjectComposite());
548 wxTextDataObject* textDataObject(new wxTextDataObject());
550 osxData = ::CFStringCreateExternalRepresentation(kCFAllocatorDefault,(CFStringRef)[pasteboard stringForType:NSStringPboardType],kCFStringEncodingUTF8,32);
551 if (textDataObject->SetData(::CFDataGetLength(osxData),::CFDataGetBytePtr(osxData)))
552 dataObjects->Add(textDataObject);
554 delete textDataObject;
555 // send event if data could be copied:
556 if (dataObjects->GetFormatCount() > 0)
558 event.SetDataObject(dataObjects);
559 event.SetDataFormat(implementation->GetDnDDataFormat(dataObjects));
560 if (dvc->HandleWindowEvent(event) && event.IsAllowed())
561 dragSuccessful = true;
563 dragSuccessful = false;
566 dragSuccessful = false;
568 ::CFRelease(osxData);
573 -(id) outlineView:(NSOutlineView*)outlineView child:(NSInteger)index ofItem:(id)item
575 if ((item == currentParentItem) && (index < ((NSInteger) [self getChildCount])))
576 return [self getChild:index];
579 wxDataViewItemArray dataViewChildren;
581 wxCHECK_MSG( model, 0, "Valid model in data source does not exist." );
582 (void) model->GetChildren((item == nil) ? wxDataViewItem() : wxDataViewItem([((wxPointerObject*) item) pointer]),dataViewChildren);
583 [self bufferItem:item withChildren:&dataViewChildren];
584 if ([sortDescriptors count] > 0)
585 [children sortUsingFunction:CompareItems context:sortDescriptors];
586 return [self getChild:index];
590 -(BOOL) outlineView:(NSOutlineView*)outlineView isItemExpandable:(id)item
592 wxCHECK_MSG( model, 0, "Valid model in data source does not exist." );
593 return model->IsContainer(wxDataViewItem([((wxPointerObject*) item) pointer]));
596 -(NSInteger) outlineView:(NSOutlineView*)outlineView numberOfChildrenOfItem:(id)item
598 NSInteger noOfChildren;
600 wxDataViewItemArray dataViewChildren;
603 wxCHECK_MSG( model, 0, "Valid model in data source does not exist." );
604 noOfChildren = model->GetChildren((item == nil) ? wxDataViewItem() : wxDataViewItem([((wxPointerObject*) item) pointer]),dataViewChildren);
605 [self bufferItem:item withChildren:&dataViewChildren];
606 if ([sortDescriptors count] > 0)
607 [children sortUsingFunction:CompareItems context:sortDescriptors];
612 outlineView:(NSOutlineView*)outlineView
613 objectValueForTableColumn:(NSTableColumn*)tableColumn
616 wxCHECK_MSG( model, nil, "Valid model in data source does not exist." );
618 wxDataViewColumn* col(static_cast<wxDataViewColumn*>([[tableColumn identifier] pointer]));
619 const unsigned colIdx = col->GetModelColumn();
621 wxDataViewItem dataViewItem([((wxPointerObject*) item) pointer]);
623 if ( model->HasValue(dataViewItem, colIdx) )
626 model->GetValue(value,dataViewItem, colIdx);
627 col->GetRenderer()->SetValue(value);
634 outlineView:(NSOutlineView*)outlineView
635 setObjectValue:(id)object
636 forTableColumn:(NSTableColumn*)tableColumn
639 wxDataViewColumn* col(static_cast<wxDataViewColumn*>([[tableColumn identifier] pointer]));
641 wxDataViewItem dataViewItem([((wxPointerObject*) item) pointer]);
644 OSXOnCellChanged(object, dataViewItem, col->GetModelColumn());
647 -(void) outlineView:(NSOutlineView*)outlineView sortDescriptorsDidChange:(NSArray*)oldDescriptors
648 // Warning: the new sort descriptors are guaranteed to be only of type NSSortDescriptor! Therefore, the
649 // sort descriptors for the data source have to be converted.
651 NSArray* newDescriptors;
653 NSMutableArray* wxSortDescriptors;
655 NSUInteger noOfDescriptors;
657 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
660 // convert NSSortDescriptors to wxSortDescriptorObjects:
661 newDescriptors = [outlineView sortDescriptors];
662 noOfDescriptors = [newDescriptors count];
663 wxSortDescriptors = [NSMutableArray arrayWithCapacity:noOfDescriptors];
664 for (NSUInteger i=0; i<noOfDescriptors; ++i)
666 // constant definition for abbreviational purposes:
667 NSSortDescriptor* const newDescriptor = [newDescriptors objectAtIndex:i];
669 [wxSortDescriptors addObject:[[[wxSortDescriptorObject alloc] initWithModelPtr:model
670 sortingColumnPtr:dvc->GetColumn([[newDescriptor key] intValue])
671 ascending:[newDescriptor ascending]] autorelease]];
673 [[outlineView dataSource] setSortDescriptors:wxSortDescriptors];
675 // send first the event to wxWidgets that the sorting has changed so that the program can do special actions before
676 // the sorting actually starts:
677 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED,dvc->GetId()); // variable defintion
679 event.SetEventObject(dvc);
680 if (noOfDescriptors > 0)
682 // constant definition for abbreviational purposes:
683 wxDataViewColumn* const col = [[wxSortDescriptors objectAtIndex:0] columnPtr];
685 event.SetColumn(dvc->GetColumnPosition(col));
686 event.SetDataViewColumn(col);
688 dvc->GetEventHandler()->ProcessEvent(event);
690 // start re-ordering the data;
691 // children's buffer must be cleared first because it contains the old order:
692 [self clearChildren];
693 // sorting is done while reloading the data:
694 [outlineView reloadData];
697 -(NSDragOperation) outlineView:(NSOutlineView*)outlineView validateDrop:(id<NSDraggingInfo>)info proposedItem:(id)item proposedChildIndex:(NSInteger)index
699 NSArray* supportedTypes([NSArray arrayWithObjects:DataViewPboardType,NSStringPboardType,nil]);
701 NSPasteboard* pasteboard([info draggingPasteboard]);
703 NSString* bestType([pasteboard availableTypeFromArray:supportedTypes]);
705 return NSDragOperationNone;
707 NSDragOperation dragOperation;
708 wxDataViewCtrl* const dvc(implementation->GetDataViewCtrl());
710 wxCHECK_MSG(dvc, false, "Pointer to data view control not set correctly.");
711 wxCHECK_MSG(dvc->GetModel(), false, "Pointer to model not set correctly.");
714 event(wxEVT_COMMAND_DATAVIEW_ITEM_DROP_POSSIBLE,dvc->GetId());
716 event.SetEventObject(dvc);
717 event.SetItem(wxDataViewItem([((wxPointerObject*) item) pointer]));
718 event.SetModel(dvc->GetModel());
719 if ([bestType compare:DataViewPboardType] == NSOrderedSame)
721 NSArray* dataArray((NSArray*)[pasteboard propertyListForType:DataViewPboardType]);
722 NSUInteger indexDraggedItem, noOfDraggedItems([dataArray count]);
724 indexDraggedItem = 0;
725 while (indexDraggedItem < noOfDraggedItems)
727 wxDataObjectComposite* dataObjects(implementation->GetDnDDataObjects((NSData*)[dataArray objectAtIndex:indexDraggedItem]));
729 if (dataObjects && (dataObjects->GetFormatCount() > 0))
731 wxMemoryBuffer buffer;
733 // copy data into data object:
734 event.SetDataObject(dataObjects);
735 event.SetDataFormat(implementation->GetDnDDataFormat(dataObjects));
736 // copy data into buffer:
737 dataObjects->GetDataHere(event.GetDataFormat().GetType(),buffer.GetWriteBuf(event.GetDataSize()));
738 buffer.UngetWriteBuf(event.GetDataSize());
739 event.SetDataBuffer(buffer.GetData());
740 // finally, send event:
741 if (dvc->HandleWindowEvent(event) && event.IsAllowed())
743 dragOperation = NSDragOperationEvery;
748 dragOperation = NSDragOperationNone;
749 indexDraggedItem = noOfDraggedItems; // stop loop
754 dragOperation = NSDragOperationNone;
755 indexDraggedItem = noOfDraggedItems; // stop loop
763 CFDataRef osxData; // needed to convert internally used UTF-16 representation to a UTF-8 representation
764 wxDataObjectComposite* dataObjects (new wxDataObjectComposite());
765 wxTextDataObject* textDataObject(new wxTextDataObject());
767 osxData = ::CFStringCreateExternalRepresentation(kCFAllocatorDefault,(CFStringRef)[pasteboard stringForType:NSStringPboardType],kCFStringEncodingUTF8,32);
768 if (textDataObject->SetData(::CFDataGetLength(osxData),::CFDataGetBytePtr(osxData)))
769 dataObjects->Add(textDataObject);
771 delete textDataObject;
772 // send event if data could be copied:
773 if (dataObjects->GetFormatCount() > 0)
775 event.SetDataObject(dataObjects);
776 event.SetDataFormat(implementation->GetDnDDataFormat(dataObjects));
777 if (dvc->HandleWindowEvent(event) && event.IsAllowed())
778 dragOperation = NSDragOperationEvery;
780 dragOperation = NSDragOperationNone;
783 dragOperation = NSDragOperationNone;
785 ::CFRelease(osxData);
789 return dragOperation;
792 -(BOOL) outlineView:(NSOutlineView*)outlineView writeItems:(NSArray*)writeItems toPasteboard:(NSPasteboard*)pasteboard
793 // the pasteboard will be filled up with an array containing the data as returned by the events (including the data type)
794 // and a concatenation of text (string) data; the text data will only be put onto the pasteboard if for all items a
795 // string representation exists
797 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
799 wxDataViewItemArray dataViewItems;
802 wxCHECK_MSG(dvc, false,"Pointer to data view control not set correctly.");
803 wxCHECK_MSG(dvc->GetModel(),false,"Pointer to model not set correctly.");
805 if ([writeItems count] > 0)
807 bool dataStringAvailable(true); // a flag indicating if for all items a data string is available
808 NSMutableArray* dataArray = [[NSMutableArray arrayWithCapacity:[writeItems count]] retain]; // data of all items
809 wxString dataString; // contains the string data of all items
811 // send a begin drag event for all selected items and proceed with dragging unless the event is vetoed:
813 event(wxEVT_COMMAND_DATAVIEW_ITEM_BEGIN_DRAG,dvc->GetId());
815 event.SetEventObject(dvc);
816 event.SetModel(dvc->GetModel());
817 for (size_t itemCounter=0; itemCounter<[writeItems count]; ++itemCounter)
819 bool itemStringAvailable(false); // a flag indicating if for the current item a string is available
820 wxDataObjectComposite* itemObject(new wxDataObjectComposite()); // data object for current item
821 wxString itemString; // contains the TAB concatenated data of an item
823 event.SetItem(wxDataViewItem([((wxPointerObject*) [writeItems objectAtIndex:itemCounter]) pointer]));
824 itemString = ::ConcatenateDataViewItemValues(dvc,event.GetItem());
825 itemObject->Add(new wxTextDataObject(itemString));
826 event.SetDataObject(itemObject);
827 // check if event has not been vetoed:
828 if (dvc->HandleWindowEvent(event) && event.IsAllowed() && (event.GetDataObject()->GetFormatCount() > 0))
830 // constant definition for abbreviational purposes:
831 size_t const noOfFormats = event.GetDataObject()->GetFormatCount();
832 // variable definition and initialization:
833 wxDataFormat* dataFormats(new wxDataFormat[noOfFormats]);
835 event.GetDataObject()->GetAllFormats(dataFormats,wxDataObject::Get);
836 for (size_t formatCounter=0; formatCounter<noOfFormats; ++formatCounter)
838 // constant definitions for abbreviational purposes:
839 wxDataFormatId const idDataFormat = dataFormats[formatCounter].GetType();
840 size_t const dataSize = event.GetDataObject()->GetDataSize(idDataFormat);
841 size_t const dataBufferSize = sizeof(wxDataFormatId)+dataSize;
842 // variable definitions (used in all case statements):
843 wxMemoryBuffer dataBuffer(dataBufferSize);
845 dataBuffer.AppendData(&idDataFormat,sizeof(wxDataFormatId));
846 switch (idDataFormat)
849 if (!itemStringAvailable) // otherwise wxDF_UNICODETEXT already filled up the string; and the UNICODE representation has priority
851 event.GetDataObject()->GetDataHere(wxDF_TEXT,dataBuffer.GetAppendBuf(dataSize));
852 dataBuffer.UngetAppendBuf(dataSize);
853 [dataArray addObject:[NSData dataWithBytes:dataBuffer.GetData() length:dataBufferSize]];
854 itemString = wxString(static_cast<char const*>(dataBuffer.GetData())+sizeof(wxDataFormatId),wxConvLocal);
855 itemStringAvailable = true;
858 case wxDF_UNICODETEXT:
860 event.GetDataObject()->GetDataHere(wxDF_UNICODETEXT,dataBuffer.GetAppendBuf(dataSize));
861 dataBuffer.UngetAppendBuf(dataSize);
862 if (itemStringAvailable) // does an object already exist as an ASCII text (see wxDF_TEXT case statement)?
863 [dataArray replaceObjectAtIndex:itemCounter withObject:[NSData dataWithBytes:dataBuffer.GetData() length:dataBufferSize]];
865 [dataArray addObject:[NSData dataWithBytes:dataBuffer.GetData() length:dataBufferSize]];
866 itemString = wxString::FromUTF8(static_cast<char const*>(dataBuffer.GetData())+sizeof(wxDataFormatId),dataSize);
867 itemStringAvailable = true;
871 wxFAIL_MSG("Data object has invalid or unsupported data format");
876 delete[] dataFormats;
878 if (dataStringAvailable)
879 if (itemStringAvailable)
882 dataString << wxT('\n');
883 dataString << itemString;
886 dataStringAvailable = false;
892 return NO; // dragging was vetoed or no data available
895 if (dataStringAvailable)
897 wxCFStringRef osxString(dataString);
899 [pasteboard declareTypes:[NSArray arrayWithObjects:DataViewPboardType,NSStringPboardType,nil] owner:nil];
900 [pasteboard setPropertyList:dataArray forType:DataViewPboardType];
901 [pasteboard setString:osxString.AsNSString() forType:NSStringPboardType];
905 [pasteboard declareTypes:[NSArray arrayWithObject:DataViewPboardType] owner:nil];
906 [pasteboard setPropertyList:dataArray forType:DataViewPboardType];
911 return NO; // no items to drag (should never occur)
917 -(void) addToBuffer:(wxPointerObject*)item
919 [items addObject:item];
924 [items removeAllObjects];
927 -(wxPointerObject*) getDataViewItemFromBuffer:(const wxDataViewItem&)item
929 return [items member:[[[wxPointerObject alloc] initWithPointer:item.GetID()] autorelease]];
932 -(wxPointerObject*) getItemFromBuffer:(wxPointerObject*)item
934 return [items member:item];
937 -(BOOL) isInBuffer:(wxPointerObject*)item
939 return [items containsObject:item];
942 -(void) removeFromBuffer:(wxPointerObject*)item
944 [items removeObject:item];
950 -(void) appendChild:(wxPointerObject*)item
952 [children addObject:item];
955 -(void) clearChildren
957 [children removeAllObjects];
960 -(wxPointerObject*) getChild:(NSUInteger)index
962 return [children objectAtIndex:index];
965 -(NSUInteger) getChildCount
967 return [children count];
970 -(void) removeChild:(NSUInteger)index
972 [children removeObjectAtIndex:index];
981 [self clearChildren];
982 [self setCurrentParentItem:nil];
988 -(NSArray*) sortDescriptors
990 return sortDescriptors;
993 -(void) setSortDescriptors:(NSArray*)newSortDescriptors
995 [newSortDescriptors retain];
996 [sortDescriptors release];
997 sortDescriptors = newSortDescriptors;
1001 // access to wxWidget's implementation
1003 -(wxPointerObject*) currentParentItem
1005 return currentParentItem;
1008 -(wxCocoaDataViewControl*) implementation
1010 return implementation;
1013 -(wxDataViewModel*) model
1018 -(void) setCurrentParentItem:(wxPointerObject*)newCurrentParentItem
1020 [newCurrentParentItem retain];
1021 [currentParentItem release];
1022 currentParentItem = newCurrentParentItem;
1025 -(void) setImplementation:(wxCocoaDataViewControl*) newImplementation
1027 implementation = newImplementation;
1030 -(void) setModel:(wxDataViewModel*) newModel
1038 -(void) bufferItem:(wxPointerObject*)parentItem withChildren:(wxDataViewItemArray*)dataViewChildrenPtr
1040 NSInteger const noOfChildren = (*dataViewChildrenPtr).GetCount();
1042 [self setCurrentParentItem:parentItem];
1043 [self clearChildren];
1044 for (NSInteger indexChild=0; indexChild<noOfChildren; ++indexChild)
1046 wxPointerObject* bufferedPointerObject;
1047 wxPointerObject* newPointerObject([[wxPointerObject alloc] initWithPointer:(*dataViewChildrenPtr)[indexChild].GetID()]);
1049 // The next statement and test looks strange but there is
1050 // unfortunately no workaround: due to the fact that two pointer
1051 // objects are identical if their pointers are identical - because the
1052 // method isEqual has been overloaded - the set operation will only
1053 // add a new pointer object if there is not already one in the set
1054 // having the same pointer. On the other side the children's array
1055 // would always add the new pointer object. This means that different
1056 // pointer objects are stored in the set and array. This will finally
1057 // lead to a crash as objects diverge. To solve this issue it is first
1058 // tested if the child already exists in the set and if it is the case
1059 // the sets object is going to be appended to the array, otheriwse the
1060 // new pointer object is added to the set and array:
1061 bufferedPointerObject = [self getItemFromBuffer:newPointerObject];
1062 if (bufferedPointerObject == nil)
1064 [items addObject:newPointerObject];
1065 [children addObject:newPointerObject];
1068 [children addObject:bufferedPointerObject];
1069 [newPointerObject release];
1075 // ============================================================================
1077 // ============================================================================
1079 @implementation wxCustomCell
1083 wxCustomRendererObject * const
1084 obj = static_cast<wxCustomRendererObject *>([self objectValue]);
1087 const wxSize size = obj->customRenderer->GetSize();
1088 return NSMakeSize(size.x, size.y);
1094 -(void) drawWithFrame:(NSRect)cellFrame inView:(NSView*)controlView
1096 wxCustomRendererObject * const
1097 obj = static_cast<wxCustomRendererObject *>([self objectValue]);
1100 // this may happen for the custom cells in container rows: they don't
1105 wxDataViewCustomRenderer * const renderer = obj->customRenderer;
1107 wxDC * const dc = renderer->GetDC();
1108 renderer->WXCallRender(wxFromNSRect(controlView, cellFrame), dc, 0);
1109 renderer->SetDC(NULL);
1112 -(NSRect) imageRectForBounds:(NSRect)cellFrame
1117 -(NSRect) titleRectForBounds:(NSRect)cellFrame
1124 // ============================================================================
1126 // ============================================================================
1127 @implementation wxImageTextCell
1133 self = [super init];
1136 // initializing the text part:
1137 [self setSelectable:YES];
1138 // initializing the image part:
1140 imageSize = NSMakeSize(16,16);
1141 spaceImageText = 5.0;
1147 -(id) copyWithZone:(NSZone*)zone
1149 wxImageTextCell* cell;
1152 cell = (wxImageTextCell*) [super copyWithZone:zone];
1153 cell->image = [image retain];
1154 cell->imageSize = imageSize;
1155 cell->spaceImageText = spaceImageText;
1156 cell->xImageShift = xImageShift;
1171 -(NSTextAlignment) alignment
1173 return cellAlignment;
1176 -(void) setAlignment:(NSTextAlignment)newAlignment
1178 cellAlignment = newAlignment;
1179 switch (newAlignment)
1181 case NSCenterTextAlignment:
1182 case NSLeftTextAlignment:
1183 case NSJustifiedTextAlignment:
1184 case NSNaturalTextAlignment:
1185 [super setAlignment:NSLeftTextAlignment];
1187 case NSRightTextAlignment:
1188 [super setAlignment:NSRightTextAlignment];
1191 wxFAIL_MSG("Unknown alignment type.");
1203 -(void) setImage:(NSImage*)newImage
1215 -(void) setImageSize:(NSSize) newImageSize
1217 imageSize = newImageSize;
1223 -(NSSize) cellImageSize
1225 return NSMakeSize(imageSize.width+xImageShift+spaceImageText,imageSize.height);
1230 NSSize cellSize([super cellSize]);
1233 if (imageSize.height > cellSize.height)
1234 cellSize.height = imageSize.height;
1235 cellSize.width += imageSize.width+xImageShift+spaceImageText;
1240 -(NSSize) cellTextSize
1242 return [super cellSize];
1248 -(void) determineCellParts:(NSRect)cellFrame imagePart:(NSRect*)imageFrame textPart:(NSRect*)textFrame
1250 switch (cellAlignment)
1252 case NSCenterTextAlignment:
1254 CGFloat const cellSpace = cellFrame.size.width-[self cellSize].width;
1256 if (cellSpace <= 0) // if the cell's frame is smaller than its contents (at least in x-direction) make sure that the image is visible:
1257 NSDivideRect(cellFrame,imageFrame,textFrame,xImageShift+imageSize.width+spaceImageText,NSMinXEdge);
1258 else // otherwise center the image and text in the cell's frame
1259 NSDivideRect(cellFrame,imageFrame,textFrame,xImageShift+imageSize.width+spaceImageText+0.5*cellSpace,NSMinXEdge);
1262 case NSJustifiedTextAlignment:
1263 case NSLeftTextAlignment:
1264 case NSNaturalTextAlignment: // how to determine the natural writing direction? TODO
1265 NSDivideRect(cellFrame,imageFrame,textFrame,xImageShift+imageSize.width+spaceImageText,NSMinXEdge);
1267 case NSRightTextAlignment:
1269 CGFloat const cellSpace = cellFrame.size.width-[self cellSize].width;
1271 if (cellSpace <= 0) // if the cell's frame is smaller than its contents (at least in x-direction) make sure that the image is visible:
1272 NSDivideRect(cellFrame,imageFrame,textFrame,xImageShift+imageSize.width+spaceImageText,NSMinXEdge);
1273 else // otherwise right align the image and text in the cell's frame
1274 NSDivideRect(cellFrame,imageFrame,textFrame,xImageShift+imageSize.width+spaceImageText+cellSpace,NSMinXEdge);
1278 *imageFrame = NSZeroRect;
1279 *textFrame = NSZeroRect;
1280 wxFAIL_MSG("Unhandled alignment type.");
1284 -(void) drawWithFrame:(NSRect)cellFrame inView:(NSView*)controlView
1286 NSRect textFrame, imageFrame;
1289 [self determineCellParts:cellFrame imagePart:&imageFrame textPart:&textFrame];
1290 // draw the image part by ourselves;
1291 // check if the cell has to draw its own background (checking is done by the parameter of the textfield's cell):
1292 if ([self drawsBackground])
1294 [[self backgroundColor] set];
1295 NSRectFill(imageFrame);
1299 // the image is slightly shifted (xImageShift) and has a fixed size but the image's frame might be larger and starts
1300 // currently on the left side of the cell's frame; therefore, the origin and the image's frame size have to be adjusted:
1301 if (imageFrame.size.width >= xImageShift+imageSize.width+spaceImageText)
1303 imageFrame.origin.x += imageFrame.size.width-imageSize.width-spaceImageText;
1304 imageFrame.size.width = imageSize.width;
1308 imageFrame.origin.x += xImageShift;
1309 imageFrame.size.width -= xImageShift+spaceImageText;
1311 // ...and the image has to be centered in the y-direction:
1312 if (imageFrame.size.height > imageSize.height)
1313 imageFrame.size.height = imageSize.height;
1314 imageFrame.origin.y += ceil(0.5*(cellFrame.size.height-imageFrame.size.height));
1316 // according to the documentation the coordinate system should be flipped for NSTableViews (y-coordinate goes from top to bottom);
1317 // to draw an image correctly the coordinate system has to be transformed to a bottom-top coordinate system, otherwise the image's
1318 // content is flipped:
1319 NSAffineTransform* coordinateTransform([NSAffineTransform transform]);
1321 if ([controlView isFlipped])
1323 [coordinateTransform scaleXBy: 1.0 yBy:-1.0]; // first the coordinate system is brought back to bottom-top orientation
1324 [coordinateTransform translateXBy:0.0 yBy:(-2.0)*imageFrame.origin.y-imageFrame.size.height]; // the coordinate system has to be moved to compensate for the
1325 [coordinateTransform concat]; // other orientation and the position of the image's frame
1327 [image drawInRect:imageFrame fromRect:NSZeroRect operation:NSCompositeSourceOver fraction:1.0]; // suggested method to draw the image
1328 // instead of compositeToPoint:operation:
1329 // take back previous transformation (if the view is not flipped the coordinate transformation matrix contains the identity matrix
1330 // and the next two operations do not change the content's transformation matrix):
1331 [coordinateTransform invert];
1332 [coordinateTransform concat];
1334 // let the textfield cell draw the text part:
1335 if (textFrame.size.width > [self cellTextSize].width) // for unknown reasons the alignment of the text cell is ignored; therefore change the size so that
1336 textFrame.size.width = [self cellTextSize].width; // alignment does not influence the visualization anymore
1337 [super drawWithFrame:textFrame inView:controlView];
1340 -(void) editWithFrame:(NSRect)aRect inView:(NSView*)controlView editor:(NSText*)textObj delegate:(id)anObject event:(NSEvent*)theEvent
1342 NSRect textFrame, imageFrame;
1345 [self determineCellParts:aRect imagePart:&imageFrame textPart:&textFrame];
1346 [super editWithFrame:textFrame inView:controlView editor:textObj delegate:anObject event:theEvent];
1349 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
1350 -(NSUInteger) hitTestForEvent:(NSEvent*)event inRect:(NSRect)cellFrame ofView:(NSView*)controlView
1352 NSPoint point = [controlView convertPoint:[event locationInWindow] fromView:nil];
1354 NSRect imageFrame, textFrame;
1357 [self determineCellParts:cellFrame imagePart:&imageFrame textPart:&textFrame];
1360 // the image is shifted...
1361 if (imageFrame.size.width >= xImageShift+imageSize.width+spaceImageText)
1363 imageFrame.origin.x += imageFrame.size.width-imageSize.width-spaceImageText;
1364 imageFrame.size.width = imageSize.width;
1368 imageFrame.origin.x += xImageShift;
1369 imageFrame.size.width -= xImageShift+spaceImageText;
1372 if (imageFrame.size.height > imageSize.height)
1373 imageFrame.size.height = imageSize.height;
1374 imageFrame.origin.y += ceil(0.5*(cellFrame.size.height-imageFrame.size.height));
1375 // If the point is in the image rect, then it is a content hit (see documentation for hitTestForEvent:inRect:ofView):
1376 if (NSMouseInRect(point, imageFrame, [controlView isFlipped]))
1377 return NSCellHitContentArea;
1379 // if the image was not hit let's try the text part:
1380 if (textFrame.size.width > [self cellTextSize].width) // for unknown reasons the alignment of the text cell is ignored; therefore change the size so that
1381 textFrame.size.width = [self cellTextSize].width; // alignment does not influence the visualization anymore
1382 return [super hitTestForEvent:event inRect:textFrame ofView:controlView];
1386 -(NSRect) imageRectForBounds:(NSRect)cellFrame
1388 NSRect textFrame, imageFrame;
1391 [self determineCellParts:cellFrame imagePart:&imageFrame textPart:&textFrame];
1392 if (imageFrame.size.width >= xImageShift+imageSize.width+spaceImageText)
1394 imageFrame.origin.x += imageFrame.size.width-imageSize.width-spaceImageText;
1395 imageFrame.size.width = imageSize.width;
1399 imageFrame.origin.x += xImageShift;
1400 imageFrame.size.width -= xImageShift+spaceImageText;
1403 if (imageFrame.size.height > imageSize.height)
1404 imageFrame.size.height = imageSize.height;
1405 imageFrame.origin.y += ceil(0.5*(cellFrame.size.height-imageFrame.size.height));
1410 -(void) selectWithFrame:(NSRect)aRect inView:(NSView*)controlView editor:(NSText*)textObj delegate:(id)anObject start:(NSInteger)selStart length:(NSInteger)selLength
1412 NSRect textFrame, imageFrame;
1415 [self determineCellParts:aRect imagePart:&imageFrame textPart:&textFrame];
1416 [super selectWithFrame:textFrame inView:controlView editor:textObj delegate:anObject start:selStart length:selLength];
1419 -(NSRect) titleRectForBounds:(NSRect)cellFrame
1421 NSRect textFrame, imageFrame;
1424 [self determineCellParts:cellFrame imagePart:&imageFrame textPart:&textFrame];
1430 // ============================================================================
1431 // wxCocoaOutlineView
1432 // ============================================================================
1433 @implementation wxCocoaOutlineView
1436 // initializers / destructor
1440 self = [super init];
1443 currentlyEditedColumn =
1444 currentlyEditedRow = -1;
1446 [self registerForDraggedTypes:[NSArray arrayWithObjects:DataViewPboardType,NSStringPboardType,nil]];
1447 [self setDelegate:self];
1448 [self setDoubleAction:@selector(actionDoubleClick:)];
1449 [self setDraggingSourceOperationMask:NSDragOperationEvery forLocal:NO];
1450 [self setDraggingSourceOperationMask:NSDragOperationEvery forLocal:YES];
1451 [self setTarget:self];
1457 // access to wxWidget's implementation
1459 -(wxCocoaDataViewControl*) implementation
1461 return implementation;
1464 -(void) setImplementation:(wxCocoaDataViewControl*) newImplementation
1466 implementation = newImplementation;
1472 -(void) actionDoubleClick:(id)sender
1473 // actually the documentation (NSTableView 2007-10-31) for doubleAction: and setDoubleAction: seems to be wrong as this action message is always sent
1474 // whether the cell is editable or not
1476 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1478 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED,dvc->GetId()); // variable definition
1481 event.SetEventObject(dvc);
1482 event.SetItem(wxDataViewItem([((wxPointerObject*) [self itemAtRow:[self clickedRow]]) pointer]));
1483 dvc->GetEventHandler()->ProcessEvent(event);
1490 -(NSMenu*) menuForEvent:(NSEvent*)theEvent
1491 // this method does not do any special menu event handling but only sends an event message; therefore, the user
1492 // has full control if a context menu should be shown or not
1494 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1496 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_ITEM_CONTEXT_MENU,dvc->GetId());
1498 wxDataViewItemArray selectedItems;
1501 event.SetEventObject(dvc);
1502 event.SetModel(dvc->GetModel());
1503 // get the item information;
1504 // theoretically more than one ID can be returned but the event can only handle one item, therefore only the first
1505 // item of the array is returned:
1506 if (dvc->GetSelections(selectedItems) > 0)
1507 event.SetItem(selectedItems[0]);
1508 dvc->GetEventHandler()->ProcessEvent(event);
1516 -(void) outlineView:(NSOutlineView*)outlineView mouseDownInHeaderOfTableColumn:(NSTableColumn*)tableColumn
1518 wxDataViewColumn* const col(static_cast<wxDataViewColumn*>([[tableColumn identifier] pointer]));
1520 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1523 event(wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK,dvc->GetId());
1526 // first, send an event that the user clicked into a column's header:
1527 event.SetEventObject(dvc);
1528 event.SetColumn(dvc->GetColumnPosition(col));
1529 event.SetDataViewColumn(col);
1530 dvc->HandleWindowEvent(event);
1532 // now, check if the click may have had an influence on sorting, too;
1533 // the sorting setup has to be done only if the clicked table column is sortable and has not been used for
1534 // sorting before the click; if the column is already responsible for sorting the native control changes
1535 // the sorting direction automatically and informs the data source via outlineView:sortDescriptorsDidChange:
1536 if (col->IsSortable() && ([tableColumn sortDescriptorPrototype] == nil))
1538 // remove the sort order from the previously sorted column table (it can also be that
1539 // no sorted column table exists):
1540 UInt32 const noOfColumns = [outlineView numberOfColumns];
1542 for (UInt32 i=0; i<noOfColumns; ++i)
1543 [[[outlineView tableColumns] objectAtIndex:i] setSortDescriptorPrototype:nil];
1544 // make column table sortable:
1545 NSArray* sortDescriptors;
1546 NSSortDescriptor* sortDescriptor;
1548 sortDescriptor = [[NSSortDescriptor alloc] initWithKey:[NSString stringWithFormat:@"%d",[outlineView columnWithIdentifier:[tableColumn identifier]]]
1550 sortDescriptors = [NSArray arrayWithObject:sortDescriptor];
1551 [tableColumn setSortDescriptorPrototype:sortDescriptor];
1552 [outlineView setSortDescriptors:sortDescriptors];
1553 [sortDescriptor release];
1557 -(BOOL) outlineView:(NSOutlineView*)outlineView shouldCollapseItem:(id)item
1559 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1561 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING,dvc->GetId()); // variable definition
1564 event.SetEventObject(dvc);
1565 event.SetItem (wxDataViewItem([((wxPointerObject*) item) pointer]));
1566 event.SetModel (dvc->GetModel());
1567 // finally send the equivalent wxWidget event:
1568 dvc->GetEventHandler()->ProcessEvent(event);
1569 // opening the container is allowed if not vetoed:
1570 return event.IsAllowed();
1573 -(BOOL) outlineView:(NSOutlineView*)outlineView shouldExpandItem:(id)item
1575 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1577 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING,dvc->GetId()); // variable definition
1580 event.SetEventObject(dvc);
1581 event.SetItem (wxDataViewItem([((wxPointerObject*) item) pointer]));
1582 event.SetModel (dvc->GetModel());
1583 // finally send the equivalent wxWidget event:
1584 dvc->GetEventHandler()->ProcessEvent(event);
1585 // opening the container is allowed if not vetoed:
1586 return event.IsAllowed();
1589 -(BOOL) outlineView:(NSOutlineView*)outlineView shouldSelectTableColumn:(NSTableColumn*)tableColumn
1594 -(void) outlineView:(wxCocoaOutlineView*)outlineView
1595 willDisplayCell:(id)cell
1596 forTableColumn:(NSTableColumn*)tableColumn
1599 wxDataViewCtrl * const dvc = implementation->GetDataViewCtrl();
1600 wxDataViewModel * const model = dvc->GetModel();
1602 wxDataViewColumn * const
1603 dvCol(static_cast<wxDataViewColumn*>(
1604 [[tableColumn identifier] pointer]
1607 const unsigned colIdx = dvCol->GetModelColumn();
1609 wxDataViewItem dvItem([static_cast<wxPointerObject *>(item) pointer]);
1611 if ( !model->HasValue(dvItem, colIdx) )
1614 wxDataViewRenderer * const renderer = dvCol->GetRenderer();
1615 wxDataViewRendererNativeData * const data = renderer->GetNativeData();
1617 // let the renderer know about what it's going to render next
1618 data->SetColumnPtr(tableColumn);
1619 data->SetItem(item);
1620 data->SetItemCell(cell);
1622 // use the attributes: notice that we need to do this whether we have them
1623 // or not as even if this cell doesn't have any attributes, the previous
1624 // one might have had some and then we need to reset them back to default
1625 wxDataViewItemAttr attr;
1626 model->GetAttr(dvItem, colIdx, attr);
1627 renderer->OSXApplyAttr(attr);
1629 // and finally do draw it
1630 renderer->MacRender();
1636 -(void) outlineViewColumnDidMove:(NSNotification*)notification
1638 int const newColumnPosition = [[[notification userInfo] objectForKey:@"NSNewColumn"] intValue];
1640 wxDataViewColumn* const col(static_cast<wxDataViewColumn*>([[[[self tableColumns] objectAtIndex:newColumnPosition] identifier] pointer]));
1642 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1644 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_COLUMN_REORDERED,dvc->GetId());
1647 event.SetEventObject(dvc);
1648 event.SetColumn(dvc->GetColumnPosition(col));
1649 event.SetDataViewColumn(col);
1650 dvc->GetEventHandler()->ProcessEvent(event);
1653 -(void) outlineViewItemDidCollapse:(NSNotification*)notification
1655 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1657 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED,dvc->GetId());
1660 event.SetEventObject(dvc);
1661 event.SetItem(wxDataViewItem([((wxPointerObject*) [[notification userInfo] objectForKey:@"NSObject"]) pointer]));
1662 dvc->GetEventHandler()->ProcessEvent(event);
1665 -(void) outlineViewItemDidExpand:(NSNotification*)notification
1667 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1669 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED,dvc->GetId());
1672 event.SetEventObject(dvc);
1673 event.SetItem(wxDataViewItem([((wxPointerObject*) [[notification userInfo] objectForKey:@"NSObject"]) pointer]));
1674 dvc->GetEventHandler()->ProcessEvent(event);
1677 -(void) outlineViewSelectionDidChange:(NSNotification*)notification
1679 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1681 wxDataViewEvent event(wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED,dvc->GetId()); // variable definition
1684 event.SetEventObject(dvc);
1685 event.SetModel (dvc->GetModel());
1686 dvc->GetEventHandler()->ProcessEvent(event);
1689 -(void) textDidBeginEditing:(NSNotification*)notification
1690 // this notification is only sent if the user started modifying the cell (not when the user clicked into the cell
1691 // and the cell's editor is called!)
1693 // call method of superclass (otherwise editing does not work correctly - the outline data source class is not
1694 // informed about a change of data):
1695 [super textDidBeginEditing:notification];
1697 // remember the column being edited, it will be used in textDidEndEditing:
1698 currentlyEditedColumn = [self editedColumn];
1699 currentlyEditedRow = [self editedRow];
1701 wxDataViewColumn* const col =
1702 static_cast<wxDataViewColumn*>(
1703 [[[[self tableColumns] objectAtIndex:currentlyEditedColumn] identifier] pointer]);
1705 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1708 // stop editing of a custom item first (if necessary)
1709 dvc->FinishCustomItemEditing();
1711 // now, send the event:
1713 event(wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED,dvc->GetId()); // variable definition
1715 event.SetEventObject(dvc);
1717 wxDataViewItem([((wxPointerObject*) [self itemAtRow:currentlyEditedRow]) pointer]));
1718 event.SetColumn(dvc->GetColumnPosition(col));
1719 event.SetDataViewColumn(col);
1720 dvc->GetEventHandler()->ProcessEvent(event);
1723 -(void) textDidEndEditing:(NSNotification*)notification
1725 // call method of superclass (otherwise editing does not work correctly - the outline data source class is not
1726 // informed about a change of data):
1727 [super textDidEndEditing:notification];
1729 // under OSX an event indicating the end of an editing session can be sent even if no event indicating a start of an
1730 // editing session has been sent (see Documentation for NSControl controlTextDidEndEditing:); this is not expected by a user
1731 // of the wxWidgets library and therefore an wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE event is only sent if a corresponding
1732 // wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED has been sent before; to check if a wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED
1733 // has been sent the last edited column/row are valid:
1734 if ( currentlyEditedColumn != -1 && currentlyEditedRow != -1 )
1736 wxDataViewColumn* const col =
1737 static_cast<wxDataViewColumn*>(
1738 [[[[self tableColumns] objectAtIndex:currentlyEditedColumn] identifier] pointer]);
1740 wxDataViewCtrl* const dvc = implementation->GetDataViewCtrl();
1742 // send event to wxWidgets:
1744 event(wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE,dvc->GetId()); // variable definition
1746 event.SetEventObject(dvc);
1748 wxDataViewItem([((wxPointerObject*) [self itemAtRow:currentlyEditedRow]) pointer]));
1749 event.SetColumn(dvc->GetColumnPosition(col));
1750 event.SetDataViewColumn(col);
1751 dvc->GetEventHandler()->ProcessEvent(event);
1754 // we're not editing any more
1755 currentlyEditedColumn =
1756 currentlyEditedRow = -1;
1761 // ============================================================================
1762 // wxCocoaDataViewControl
1763 // ============================================================================
1765 // constructors / destructor
1767 wxCocoaDataViewControl::wxCocoaDataViewControl(wxWindow* peer, const wxPoint& pos, const wxSize& size, long style)
1768 :wxWidgetCocoaImpl(peer,[[NSScrollView alloc] initWithFrame:wxOSXGetFrameForControl(peer,pos,size)]),
1769 m_DataSource(NULL), m_OutlineView([[wxCocoaOutlineView alloc] init])
1771 // initialize scrollview (the outline view is part of a scrollview):
1772 NSScrollView* scrollview = (NSScrollView*) GetWXWidget(); // definition for abbreviational purposes
1775 [scrollview setAutoresizingMask:NSViewWidthSizable | NSViewHeightSizable];
1776 [scrollview setBorderType:NSNoBorder];
1777 [scrollview setHasVerticalScroller:YES];
1778 [scrollview setHasHorizontalScroller:YES];
1779 [scrollview setAutohidesScrollers:YES];
1780 [scrollview setDocumentView:m_OutlineView];
1782 // setting up the native control itself
1783 NSUInteger maskGridStyle(NSTableViewGridNone);
1785 [m_OutlineView setImplementation:this];
1786 [m_OutlineView setColumnAutoresizingStyle:NSTableViewSequentialColumnAutoresizingStyle];
1787 [m_OutlineView setIndentationPerLevel:GetDataViewCtrl()->GetIndent()];
1788 if (style & wxDV_HORIZ_RULES)
1789 maskGridStyle |= NSTableViewSolidHorizontalGridLineMask;
1790 if (style & wxDV_VERT_RULES)
1791 maskGridStyle |= NSTableViewSolidVerticalGridLineMask;
1792 [m_OutlineView setGridStyleMask:maskGridStyle];
1793 [m_OutlineView setAllowsMultipleSelection: (style & wxDV_MULTIPLE) != 0];
1794 [m_OutlineView setUsesAlternatingRowBackgroundColors:(style & wxDV_ROW_LINES) != 0];
1797 wxCocoaDataViewControl::~wxCocoaDataViewControl()
1799 [m_DataSource release];
1800 [m_OutlineView release];
1804 // column related methods (inherited from wxDataViewWidgetImpl)
1806 bool wxCocoaDataViewControl::ClearColumns()
1808 bool const bufAllowsMultipleSelection = [m_OutlineView allowsMultipleSelection];
1811 // as there is a bug in NSOutlineView version (OSX 10.5.6 #6555162) the columns cannot be deleted if there is an outline column in the view;
1812 // therefore, the whole view is deleted and newly constructed:
1813 [m_OutlineView release];
1814 m_OutlineView = [[wxCocoaOutlineView alloc] init];
1815 [((NSScrollView*) GetWXWidget()) setDocumentView:m_OutlineView];
1817 // setting up the native control itself
1818 [m_OutlineView setImplementation:this];
1819 [m_OutlineView setColumnAutoresizingStyle:NSTableViewSequentialColumnAutoresizingStyle];
1820 [m_OutlineView setIndentationPerLevel:GetDataViewCtrl()->GetIndent()];
1821 if (bufAllowsMultipleSelection)
1822 [m_OutlineView setAllowsMultipleSelection:YES];
1823 [m_OutlineView setDataSource:m_DataSource];
1828 bool wxCocoaDataViewControl::DeleteColumn(wxDataViewColumn* columnPtr)
1830 if ([m_OutlineView outlineTableColumn] == columnPtr->GetNativeData()->GetNativeColumnPtr())
1831 [m_OutlineView setOutlineTableColumn:nil]; // due to a bug this does not work
1832 [m_OutlineView removeTableColumn:columnPtr->GetNativeData()->GetNativeColumnPtr()]; // due to a confirmed bug #6555162 the deletion does not work for
1833 // outline table columns (... and there is no workaround)
1834 return (([m_OutlineView columnWithIdentifier:[[[wxPointerObject alloc] initWithPointer:columnPtr] autorelease]]) == -1);
1837 void wxCocoaDataViewControl::DoSetExpanderColumn(const wxDataViewColumn *columnPtr)
1839 [m_OutlineView setOutlineTableColumn:columnPtr->GetNativeData()->GetNativeColumnPtr()];
1842 wxDataViewColumn* wxCocoaDataViewControl::GetColumn(unsigned int pos) const
1844 return static_cast<wxDataViewColumn*>([[[[m_OutlineView tableColumns] objectAtIndex:pos] identifier] pointer]);
1847 int wxCocoaDataViewControl::GetColumnPosition(const wxDataViewColumn *columnPtr) const
1849 return [m_OutlineView columnWithIdentifier:[[[wxPointerObject alloc] initWithPointer:const_cast<wxDataViewColumn*>(columnPtr)] autorelease]];
1852 bool wxCocoaDataViewControl::InsertColumn(unsigned int pos, wxDataViewColumn* columnPtr)
1854 // create column and set the native data of the dataview column:
1855 NSTableColumn *nativeColumn = ::CreateNativeColumn(columnPtr);
1856 columnPtr->GetNativeData()->SetNativeColumnPtr(nativeColumn);
1857 // as the native control does not allow the insertion of a column at a specified position the column is first appended and
1858 // - if necessary - moved to its final position:
1859 [m_OutlineView addTableColumn:nativeColumn];
1860 if (pos != static_cast<unsigned int>([m_OutlineView numberOfColumns]-1))
1861 [m_OutlineView moveColumn:[m_OutlineView numberOfColumns]-1 toColumn:pos];
1867 // item related methods (inherited from wxDataViewWidgetImpl)
1869 bool wxCocoaDataViewControl::Add(const wxDataViewItem& parent, const wxDataViewItem& WXUNUSED(item))
1872 [m_OutlineView reloadItem:[m_DataSource getDataViewItemFromBuffer:parent] reloadChildren:YES];
1874 [m_OutlineView reloadData];
1878 bool wxCocoaDataViewControl::Add(const wxDataViewItem& parent, const wxDataViewItemArray& WXUNUSED(items))
1881 [m_OutlineView reloadItem:[m_DataSource getDataViewItemFromBuffer:parent] reloadChildren:YES];
1883 [m_OutlineView reloadData];
1887 void wxCocoaDataViewControl::Collapse(const wxDataViewItem& item)
1889 [m_OutlineView collapseItem:[m_DataSource getDataViewItemFromBuffer:item]];
1892 void wxCocoaDataViewControl::EnsureVisible(const wxDataViewItem& item, const wxDataViewColumn *columnPtr)
1896 [m_OutlineView scrollRowToVisible:[m_OutlineView rowForItem:[m_DataSource getDataViewItemFromBuffer:item]]];
1898 [m_OutlineView scrollColumnToVisible:GetColumnPosition(columnPtr)];
1902 void wxCocoaDataViewControl::Expand(const wxDataViewItem& item)
1904 [m_OutlineView expandItem:[m_DataSource getDataViewItemFromBuffer:item]];
1907 unsigned int wxCocoaDataViewControl::GetCount() const
1909 return [m_OutlineView numberOfRows];
1912 wxRect wxCocoaDataViewControl::GetRectangle(const wxDataViewItem& item, const wxDataViewColumn *columnPtr)
1914 return wxFromNSRect([m_osxView superview],[m_OutlineView frameOfCellAtColumn:GetColumnPosition(columnPtr)
1915 row:[m_OutlineView rowForItem:[m_DataSource getDataViewItemFromBuffer:item]]]);
1918 bool wxCocoaDataViewControl::IsExpanded(const wxDataViewItem& item) const
1920 return [m_OutlineView isItemExpanded:[m_DataSource getDataViewItemFromBuffer:item]];
1923 bool wxCocoaDataViewControl::Reload()
1925 [m_DataSource clearBuffers];
1926 [m_OutlineView scrollColumnToVisible:0];
1927 [m_OutlineView scrollRowToVisible:0];
1928 [m_OutlineView reloadData];
1932 bool wxCocoaDataViewControl::Remove(const wxDataViewItem& parent, const wxDataViewItem& WXUNUSED(item))
1935 [m_OutlineView reloadItem:[m_DataSource getDataViewItemFromBuffer:parent] reloadChildren:YES];
1937 [m_OutlineView reloadData];
1941 bool wxCocoaDataViewControl::Remove(const wxDataViewItem& parent, const wxDataViewItemArray& WXUNUSED(item))
1944 [m_OutlineView reloadItem:[m_DataSource getDataViewItemFromBuffer:parent] reloadChildren:YES];
1946 [m_OutlineView reloadData];
1950 bool wxCocoaDataViewControl::Update(const wxDataViewColumn *columnPtr)
1955 bool wxCocoaDataViewControl::Update(const wxDataViewItem& WXUNUSED(parent), const wxDataViewItem& item)
1957 [m_OutlineView reloadItem:[m_DataSource getDataViewItemFromBuffer:item]];
1961 bool wxCocoaDataViewControl::Update(const wxDataViewItem& WXUNUSED(parent), const wxDataViewItemArray& items)
1963 for (size_t i=0; i<items.GetCount(); ++i)
1964 [m_OutlineView reloadItem:[m_DataSource getDataViewItemFromBuffer:items[i]]];
1969 // model related methods
1971 bool wxCocoaDataViewControl::AssociateModel(wxDataViewModel* model)
1973 [m_DataSource release];
1976 m_DataSource = [[wxCocoaOutlineDataSource alloc] init];
1977 [m_DataSource setImplementation:this];
1978 [m_DataSource setModel:model];
1981 m_DataSource = NULL;
1982 [m_OutlineView setDataSource:m_DataSource]; // if there is a data source the data is immediately going to be requested
1987 // selection related methods (inherited from wxDataViewWidgetImpl)
1989 int wxCocoaDataViewControl::GetSelections(wxDataViewItemArray& sel) const
1991 NSIndexSet* selectedRowIndexes([m_OutlineView selectedRowIndexes]);
1993 NSUInteger indexRow;
1997 sel.Alloc([selectedRowIndexes count]);
1998 indexRow = [selectedRowIndexes firstIndex];
1999 while (indexRow != NSNotFound)
2001 sel.Add(wxDataViewItem([[m_OutlineView itemAtRow:indexRow] pointer]));
2002 indexRow = [selectedRowIndexes indexGreaterThanIndex:indexRow];
2004 return sel.GetCount();
2007 bool wxCocoaDataViewControl::IsSelected(const wxDataViewItem& item) const
2009 return [m_OutlineView isRowSelected:[m_OutlineView rowForItem:[m_DataSource getDataViewItemFromBuffer:item]]];
2012 void wxCocoaDataViewControl::Select(const wxDataViewItem& item)
2015 [m_OutlineView selectRowIndexes:[NSIndexSet indexSetWithIndex:[m_OutlineView rowForItem:[m_DataSource getDataViewItemFromBuffer:item]]]
2016 byExtendingSelection:NO];
2019 void wxCocoaDataViewControl::SelectAll()
2021 [m_OutlineView selectAll:m_OutlineView];
2024 void wxCocoaDataViewControl::Unselect(const wxDataViewItem& item)
2027 [m_OutlineView deselectRow:[m_OutlineView rowForItem:[m_DataSource getDataViewItemFromBuffer:item]]];
2030 void wxCocoaDataViewControl::UnselectAll()
2032 [m_OutlineView deselectAll:m_OutlineView];
2036 // sorting related methods
2038 wxDataViewColumn* wxCocoaDataViewControl::GetSortingColumn() const
2040 NSArray* const columns = [m_OutlineView tableColumns];
2042 UInt32 const noOfColumns = [columns count];
2045 for (UInt32 i=0; i<noOfColumns; ++i)
2046 if ([[columns objectAtIndex:i] sortDescriptorPrototype] != nil)
2047 return static_cast<wxDataViewColumn*>([[[columns objectAtIndex:i] identifier] pointer]);
2051 void wxCocoaDataViewControl::Resort()
2053 [m_DataSource clearChildren];
2054 [m_OutlineView reloadData];
2058 // other methods (inherited from wxDataViewWidgetImpl)
2060 void wxCocoaDataViewControl::DoSetIndent(int indent)
2062 [m_OutlineView setIndentationPerLevel:static_cast<CGFloat>(indent)];
2065 void wxCocoaDataViewControl::HitTest(const wxPoint& point, wxDataViewItem& item, wxDataViewColumn*& columnPtr) const
2067 NSPoint const nativePoint = wxToNSPoint((NSScrollView*) GetWXWidget(),point);
2073 indexColumn = [m_OutlineView columnAtPoint:nativePoint];
2074 indexRow = [m_OutlineView rowAtPoint: nativePoint];
2075 if ((indexColumn >= 0) && (indexRow >= 0))
2077 columnPtr = static_cast<wxDataViewColumn*>([[[[m_OutlineView tableColumns] objectAtIndex:indexColumn] identifier] pointer]);
2078 item = wxDataViewItem([[m_OutlineView itemAtRow:indexRow] pointer]);
2083 item = wxDataViewItem();
2087 void wxCocoaDataViewControl::SetRowHeight(const wxDataViewItem& WXUNUSED(item), unsigned int WXUNUSED(height))
2088 // Not supported by the native control
2092 void wxCocoaDataViewControl::OnSize()
2094 if ([m_OutlineView numberOfColumns] == 1)
2095 [m_OutlineView sizeLastColumnToFit];
2099 // drag & drop helper methods
2101 wxDataFormat wxCocoaDataViewControl::GetDnDDataFormat(wxDataObjectComposite* dataObjects)
2103 wxDataFormat resultFormat;
2105 return resultFormat;
2107 bool compatible(true);
2109 size_t const noOfFormats = dataObjects->GetFormatCount();
2112 wxDataFormat* formats;
2114 // get all formats and check afterwards if the formats are compatible; if
2115 // they are compatible the preferred format is returned otherwise
2116 // wxDF_INVALID is returned;
2117 // currently compatible types (ordered by priority are):
2118 // - wxDF_UNICODETEXT - wxDF_TEXT
2119 formats = new wxDataFormat[noOfFormats];
2120 dataObjects->GetAllFormats(formats);
2122 while ((indexFormat < noOfFormats) && compatible)
2124 switch (resultFormat.GetType())
2127 resultFormat.SetType(formats[indexFormat].GetType()); // first format (should only be reached if indexFormat == 0)
2130 if (formats[indexFormat].GetType() == wxDF_UNICODETEXT)
2131 resultFormat.SetType(wxDF_UNICODETEXT);
2132 else // incompatible
2134 resultFormat.SetType(wxDF_INVALID);
2138 case wxDF_UNICODETEXT:
2139 if (formats[indexFormat].GetType() != wxDF_TEXT)
2141 resultFormat.SetType(wxDF_INVALID);
2146 resultFormat.SetType(wxDF_INVALID); // not (yet) supported format
2154 return resultFormat;
2157 wxDataObjectComposite* wxCocoaDataViewControl::GetDnDDataObjects(NSData* dataObject) const
2159 wxDataFormatId dataFormatID;
2162 [dataObject getBytes:&dataFormatID length:sizeof(wxDataFormatId)];
2163 switch (dataFormatID)
2166 case wxDF_UNICODETEXT:
2168 wxTextDataObject* textDataObject(new wxTextDataObject());
2170 if (textDataObject->SetData(wxDataFormat(dataFormatID),[dataObject length]-sizeof(wxDataFormatId),static_cast<char const*>([dataObject bytes])+sizeof(wxDataFormatId)))
2172 wxDataObjectComposite* dataObjectComposite(new wxDataObjectComposite());
2174 dataObjectComposite->Add(textDataObject);
2175 return dataObjectComposite;
2179 delete textDataObject;
2189 id wxCocoaDataViewControl::GetItemAtRow(int row) const
2191 return [m_OutlineView itemAtRow:row];
2194 // ----------------------------------------------------------------------------
2195 // wxDataViewRendererNativeData
2196 // ----------------------------------------------------------------------------
2198 void wxDataViewRendererNativeData::Init()
2201 m_origTextColour = NULL;
2202 m_ellipsizeMode = wxELLIPSIZE_MIDDLE;
2205 ApplyLineBreakMode(m_ColumnCell);
2208 void wxDataViewRendererNativeData::ApplyLineBreakMode(NSCell *cell)
2210 NSLineBreakMode nsMode = NSLineBreakByWordWrapping;
2211 switch ( m_ellipsizeMode )
2213 case wxELLIPSIZE_NONE:
2214 nsMode = NSLineBreakByClipping;
2217 case wxELLIPSIZE_START:
2218 nsMode = NSLineBreakByTruncatingHead;
2221 case wxELLIPSIZE_MIDDLE:
2222 nsMode = NSLineBreakByTruncatingMiddle;
2225 case wxELLIPSIZE_END:
2226 nsMode = NSLineBreakByTruncatingTail;
2230 wxASSERT_MSG( nsMode != NSLineBreakByWordWrapping, "unknown wxEllipsizeMode" );
2232 [cell setLineBreakMode: nsMode];
2235 // ---------------------------------------------------------
2236 // wxDataViewRenderer
2237 // ---------------------------------------------------------
2239 wxDataViewRenderer::wxDataViewRenderer(const wxString& varianttype,
2240 wxDataViewCellMode mode,
2242 : wxDataViewRendererBase(varianttype, mode, align),
2245 m_NativeDataPtr(NULL)
2249 wxDataViewRenderer::~wxDataViewRenderer()
2251 delete m_NativeDataPtr;
2254 void wxDataViewRenderer::SetAlignment(int align)
2256 m_alignment = align;
2257 [GetNativeData()->GetColumnCell() setAlignment:ConvertToNativeHorizontalTextAlignment(align)];
2260 void wxDataViewRenderer::SetMode(wxDataViewCellMode mode)
2264 [GetOwner()->GetNativeData()->GetNativeColumnPtr() setEditable:(mode == wxDATAVIEW_CELL_EDITABLE)];
2267 void wxDataViewRenderer::SetNativeData(wxDataViewRendererNativeData* newNativeDataPtr)
2269 delete m_NativeDataPtr;
2270 m_NativeDataPtr = newNativeDataPtr;
2273 void wxDataViewRenderer::EnableEllipsize(wxEllipsizeMode mode)
2275 // we need to store this value to apply it to the columns headerCell in
2276 // CreateNativeColumn()
2277 GetNativeData()->SetEllipsizeMode(mode);
2279 // but we may already apply it to the column cell which will be used for
2281 GetNativeData()->ApplyLineBreakMode(GetNativeData()->GetColumnCell());
2284 wxEllipsizeMode wxDataViewRenderer::GetEllipsizeMode() const
2286 return GetNativeData()->GetEllipsizeMode();
2290 wxDataViewRenderer::OSXOnCellChanged(NSObject *object,
2291 const wxDataViewItem& item,
2294 // TODO: we probably should get rid of this code entirely and make this
2295 // function pure virtual, but currently we still have some native
2296 // renderers (wxDataViewChoiceRenderer) which don't override it and
2297 // there is also wxDataViewCustomRenderer for which it's not obvious
2298 // how it should be implemented so keep this "auto-deduction" of
2299 // variant type from NSObject for now
2302 if ( [object isKindOfClass:[NSString class]] )
2303 value = ObjectToString(object);
2304 else if ( [object isKindOfClass:[NSNumber class]] )
2305 value = ObjectToLong(object);
2306 else if ( [object isKindOfClass:[NSDate class]] )
2307 value = ObjectToDate(object);
2310 wxFAIL_MSG( wxString::Format
2312 "unknown value type %s",
2313 wxCFStringRef::AsString([object className])
2318 wxDataViewModel *model = GetOwner()->GetOwner()->GetModel();
2319 model->ChangeValue(value, item, col);
2322 void wxDataViewRenderer::OSXApplyAttr(const wxDataViewItemAttr& attr)
2324 wxDataViewRendererNativeData * const data = GetNativeData();
2325 NSCell * const cell = data->GetItemCell();
2327 // set the font and text colour to use: we need to do it if we had ever
2328 // changed them before, even if this item itself doesn't have any special
2329 // attributes as otherwise it would reuse the attributes from the previous
2330 // cell rendered using the same renderer
2331 NSFont *font = NULL;
2332 NSColor *colText = NULL;
2334 if ( attr.HasFont() )
2336 font = data->GetOriginalFont();
2339 // this is the first time we're setting the font, remember the
2340 // original one before changing it
2342 data->SaveOriginalFont(font);
2347 // FIXME: using wxFont methods here doesn't work for some reason
2348 NSFontManager * const fm = [NSFontManager sharedFontManager];
2349 if ( attr.GetBold() )
2350 font = [fm convertFont:font toHaveTrait:NSBoldFontMask];
2351 if ( attr.GetItalic() )
2352 font = [fm convertFont:font toHaveTrait:NSItalicFontMask];
2354 //else: can't change font if the cell doesn't have any
2357 if ( attr.HasColour() )
2359 // we can set font for any cell but only NSTextFieldCell provides
2360 // a method for setting text colour so check that this method is
2361 // available before using it
2362 if ( [cell respondsToSelector:@selector(setTextColor:)] &&
2363 [cell respondsToSelector:@selector(textColor)] )
2365 if ( !data->GetOriginalTextColour() )
2367 // the cast to (untyped) id is safe because of the check above
2368 data->SaveOriginalTextColour([(id)cell textColor]);
2371 const wxColour& c = attr.GetColour();
2372 colText = [NSColor colorWithDeviceRed:c.Red() / 255.
2373 green:c.Green() / 255.
2374 blue:c.Blue() / 255.
2375 alpha:c.Alpha() / 255.];
2380 font = data->GetOriginalFont();
2382 colText = data->GetOriginalTextColour();
2385 [cell setFont:font];
2388 [(id)cell setTextColor:colText];
2391 IMPLEMENT_ABSTRACT_CLASS(wxDataViewRenderer,wxDataViewRendererBase)
2393 // ---------------------------------------------------------
2394 // wxDataViewCustomRenderer
2395 // ---------------------------------------------------------
2396 wxDataViewCustomRenderer::wxDataViewCustomRenderer(const wxString& varianttype,
2397 wxDataViewCellMode mode,
2399 : wxDataViewCustomRendererBase(varianttype, mode, align),
2400 m_editorCtrlPtr(NULL),
2403 SetNativeData(new wxDataViewRendererNativeData([[wxCustomCell alloc] init]));
2406 bool wxDataViewCustomRenderer::MacRender()
2408 [GetNativeData()->GetItemCell() setObjectValue:[[[wxCustomRendererObject alloc] initWithRenderer:this] autorelease]];
2412 void wxDataViewCustomRenderer::OSXApplyAttr(const wxDataViewItemAttr& attr)
2414 // simply save the attribute so that it could be reused from our Render()
2417 // it's not necessary to call the base class version which sets the cell
2418 // properties to correspond to this attribute because we currently don't
2419 // use any NSCell methods in custom renderers anyhow but if we ever start
2420 // doing this (e.g. override RenderText() here to use NSTextFieldCell
2421 // methods), then we should pass it on to wxDataViewRenderer here
2424 IMPLEMENT_ABSTRACT_CLASS(wxDataViewCustomRenderer, wxDataViewRenderer)
2426 // ---------------------------------------------------------
2427 // wxDataViewTextRenderer
2428 // ---------------------------------------------------------
2429 wxDataViewTextRenderer::wxDataViewTextRenderer(const wxString& varianttype,
2430 wxDataViewCellMode mode,
2432 : wxDataViewRenderer(varianttype,mode,align)
2434 NSTextFieldCell* cell;
2437 cell = [[NSTextFieldCell alloc] init];
2438 [cell setAlignment:ConvertToNativeHorizontalTextAlignment(align)];
2439 SetNativeData(new wxDataViewRendererNativeData(cell));
2443 bool wxDataViewTextRenderer::MacRender()
2445 if (GetValue().GetType() == GetVariantType())
2447 [GetNativeData()->GetItemCell() setObjectValue:wxCFStringRef(GetValue().GetString()).AsNSString()];
2452 wxFAIL_MSG(wxString("Text renderer cannot render value because of wrong value type; value type: ") << GetValue().GetType());
2458 wxDataViewTextRenderer::OSXOnCellChanged(NSObject *value,
2459 const wxDataViewItem& item,
2462 wxDataViewModel *model = GetOwner()->GetOwner()->GetModel();
2463 model->ChangeValue(ObjectToString(value), item, col);
2466 IMPLEMENT_CLASS(wxDataViewTextRenderer,wxDataViewRenderer)
2468 // ---------------------------------------------------------
2469 // wxDataViewBitmapRenderer
2470 // ---------------------------------------------------------
2471 wxDataViewBitmapRenderer::wxDataViewBitmapRenderer(const wxString& varianttype,
2472 wxDataViewCellMode mode,
2474 : wxDataViewRenderer(varianttype,mode,align)
2479 cell = [[NSImageCell alloc] init];
2480 SetNativeData(new wxDataViewRendererNativeData(cell));
2484 bool wxDataViewBitmapRenderer::MacRender()
2485 // This method returns 'true' if
2486 // - the passed bitmap is valid and it could be assigned to the native data browser;
2487 // - the passed bitmap is invalid (or is not initialized); this case simulates a non-existing bitmap.
2488 // In all other cases the method returns 'false'.
2490 wxCHECK_MSG(GetValue().GetType() == GetVariantType(),false,wxString("Bitmap renderer cannot render value; value type: ") << GetValue().GetType());
2494 bitmap << GetValue();
2496 [GetNativeData()->GetItemCell() setObjectValue:[[bitmap.GetNSImage() retain] autorelease]];
2500 IMPLEMENT_CLASS(wxDataViewBitmapRenderer,wxDataViewRenderer)
2502 // -------------------------------------
2503 // wxDataViewChoiceRenderer
2504 // -------------------------------------
2505 wxDataViewChoiceRenderer::wxDataViewChoiceRenderer(const wxArrayString& choices,
2506 wxDataViewCellMode mode,
2508 : wxDataViewRenderer(wxT("string"), mode, alignment),
2511 NSPopUpButtonCell* cell;
2514 cell = [[NSPopUpButtonCell alloc] init];
2515 [cell setControlSize:NSMiniControlSize];
2516 [cell setFont:[[NSFont fontWithName:[[cell font] fontName] size:[NSFont systemFontSizeForControlSize:NSMiniControlSize]] autorelease]];
2517 for (size_t i=0; i<choices.GetCount(); ++i)
2518 [cell addItemWithTitle:[[wxCFStringRef(choices[i]).AsNSString() retain] autorelease]];
2519 SetNativeData(new wxDataViewRendererNativeData(cell));
2523 bool wxDataViewChoiceRenderer::MacRender()
2525 if (GetValue().GetType() == GetVariantType())
2527 [((NSPopUpButtonCell*) GetNativeData()->GetItemCell()) selectItemWithTitle:[[wxCFStringRef(GetValue().GetString()).AsNSString() retain] autorelease]];
2532 wxFAIL_MSG(wxString("Choice renderer cannot render value because of wrong value type; value type: ") << GetValue().GetType());
2537 IMPLEMENT_CLASS(wxDataViewChoiceRenderer,wxDataViewRenderer)
2539 // ---------------------------------------------------------
2540 // wxDataViewDateRenderer
2541 // ---------------------------------------------------------
2543 wxDataViewDateRenderer::wxDataViewDateRenderer(const wxString& varianttype,
2544 wxDataViewCellMode mode,
2546 : wxDataViewRenderer(varianttype,mode,align)
2548 NSTextFieldCell* cell;
2550 NSDateFormatter* dateFormatter;
2553 dateFormatter = [[NSDateFormatter alloc] init];
2554 [dateFormatter setFormatterBehavior:NSDateFormatterBehavior10_4];
2555 [dateFormatter setDateStyle:NSDateFormatterShortStyle];
2556 cell = [[NSTextFieldCell alloc] init];
2557 [cell setFormatter:dateFormatter];
2558 SetNativeData(new wxDataViewRendererNativeData(cell,[NSDate dateWithString:@"2000-12-30 20:00:00 +0000"]));
2560 [dateFormatter release];
2563 bool wxDataViewDateRenderer::MacRender()
2565 if (GetValue().GetType() == GetVariantType())
2567 if (GetValue().GetDateTime().IsValid())
2569 // -- find best fitting style to show the date --
2570 // as the style should be identical for all cells a reference date instead of the actual cell's date
2571 // value is used for all cells; this reference date is stored in the renderer's native data section
2572 // for speed purposes; otherwise, the reference date's string has to be recalculated for each item that
2573 // may become timewise long if a lot of rows using dates exist;
2574 // the algorithm has the preference to display as much information as possible in the first instance;
2575 // but as this is often impossible due to space restrictions the style is shortened per loop; finally,
2576 // if the shortest time and date format does not fit into the cell the time part is dropped;
2577 // remark: the time part itself is not modified per iteration loop and only uses the short style,
2578 // means that only the hours and minutes are being shown
2579 [GetNativeData()->GetItemCell() setObjectValue:GetNativeData()->GetObject()]; // GetObject() returns a date for testing the size of a date object
2580 [[GetNativeData()->GetItemCell() formatter] setTimeStyle:NSDateFormatterShortStyle];
2581 for (int dateFormatterStyle=4; dateFormatterStyle>0; --dateFormatterStyle)
2583 [[GetNativeData()->GetItemCell() formatter] setDateStyle:(NSDateFormatterStyle)dateFormatterStyle];
2584 if (dateFormatterStyle == 1)
2586 // if the shortest style for displaying the date and time is too long to be fully visible remove the time part of the date:
2587 if ([GetNativeData()->GetItemCell() cellSize].width > [GetNativeData()->GetColumnPtr() width])
2588 [[GetNativeData()->GetItemCell() formatter] setTimeStyle:NSDateFormatterNoStyle];
2589 break; // basically not necessary as the loop would end anyway but let's save the last comparison
2591 else if ([GetNativeData()->GetItemCell() cellSize].width <= [GetNativeData()->GetColumnPtr() width])
2594 // set data (the style is set by the previous loop);
2595 // on OSX the date has to be specified with respect to UTC; in wxWidgets the date is always entered in the local timezone; so, we have to do a conversion
2596 // from the local to UTC timezone when adding the seconds to 1970-01-01 UTC:
2597 [GetNativeData()->GetItemCell() setObjectValue:[NSDate dateWithTimeIntervalSince1970:GetValue().GetDateTime().ToUTC().Subtract(wxDateTime(1,wxDateTime::Jan,1970)).GetSeconds().ToDouble()]];
2603 wxFAIL_MSG(wxString("Date renderer cannot render value because of wrong value type; value type: ") << GetValue().GetType());
2609 wxDataViewDateRenderer::OSXOnCellChanged(NSObject *value,
2610 const wxDataViewItem& item,
2613 wxDataViewModel *model = GetOwner()->GetOwner()->GetModel();
2614 model->ChangeValue(ObjectToDate(value), item, col);
2617 IMPLEMENT_ABSTRACT_CLASS(wxDataViewDateRenderer,wxDataViewRenderer)
2619 // ---------------------------------------------------------
2620 // wxDataViewIconTextRenderer
2621 // ---------------------------------------------------------
2622 wxDataViewIconTextRenderer::wxDataViewIconTextRenderer(const wxString& varianttype,
2623 wxDataViewCellMode mode,
2625 : wxDataViewRenderer(varianttype,mode)
2627 wxImageTextCell* cell;
2630 cell = [[wxImageTextCell alloc] init];
2631 [cell setAlignment:ConvertToNativeHorizontalTextAlignment(align)];
2632 SetNativeData(new wxDataViewRendererNativeData(cell));
2636 bool wxDataViewIconTextRenderer::MacRender()
2638 if (GetValue().GetType() == GetVariantType())
2640 wxDataViewIconText iconText;
2642 wxImageTextCell* cell;
2644 cell = (wxImageTextCell*) GetNativeData()->GetItemCell();
2645 iconText << GetValue();
2646 if (iconText.GetIcon().IsOk())
2647 [cell setImage:[[wxBitmap(iconText.GetIcon()).GetNSImage() retain] autorelease]];
2648 [cell setStringValue:[[wxCFStringRef(iconText.GetText()).AsNSString() retain] autorelease]];
2653 wxFAIL_MSG(wxString("Icon & text renderer cannot render value because of wrong value type; value type: ") << GetValue().GetType());
2659 wxDataViewIconTextRenderer::OSXOnCellChanged(NSObject *value,
2660 const wxDataViewItem& item,
2663 wxVariant valueIconText;
2664 valueIconText << wxDataViewIconText(ObjectToString(value));
2666 wxDataViewModel *model = GetOwner()->GetOwner()->GetModel();
2667 model->ChangeValue(valueIconText, item, col);
2670 IMPLEMENT_ABSTRACT_CLASS(wxDataViewIconTextRenderer,wxDataViewRenderer)
2672 // ---------------------------------------------------------
2673 // wxDataViewToggleRenderer
2674 // ---------------------------------------------------------
2675 wxDataViewToggleRenderer::wxDataViewToggleRenderer(const wxString& varianttype,
2676 wxDataViewCellMode mode,
2678 : wxDataViewRenderer(varianttype,mode)
2683 cell = [[NSButtonCell alloc] init];
2684 [cell setAlignment:ConvertToNativeHorizontalTextAlignment(align)];
2685 [cell setButtonType:NSSwitchButton];
2686 [cell setImagePosition:NSImageOnly];
2687 SetNativeData(new wxDataViewRendererNativeData(cell));
2691 bool wxDataViewToggleRenderer::MacRender()
2693 if (GetValue().GetType() == GetVariantType())
2695 [GetNativeData()->GetItemCell() setIntValue:GetValue().GetLong()];
2700 wxFAIL_MSG(wxString("Toggle renderer cannot render value because of wrong value type; value type: ") << GetValue().GetType());
2706 wxDataViewToggleRenderer::OSXOnCellChanged(NSObject *value,
2707 const wxDataViewItem& item,
2710 wxDataViewModel *model = GetOwner()->GetOwner()->GetModel();
2711 model->ChangeValue(ObjectToBool(value), item, col);
2714 IMPLEMENT_ABSTRACT_CLASS(wxDataViewToggleRenderer,wxDataViewRenderer)
2716 // ---------------------------------------------------------
2717 // wxDataViewProgressRenderer
2718 // ---------------------------------------------------------
2719 wxDataViewProgressRenderer::wxDataViewProgressRenderer(const wxString& label,
2720 const wxString& varianttype,
2721 wxDataViewCellMode mode,
2723 : wxDataViewRenderer(varianttype,mode,align)
2725 NSLevelIndicatorCell* cell;
2727 cell = [[NSLevelIndicatorCell alloc] initWithLevelIndicatorStyle:NSContinuousCapacityLevelIndicatorStyle];
2728 [cell setMinValue:0];
2729 [cell setMaxValue:100];
2730 SetNativeData(new wxDataViewRendererNativeData(cell));
2734 bool wxDataViewProgressRenderer::MacRender()
2736 if (GetValue().GetType() == GetVariantType())
2738 [GetNativeData()->GetItemCell() setIntValue:GetValue().GetLong()];
2743 wxFAIL_MSG(wxString("Progress renderer cannot render value because of wrong value type; value type: ") << GetValue().GetType());
2749 wxDataViewProgressRenderer::OSXOnCellChanged(NSObject *value,
2750 const wxDataViewItem& item,
2753 wxDataViewModel *model = GetOwner()->GetOwner()->GetModel();
2754 model->ChangeValue(ObjectToLong(value), item, col);
2757 IMPLEMENT_ABSTRACT_CLASS(wxDataViewProgressRenderer,wxDataViewRenderer)
2759 // ---------------------------------------------------------
2761 // ---------------------------------------------------------
2763 wxDataViewColumn::wxDataViewColumn(const wxString& title,
2764 wxDataViewRenderer* renderer,
2765 unsigned int model_column,
2769 : wxDataViewColumnBase(renderer, model_column),
2770 m_NativeDataPtr(new wxDataViewColumnNativeData()),
2773 InitCommon(width, align, flags);
2774 if (renderer && (renderer->GetAlignment() == wxDVR_DEFAULT_ALIGNMENT))
2775 renderer->SetAlignment(align);
2778 wxDataViewColumn::wxDataViewColumn(const wxBitmap& bitmap,
2779 wxDataViewRenderer* renderer,
2780 unsigned int model_column,
2784 : wxDataViewColumnBase(bitmap, renderer, model_column),
2785 m_NativeDataPtr(new wxDataViewColumnNativeData())
2787 InitCommon(width, align, flags);
2788 if (renderer && (renderer->GetAlignment() == wxDVR_DEFAULT_ALIGNMENT))
2789 renderer->SetAlignment(align);
2792 wxDataViewColumn::~wxDataViewColumn()
2794 delete m_NativeDataPtr;
2797 int wxDataViewColumn::GetWidth() const
2799 return [m_NativeDataPtr->GetNativeColumnPtr() width];
2802 bool wxDataViewColumn::IsSortKey() const
2804 NSTableColumn *nsCol = GetNativeData()->GetNativeColumnPtr();
2805 return nsCol && ([nsCol sortDescriptorPrototype] != nil);
2808 void wxDataViewColumn::SetAlignment(wxAlignment align)
2810 m_alignment = align;
2811 [[m_NativeDataPtr->GetNativeColumnPtr() headerCell] setAlignment:ConvertToNativeHorizontalTextAlignment(align)];
2812 if (m_renderer && (m_renderer->GetAlignment() == wxDVR_DEFAULT_ALIGNMENT))
2813 m_renderer->SetAlignment(align);
2816 void wxDataViewColumn::SetBitmap(const wxBitmap& bitmap)
2818 // bitmaps and titles cannot exist at the same time - if the bitmap is set the title is removed:
2819 m_title = wxEmptyString;
2820 wxDataViewColumnBase::SetBitmap(bitmap);
2821 [[m_NativeDataPtr->GetNativeColumnPtr() headerCell] setImage:[[bitmap.GetNSImage() retain] autorelease]];
2824 void wxDataViewColumn::SetMaxWidth(int maxWidth)
2826 m_maxWidth = maxWidth;
2827 [m_NativeDataPtr->GetNativeColumnPtr() setMaxWidth:maxWidth];
2830 void wxDataViewColumn::SetMinWidth(int minWidth)
2832 m_minWidth = minWidth;
2833 [m_NativeDataPtr->GetNativeColumnPtr() setMinWidth:minWidth];
2836 void wxDataViewColumn::SetReorderable(bool reorderable)
2840 void wxDataViewColumn::SetResizeable(bool resizeable)
2842 wxDataViewColumnBase::SetResizeable(resizeable);
2844 [m_NativeDataPtr->GetNativeColumnPtr() setResizingMask:NSTableColumnUserResizingMask];
2846 [m_NativeDataPtr->GetNativeColumnPtr() setResizingMask:NSTableColumnNoResizing];
2849 void wxDataViewColumn::SetSortable(bool sortable)
2851 wxDataViewColumnBase::SetSortable(sortable);
2854 void wxDataViewColumn::SetSortOrder(bool ascending)
2856 if (m_ascending != ascending)
2858 m_ascending = ascending;
2861 // change sorting order:
2862 NSArray* sortDescriptors;
2863 NSSortDescriptor* sortDescriptor;
2864 NSTableColumn* tableColumn;
2866 tableColumn = m_NativeDataPtr->GetNativeColumnPtr();
2867 sortDescriptor = [[NSSortDescriptor alloc] initWithKey:[[tableColumn sortDescriptorPrototype] key] ascending:m_ascending];
2868 sortDescriptors = [NSArray arrayWithObject:sortDescriptor];
2869 [tableColumn setSortDescriptorPrototype:sortDescriptor];
2870 [[tableColumn tableView] setSortDescriptors:sortDescriptors];
2871 [sortDescriptor release];
2876 void wxDataViewColumn::SetTitle(const wxString& title)
2878 // bitmaps and titles cannot exist at the same time - if the title is set the bitmap is removed:
2879 wxDataViewColumnBase::SetBitmap(wxBitmap());
2881 [[m_NativeDataPtr->GetNativeColumnPtr() headerCell] setStringValue:[[wxCFStringRef(title).AsNSString() retain] autorelease]];
2884 void wxDataViewColumn::SetWidth(int width)
2886 [m_NativeDataPtr->GetNativeColumnPtr() setWidth:width];
2890 void wxDataViewColumn::SetAsSortKey(bool WXUNUSED(sort))
2892 // see wxGTK native wxDataViewColumn implementation
2893 wxFAIL_MSG("not implemented");
2896 void wxDataViewColumn::SetNativeData(wxDataViewColumnNativeData* newNativeDataPtr)
2898 delete m_NativeDataPtr;
2899 m_NativeDataPtr = newNativeDataPtr;
2902 #endif // (wxUSE_DATAVIEWCTRL == 1) && !defined(wxUSE_GENERICDATAVIEWCTRL)