src/mac/carbon/combobox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        combobox.cpp
   3 // Purpose:     wxComboBox class
   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 #ifdef __GNUG__
  13 #pragma implementation "combobox.h"
  14 #endif
  15
  16 #include "wx/combobox.h"
  17 #include "wx/button.h"
  18 #include "wx/menu.h"
  19 #include "wx/mac/uma.h"
  20
  21 #if !USE_SHARED_LIBRARY
  22 IMPLEMENT_DYNAMIC_CLASS(wxComboBox, wxControl)
  23 #endif
  24
  25 // composite combobox implementation by Dan "Bud" Keith bud@otsys.com
  26
  27
  28 static int nextPopUpMenuId = 1000 ;
  29 MenuHandle NewUniqueMenu()
  30 {
  31   MenuHandle handle = NewMenu( nextPopUpMenuId , "\pMenu" ) ;
  32   nextPopUpMenuId++ ;
  33   return handle ;
  34 }
  35
  36
  37 // ----------------------------------------------------------------------------
  38 // constants
  39 // ----------------------------------------------------------------------------
  40
  41 // the margin between the text control and the choice
  42 #if TARGET_API_MAC_OSX
  43 // margin should be bigger on OS X due to blue highlight
  44 // around text control.
  45 static const wxCoord MARGIN = 6;
  46 static const int    POPUPWIDTH = 24;
  47 #else
  48 static const wxCoord MARGIN = 2;
  49 static const int    POPUPWIDTH = 18;
  50 #endif
  51 static const int    POPUPHEIGHT = 23;
  52
  53
  54 // ----------------------------------------------------------------------------
  55 // wxComboBoxText: text control forwards events to combobox
  56 // ----------------------------------------------------------------------------
  57
  58 class wxComboBoxText : public wxTextCtrl
  59 {
  60 public:
  61     wxComboBoxText( wxComboBox * cb )
  62         : wxTextCtrl( cb , 1 )
  63     {
  64         m_cb = cb;
  65
  66         // remove the default minsize, the combobox will have one instead
  67         SetSizeHints(-1,-1);
  68     }
  69
  70 protected:
  71     void OnChar( wxKeyEvent& event )
  72     {
  73         if ( event.GetKeyCode() == WXK_RETURN )
  74         {
  75             wxString value = GetValue();
  76
  77             if ( m_cb->GetCount() == 0 )
  78             {
  79                 // make Enter generate "selected" event if there is only one item
  80                 // in the combobox - without it, it's impossible to select it at
  81                 // all!
  82                 wxCommandEvent event( wxEVT_COMMAND_COMBOBOX_SELECTED, m_cb->GetId() );
  83                 event.SetInt( 0 );
  84                 event.SetString( value );
  85                 event.SetEventObject( m_cb );
  86                 m_cb->GetEventHandler()->ProcessEvent( event );
  87             }
  88             else
  89             {
  90                 // add the item to the list if it's not there yet
  91                 if ( m_cb->FindString(value) == wxNOT_FOUND )
  92                 {
  93                     m_cb->Append(value);
  94                     m_cb->SetStringSelection(value);
  95
  96                     // and generate the selected event for it
  97                     wxCommandEvent event( wxEVT_COMMAND_COMBOBOX_SELECTED, m_cb->GetId() );
  98                     event.SetInt( m_cb->GetCount() - 1 );
  99                     event.SetString( value );
 100                     event.SetEventObject( m_cb );
 101                     m_cb->GetEventHandler()->ProcessEvent( event );
 102                 }
 103
 104                 // This will invoke the dialog default action, such
 105                 // as the clicking the default button.
 106
 107                 wxWindow *parent = GetParent();
 108                 while( parent && !parent->IsTopLevel() && parent->GetDefaultItem() == NULL ) {
 109                     parent = parent->GetParent() ;
 110                 }
 111                 if ( parent && parent->GetDefaultItem() )
 112                 {
 113                     wxButton *def = wxDynamicCast(parent->GetDefaultItem(),
 114                                                           wxButton);
 115                     if ( def && def->IsEnabled() )
 116                     {
 117                         wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, def->GetId() );
 118                         event.SetEventObject(def);
 119                         def->Command(event);
 120                         return ;
 121                    }
 122                 }
 123
 124                 return;
 125             }
 126         }
 127
 128         event.Skip();
 129     }
 130
 131 private:
 132     wxComboBox *m_cb;
 133
 134     DECLARE_EVENT_TABLE()
 135 };
 136
 137 BEGIN_EVENT_TABLE(wxComboBoxText, wxTextCtrl)
 138     EVT_CHAR( wxComboBoxText::OnChar)
 139 END_EVENT_TABLE()
 140
 141 class wxComboBoxChoice : public wxChoice
 142 {
 143 public:
 144     wxComboBoxChoice(wxComboBox *cb, int style)
 145         : wxChoice( cb , 1 )
 146     {
 147         m_cb = cb;
 148
 149         // remove the default minsize, the combobox will have one instead
 150         SetSizeHints(-1,-1);
 151     }
 152
 153 protected:
 154     void OnChoice( wxCommandEvent& e )
 155     {
 156         wxString    s = e.GetString();
 157
 158         m_cb->DelegateChoice( s );
 159         wxCommandEvent event2(wxEVT_COMMAND_COMBOBOX_SELECTED, m_cb->GetId() );
 160         event2.SetInt(m_cb->GetSelection());
 161         event2.SetEventObject(m_cb);
 162         event2.SetString(m_cb->GetStringSelection());
 163         m_cb->ProcessCommand(event2);
 164     }
 165     virtual wxSize DoGetBestSize() const
 166     {
 167         wxSize sz = wxChoice::DoGetBestSize() ;
 168         if (! m_cb->HasFlag(wxCB_READONLY) )
 169             sz.x = POPUPWIDTH;
 170         return sz ;
 171     }
 172
 173 private:
 174     wxComboBox *m_cb;
 175
 176     DECLARE_EVENT_TABLE()
 177 };
 178
 179 BEGIN_EVENT_TABLE(wxComboBoxChoice, wxChoice)
 180     EVT_CHOICE(-1, wxComboBoxChoice::OnChoice)
 181 END_EVENT_TABLE()
 182
 183 wxComboBox::~wxComboBox()
 184 {
 185     // delete client objects
 186     FreeData();
 187
 188     // delete the controls now, don't leave them alive even though they would
 189     // still be eventually deleted by our parent - but it will be too late, the
 190     // user code expects them to be gone now
 191     if (m_text != NULL) {
 192         delete m_text;
 193         m_text = NULL;
 194     }
 195     if (m_choice != NULL) {
 196         delete m_choice;
 197         m_choice = NULL;
 198     }
 199 }
 200
 201
 202 // ----------------------------------------------------------------------------
 203 // geometry
 204 // ----------------------------------------------------------------------------
 205
 206 wxSize wxComboBox::DoGetBestSize() const
 207 {
 208     if (!m_choice || !m_text)
 209         return GetSize();
 210     wxSize size = m_choice->GetBestSize();
 211
 212     if ( m_text != NULL )
 213     {
 214         wxSize  sizeText = m_text->GetBestSize();
 215         if (sizeText.y > size.y)
 216             size.y = sizeText.y;
 217         size.x = POPUPWIDTH + sizeText.x + MARGIN;
 218     }
 219
 220     return size;
 221 }
 222
 223 void wxComboBox::DoMoveWindow(int x, int y, int width, int height) {
 224     height = POPUPHEIGHT;
 225     int origin = 0;
 226 #if TARGET_API_MAC_OSX
 227     // give the controls some padding so that the text ctrl's borders
 228     // and blue highlight can appear
 229     origin = 4;
 230 #endif
 231
 232     wxControl::DoMoveWindow(x, y, width + origin, height + origin);
 233
 234     if ( m_text == NULL )
 235     {
 236         // we might not be fully constructed yet, therefore watch out...
 237         if ( m_choice )
 238             m_choice->SetSize(0, 0 , width, -1);
 239     }
 240     else
 241     {
 242         wxCoord wText = width - POPUPWIDTH - MARGIN;
 243 #if TARGET_API_MAC_OSX
 244         // also, we need to shrink the size of the wxTextCtrl a bit
 245         // to make it appear properly on OS X.
 246         height -= 8;
 247         wText -= 8;
 248 #endif
 249         m_text->SetSize(origin, origin, wText, height);
 250         m_choice->SetSize(origin + wText + MARGIN, 0, POPUPWIDTH, -1);
 251     }
 252 }
 253
 254
 255
 256 // ----------------------------------------------------------------------------
 257 // operations forwarded to the subcontrols
 258 // ----------------------------------------------------------------------------
 259
 260 bool wxComboBox::Enable(bool enable)
 261 {
 262     if ( !wxControl::Enable(enable) )
 263         return FALSE;
 264
 265     return TRUE;
 266 }
 267
 268 bool wxComboBox::Show(bool show)
 269 {
 270     if ( !wxControl::Show(show) )
 271         return FALSE;
 272
 273     return TRUE;
 274 }
 275
 276 void wxComboBox::SetFocus()
 277 {
 278     if ( m_text != NULL) {
 279         m_text->SetFocus();
 280     }
 281 }
 282
 283
 284 void wxComboBox::DelegateTextChanged( const wxString& value )
 285 {
 286     SetStringSelection( value );
 287 }
 288
 289
 290 void wxComboBox::DelegateChoice( const wxString& value )
 291 {
 292     SetStringSelection( value );
 293 }
 294
 295
 296 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 297            const wxString& value,
 298            const wxPoint& pos,
 299            const wxSize& size,
 300            const wxArrayString& choices,
 301            long style,
 302            const wxValidator& validator,
 303            const wxString& name)
 304 {
 305     wxCArrayString chs( choices );
 306
 307     return Create( parent, id, value, pos, size, chs.GetCount(),
 308                    chs.GetStrings(), style, validator, name );
 309 }
 310
 311
 312 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
 313            const wxString& value,
 314            const wxPoint& pos,
 315            const wxSize& size,
 316            int n, const wxString choices[],
 317            long style,
 318            const wxValidator& validator,
 319            const wxString& name)
 320 {
 321     if ( !wxControl::Create(parent, id, wxDefaultPosition, wxDefaultSize, style ,
 322                             wxDefaultValidator, name) )
 323     {
 324         return FALSE;
 325     }
 326
 327     m_choice = new wxComboBoxChoice(this, style );
 328     m_choice->SetSizeHints( wxSize( POPUPWIDTH , POPUPHEIGHT ) ) ;
 329     wxSize csize = size;
 330     if ( style & wxCB_READONLY )
 331     {
 332         m_text = NULL;
 333     }
 334     else
 335     {
 336         m_text = new wxComboBoxText(this);
 337         if ( size.y == -1 ) {
 338           csize.y = m_text->GetSize().y ;
 339         }
 340     }
 341
 342     DoSetSize(pos.x, pos.y, csize.x, csize.y);
 343
 344     for ( int i = 0 ; i < n ; i++ )
 345     {
 346         m_choice->DoAppend( choices[ i ] );
 347     }
 348
 349     SetBestSize(csize);   // Needed because it is a wxControlWithItems
 350
 351     return TRUE;
 352 }
 353
 354 wxString wxComboBox::GetValue() const
 355 {
 356     wxString        result;
 357
 358     if ( m_text == NULL )
 359     {
 360         result = m_choice->GetString( m_choice->GetSelection() );
 361     }
 362     else
 363     {
 364         result = m_text->GetValue();
 365     }
 366
 367     return result;
 368 }
 369
 370 int wxComboBox::GetCount() const
 371 {
 372     return m_choice->GetCount() ;
 373 }
 374
 375 void wxComboBox::SetValue(const wxString& value)
 376 {
 377     int s = FindString (value);
 378     if (s == wxNOT_FOUND && !HasFlag(wxCB_READONLY) )
 379     {
 380         m_choice->Append(value) ;
 381     }
 382     SetStringSelection( value ) ;
 383 }
 384
 385 // Clipboard operations
 386 void wxComboBox::Copy()
 387 {
 388     if ( m_text != NULL )
 389     {
 390         m_text->Copy();
 391     }
 392 }
 393
 394 void wxComboBox::Cut()
 395 {
 396     if ( m_text != NULL )
 397     {
 398         m_text->Cut();
 399     }
 400 }
 401
 402 void wxComboBox::Paste()
 403 {
 404     if ( m_text != NULL )
 405     {
 406         m_text->Paste();
 407     }
 408 }
 409
 410 void wxComboBox::SetEditable(bool editable)
 411 {
 412     if ( ( m_text == NULL ) && editable )
 413     {
 414         m_text = new wxComboBoxText( this );
 415     }
 416     else if ( ( m_text != NULL ) && !editable )
 417     {
 418         delete m_text;
 419         m_text = NULL;
 420     }
 421
 422     int currentX, currentY;
 423     GetPosition( &currentX, &currentY );
 424
 425     int currentW, currentH;
 426     GetSize( &currentW, &currentH );
 427
 428     DoMoveWindow( currentX, currentY, currentW, currentH );
 429 }
 430
 431 void wxComboBox::SetInsertionPoint(long pos)
 432 {
 433     // TODO
 434 }
 435
 436 void wxComboBox::SetInsertionPointEnd()
 437 {
 438     // TODO
 439 }
 440
 441 long wxComboBox::GetInsertionPoint() const
 442 {
 443     // TODO
 444     return 0;
 445 }
 446
 447 long wxComboBox::GetLastPosition() const
 448 {
 449     // TODO
 450     return 0;
 451 }
 452
 453 void wxComboBox::Replace(long from, long to, const wxString& value)
 454 {
 455     // TODO
 456 }
 457
 458 void wxComboBox::Remove(long from, long to)
 459 {
 460     // TODO
 461 }
 462
 463 void wxComboBox::SetSelection(long from, long to)
 464 {
 465     // TODO
 466 }
 467
 468 int wxComboBox::DoAppend(const wxString& item)
 469 {
 470     return m_choice->DoAppend( item ) ;
 471 }
 472
 473 int wxComboBox::DoInsert(const wxString& item, int pos)
 474 {
 475     return m_choice->DoInsert( item , pos ) ;
 476 }
 477
 478 void wxComboBox::DoSetItemClientData(int n, void* clientData)
 479 {
 480     return m_choice->DoSetItemClientData( n , clientData ) ;
 481 }
 482
 483 void* wxComboBox::DoGetItemClientData(int n) const
 484 {
 485     return m_choice->DoGetItemClientData( n ) ;
 486 }
 487
 488 void wxComboBox::DoSetItemClientObject(int n, wxClientData* clientData)
 489 {
 490     return m_choice->DoSetItemClientObject( n , clientData ) ;
 491 }
 492
 493 wxClientData* wxComboBox::DoGetItemClientObject(int n) const
 494 {
 495     return m_choice->DoGetItemClientObject( n ) ;
 496 }
 497
 498 void wxComboBox::FreeData()
 499 {
 500     if ( HasClientObjectData() )
 501     {
 502         size_t count = GetCount();
 503         for ( size_t n = 0; n < count; n++ )
 504         {
 505             SetClientObject( n, NULL );
 506         }
 507     }
 508 }
 509
 510 void wxComboBox::Delete(int n)
 511 {
 512     // force client object deletion
 513     if( HasClientObjectData() )
 514         SetClientObject( n, NULL );
 515     m_choice->Delete( n );
 516 }
 517
 518 void wxComboBox::Clear()
 519 {
 520     FreeData();
 521     m_choice->Clear();
 522 }
 523
 524 int wxComboBox::GetSelection() const
 525 {
 526     return m_choice->GetSelection();
 527 }
 528
 529 void wxComboBox::SetSelection(int n)
 530 {
 531     m_choice->SetSelection( n );
 532
 533     if ( m_text != NULL )
 534     {
 535         m_text->SetValue( GetString( n ) );
 536     }
 537 }
 538
 539 int wxComboBox::FindString(const wxString& s) const
 540 {
 541     return m_choice->FindString( s );
 542 }
 543
 544 wxString wxComboBox::GetString(int n) const
 545 {
 546     return m_choice->GetString( n );
 547 }
 548
 549 wxString wxComboBox::GetStringSelection() const
 550 {
 551     int sel = GetSelection ();
 552     if (sel > -1)
 553         return wxString(this->GetString (sel));
 554     else
 555         return wxEmptyString;
 556 }
 557
 558 bool wxComboBox::SetStringSelection(const wxString& sel)
 559 {
 560     int s = FindString (sel);
 561     if (s > -1)
 562         {
 563             SetSelection (s);
 564             return TRUE;
 565         }
 566     else
 567         return FALSE;
 568 }
 569
 570 void wxComboBox::SetString(int n, const wxString& s)
 571 {
 572     m_choice->SetString( n , s ) ;
 573 }
 574
 575
 576 wxInt32 wxComboBox::MacControlHit(WXEVENTHANDLERREF WXUNUSED(handler) , WXEVENTREF WXUNUSED(event) )
 577 {
 578     wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, m_windowId );
 579     event.SetInt(GetSelection());
 580     event.SetEventObject(this);
 581     event.SetString(GetStringSelection());
 582     ProcessCommand(event);
 583     return noErr ;
 584 }
 585