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