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