src/osx/cocoa/listbox.mm

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/osx/cocoa/listbox.mm
   3 // Purpose:     wxListBox
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #include "wx/wxprec.h"
  13
  14 #if wxUSE_LISTBOX
  15
  16 #include "wx/listbox.h"
  17 #include "wx/dnd.h"
  18
  19 #ifndef WX_PRECOMP
  20     #include "wx/log.h"
  21     #include "wx/intl.h"
  22     #include "wx/utils.h"
  23     #include "wx/settings.h"
  24     #include "wx/arrstr.h"
  25     #include "wx/dcclient.h"
  26 #endif
  27
  28 #include "wx/osx/private.h"
  29
  30 #include <vector>
  31
  32 // forward decls
  33
  34 class wxListWidgetCocoaImpl;
  35
  36 @interface wxNSTableDataSource : NSObject wxOSX_10_6_AND_LATER(<NSTableViewDataSource>)
  37 {
  38     wxListWidgetCocoaImpl* impl;
  39 }
  40
  41 - (id)tableView:(NSTableView *)aTableView
  42         objectValueForTableColumn:(NSTableColumn *)aTableColumn
  43         row:(NSInteger)rowIndex;
  44
  45 - (void)tableView:(NSTableView *)aTableView
  46         setObjectValue:(id)value forTableColumn:(NSTableColumn *)aTableColumn
  47         row:(NSInteger)rowIndex;
  48
  49 - (NSInteger)numberOfRowsInTableView:(NSTableView *)aTableView;
  50
  51 - (void)setImplementation: (wxListWidgetCocoaImpl *) theImplementation;
  52 - (wxListWidgetCocoaImpl*) implementation;
  53
  54 @end
  55
  56 @interface wxNSTableView : NSTableView wxOSX_10_6_AND_LATER(<NSTableViewDelegate>)
  57 {
  58 }
  59
  60 @end
  61
  62 //
  63 // table column
  64 //
  65
  66 class wxCocoaTableColumn;
  67
  68 @interface wxNSTableColumn : NSTableColumn
  69 {
  70     wxCocoaTableColumn* column;
  71 }
  72
  73 - (void) setColumn: (wxCocoaTableColumn*) col;
  74
  75 - (wxCocoaTableColumn*) column;
  76
  77 @end
  78
  79 class WXDLLIMPEXP_CORE wxCocoaTableColumn : public wxListWidgetColumn
  80 {
  81 public :
  82     wxCocoaTableColumn( wxNSTableColumn* column, bool editable )
  83         : m_column( column ), m_editable(editable)
  84     {
  85     }
  86
  87     ~wxCocoaTableColumn()
  88     {
  89     }
  90
  91     wxNSTableColumn* GetNSTableColumn() const { return m_column ; }
  92
  93     bool IsEditable() const { return m_editable; }
  94
  95 protected :
  96     wxNSTableColumn* m_column;
  97     bool m_editable;
  98 } ;
  99
 100 NSString* column1 = @"1";
 101
 102 class wxListWidgetCocoaImpl : public wxWidgetCocoaImpl, public wxListWidgetImpl
 103 {
 104 public :
 105     wxListWidgetCocoaImpl( wxWindowMac* peer, NSScrollView* view, wxNSTableView* tableview, wxNSTableDataSource* data );
 106
 107     ~wxListWidgetCocoaImpl();
 108
 109     virtual wxListWidgetColumn*     InsertTextColumn( unsigned pos, const wxString& title, bool editable = false,
 110                                 wxAlignment just = wxALIGN_LEFT , int defaultWidth = -1)  ;
 111     virtual wxListWidgetColumn*     InsertCheckColumn( unsigned pos , const wxString& title, bool editable = false,
 112                                 wxAlignment just = wxALIGN_LEFT , int defaultWidth =  -1)  ;
 113
 114     // add and remove
 115
 116     virtual void            ListDelete( unsigned int n ) ;
 117     virtual void            ListInsert( unsigned int n ) ;
 118     virtual void            ListClear() ;
 119
 120     // selecting
 121
 122     virtual void            ListDeselectAll();
 123
 124     virtual void            ListSetSelection( unsigned int n, bool select, bool multi ) ;
 125     virtual int             ListGetSelection() const ;
 126
 127     virtual int             ListGetSelections( wxArrayInt& aSelections ) const ;
 128
 129     virtual bool            ListIsSelected( unsigned int n ) const ;
 130
 131     // display
 132
 133     virtual void            ListScrollTo( unsigned int n ) ;
 134
 135     // accessing content
 136
 137     virtual unsigned int    ListGetCount() const ;
 138     virtual int             DoListHitTest( const wxPoint& inpoint ) const;
 139
 140     int                     ListGetColumnType( int col )
 141     {
 142         return col;
 143     }
 144     virtual void            UpdateLine( unsigned int n, wxListWidgetColumn* col = NULL ) ;
 145     virtual void            UpdateLineToEnd( unsigned int n);
 146
 147     virtual void            controlDoubleAction(WXWidget slf, void* _cmd, void *sender);
 148
 149
 150 protected :
 151     wxNSTableView*          m_tableView ;
 152
 153     wxNSTableDataSource*    m_dataSource;
 154 } ;
 155
 156 //
 157 // implementations
 158 //
 159
 160 @implementation wxNSTableColumn
 161
 162 - (id) init
 163 {
 164     self = [super init];
 165     column = nil;
 166     return self;
 167 }
 168
 169 - (void) setColumn: (wxCocoaTableColumn*) col
 170 {
 171     column = col;
 172 }
 173
 174 - (wxCocoaTableColumn*) column
 175 {
 176     return column;
 177 }
 178
 179 @end
 180
 181 class wxNSTableViewCellValue : public wxListWidgetCellValue
 182 {
 183 public :
 184     wxNSTableViewCellValue( id &v ) : value(v)
 185     {
 186     }
 187
 188     virtual ~wxNSTableViewCellValue() {}
 189
 190     virtual void Set( CFStringRef v )
 191     {
 192         value = [[(NSString*)v retain] autorelease];
 193     }
 194     virtual void Set( const wxString& value )
 195     {
 196         Set( (CFStringRef) wxCFStringRef( value ) );
 197     }
 198     virtual void Set( int v )
 199     {
 200         value = [NSNumber numberWithInt:v];
 201     }
 202
 203     virtual int GetIntValue() const
 204     {
 205         if ( [value isKindOfClass:[NSNumber class]] )
 206             return [ (NSNumber*) value intValue ];
 207
 208         return 0;
 209     }
 210
 211     virtual wxString GetStringValue() const
 212     {
 213         if ( [value isKindOfClass:[NSString class]] )
 214             return wxCFStringRef::AsString( (NSString*) value );
 215
 216         return wxEmptyString;
 217     }
 218
 219 protected:
 220     id& value;
 221 } ;
 222
 223 @implementation wxNSTableDataSource
 224
 225 - (id) init
 226 {
 227     self = [super init];
 228     impl = nil;
 229     return self;
 230 }
 231
 232 - (void)setImplementation: (wxListWidgetCocoaImpl *) theImplementation
 233 {
 234     impl = theImplementation;
 235 }
 236
 237 - (wxListWidgetCocoaImpl*) implementation
 238 {
 239     return impl;
 240 }
 241
 242 - (NSInteger)numberOfRowsInTableView:(NSTableView *)aTableView
 243 {
 244     wxUnusedVar(aTableView);
 245     if ( impl )
 246         return impl->ListGetCount();
 247     return 0;
 248 }
 249
 250 - (id)tableView:(NSTableView *)aTableView
 251         objectValueForTableColumn:(NSTableColumn *)aTableColumn
 252         row:(NSInteger)rowIndex
 253 {
 254     wxUnusedVar(aTableView);
 255     wxNSTableColumn* tablecol = (wxNSTableColumn *)aTableColumn;
 256     wxListBox* lb = dynamic_cast<wxListBox*>(impl->GetWXPeer());
 257     wxCocoaTableColumn* col = [tablecol column];
 258     id value = nil;
 259     wxNSTableViewCellValue cellvalue(value);
 260     lb->GetValueCallback(rowIndex, col, cellvalue);
 261     return value;
 262 }
 263
 264 - (void)tableView:(NSTableView *)aTableView
 265         setObjectValue:(id)value forTableColumn:(NSTableColumn *)aTableColumn
 266         row:(NSInteger)rowIndex
 267 {
 268     wxUnusedVar(aTableView);
 269     wxNSTableColumn* tablecol = (wxNSTableColumn *)aTableColumn;
 270     wxListBox* lb = dynamic_cast<wxListBox*>(impl->GetWXPeer());
 271     wxCocoaTableColumn* col = [tablecol column];
 272     wxNSTableViewCellValue cellvalue(value);
 273     lb->SetValueCallback(rowIndex, col, cellvalue);
 274 }
 275
 276 @end
 277
 278 @implementation wxNSTableView
 279
 280 + (void)initialize
 281 {
 282     static BOOL initialized = NO;
 283     if (!initialized)
 284     {
 285         initialized = YES;
 286         wxOSXCocoaClassAddWXMethods( self );
 287     }
 288 }
 289
 290 - (void) tableViewSelectionDidChange: (NSNotification *) notification
 291 {
 292     wxUnusedVar(notification);
 293
 294     int row = [self selectedRow];
 295
 296     if (row == -1)
 297     {
 298         // no row selected
 299     }
 300     else
 301     {
 302         wxWidgetCocoaImpl* impl = (wxWidgetCocoaImpl* ) wxWidgetImpl::FindFromWXWidget( self );
 303         wxListBox *list = static_cast<wxListBox*> ( impl->GetWXPeer());
 304         wxCHECK_RET( list != NULL , wxT("Listbox expected"));
 305
 306         wxCommandEvent event( wxEVT_LISTBOX, list->GetId() );
 307
 308         if ((row < 0) || (row > (int) list->GetCount()))  // OS X can select an item below the last item
 309             return;
 310
 311         if ( !list->MacGetBlockEvents() )
 312             list->HandleLineEvent( row, false );
 313     }
 314
 315 }
 316
 317 - (void)setFont:(NSFont *)aFont
 318 {
 319     NSArray *tableColumns = [self tableColumns];
 320     unsigned int columnIndex = [tableColumns count];
 321     while (columnIndex--)
 322         [[(NSTableColumn *)[tableColumns objectAtIndex:columnIndex] dataCell] setFont:aFont];
 323
 324     [self setRowHeight:[gNSLayoutManager defaultLineHeightForFont:aFont]+2];
 325 }
 326
 327 - (void) setControlSize:(NSControlSize) size
 328 {
 329     NSArray *tableColumns = [self tableColumns];
 330     unsigned int columnIndex = [tableColumns count];
 331     while (columnIndex--)
 332         [[(NSTableColumn *)[tableColumns objectAtIndex:columnIndex] dataCell] setControlSize:size];
 333 }
 334
 335 @end
 336
 337 //
 338 //
 339 //
 340
 341 wxListWidgetCocoaImpl::wxListWidgetCocoaImpl( wxWindowMac* peer, NSScrollView* view, wxNSTableView* tableview, wxNSTableDataSource* data ) :
 342     wxWidgetCocoaImpl( peer, view ), m_tableView(tableview), m_dataSource(data)
 343 {
 344     InstallEventHandler( tableview );
 345 }
 346
 347 wxListWidgetCocoaImpl::~wxListWidgetCocoaImpl()
 348 {
 349     [m_dataSource release];
 350 }
 351
 352 unsigned int wxListWidgetCocoaImpl::ListGetCount() const
 353 {
 354     wxListBox* lb = dynamic_cast<wxListBox*> ( GetWXPeer() );
 355     return lb->GetCount();
 356 }
 357
 358 //
 359 // columns
 360 //
 361
 362 wxListWidgetColumn* wxListWidgetCocoaImpl::InsertTextColumn( unsigned pos, const wxString& WXUNUSED(title), bool editable,
 363                                 wxAlignment WXUNUSED(just), int defaultWidth)
 364 {
 365     wxNSTableColumn* col1 = [[wxNSTableColumn alloc] init];
 366     [col1 setEditable:editable];
 367
 368     unsigned formerColCount = [m_tableView numberOfColumns];
 369
 370     // there's apparently no way to insert at a specific position
 371     [m_tableView addTableColumn:col1 ];
 372     if ( pos < formerColCount )
 373         [m_tableView moveColumn:formerColCount toColumn:pos];
 374
 375     if ( defaultWidth >= 0 )
 376     {
 377         [col1 setMaxWidth:defaultWidth];
 378         [col1 setMinWidth:defaultWidth];
 379         [col1 setWidth:defaultWidth];
 380     }
 381     else
 382     {
 383         [col1 setMaxWidth:1000];
 384         [col1 setMinWidth:10];
 385         // temporary hack, because I cannot get the automatic column resizing
 386         // to work properly
 387         [col1 setWidth:1000];
 388     }
 389     [col1 setResizingMask: NSTableColumnAutoresizingMask];
 390
 391     wxListBox *list = static_cast<wxListBox*> ( GetWXPeer());
 392     if ( list != NULL )
 393         [[col1 dataCell] setFont:list->GetFont().OSXGetNSFont()];
 394
 395     wxCocoaTableColumn* wxcol = new wxCocoaTableColumn( col1, editable );
 396     [col1 setColumn:wxcol];
 397
 398     // owned by the tableview
 399     [col1 release];
 400     return wxcol;
 401 }
 402
 403 wxListWidgetColumn* wxListWidgetCocoaImpl::InsertCheckColumn( unsigned pos , const wxString& WXUNUSED(title), bool editable,
 404                                 wxAlignment WXUNUSED(just), int defaultWidth )
 405 {
 406    wxNSTableColumn* col1 = [[wxNSTableColumn alloc] init];
 407     [col1 setEditable:editable];
 408
 409     // set your custom cell & set it up
 410     NSButtonCell* checkbox = [[NSButtonCell alloc] init];
 411     [checkbox setTitle:@""];
 412     [checkbox setButtonType:NSSwitchButton];
 413     [col1 setDataCell:checkbox] ;
 414
 415     wxListBox *list = static_cast<wxListBox*> ( GetWXPeer());
 416     if ( list != NULL )
 417     {
 418         NSControlSize size = NSRegularControlSize;
 419
 420         switch ( list->GetWindowVariant() )
 421         {
 422             case wxWINDOW_VARIANT_NORMAL :
 423                 size = NSRegularControlSize;
 424                 break ;
 425
 426             case wxWINDOW_VARIANT_SMALL :
 427                 size = NSSmallControlSize;
 428                 break ;
 429
 430             case wxWINDOW_VARIANT_MINI :
 431                 size = NSMiniControlSize;
 432                 break ;
 433
 434             case wxWINDOW_VARIANT_LARGE :
 435                 size = NSRegularControlSize;
 436                 break ;
 437
 438             default:
 439                 break ;
 440         }
 441
 442         [[col1 dataCell] setControlSize:size];
 443         // although there is no text, it may help to get the correct vertical layout
 444         [[col1 dataCell] setFont:list->GetFont().OSXGetNSFont()];
 445     }
 446
 447     [checkbox release];
 448
 449     unsigned formerColCount = [m_tableView numberOfColumns];
 450
 451     // there's apparently no way to insert at a specific position
 452     [m_tableView addTableColumn:col1 ];
 453     if ( pos < formerColCount )
 454         [m_tableView moveColumn:formerColCount toColumn:pos];
 455
 456     if ( defaultWidth >= 0 )
 457     {
 458         [col1 setMaxWidth:defaultWidth];
 459         [col1 setMinWidth:defaultWidth];
 460         [col1 setWidth:defaultWidth];
 461     }
 462
 463     [col1 setResizingMask: NSTableColumnNoResizing];
 464     wxCocoaTableColumn* wxcol = new wxCocoaTableColumn( col1, editable );
 465     [col1 setColumn:wxcol];
 466
 467     // owned by the tableview
 468     [col1 release];
 469     return wxcol;
 470 }
 471
 472
 473 //
 474 // inserting / removing lines
 475 //
 476
 477 void wxListWidgetCocoaImpl::ListInsert( unsigned int WXUNUSED(n) )
 478 {
 479     [m_tableView reloadData];
 480 }
 481
 482 void wxListWidgetCocoaImpl::ListDelete( unsigned int WXUNUSED(n) )
 483 {
 484     [m_tableView reloadData];
 485 }
 486
 487 void wxListWidgetCocoaImpl::ListClear()
 488 {
 489     [m_tableView reloadData];
 490 }
 491
 492 // selecting
 493
 494 void wxListWidgetCocoaImpl::ListDeselectAll()
 495 {
 496     [m_tableView deselectAll:nil];
 497 }
 498
 499 void wxListWidgetCocoaImpl::ListSetSelection( unsigned int n, bool select, bool multi )
 500 {
 501     // TODO
 502     if ( select )
 503         [m_tableView selectRowIndexes:[NSIndexSet indexSetWithIndex:n]
 504                      byExtendingSelection:multi];
 505     else
 506         [m_tableView deselectRow: n];
 507
 508 }
 509
 510 int wxListWidgetCocoaImpl::ListGetSelection() const
 511 {
 512     return [m_tableView selectedRow];
 513 }
 514
 515 int wxListWidgetCocoaImpl::ListGetSelections( wxArrayInt& aSelections ) const
 516 {
 517     aSelections.Empty();
 518
 519     int count = ListGetCount();
 520
 521     for ( int i = 0; i < count; ++i)
 522     {
 523         if ([m_tableView isRowSelected:i])
 524         aSelections.Add(i);
 525     }
 526
 527     return aSelections.Count();
 528 }
 529
 530 bool wxListWidgetCocoaImpl::ListIsSelected( unsigned int n ) const
 531 {
 532     return [m_tableView isRowSelected:n];
 533 }
 534
 535 // display
 536
 537 void wxListWidgetCocoaImpl::ListScrollTo( unsigned int n )
 538 {
 539     [m_tableView scrollRowToVisible:n];
 540 }
 541
 542
 543 void wxListWidgetCocoaImpl::UpdateLine( unsigned int WXUNUSED(n), wxListWidgetColumn* WXUNUSED(col) )
 544 {
 545     // TODO optimize
 546     [m_tableView reloadData];
 547 }
 548
 549 void wxListWidgetCocoaImpl::UpdateLineToEnd( unsigned int WXUNUSED(n))
 550 {
 551     // TODO optimize
 552     [m_tableView reloadData];
 553 }
 554
 555 void wxListWidgetCocoaImpl::controlDoubleAction(WXWidget WXUNUSED(slf),void* WXUNUSED(_cmd), void *WXUNUSED(sender))
 556 {
 557     wxListBox *list = static_cast<wxListBox*> ( GetWXPeer());
 558     wxCHECK_RET( list != NULL , wxT("Listbox expected"));
 559
 560     int sel = [m_tableView clickedRow];
 561     if ((sel < 0) || (sel > (int) list->GetCount()))  // OS X can select an item below the last item (why?)
 562        return;
 563
 564     list->HandleLineEvent( sel, true );
 565 }
 566
 567 // accessing content
 568
 569
 570 wxWidgetImplType* wxWidgetImpl::CreateListBox( wxWindowMac* wxpeer,
 571                                     wxWindowMac* WXUNUSED(parent),
 572                                     wxWindowID WXUNUSED(id),
 573                                     const wxPoint& pos,
 574                                     const wxSize& size,
 575                                     long style,
 576                                     long WXUNUSED(extraStyle))
 577 {
 578     NSRect r = wxOSXGetFrameForControl( wxpeer, pos , size ) ;
 579     NSScrollView* scrollview = [[NSScrollView alloc] initWithFrame:r];
 580
 581     // use same scroll flags logic as msw
 582
 583     [scrollview setHasVerticalScroller:YES];
 584
 585     if ( style & wxLB_HSCROLL )
 586         [scrollview setHasHorizontalScroller:YES];
 587
 588     [scrollview setAutohidesScrollers: ((style & wxLB_ALWAYS_SB) ? NO : YES)];
 589
 590     // setting up the true table
 591
 592     wxNSTableView* tableview = [[wxNSTableView alloc] init];
 593     [tableview setDelegate:tableview];
 594     // only one multi-select mode available
 595     if ( (style & wxLB_EXTENDED) || (style & wxLB_MULTIPLE) )
 596         [tableview setAllowsMultipleSelection:YES];
 597
 598     // simple listboxes have no header row
 599     [tableview setHeaderView:nil];
 600
 601     if ( style & wxLB_HSCROLL )
 602         [tableview setColumnAutoresizingStyle:NSTableViewNoColumnAutoresizing];
 603     else
 604         [tableview setColumnAutoresizingStyle:NSTableViewLastColumnOnlyAutoresizingStyle];
 605
 606     wxNSTableDataSource* ds = [[ wxNSTableDataSource alloc] init];
 607     [tableview setDataSource:ds];
 608     [scrollview setDocumentView:tableview];
 609     [tableview release];
 610
 611     wxListWidgetCocoaImpl* c = new wxListWidgetCocoaImpl( wxpeer, scrollview, tableview, ds );
 612
 613     // temporary hook for dnd
 614  //   [tableview registerForDraggedTypes:[NSArray arrayWithObjects:
 615  //       NSStringPboardType, NSFilenamesPboardType, (NSString*) kPasteboardTypeFileURLPromise, NSTIFFPboardType, NSPICTPboardType, NSPDFPboardType, nil]];
 616
 617     [ds setImplementation:c];
 618     return c;
 619 }
 620
 621 int wxListWidgetCocoaImpl::DoListHitTest(const wxPoint& inpoint) const
 622 {
 623     // translate inpoint to listpoint via scrollview
 624     NSPoint p = wxToNSPoint( m_osxView, inpoint );
 625     p = [m_osxView convertPoint:p toView:m_tableView];
 626     // hittest using new point
 627     NSInteger i = [m_tableView rowAtPoint:p];
 628     return i;
 629 }
 630
 631 #endif // wxUSE_LISTBOX