src/univ/combobox.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/univ/combobox.cpp
   3 // Purpose:     wxComboBox implementation
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     15.12.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #if wxUSE_COMBOBOX
  27
  28 #ifndef WX_PRECOMP
  29     #include "wx/log.h"
  30
  31     #include "wx/button.h"
  32     #include "wx/combobox.h"
  33     #include "wx/listbox.h"
  34     #include "wx/textctrl.h"
  35     #include "wx/bmpbuttn.h"
  36
  37     #include "wx/validate.h"
  38 #endif
  39
  40 #include "wx/tooltip.h"
  41 #include "wx/combo.h"
  42
  43 #include "wx/univ/renderer.h"
  44 #include "wx/univ/inphand.h"
  45 #include "wx/univ/theme.h"
  46
  47 // ----------------------------------------------------------------------------
  48 // wxStdComboBoxInputHandler: allows the user to open/close the combo from kbd
  49 // ----------------------------------------------------------------------------
  50
  51 class WXDLLEXPORT wxStdComboBoxInputHandler : public wxStdInputHandler
  52 {
  53 public:
  54     wxStdComboBoxInputHandler(wxInputHandler *inphand);
  55
  56     virtual bool HandleKey(wxInputConsumer *consumer,
  57                            const wxKeyEvent& event,
  58                            bool pressed);
  59 };
  60
  61 // ----------------------------------------------------------------------------
  62 // wxComboListBox is a listbox modified to be used as a popup window in a
  63 // combobox
  64 // ----------------------------------------------------------------------------
  65
  66 class wxComboListBox : public wxListBox, public wxComboPopup
  67 {
  68 public:
  69     // ctor and dtor
  70     wxComboListBox();
  71     virtual ~wxComboListBox();
  72
  73     // implement wxComboPopup methods
  74     virtual bool Create(wxWindow* parent);
  75     virtual void SetStringValue(const wxString& s);
  76     virtual wxString GetStringValue() const;
  77     virtual wxWindow *GetControl() { return this; }
  78     virtual void OnPopup();
  79     virtual wxSize GetAdjustedSize(int minWidth, int prefHeight, int maxHeight);
  80
  81     // fix virtual function hiding
  82     virtual void SetSelection(int n) { DoSetSelection(n, true); }
  83     void SetSelection(int n, bool select) { DoSetSelection(n, select); }
  84
  85     // used to process wxUniv actions
  86     bool PerformAction(const wxControlAction& action,
  87                        long numArg,
  88                        const wxString& strArg);
  89
  90 protected:
  91     // set m_clicked value from here
  92     void OnLeftUp(wxMouseEvent& event);
  93
  94 private:
  95     DECLARE_EVENT_TABLE()
  96 };
  97
  98 // ----------------------------------------------------------------------------
  99 // event tables and such
 100 // ----------------------------------------------------------------------------
 101
 102 BEGIN_EVENT_TABLE(wxComboListBox, wxListBox)
 103     EVT_LEFT_UP(wxComboListBox::OnLeftUp)
 104 END_EVENT_TABLE()
 105
 106 IMPLEMENT_DYNAMIC_CLASS2(wxComboBox, wxControl, wxComboCtrl)
 107
 108 // ============================================================================
 109 // implementation
 110 // ============================================================================
 111
 112 // ----------------------------------------------------------------------------
 113 // wxComboListBox
 114 // ----------------------------------------------------------------------------
 115
 116 wxComboListBox::wxComboListBox() : wxListBox(), wxComboPopup()
 117 {
 118 }
 119
 120 bool wxComboListBox::Create(wxWindow* parent)
 121 {
 122     if ( !wxListBox::Create(parent, wxID_ANY,
 123                             wxDefaultPosition, wxDefaultSize,
 124                             0, NULL,
 125                             wxBORDER_SIMPLE |
 126                             ( m_combo->GetWindowStyle() & wxCB_SORT ? wxLB_SORT : 0 ) ) )
 127         return false;
 128
 129     // we don't react to the mouse events outside the window at all
 130     StopAutoScrolling();
 131
 132     return true;
 133 }
 134
 135 wxComboListBox::~wxComboListBox()
 136 {
 137 }
 138
 139 wxString wxComboListBox::GetStringValue() const
 140 {
 141     return wxListBox::GetStringSelection();
 142 }
 143
 144 void wxComboListBox::SetStringValue(const wxString& value)
 145 {
 146     if ( !value.empty() )
 147     {
 148         if (FindString(value) != wxNOT_FOUND)
 149             wxListBox::SetStringSelection(value);
 150     }
 151     else
 152         wxListBox::SetSelection(-1);
 153 }
 154
 155 void wxComboListBox::OnPopup()
 156 {
 157 }
 158
 159 bool wxComboListBox::PerformAction(const wxControlAction& action,
 160                                    long numArg,
 161                                    const wxString& strArg)
 162
 163 {
 164     if ( action == wxACTION_LISTBOX_FIND )
 165     {
 166         // we don't let the listbox handle this as instead of just using the
 167         // single key presses, as usual, we use the text ctrl value as prefix
 168         // and this is done by wxComboCtrl itself
 169         return true;
 170     }
 171
 172     return wxListBox::PerformAction(action, numArg, strArg);
 173 }
 174
 175 void wxComboListBox::OnLeftUp(wxMouseEvent& event)
 176 {
 177     // we should dismiss the combo now
 178     // first update the combo and close the listbox
 179     Dismiss();
 180     m_combo->SetValue(wxListBox::GetStringSelection());
 181
 182     // next let the user code have the event
 183     wxCommandEvent evt(wxEVT_COMMAND_COMBOBOX_SELECTED,m_combo->GetId());
 184     evt.SetInt(wxListBox::GetSelection());
 185     evt.SetEventObject(m_combo);
 186     m_combo->ProcessEvent(evt);
 187
 188     event.Skip();
 189 }
 190
 191 wxSize wxComboListBox::GetAdjustedSize(int minWidth,
 192                                        int WXUNUSED(prefHeight),
 193                                        int maxHeight)
 194 {
 195     wxSize bestSize = wxListBox::GetBestSize();
 196     return wxSize(wxMax(bestSize.x,minWidth),
 197                   wxMin(bestSize.y,maxHeight));
 198 }
 199
 200 // ----------------------------------------------------------------------------
 201 // wxComboBox
 202 // ----------------------------------------------------------------------------
 203
 204 void wxComboBox::Init()
 205 {
 206     m_lbox = (wxListBox *)NULL;
 207 }
 208
 209 wxComboBox::wxComboBox(wxWindow *parent,
 210                        wxWindowID id,
 211                        const wxString& value,
 212                        const wxPoint& pos,
 213                        const wxSize& size,
 214                        const wxArrayString& choices,
 215                        long style,
 216                        const wxValidator& validator,
 217                        const wxString& name)
 218 {
 219     Init();
 220
 221     Create(parent, id, value, pos, size, choices, style, validator, name);
 222 }
 223
 224 bool wxComboBox::Create(wxWindow *parent,
 225                         wxWindowID id,
 226                         const wxString& value,
 227                         const wxPoint& pos,
 228                         const wxSize& size,
 229                         const wxArrayString& choices,
 230                         long style,
 231                         const wxValidator& validator,
 232                         const wxString& name)
 233 {
 234     wxCArrayString chs(choices);
 235
 236     return Create(parent, id, value, pos, size, chs.GetCount(),
 237                   chs.GetStrings(), style, validator, name);
 238 }
 239
 240 bool wxComboBox::Create(wxWindow *parent,
 241                         wxWindowID id,
 242                         const wxString& value,
 243                         const wxPoint& pos,
 244                         const wxSize& size,
 245                         int n,
 246                         const wxString choices[],
 247                         long style,
 248                         const wxValidator& validator,
 249                         const wxString& name)
 250 {
 251     if ( !wxComboCtrl::Create(parent, id, value, pos, size, style,
 252                                  validator, name) )
 253     {
 254         return false;
 255     }
 256
 257     wxComboListBox *combolbox = new wxComboListBox();
 258     SetPopupControl(combolbox);
 259
 260     m_lbox = combolbox;
 261     m_lbox->Set(n, choices);
 262
 263     return true;
 264 }
 265
 266 wxComboBox::~wxComboBox()
 267 {
 268 }
 269
 270 // ----------------------------------------------------------------------------
 271 // wxComboBox methods forwarded to wxTextCtrl
 272 // ----------------------------------------------------------------------------
 273
 274 wxString wxComboBox::GetValue() const
 275 {
 276     return wxComboCtrl::GetValue();
 277 }
 278
 279 void wxComboBox::SetValue(const wxString& value)
 280 {
 281     wxComboCtrl::SetValue(value);
 282 }
 283
 284 void wxComboBox::Copy()
 285 {
 286     if ( GetTextCtrl() ) GetTextCtrl()->Copy();
 287 }
 288
 289 void wxComboBox::Cut()
 290 {
 291     if ( GetTextCtrl() ) GetTextCtrl()->Cut();
 292 }
 293
 294 void wxComboBox::Paste()
 295 {
 296     if ( GetTextCtrl() ) GetTextCtrl()->Paste();
 297 }
 298
 299 void wxComboBox::SetInsertionPoint(long pos)
 300 {
 301     if ( GetTextCtrl() ) GetTextCtrl()->SetInsertionPoint(pos);
 302 }
 303
 304 void wxComboBox::SetInsertionPointEnd()
 305 {
 306     if ( GetTextCtrl() ) GetTextCtrl()->SetInsertionPointEnd();
 307 }
 308
 309 long wxComboBox::GetInsertionPoint() const
 310 {
 311     if ( GetTextCtrl() )
 312         return GetTextCtrl()->GetInsertionPoint();
 313     return -1;
 314 }
 315
 316 wxTextPos wxComboBox::GetLastPosition() const
 317 {
 318     if ( GetTextCtrl() )
 319         return GetTextCtrl()->GetLastPosition();
 320     return -1;
 321 }
 322
 323 void wxComboBox::Replace(long from, long to, const wxString& value)
 324 {
 325     if ( GetTextCtrl() ) GetTextCtrl()->Replace(from, to, value);
 326 }
 327
 328 void wxComboBox::Remove(long from, long to)
 329 {
 330     if ( GetTextCtrl() ) GetTextCtrl()->Remove(from, to);
 331 }
 332
 333 void wxComboBox::SetSelection(long from, long to)
 334 {
 335     if ( GetTextCtrl() ) GetTextCtrl()->SetSelection(from, to);
 336 }
 337
 338 void wxComboBox::SetEditable(bool editable)
 339 {
 340     if ( GetTextCtrl() ) GetTextCtrl()->SetEditable(editable);
 341 }
 342
 343 // ----------------------------------------------------------------------------
 344 // wxComboBox methods forwarded to wxListBox
 345 // ----------------------------------------------------------------------------
 346
 347 void wxComboBox::Clear()
 348 {
 349     GetLBox()->Clear();
 350     if ( GetTextCtrl() ) GetTextCtrl()->SetValue(wxEmptyString);
 351 }
 352
 353 void wxComboBox::Delete(unsigned int n)
 354 {
 355     wxCHECK_RET( IsValid(n), _T("invalid index in wxComboBox::Delete") );
 356
 357     if (GetSelection() == (int)n)
 358         if ( GetTextCtrl() ) GetTextCtrl()->SetValue(wxEmptyString);
 359
 360     GetLBox()->Delete(n);
 361 }
 362
 363 unsigned int wxComboBox::GetCount() const
 364 {
 365     return GetLBox()->GetCount();
 366 }
 367
 368 wxString wxComboBox::GetString(unsigned int n) const
 369 {
 370     wxCHECK_MSG( IsValid(n), wxEmptyString, _T("invalid index in wxComboBox::GetString") );
 371
 372     return GetLBox()->GetString(n);
 373 }
 374
 375 void wxComboBox::SetString(unsigned int n, const wxString& s)
 376 {
 377     wxCHECK_RET( IsValid(n), _T("invalid index in wxComboBox::SetString") );
 378
 379     GetLBox()->SetString(n, s);
 380 }
 381
 382 int wxComboBox::FindString(const wxString& s, bool bCase) const
 383 {
 384     return GetLBox()->FindString(s, bCase);
 385 }
 386
 387 void wxComboBox::SetSelection(int n)
 388 {
 389     wxCHECK_RET( (n == wxNOT_FOUND || IsValid(n)), _T("invalid index in wxComboBox::Select") );
 390
 391     GetLBox()->SetSelection(n);
 392
 393     SetText(GetLBox()->GetString(n));
 394 }
 395
 396 int wxComboBox::GetSelection() const
 397 {
 398 #if 1 // FIXME:: What is the correct behavior?
 399     // if the current value isn't one of the listbox strings, return -1
 400     return GetLBox()->GetSelection();
 401 #else
 402     // Why oh why is this done this way?
 403     // It is not because the value displayed in the text can be found
 404     // in the list that it is the item that is selected!
 405     return FindString(if ( GetTextCtrl() ) GetTextCtrl()->GetValue());
 406 #endif
 407 }
 408
 409 int wxComboBox::DoAppend(const wxString& item)
 410 {
 411     return GetLBox()->Append(item);
 412 }
 413
 414 int wxComboBox::DoInsert(const wxString& item, unsigned int pos)
 415 {
 416     wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
 417     wxCHECK_MSG(IsValidInsert(pos), -1, wxT("invalid index"));
 418
 419     if (pos == GetCount())
 420         return DoAppend(item);
 421
 422     GetLBox()->Insert(item, pos);
 423     return pos;
 424 }
 425
 426 void wxComboBox::DoSetItemClientData(unsigned int n, void* clientData)
 427 {
 428     GetLBox()->SetClientData(n, clientData);
 429 }
 430
 431 void *wxComboBox::DoGetItemClientData(unsigned int n) const
 432 {
 433     return GetLBox()->GetClientData(n);
 434 }
 435
 436 void wxComboBox::DoSetItemClientObject(unsigned int n, wxClientData* clientData)
 437 {
 438     GetLBox()->SetClientObject(n, clientData);
 439 }
 440
 441 wxClientData* wxComboBox::DoGetItemClientObject(unsigned int n) const
 442 {
 443     return GetLBox()->GetClientObject(n);
 444 }
 445
 446 bool wxComboBox::IsEditable() const
 447 {
 448     return GetTextCtrl() != NULL && (!HasFlag(wxCB_READONLY) || GetTextCtrl()->IsEditable() );
 449 }
 450
 451 void wxComboBox::Undo()
 452 {
 453     if (IsEditable())
 454         if ( GetTextCtrl() ) GetTextCtrl()->Undo();
 455 }
 456
 457 void wxComboBox::Redo()
 458 {
 459     if (IsEditable())
 460         if ( GetTextCtrl() ) GetTextCtrl()->Redo();
 461 }
 462
 463 void wxComboBox::SelectAll()
 464 {
 465     if ( GetTextCtrl() ) GetTextCtrl()->SelectAll();
 466 }
 467
 468 bool wxComboBox::CanCopy() const
 469 {
 470     if (GetTextCtrl() != NULL)
 471         return GetTextCtrl()->CanCopy();
 472     else
 473         return false;
 474 }
 475
 476 bool wxComboBox::CanCut() const
 477 {
 478     if (GetTextCtrl() != NULL)
 479         return GetTextCtrl()->CanCut();
 480     else
 481         return false;
 482 }
 483
 484 bool wxComboBox::CanPaste() const
 485 {
 486     if (IsEditable())
 487         return GetTextCtrl()->CanPaste();
 488     else
 489         return false;
 490 }
 491
 492 bool wxComboBox::CanUndo() const
 493 {
 494     if (IsEditable())
 495         return GetTextCtrl()->CanUndo();
 496     else
 497         return false;
 498 }
 499
 500 bool wxComboBox::CanRedo() const
 501 {
 502     if (IsEditable())
 503         return GetTextCtrl()->CanRedo();
 504     else
 505         return false;
 506 }
 507
 508
 509 // ----------------------------------------------------------------------------
 510 // wxStdComboBoxInputHandler
 511 // ----------------------------------------------------------------------------
 512
 513 wxStdComboBoxInputHandler::wxStdComboBoxInputHandler(wxInputHandler *inphand)
 514                          : wxStdInputHandler(inphand)
 515 {
 516 }
 517
 518 bool wxStdComboBoxInputHandler::HandleKey(wxInputConsumer *consumer,
 519                                           const wxKeyEvent& event,
 520                                           bool pressed)
 521 {
 522     if ( pressed )
 523     {
 524         wxControlAction action;
 525         switch ( event.GetKeyCode() )
 526         {
 527             case WXK_DOWN:
 528                 action = wxACTION_COMBOBOX_POPUP;
 529                 break;
 530
 531             case WXK_ESCAPE:
 532                 action = wxACTION_COMBOBOX_DISMISS;
 533                 break;
 534         }
 535
 536         if ( !action.IsEmpty() )
 537         {
 538             consumer->PerformAction(action);
 539
 540             return true;
 541         }
 542     }
 543
 544     return wxStdInputHandler::HandleKey(consumer, event, pressed);
 545 }
 546
 547 /* static */
 548 wxInputHandler *wxComboBox::GetStdInputHandler(wxInputHandler *handlerDef)
 549 {
 550     static wxStdComboBoxInputHandler s_handler(handlerDef);
 551
 552     return &s_handler;
 553 }
 554
 555 #endif // wxUSE_COMBOBOX