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 // XTI
  49 // ----------------------------------------------------------------------------
  50
  51 wxDEFINE_FLAGS( wxListBoxStyle )
  52 wxBEGIN_FLAGS( wxListBoxStyle )
  53 // new style border flags, we put them first to
  54 // use them for streaming out
  55 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  56 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  57 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  58 wxFLAGS_MEMBER(wxBORDER_RAISED)
  59 wxFLAGS_MEMBER(wxBORDER_STATIC)
  60 wxFLAGS_MEMBER(wxBORDER_NONE)
  61
  62 // old style border flags
  63 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  64 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  65 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  66 wxFLAGS_MEMBER(wxRAISED_BORDER)
  67 wxFLAGS_MEMBER(wxSTATIC_BORDER)
  68 wxFLAGS_MEMBER(wxBORDER)
  69
  70 // standard window styles
  71 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  72 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  73 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
  74 wxFLAGS_MEMBER(wxWANTS_CHARS)
  75 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
  76 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
  77 wxFLAGS_MEMBER(wxVSCROLL)
  78 wxFLAGS_MEMBER(wxHSCROLL)
  79
  80 wxFLAGS_MEMBER(wxLB_SINGLE)
  81 wxFLAGS_MEMBER(wxLB_MULTIPLE)
  82 wxFLAGS_MEMBER(wxLB_EXTENDED)
  83 wxFLAGS_MEMBER(wxLB_HSCROLL)
  84 wxFLAGS_MEMBER(wxLB_ALWAYS_SB)
  85 wxFLAGS_MEMBER(wxLB_NEEDED_SB)
  86 wxFLAGS_MEMBER(wxLB_SORT)
  87 wxEND_FLAGS( wxListBoxStyle )
  88
  89 wxIMPLEMENT_DYNAMIC_CLASS_XTI(wxListBox, wxControl, "wx/listbox.h")
  90
  91 wxBEGIN_PROPERTIES_TABLE(wxListBox)
  92 wxEVENT_PROPERTY( Select, wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent )
  93 wxEVENT_PROPERTY( DoubleClick, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent )
  94
  95 wxPROPERTY( Font, wxFont, SetFont, GetFont , wxEMPTY_PARAMETER_VALUE, 0 /*flags*/, \
  96            wxT("Helpstring"), wxT("group"))
  97 wxPROPERTY_COLLECTION( Choices, wxArrayString, wxString, AppendString, \
  98                       GetStrings, 0 /*flags*/, wxT("Helpstring"), wxT("group") )
  99 wxPROPERTY( Selection, int, SetSelection, GetSelection, wxEMPTY_PARAMETER_VALUE, \
 100            0 /*flags*/, wxT("Helpstring"), wxT("group") )
 101
 102 wxPROPERTY_FLAGS( WindowStyle, wxListBoxStyle, long, SetWindowStyleFlag, \
 103                  GetWindowStyleFlag, wxEMPTY_PARAMETER_VALUE, 0 /*flags*/, \
 104                  wxT("Helpstring"), wxT("group")) // style
 105 wxEND_PROPERTIES_TABLE()
 106
 107 wxEMPTY_HANDLERS_TABLE(wxListBox)
 108
 109 wxCONSTRUCTOR_4( wxListBox, wxWindow*, Parent, wxWindowID, Id, \
 110                 wxPoint, Position, wxSize, Size )
 111
 112 /*
 113  TODO PROPERTIES
 114  selection
 115  content
 116  item
 117  */
 118
 119 // ----------------------------------------------------------------------------
 120 // selection
 121 // ----------------------------------------------------------------------------
 122
 123 bool wxListBoxBase::SetStringSelection(const wxString& s, bool select)
 124 {
 125     const int sel = FindString(s);
 126     if ( sel == wxNOT_FOUND )
 127         return false;
 128
 129     SetSelection(sel, select);
 130
 131     return true;
 132 }
 133
 134 void wxListBoxBase::SetSelection(int n)
 135 {
 136     if ( !HasMultipleSelection() )
 137         DoChangeSingleSelection(n);
 138
 139     DoSetSelection(n, true);
 140 }
 141
 142 void wxListBoxBase::DeselectAll(int itemToLeaveSelected)
 143 {
 144     if ( HasMultipleSelection() )
 145     {
 146         wxArrayInt selections;
 147         GetSelections(selections);
 148
 149         size_t count = selections.GetCount();
 150         for ( size_t n = 0; n < count; n++ )
 151         {
 152             int item = selections[n];
 153             if ( item != itemToLeaveSelected )
 154                 Deselect(item);
 155         }
 156     }
 157     else // single selection
 158     {
 159         int sel = GetSelection();
 160         if ( sel != wxNOT_FOUND && sel != itemToLeaveSelected )
 161         {
 162             Deselect(sel);
 163         }
 164     }
 165 }
 166
 167 void wxListBoxBase::UpdateOldSelections()
 168 {
 169     // We need to remember the selection even in single-selection case on
 170     // Windows, so that we don't send an event when the user clicks on an
 171     // already selected item.
 172 #ifndef __WXMSW__
 173     if (HasFlag(wxLB_MULTIPLE) || HasFlag(wxLB_EXTENDED))
 174 #endif
 175     {
 176         GetSelections( m_oldSelections );
 177     }
 178 }
 179
 180 bool wxListBoxBase::SendEvent(wxEventType evtType, int item, bool selected)
 181 {
 182     wxCommandEvent event(evtType, GetId());
 183     event.SetEventObject(this);
 184
 185     event.SetInt(item);
 186     event.SetString(GetString(item));
 187     event.SetExtraLong(selected);
 188
 189     if ( HasClientObjectData() )
 190         event.SetClientObject(GetClientObject(item));
 191     else if ( HasClientUntypedData() )
 192         event.SetClientData(GetClientData(item));
 193
 194     return HandleWindowEvent(event);
 195 }
 196
 197 bool wxListBoxBase::DoChangeSingleSelection(int item)
 198 {
 199     // As we don't use m_oldSelections in single selection mode, we store the
 200     // last item that we notified the user about in it in this case because we
 201     // need to remember it to be able to filter out the dummy selection changes
 202     // that we get when the user clicks on an already selected item.
 203     if ( !m_oldSelections.empty() && *m_oldSelections.begin() == item )
 204     {
 205         // Same item as the last time.
 206         return false;
 207     }
 208
 209     m_oldSelections.clear();
 210     m_oldSelections.push_back(item);
 211
 212     return true;
 213 }
 214
 215 bool wxListBoxBase::CalcAndSendEvent()
 216 {
 217     wxArrayInt selections;
 218     GetSelections(selections);
 219     bool selected = true;
 220
 221     if ( selections.empty() && m_oldSelections.empty() )
 222     {
 223         // nothing changed, just leave
 224         return false;
 225     }
 226
 227     const size_t countSel = selections.size(),
 228                  countSelOld = m_oldSelections.size();
 229     if ( countSel == countSelOld )
 230     {
 231         bool changed = false;
 232         for ( size_t idx = 0; idx < countSel; idx++ )
 233         {
 234             if (selections[idx] != m_oldSelections[idx])
 235             {
 236                 changed = true;
 237                 break;
 238             }
 239         }
 240
 241         // nothing changed, just leave
 242         if ( !changed )
 243            return false;
 244     }
 245
 246     int item = wxNOT_FOUND;
 247     if ( selections.empty() )
 248     {
 249         selected = false;
 250         item = m_oldSelections[0];
 251     }
 252     else // we [still] have some selections
 253     {
 254         // Now test if any new item is selected
 255         bool any_new_selected = false;
 256         for ( size_t idx = 0; idx < countSel; idx++ )
 257         {
 258             item = selections[idx];
 259             if ( m_oldSelections.Index(item) == wxNOT_FOUND )
 260             {
 261                 any_new_selected = true;
 262                 break;
 263             }
 264         }
 265
 266         if ( !any_new_selected )
 267         {
 268             // No new items selected, now test if any new item is deselected
 269             bool any_new_deselected = false;
 270             for ( size_t idx = 0; idx < countSelOld; idx++ )
 271             {
 272                 item = m_oldSelections[idx];
 273                 if ( selections.Index(item) == wxNOT_FOUND )
 274                 {
 275                     any_new_deselected = true;
 276                     break;
 277                 }
 278             }
 279
 280             if ( any_new_deselected )
 281             {
 282                 // indicate that this is a selection
 283                 selected = false;
 284             }
 285             else
 286             {
 287                 item = wxNOT_FOUND; // this should be impossible
 288             }
 289         }
 290     }
 291
 292     wxASSERT_MSG( item != wxNOT_FOUND,
 293                   "Logic error in wxListBox selection event generation code" );
 294
 295     m_oldSelections = selections;
 296
 297     return SendEvent(wxEVT_COMMAND_LISTBOX_SELECTED, item, selected);
 298 }
 299
 300 // ----------------------------------------------------------------------------
 301 // misc
 302 // ----------------------------------------------------------------------------
 303
 304 void wxListBoxBase::Command(wxCommandEvent& event)
 305 {
 306     SetSelection(event.GetInt(), event.GetExtraLong() != 0);
 307     (void)GetEventHandler()->ProcessEvent(event);
 308 }
 309
 310 // ----------------------------------------------------------------------------
 311 // SetFirstItem() and such
 312 // ----------------------------------------------------------------------------
 313
 314 void wxListBoxBase::SetFirstItem(const wxString& s)
 315 {
 316     int n = FindString(s);
 317
 318     wxCHECK_RET( n != wxNOT_FOUND, wxT("invalid string in wxListBox::SetFirstItem") );
 319
 320     DoSetFirstItem(n);
 321 }
 322
 323 void wxListBoxBase::AppendAndEnsureVisible(const wxString& s)
 324 {
 325     Append(s);
 326     EnsureVisible(GetCount() - 1);
 327 }
 328
 329 void wxListBoxBase::EnsureVisible(int WXUNUSED(n))
 330 {
 331     // the base class version does nothing (the only alternative would be to
 332     // call SetFirstItem() but this is probably even more stupid)
 333 }
 334
 335 #endif // wxUSE_LISTBOX