src/common/lboxcmn.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/lboxcmn.cpp
   3 // Purpose:     wxListBox class methods common to all platforms
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     22.10.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWidgets team
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_LISTBOX
  28
  29 #include "wx/listbox.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/dynarray.h"
  33     #include "wx/arrstr.h"
  34 #endif
  35
  36 #include "wx/log.h"
  37
  38 // ============================================================================
  39 // implementation
  40 // ============================================================================
  41
  42 wxListBoxBase::~wxListBoxBase()
  43 {
  44     // this destructor is required for Darwin
  45 }
  46
  47 // ----------------------------------------------------------------------------
  48 // selection
  49 // ----------------------------------------------------------------------------
  50
  51 bool wxListBoxBase::SetStringSelection(const wxString& s, bool select)
  52 {
  53     const int sel = FindString(s);
  54     if ( sel == wxNOT_FOUND )
  55         return false;
  56
  57     SetSelection(sel, select);
  58
  59     return true;
  60 }
  61
  62 void wxListBoxBase::DeselectAll(int itemToLeaveSelected)
  63 {
  64     if ( HasMultipleSelection() )
  65     {
  66         wxArrayInt selections;
  67         GetSelections(selections);
  68
  69         size_t count = selections.GetCount();
  70         for ( size_t n = 0; n < count; n++ )
  71         {
  72             int item = selections[n];
  73             if ( item != itemToLeaveSelected )
  74                 Deselect(item);
  75         }
  76     }
  77     else // single selection
  78     {
  79         int sel = GetSelection();
  80         if ( sel != wxNOT_FOUND && sel != itemToLeaveSelected )
  81         {
  82             Deselect(sel);
  83         }
  84     }
  85 }
  86
  87 void wxListBoxBase::UpdateOldSelections()
  88 {
  89     if (HasFlag(wxLB_MULTIPLE) || HasFlag(wxLB_EXTENDED))
  90         GetSelections( m_oldSelections );
  91 }
  92
  93 static void LBSendEvent( wxCommandEvent &event, wxListBoxBase *listbox, int item )
  94 {
  95     event.SetInt( item );
  96     event.SetString( listbox->GetString( item ) );
  97     if ( listbox->HasClientObjectData() )
  98         event.SetClientObject( listbox->GetClientObject(item) );
  99     else if ( listbox->HasClientUntypedData() )
 100         event.SetClientData( listbox->GetClientData(item) );
 101     listbox->HandleWindowEvent( event );
 102 }
 103
 104 void wxListBoxBase::CalcAndSendEvent()
 105 {
 106     wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, GetId());
 107     event.SetEventObject( this );
 108
 109     wxArrayInt selections;
 110     GetSelections(selections);
 111
 112     if ( selections.empty() && m_oldSelections.empty() )
 113     {
 114         // nothing changed, just leave
 115         return;
 116     }
 117
 118     const size_t countSel = selections.size(),
 119                  countSelOld = m_oldSelections.size();
 120     if ( countSel == countSelOld )
 121     {
 122         bool changed = false;
 123         for ( size_t idx = 0; idx < countSel; idx++ )
 124         {
 125             if (selections[idx] != m_oldSelections[idx])
 126             {
 127                 changed = true;
 128                 break;
 129             }
 130         }
 131
 132         // nothing changed, just leave
 133         if ( !changed )
 134            return;
 135     }
 136
 137     int item = wxNOT_FOUND;
 138     if ( selections.empty() )
 139     {
 140         // indicate that this is a deselection
 141         event.SetExtraLong(0);
 142         item = m_oldSelections[0];
 143     }
 144     else // we [still] have some selections
 145     {
 146         // Now test if any new item is selected
 147         bool any_new_selected = false;
 148         for ( size_t idx = 0; idx < countSel; idx++ )
 149         {
 150             item = selections[idx];
 151             if ( m_oldSelections.Index(item) == wxNOT_FOUND )
 152             {
 153                 any_new_selected = true;
 154                 break;
 155             }
 156         }
 157
 158         if ( any_new_selected )
 159         {
 160             // indicate that this is a selection
 161             event.SetExtraLong(1);
 162         }
 163         else // no new items selected
 164         {
 165             // Now test if any new item is deselected
 166             bool any_new_deselected = false;
 167             for ( size_t idx = 0; idx < countSelOld; idx++ )
 168             {
 169                 item = m_oldSelections[idx];
 170                 if ( selections.Index(item) == wxNOT_FOUND )
 171                 {
 172                     any_new_deselected = true;
 173                     break;
 174                 }
 175             }
 176
 177             if ( any_new_deselected )
 178             {
 179                 // indicate that this is a selection
 180                 event.SetExtraLong(0);
 181             }
 182             else
 183             {
 184                 item = wxNOT_FOUND; // this should be impossible
 185             }
 186         }
 187     }
 188
 189     wxASSERT_MSG( item != wxNOT_FOUND,
 190                   "Logic error in wxListBox selection event generation code" );
 191
 192     m_oldSelections = selections;
 193
 194     LBSendEvent(event, this, item);
 195 }
 196
 197 // ----------------------------------------------------------------------------
 198 // misc
 199 // ----------------------------------------------------------------------------
 200
 201 void wxListBoxBase::Command(wxCommandEvent& event)
 202 {
 203     SetSelection(event.GetInt(), event.GetExtraLong() != 0);
 204     (void)GetEventHandler()->ProcessEvent(event);
 205 }
 206
 207 // ----------------------------------------------------------------------------
 208 // SetFirstItem() and such
 209 // ----------------------------------------------------------------------------
 210
 211 void wxListBoxBase::SetFirstItem(const wxString& s)
 212 {
 213     int n = FindString(s);
 214
 215     wxCHECK_RET( n != wxNOT_FOUND, wxT("invalid string in wxListBox::SetFirstItem") );
 216
 217     DoSetFirstItem(n);
 218 }
 219
 220 void wxListBoxBase::AppendAndEnsureVisible(const wxString& s)
 221 {
 222     Append(s);
 223     EnsureVisible(GetCount() - 1);
 224 }
 225
 226 void wxListBoxBase::EnsureVisible(int WXUNUSED(n))
 227 {
 228     // the base class version does nothing (the only alternative would be to
 229     // call SetFirstItem() but this is probably even more stupid)
 230 }
 231
 232 #endif // wxUSE_LISTBOX