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     // We need to remember the selection even in single-selection case on
 171     // Windows, so that we don't send an event when the user clicks on an
 172     // already selected item.
 173 #ifndef __WXMSW__
 174     if (HasFlag(wxLB_MULTIPLE) || HasFlag(wxLB_EXTENDED))
 175 #endif
 176     {
 177         GetSelections( m_oldSelections );
 178     }
 179 }
 180
 181 bool wxListBoxBase::SendEvent(wxEventType evtType, int item, bool selected)
 182 {
 183     wxCommandEvent event(evtType, GetId());
 184     event.SetEventObject(this);
 185
 186     event.SetInt(item);
 187     event.SetString(GetString(item));
 188     event.SetExtraLong(selected);
 189
 190     if ( HasClientObjectData() )
 191         event.SetClientObject(GetClientObject(item));
 192     else if ( HasClientUntypedData() )
 193         event.SetClientData(GetClientData(item));
 194
 195     return HandleWindowEvent(event);
 196 }
 197
 198 bool wxListBoxBase::DoChangeSingleSelection(int item)
 199 {
 200     // As we don't use m_oldSelections in single selection mode, we store the
 201     // last item that we notified the user about in it in this case because we
 202     // need to remember it to be able to filter out the dummy selection changes
 203     // that we get when the user clicks on an already selected item.
 204     if ( !m_oldSelections.empty() && *m_oldSelections.begin() == item )
 205     {
 206         // Same item as the last time.
 207         return false;
 208     }
 209
 210     m_oldSelections.clear();
 211     m_oldSelections.push_back(item);
 212
 213     return true;
 214 }
 215
 216 bool wxListBoxBase::CalcAndSendEvent()
 217 {
 218     wxArrayInt selections;
 219     GetSelections(selections);
 220     bool selected = true;
 221
 222     if ( selections.empty() && m_oldSelections.empty() )
 223     {
 224         // nothing changed, just leave
 225         return false;
 226     }
 227
 228     const size_t countSel = selections.size(),
 229                  countSelOld = m_oldSelections.size();
 230     if ( countSel == countSelOld )
 231     {
 232         bool changed = false;
 233         for ( size_t idx = 0; idx < countSel; idx++ )
 234         {
 235             if (selections[idx] != m_oldSelections[idx])
 236             {
 237                 changed = true;
 238                 break;
 239             }
 240         }
 241
 242         // nothing changed, just leave
 243         if ( !changed )
 244            return false;
 245     }
 246
 247     int item = wxNOT_FOUND;
 248     if ( selections.empty() )
 249     {
 250         selected = false;
 251         item = m_oldSelections[0];
 252     }
 253     else // we [still] have some selections
 254     {
 255         // Now test if any new item is selected
 256         bool any_new_selected = false;
 257         for ( size_t idx = 0; idx < countSel; idx++ )
 258         {
 259             item = selections[idx];
 260             if ( m_oldSelections.Index(item) == wxNOT_FOUND )
 261             {
 262                 any_new_selected = true;
 263                 break;
 264             }
 265         }
 266
 267         if ( !any_new_selected )
 268         {
 269             // No new items selected, now test if any new item is deselected
 270             bool any_new_deselected = false;
 271             for ( size_t idx = 0; idx < countSelOld; idx++ )
 272             {
 273                 item = m_oldSelections[idx];
 274                 if ( selections.Index(item) == wxNOT_FOUND )
 275                 {
 276                     any_new_deselected = true;
 277                     break;
 278                 }
 279             }
 280
 281             if ( any_new_deselected )
 282             {
 283                 // indicate that this is a selection
 284                 selected = false;
 285             }
 286             else
 287             {
 288                 item = wxNOT_FOUND; // this should be impossible
 289             }
 290         }
 291     }
 292
 293     wxASSERT_MSG( item != wxNOT_FOUND,
 294                   "Logic error in wxListBox selection event generation code" );
 295
 296     m_oldSelections = selections;
 297
 298     return SendEvent(wxEVT_COMMAND_LISTBOX_SELECTED, item, selected);
 299 }
 300
 301 // ----------------------------------------------------------------------------
 302 // misc
 303 // ----------------------------------------------------------------------------
 304
 305 void wxListBoxBase::Command(wxCommandEvent& event)
 306 {
 307     SetSelection(event.GetInt(), event.GetExtraLong() != 0);
 308     (void)GetEventHandler()->ProcessEvent(event);
 309 }
 310
 311 // ----------------------------------------------------------------------------
 312 // SetFirstItem() and such
 313 // ----------------------------------------------------------------------------
 314
 315 void wxListBoxBase::SetFirstItem(const wxString& s)
 316 {
 317     int n = FindString(s);
 318
 319     wxCHECK_RET( n != wxNOT_FOUND, wxT("invalid string in wxListBox::SetFirstItem") );
 320
 321     DoSetFirstItem(n);
 322 }
 323
 324 void wxListBoxBase::AppendAndEnsureVisible(const wxString& s)
 325 {
 326     Append(s);
 327     EnsureVisible(GetCount() - 1);
 328 }
 329
 330 void wxListBoxBase::EnsureVisible(int WXUNUSED(n))
 331 {
 332     // the base class version does nothing (the only alternative would be to
 333     // call SetFirstItem() but this is probably even more stupid)
 334 }
 335
 336 #endif // wxUSE_LISTBOX