///////////////////////////////////////////////////////////////////////////////
-// Name: common/lboxcmn.cpp
+// Name: src/common/lboxcmn.cpp
// Purpose: wxListBox class methods common to all platforms
// Author: Vadim Zeitlin
// Modified by:
// Created: 22.10.99
-// RCS-ID: $Id$
-// Copyright: (c) wxWindows team
-// Licence: wxWindows licence
+// Copyright: (c) wxWidgets team
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "listboxbase.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
+#if wxUSE_LISTBOX
+
+#include "wx/listbox.h"
+
#ifndef WX_PRECOMP
- #include "wx/listbox.h"
+ #include "wx/dynarray.h"
+ #include "wx/arrstr.h"
+ #include "wx/log.h"
#endif
+extern WXDLLEXPORT_DATA(const char) wxListBoxNameStr[] = "listBox";
+
// ============================================================================
// implementation
// ============================================================================
+wxListBoxBase::~wxListBoxBase()
+{
+ // this destructor is required for Darwin
+}
+
// ----------------------------------------------------------------------------
-// adding items
+// XTI
// ----------------------------------------------------------------------------
-void wxListBoxBase::InsertItems(int nItems, const wxString *items, int pos)
+wxDEFINE_FLAGS( wxListBoxStyle )
+wxBEGIN_FLAGS( wxListBoxStyle )
+// new style border flags, we put them first to
+// use them for streaming out
+wxFLAGS_MEMBER(wxBORDER_SIMPLE)
+wxFLAGS_MEMBER(wxBORDER_SUNKEN)
+wxFLAGS_MEMBER(wxBORDER_DOUBLE)
+wxFLAGS_MEMBER(wxBORDER_RAISED)
+wxFLAGS_MEMBER(wxBORDER_STATIC)
+wxFLAGS_MEMBER(wxBORDER_NONE)
+
+// old style border flags
+wxFLAGS_MEMBER(wxSIMPLE_BORDER)
+wxFLAGS_MEMBER(wxSUNKEN_BORDER)
+wxFLAGS_MEMBER(wxDOUBLE_BORDER)
+wxFLAGS_MEMBER(wxRAISED_BORDER)
+wxFLAGS_MEMBER(wxSTATIC_BORDER)
+wxFLAGS_MEMBER(wxBORDER)
+
+// standard window styles
+wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
+wxFLAGS_MEMBER(wxCLIP_CHILDREN)
+wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
+wxFLAGS_MEMBER(wxWANTS_CHARS)
+wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
+wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
+wxFLAGS_MEMBER(wxVSCROLL)
+wxFLAGS_MEMBER(wxHSCROLL)
+
+wxFLAGS_MEMBER(wxLB_SINGLE)
+wxFLAGS_MEMBER(wxLB_MULTIPLE)
+wxFLAGS_MEMBER(wxLB_EXTENDED)
+wxFLAGS_MEMBER(wxLB_HSCROLL)
+wxFLAGS_MEMBER(wxLB_ALWAYS_SB)
+wxFLAGS_MEMBER(wxLB_NEEDED_SB)
+wxFLAGS_MEMBER(wxLB_SORT)
+wxEND_FLAGS( wxListBoxStyle )
+
+wxIMPLEMENT_DYNAMIC_CLASS_XTI(wxListBox, wxControl, "wx/listbox.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxListBox)
+wxEVENT_PROPERTY( Select, wxEVT_LISTBOX, wxCommandEvent )
+wxEVENT_PROPERTY( DoubleClick, wxEVT_LISTBOX_DCLICK, wxCommandEvent )
+
+wxPROPERTY( Font, wxFont, SetFont, GetFont , wxEMPTY_PARAMETER_VALUE, 0 /*flags*/, \
+ wxT("Helpstring"), wxT("group"))
+wxPROPERTY_COLLECTION( Choices, wxArrayString, wxString, AppendString, \
+ GetStrings, 0 /*flags*/, wxT("Helpstring"), wxT("group") )
+wxPROPERTY( Selection, int, SetSelection, GetSelection, wxEMPTY_PARAMETER_VALUE, \
+ 0 /*flags*/, wxT("Helpstring"), wxT("group") )
+
+wxPROPERTY_FLAGS( WindowStyle, wxListBoxStyle, long, SetWindowStyleFlag, \
+ GetWindowStyleFlag, wxEMPTY_PARAMETER_VALUE, 0 /*flags*/, \
+ wxT("Helpstring"), wxT("group")) // style
+wxEND_PROPERTIES_TABLE()
+
+wxEMPTY_HANDLERS_TABLE(wxListBox)
+
+wxCONSTRUCTOR_4( wxListBox, wxWindow*, Parent, wxWindowID, Id, \
+ wxPoint, Position, wxSize, Size )
+
+/*
+ TODO PROPERTIES
+ selection
+ content
+ item
+ */
+
+// ----------------------------------------------------------------------------
+// selection
+// ----------------------------------------------------------------------------
+
+bool wxListBoxBase::SetStringSelection(const wxString& s, bool select)
{
- wxArrayString aItems;
- for ( int n = 0; n < nItems; n++ )
- {
- aItems.Add(items[n]);
- }
+ const int sel = FindString(s);
+ if ( sel == wxNOT_FOUND )
+ return false;
- DoInsertItems(aItems, pos);
+ SetSelection(sel, select);
+
+ return true;
}
+void wxListBoxBase::SetSelection(int n)
+{
+ if ( !HasMultipleSelection() )
+ DoChangeSingleSelection(n);
+
+ DoSetSelection(n, true);
+}
-void wxListBoxBase::Set(int nItems, const wxString* items, void **clientData)
+void wxListBoxBase::DeselectAll(int itemToLeaveSelected)
{
- wxArrayString aItems;
- for ( int n = 0; n < nItems; n++ )
+ if ( HasMultipleSelection() )
{
- aItems.Add(items[n]);
+ wxArrayInt selections;
+ GetSelections(selections);
+
+ size_t count = selections.GetCount();
+ for ( size_t n = 0; n < count; n++ )
+ {
+ int item = selections[n];
+ if ( item != itemToLeaveSelected )
+ Deselect(item);
+ }
+ }
+ else // single selection
+ {
+ int sel = GetSelection();
+ if ( sel != wxNOT_FOUND && sel != itemToLeaveSelected )
+ {
+ Deselect(sel);
+ }
}
-
- DoSetItems(aItems, clientData);
}
-// ----------------------------------------------------------------------------
-// selection
-// ----------------------------------------------------------------------------
-
-wxString wxListBoxBase::GetStringSelection () const
+void wxListBoxBase::UpdateOldSelections()
{
- wxString s;
- int sel = GetSelection();
- if ( sel != -1 )
- s = GetString(sel);
+ // When the control becomes empty, any previously remembered selections are
+ // invalid anyhow, so just forget them.
+ if ( IsEmpty() )
+ {
+ m_oldSelections.clear();
+ return;
+ }
- return s;
+ // We need to remember the selection even in single-selection case on
+ // Windows, so that we don't send an event when the user clicks on an
+ // already selected item.
+#ifndef __WXMSW__
+ if (HasFlag(wxLB_MULTIPLE) || HasFlag(wxLB_EXTENDED))
+#endif
+ {
+ GetSelections( m_oldSelections );
+ }
}
-bool wxListBoxBase::SetStringSelection(const wxString& s, bool select)
+bool wxListBoxBase::SendEvent(wxEventType evtType, int item, bool selected)
{
- int sel = FindString(s);
- wxCHECK_MSG( sel != -1, FALSE,
- wxT("invalid string in wxListBox::SetStringSelection") );
+ wxCommandEvent event(evtType, GetId());
+ event.SetEventObject(this);
- SetSelection(sel, select);
+ event.SetInt(item);
+ event.SetString(GetString(item));
+ event.SetExtraLong(selected);
- return TRUE;
-}
+ if ( HasClientObjectData() )
+ event.SetClientObject(GetClientObject(item));
+ else if ( HasClientUntypedData() )
+ event.SetClientData(GetClientData(item));
-// ----------------------------------------------------------------------------
-// client data
-// ----------------------------------------------------------------------------
+ return HandleWindowEvent(event);
+}
-void wxListBoxBase::SetClientObject(int n, wxClientData *data)
+bool wxListBoxBase::DoChangeSingleSelection(int item)
{
- wxASSERT_MSG( m_clientDataItemsType != ClientData_Void,
- wxT("can't have both object and void client data") );
+ // As we don't use m_oldSelections in single selection mode, we store the
+ // last item that we notified the user about in it in this case because we
+ // need to remember it to be able to filter out the dummy selection changes
+ // that we get when the user clicks on an already selected item.
+ if ( !m_oldSelections.empty() && *m_oldSelections.begin() == item )
+ {
+ // Same item as the last time.
+ return false;
+ }
- wxClientData *clientDataOld = DoGetClientObject(n);
- if ( clientDataOld )
- delete clientDataOld;
+ m_oldSelections.clear();
+ m_oldSelections.push_back(item);
- DoSetClientObject(n, data);
- m_clientDataItemsType = ClientData_Object;
+ return true;
}
-wxClientData *wxListBoxBase::GetClientObject(int n) const
+bool wxListBoxBase::CalcAndSendEvent()
{
- wxASSERT_MSG( m_clientDataItemsType == ClientData_Object,
- wxT("this window doesn't have object client data") );
+ wxArrayInt selections;
+ GetSelections(selections);
+ bool selected = true;
- return DoGetClientObject(n);
-}
+ if ( selections.empty() && m_oldSelections.empty() )
+ {
+ // nothing changed, just leave
+ return false;
+ }
-void wxListBoxBase::SetClientData(int n, void *data)
-{
- wxASSERT_MSG( m_clientDataItemsType != ClientData_Object,
- wxT("can't have both object and void client data") );
+ const size_t countSel = selections.size(),
+ countSelOld = m_oldSelections.size();
+ if ( countSel == countSelOld )
+ {
+ bool changed = false;
+ for ( size_t idx = 0; idx < countSel; idx++ )
+ {
+ if (selections[idx] != m_oldSelections[idx])
+ {
+ changed = true;
+ break;
+ }
+ }
+
+ // nothing changed, just leave
+ if ( !changed )
+ return false;
+ }
- DoSetClientData(n, data);
- m_clientDataItemsType = ClientData_Void;
-}
+ int item = wxNOT_FOUND;
+ if ( selections.empty() )
+ {
+ selected = false;
+ item = m_oldSelections[0];
+ }
+ else // we [still] have some selections
+ {
+ // Now test if any new item is selected
+ bool any_new_selected = false;
+ for ( size_t idx = 0; idx < countSel; idx++ )
+ {
+ item = selections[idx];
+ if ( m_oldSelections.Index(item) == wxNOT_FOUND )
+ {
+ any_new_selected = true;
+ break;
+ }
+ }
+
+ if ( !any_new_selected )
+ {
+ // No new items selected, now test if any new item is deselected
+ bool any_new_deselected = false;
+ for ( size_t idx = 0; idx < countSelOld; idx++ )
+ {
+ item = m_oldSelections[idx];
+ if ( selections.Index(item) == wxNOT_FOUND )
+ {
+ any_new_deselected = true;
+ break;
+ }
+ }
+
+ if ( any_new_deselected )
+ {
+ // indicate that this is a selection
+ selected = false;
+ }
+ else
+ {
+ item = wxNOT_FOUND; // this should be impossible
+ }
+ }
+ }
-void *wxListBoxBase::GetClientData(int n) const
-{
- wxASSERT_MSG( m_clientDataItemsType == ClientData_Void,
- wxT("this window doesn't have void client data") );
+ wxASSERT_MSG( item != wxNOT_FOUND,
+ "Logic error in wxListBox selection event generation code" );
+
+ m_oldSelections = selections;
- return DoGetClientData(n);
+ return SendEvent(wxEVT_LISTBOX, item, selected);
}
// ----------------------------------------------------------------------------
// misc
// ----------------------------------------------------------------------------
+void wxListBoxBase::Command(wxCommandEvent& event)
+{
+ SetSelection(event.GetInt(), event.GetExtraLong() != 0);
+ (void)GetEventHandler()->ProcessEvent(event);
+}
+
+// ----------------------------------------------------------------------------
+// SetFirstItem() and such
+// ----------------------------------------------------------------------------
+
void wxListBoxBase::SetFirstItem(const wxString& s)
{
int n = FindString(s);
- wxCHECK_RET( n != -1, wxT("invalid string in wxListBox::SetFirstItem") );
+ wxCHECK_RET( n != wxNOT_FOUND, wxT("invalid string in wxListBox::SetFirstItem") );
DoSetFirstItem(n);
}
-void wxListBoxBase::Command(wxCommandEvent & event)
+void wxListBoxBase::AppendAndEnsureVisible(const wxString& s)
+{
+ Append(s);
+ EnsureVisible(GetCount() - 1);
+}
+
+void wxListBoxBase::EnsureVisible(int WXUNUSED(n))
{
- SetSelection(event.m_commandInt, event.m_extraLong);
- (void)ProcessEvent(event);
+ // the base class version does nothing (the only alternative would be to
+ // call SetFirstItem() but this is probably even more stupid)
}
+#endif // wxUSE_LISTBOX
projects / wxWidgets.git / blobdiff