src/osx/carbon/combobox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/mac/carbon/combobox.cpp
   3 // Purpose:     wxComboBox class
   4 // Author:      Stefan Csomor, Dan "Bud" Keith (composite combobox)
   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_COMBOBOX
  15
  16 #include "wx/combobox.h"
  17
  18 #ifndef WX_PRECOMP
  19     #include "wx/button.h"
  20     #include "wx/menu.h"
  21     #include "wx/containr.h"
  22     #include "wx/toplevel.h"
  23     #include "wx/textctrl.h"
  24 #endif
  25
  26 #include "wx/osx/uma.h"
  27
  28 IMPLEMENT_DYNAMIC_CLASS(wxComboBox, wxControl)
  29
  30 WX_DELEGATE_TO_CONTROL_CONTAINER(wxComboBox, wxControl)
  31
  32 BEGIN_EVENT_TABLE(wxComboBox, wxControl)
  33     WX_EVENT_TABLE_CONTROL_CONTAINER(wxComboBox)
  34 END_EVENT_TABLE()
  35
  36
  37 static int nextPopUpMenuId = 1000 ;
  38
  39 MenuHandle NewUniqueMenu()
  40 {
  41     MenuHandle handle = UMANewMenu(nextPopUpMenuId, wxString(wxT("Menu")), wxFont::GetDefaultEncoding() );
  42     nextPopUpMenuId++ ;
  43
  44     return handle ;
  45 }
  46
  47
  48 // ----------------------------------------------------------------------------
  49 // constants
  50 // ----------------------------------------------------------------------------
  51
  52 // the margin between the text control and the choice
  53 // margin should be bigger on OS X due to blue highlight
  54 // around text control.
  55 static const wxCoord MARGIN = 4;
  56 // this is the border a focus rect on OSX is needing
  57 static const int    TEXTFOCUSBORDER = 3 ;
  58
  59
  60 // ----------------------------------------------------------------------------
  61 // wxComboBoxText: text control forwards events to combobox
  62 // ----------------------------------------------------------------------------
  63
  64 class wxComboBoxText : public wxTextCtrl
  65 {
  66 public:
  67     wxComboBoxText( wxComboBox * cb )
  68         : wxTextCtrl( cb , 1 )
  69     {
  70         m_cb = cb;
  71         SetTriggerOnSetValue( false );
  72     }
  73
  74 protected:
  75     void OnChar( wxKeyEvent& event )
  76     {
  77         // Allows processing the tab key to go to the next control
  78         if (event.GetKeyCode() == WXK_TAB)
  79         {
  80             wxNavigationKeyEvent NavEvent;
  81             NavEvent.SetEventObject(this);
  82             NavEvent.SetDirection(true);
  83             NavEvent.SetWindowChange(false);
  84
  85             // Get the parent of the combo and have it process the navigation?
  86             if (m_cb->GetParent()->HandleWindowEvent(NavEvent))
  87                     return;
  88         }
  89
  90         // send the event to the combobox class in case the user has bound EVT_CHAR
  91         wxKeyEvent kevt(event);
  92         kevt.SetEventObject(m_cb);
  93         if (m_cb->HandleWindowEvent(kevt))
  94             // If the event was handled and not skipped then we're done
  95             return;
  96
  97         if ( event.GetKeyCode() == WXK_RETURN )
  98         {
  99             wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_cb->GetId());
 100             event.SetString( GetValue() );
 101             event.SetInt( m_cb->GetSelection() );
 102             event.SetEventObject( m_cb );
 103
 104             // This will invoke the dialog default action,
 105             // such as the clicking the default button.
 106             if (!m_cb->HandleWindowEvent( event ))
 107             {
 108                 wxTopLevelWindow *tlw = wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow);
 109                 if ( tlw && tlw->GetDefaultItem() )
 110                 {
 111                     wxButton *def = wxDynamicCast(tlw->GetDefaultItem(), wxButton);
 112                     if ( def && def->IsEnabled() )
 113                     {
 114                         wxCommandEvent event( wxEVT_COMMAND_BUTTON_CLICKED, def->GetId() );
 115                         event.SetEventObject(def);
 116                         def->Command(event);
 117                     }
 118                 }
 119
 120                 return;
 121             }
 122         }
 123
 124         event.Skip();
 125     }
 126
 127     void OnKeyUp( wxKeyEvent& event )
 128     {
 129         event.SetEventObject(m_cb);
 130         event.SetId(m_cb->GetId());
 131         if (! m_cb->HandleWindowEvent(event))
 132             event.Skip();
 133     }
 134
 135     void OnKeyDown( wxKeyEvent& event )
 136     {
 137         event.SetEventObject(m_cb);
 138         event.SetId(m_cb->GetId());
 139         if (! m_cb->HandleWindowEvent(event))
 140             event.Skip();
 141     }
 142
 143     void OnText( wxCommandEvent& event )
 144     {
 145         event.SetEventObject(m_cb);
 146         event.SetId(m_cb->GetId());
 147         if (! m_cb->HandleWindowEvent(event))
 148             event.Skip();
 149     }
 150
 151 private:
 152     wxComboBox *m_cb;
 153
 154     DECLARE_EVENT_TABLE()
 155 };
 156
 157 BEGIN_EVENT_TABLE(wxComboBoxText, wxTextCtrl)
 158     EVT_KEY_DOWN(wxComboBoxText::OnKeyDown)
 159     EVT_CHAR(wxComboBoxText::OnChar)
 160     EVT_KEY_UP(wxComboBoxText::OnKeyUp)
 161     EVT_TEXT(wxID_ANY, wxComboBoxText::OnText)
 162 END_EVENT_TABLE()
 163
 164 class wxComboBoxChoice : public wxChoice
 165 {
 166 public:
 167     wxComboBoxChoice( wxComboBox *cb, int style )
 168         : wxChoice( cb , 1 , wxDefaultPosition , wxDefaultSize , 0 , NULL , style & (wxCB_SORT) )
 169     {
 170         m_cb = cb;
 171     }
 172
 173     int GetPopupWidth() const
 174     {
 175         switch ( GetWindowVariant() )
 176         {
 177             case wxWINDOW_VARIANT_NORMAL :
 178             case wxWINDOW_VARIANT_LARGE :
 179                 return 24 ;
 180
 181             default :
 182                 return 21 ;
 183         }
 184     }
 185
 186 protected:
 187     void OnChoice( wxCommandEvent& e )
 188     {
 189         wxString    s = e.GetString();
 190
 191         m_cb->DelegateChoice( s );
 192         wxCommandEvent event2(wxEVT_COMMAND_COMBOBOX_SELECTED, m_cb->GetId() );
 193         event2.SetInt(m_cb->GetSelection());
 194         event2.SetEventObject(m_cb);
 195         event2.SetString(m_cb->GetStringSelection());
 196         m_cb->ProcessCommand(event2);
 197
 198         // For consistency with MSW and GTK, also send a text updated event
 199         // After all, the text is updated when a selection is made
 200         wxCommandEvent TextEvent( wxEVT_COMMAND_TEXT_UPDATED, m_cb->GetId() );
 201         TextEvent.SetString( m_cb->GetStringSelection() );
 202         TextEvent.SetEventObject( m_cb );
 203         m_cb->ProcessCommand( TextEvent );
 204     }
 205
 206     virtual wxSize DoGetBestSize() const
 207     {
 208         wxSize sz = wxChoice::DoGetBestSize() ;
 209         if (! m_cb->HasFlag(wxCB_READONLY) )
 210             sz.x = GetPopupWidth() ;
 211
 212         return sz ;
 213     }
 214
 215 private:
 216     wxComboBox *m_cb;
 217
 218     friend class wxComboBox;
 219
 220     DECLARE_EVENT_TABLE()
 221 };
 222
 223 BEGIN_EVENT_TABLE(wxComboBoxChoice, wxChoice)
 224     EVT_CHOICE(wxID_ANY, wxComboBoxChoice::OnChoice)
 225 END_EVENT_TABLE()
 226
 227 wxComboBox::~wxComboBox()
 228 {
 229     // delete the controls now, don't leave them alive even though they would
 230     // still be eventually deleted by our parent - but it will be too late, the
 231     // user code expects them to be gone now
 232     if (m_text != NULL)
 233     {
 234         delete m_text;
 235         m_text = NULL;
 236     }
 237
 238     if (m_choice != NULL)
 239     {
 240         delete m_choice;
 241         m_choice = NULL;
 242     }
 243 }
 244
 245 // ----------------------------------------------------------------------------
 246 // geometry
 247 // ----------------------------------------------------------------------------
 248
 249 wxSize wxComboBox::DoGetBestSize() const
 250 {
 251     if (!m_choice && !m_text)
 252         return GetSize();
 253
 254     wxSize size = m_choice->GetBestSize();
 255
 256     if ( m_text != NULL )
 257     {
 258         wxSize  sizeText = m_text->GetBestSize();
 259         if (sizeText.y > size.y)
 260             size.y = sizeText.y;
 261
 262         size.x = m_choice->GetPopupWidth() + sizeText.x + MARGIN;
 263         size.x += TEXTFOCUSBORDER ;
 264         size.y += 2 * TEXTFOCUSBORDER ;
 265     }
 266     else
 267     {
 268         // clipping is too tight
 269         size.y += 1 ;
 270     }
 271
 272     return size;
 273 }
 274
 275 void wxComboBox::DoMoveWindow(int x, int y, int width, int height)
 276 {
 277     wxControl::DoMoveWindow( x, y, width , height );
 278
 279     if ( m_text == NULL )
 280     {
 281         // we might not be fully constructed yet, therefore watch out...
 282         if ( m_choice )
 283             m_choice->SetSize(0, 0 , width, -1);
 284     }
 285     else
 286     {
 287         wxCoord wText = width - m_choice->GetPopupWidth() - MARGIN;
 288         m_text->SetSize(TEXTFOCUSBORDER, TEXTFOCUSBORDER, wText, -1);
 289
 290         // put it at an inset of 1 to have outer area shadows drawn as well
 291         m_choice->SetSize(TEXTFOCUSBORDER + wText + MARGIN - 1 , TEXTFOCUSBORDER, m_choice->GetPopupWidth() , -1);
 292     }
 293 }
 294
 295 // ----------------------------------------------------------------------------
 296 // operations forwarded to the subcontrols
 297 // ----------------------------------------------------------------------------
 298
 299 bool wxComboBox::Enable(bool enable)
 300 {
 301     if ( !wxControl::Enable(enable) )
 302         return false;
 303
 304     if (m_text)
 305         m_text->Enable(enable);
 306
 307     return true;
 308 }
 309
 310 bool wxComboBox::Show(bool show)
 311 {
 312     if ( !wxControl::Show(show) )
 313         return false;
 314
 315     return true;
 316 }
 317
 318 void wxComboBox::DelegateTextChanged( const wxString& value )
 319 {
 320     SetStringSelection( value );
 321 }
 322
 323 void wxComboBox::DelegateChoice( const wxString& value )
 324 {
 325     SetStringSelection( value );
 326 }
 327
 328 void wxComboBox::Init()
 329 {
 330     WX_INIT_CONTROL_CONTAINER();
 331 }
 332
 333 bool wxComboBox::Create(wxWindow *parent,
 334     wxWindowID id,
 335     const wxString& value,
 336     const wxPoint& pos,
 337     const wxSize& size,
 338     const wxArrayString& choices,
 339     long style,
 340     const wxValidator& validator,
 341     const wxString& name)
 342 {
 343     if ( !Create( parent, id, value, pos, size, 0, NULL,
 344                    style, validator, name ) )
 345         return false;
 346
 347     Append(choices);
 348
 349     return true;
 350 }
 351
 352 bool wxComboBox::Create(wxWindow *parent,
 353     wxWindowID id,
 354     const wxString& value,
 355     const wxPoint& pos,
 356     const wxSize& size,
 357     int n,
 358     const wxString choices[],
 359     long style,
 360     const wxValidator& validator,
 361     const wxString& name)
 362 {
 363     if ( !wxControl::Create(parent, id, wxDefaultPosition, wxDefaultSize, style ,
 364                             validator, name) )
 365     {
 366         return false;
 367     }
 368
 369     wxSize csize = size;
 370     if ( style & wxCB_READONLY )
 371     {
 372         m_text = NULL;
 373     }
 374     else
 375     {
 376         m_text = new wxComboBoxText(this);
 377         if ( size.y == -1 )
 378         {
 379             csize.y = m_text->GetSize().y ;
 380             csize.y += 2 * TEXTFOCUSBORDER ;
 381         }
 382     }
 383     m_choice = new wxComboBoxChoice(this, style );
 384
 385     DoSetSize(pos.x, pos.y, csize.x, csize.y);
 386
 387     Append( n, choices );
 388
 389     // Needed because it is a wxControlWithItems
 390     SetInitialSize(size);
 391     SetStringSelection(value);
 392
 393     return true;
 394 }
 395
 396 wxString wxComboBox::GetValue() const
 397 {
 398     wxString        result;
 399
 400     if ( m_text == NULL )
 401         result = m_choice->GetString( m_choice->GetSelection() );
 402     else
 403         result = m_text->GetValue();
 404
 405     return result;
 406 }
 407
 408 unsigned int wxComboBox::GetCount() const
 409 {
 410     return m_choice->GetCount() ;
 411 }
 412
 413 void wxComboBox::SetValue(const wxString& value)
 414 {
 415     if ( HasFlag(wxCB_READONLY) )
 416         SetStringSelection( value ) ;
 417     else
 418         m_text->SetValue( value );
 419 }
 420
 421 void wxComboBox::WriteText(const wxString& text)
 422 {
 423     m_text->WriteText(text);
 424 }
 425
 426 void wxComboBox::GetSelection(long *from, long *to) const
 427 {
 428     m_text->GetSelection(from, to);
 429 }
 430
 431 // Clipboard operations
 432
 433 void wxComboBox::Copy()
 434 {
 435     if ( m_text != NULL )
 436         m_text->Copy();
 437 }
 438
 439 void wxComboBox::Cut()
 440 {
 441     if ( m_text != NULL )
 442         m_text->Cut();
 443 }
 444
 445 void wxComboBox::Paste()
 446 {
 447     if ( m_text != NULL )
 448         m_text->Paste();
 449 }
 450
 451 void wxComboBox::SetEditable(bool editable)
 452 {
 453     if ( ( m_text == NULL ) && editable )
 454     {
 455         m_text = new wxComboBoxText( this );
 456     }
 457     else if ( ( m_text != NULL ) && !editable )
 458     {
 459         delete m_text;
 460         m_text = NULL;
 461     }
 462
 463     int currentX, currentY;
 464     GetPosition( &currentX, &currentY );
 465
 466     int currentW, currentH;
 467     GetSize( &currentW, &currentH );
 468
 469     DoMoveWindow( currentX, currentY, currentW, currentH );
 470 }
 471
 472 void wxComboBox::SetInsertionPoint(long pos)
 473 {
 474     if ( m_text )
 475         m_text->SetInsertionPoint(pos);
 476 }
 477
 478 void wxComboBox::SetInsertionPointEnd()
 479 {
 480     if ( m_text )
 481         m_text->SetInsertionPointEnd();
 482 }
 483
 484 long wxComboBox::GetInsertionPoint() const
 485 {
 486     if ( m_text )
 487         return m_text->GetInsertionPoint();
 488     return 0;
 489 }
 490
 491 wxTextPos wxComboBox::GetLastPosition() const
 492 {
 493     if ( m_text )
 494         return m_text->GetLastPosition();
 495     return 0;
 496 }
 497
 498 void wxComboBox::Replace(long from, long to, const wxString& value)
 499 {
 500     if ( m_text )
 501         m_text->Replace(from,to,value);
 502 }
 503
 504 void wxComboBox::Remove(long from, long to)
 505 {
 506     if ( m_text )
 507         m_text->Remove(from,to);
 508 }
 509
 510 void wxComboBox::SetSelection(long from, long to)
 511 {
 512     if ( m_text )
 513         m_text->SetSelection(from,to);
 514 }
 515
 516 int wxComboBox::DoInsertItems(const wxArrayStringsAdapter& items,
 517                               unsigned int pos,
 518                               void **clientData,
 519                               wxClientDataType type)
 520 {
 521     return m_choice->DoInsertItems(items, pos, clientData, type);
 522 }
 523
 524 void wxComboBox::DoSetItemClientData(unsigned int n, void* clientData)
 525 {
 526     return m_choice->DoSetItemClientData( n , clientData ) ;
 527 }
 528
 529 void* wxComboBox::DoGetItemClientData(unsigned int n) const
 530 {
 531     return m_choice->DoGetItemClientData( n ) ;
 532 }
 533
 534 wxClientDataType wxComboBox::GetClientDataType() const
 535 {
 536     return m_choice->GetClientDataType();
 537 }
 538
 539 void wxComboBox::SetClientDataType(wxClientDataType clientDataItemsType)
 540 {
 541     m_choice->SetClientDataType(clientDataItemsType);
 542 }
 543
 544 void wxComboBox::DoDeleteOneItem(unsigned int n)
 545 {
 546     m_choice->DoDeleteOneItem( n );
 547 }
 548
 549 void wxComboBox::DoClear()
 550 {
 551     m_choice->DoClear();
 552 }
 553
 554 int wxComboBox::GetSelection() const
 555 {
 556     return m_choice->GetSelection();
 557 }
 558
 559 void wxComboBox::SetSelection(int n)
 560 {
 561     m_choice->SetSelection( n );
 562
 563     if ( m_text != NULL )
 564         m_text->SetValue(n != wxNOT_FOUND ? GetString(n) : wxString(wxEmptyString));
 565 }
 566
 567 int wxComboBox::FindString(const wxString& s, bool bCase) const
 568 {
 569     return m_choice->FindString( s, bCase );
 570 }
 571
 572 wxString wxComboBox::GetString(unsigned int n) const
 573 {
 574     return m_choice->GetString( n );
 575 }
 576
 577 wxString wxComboBox::GetStringSelection() const
 578 {
 579     int sel = GetSelection();
 580     if (sel != wxNOT_FOUND)
 581         return wxString(this->GetString((unsigned int)sel));
 582     else
 583         return wxEmptyString;
 584 }
 585
 586 void wxComboBox::SetString(unsigned int n, const wxString& s)
 587 {
 588     m_choice->SetString( n , s );
 589 }
 590
 591 bool wxComboBox::IsEditable() const
 592 {
 593     return m_text != NULL && !HasFlag(wxCB_READONLY);
 594 }
 595
 596 void wxComboBox::Undo()
 597 {
 598     if (m_text != NULL)
 599         m_text->Undo();
 600 }
 601
 602 void wxComboBox::Redo()
 603 {
 604     if (m_text != NULL)
 605         m_text->Redo();
 606 }
 607
 608 void wxComboBox::SelectAll()
 609 {
 610     if (m_text != NULL)
 611         m_text->SelectAll();
 612 }
 613
 614 bool wxComboBox::CanCopy() const
 615 {
 616     if (m_text != NULL)
 617         return m_text->CanCopy();
 618     else
 619         return false;
 620 }
 621
 622 bool wxComboBox::CanCut() const
 623 {
 624     if (m_text != NULL)
 625         return m_text->CanCut();
 626     else
 627         return false;
 628 }
 629
 630 bool wxComboBox::CanPaste() const
 631 {
 632     if (m_text != NULL)
 633         return m_text->CanPaste();
 634     else
 635         return false;
 636 }
 637
 638 bool wxComboBox::CanUndo() const
 639 {
 640     if (m_text != NULL)
 641         return m_text->CanUndo();
 642     else
 643         return false;
 644 }
 645
 646 bool wxComboBox::CanRedo() const
 647 {
 648     if (m_text != NULL)
 649         return m_text->CanRedo();
 650     else
 651         return false;
 652 }
 653
 654 wxInt32 wxComboBox::MacControlHit( WXEVENTHANDLERREF WXUNUSED(handler) , WXEVENTREF WXUNUSED(event) )
 655 {
 656 /*
 657     For consistency with other platforms, clicking in the text area does not constitute a selection
 658     wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, m_windowId );
 659     event.SetInt(GetSelection());
 660     event.SetEventObject(this);
 661     event.SetString(GetStringSelection());
 662     ProcessCommand(event);
 663 */
 664
 665     return noErr ;
 666 }
 667
 668 #endif // wxUSE_COMBOBOX