Add start of selection api, support for HasSelection, SelectAll and DeleteSelection...

[wxWidgets.git] / src / common / lboxcmn.cpp

diff --git a/src/common/lboxcmn.cpp b/src/common/lboxcmn.cpp
index dfd4b695644a32f0918198125bb30608e6da5484..ce0cbbb16efd4c07a8f61f11b88ae36579af11c2 100644 (file)
--- a/src/common/lboxcmn.cpp
+++ b/src/common/lboxcmn.cpp
@@ -31,9 +31,10 @@
 #ifndef WX_PRECOMP
     #include "wx/dynarray.h"
     #include "wx/arrstr.h"
 #ifndef WX_PRECOMP
     #include "wx/dynarray.h"
     #include "wx/arrstr.h"

+    #include "wx/log.h"

 #endif
 
 #endif
 

-#include "wx/log.h"
+extern WXDLLEXPORT_DATA(const char) wxListBoxNameStr[] = "listBox";

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -44,6 +45,78 @@ wxListBoxBase::~wxListBoxBase()
     // this destructor is required for Darwin
 }
 
     // this destructor is required for Darwin
 }
 

+// ----------------------------------------------------------------------------
+// XTI
+// ----------------------------------------------------------------------------
+
+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_COMMAND_LISTBOX_SELECTED, wxCommandEvent )
+wxEVENT_PROPERTY( DoubleClick, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // selection
 // ----------------------------------------------------------------------------


@@ -59,6 +132,14 @@ bool wxListBoxBase::SetStringSelection(const wxString& s, bool select)
     return true;
 }
 
     return true;
 }
 

+void wxListBoxBase::SetSelection(int n)
+{
+    if ( !HasMultipleSelection() )
+        DoChangeSingleSelection(n);
+
+    DoSetSelection(n, true);
+}
+

 void wxListBoxBase::DeselectAll(int itemToLeaveSelected)
 {
     if ( HasMultipleSelection() )
 void wxListBoxBase::DeselectAll(int itemToLeaveSelected)
 {
     if ( HasMultipleSelection() )


@@ -86,108 +167,135 @@ void wxListBoxBase::DeselectAll(int itemToLeaveSelected)
 
 void wxListBoxBase::UpdateOldSelections()
 {
 
 void wxListBoxBase::UpdateOldSelections()
 {

+    // 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))
     if (HasFlag(wxLB_MULTIPLE) || HasFlag(wxLB_EXTENDED))

+#endif
+    {

         GetSelections( m_oldSelections );
         GetSelections( m_oldSelections );

+    }

 }
 
 }
 

-static void LBSendEvent( wxCommandEvent &event, wxListBoxBase *listbox, int item )
+bool wxListBoxBase::SendEvent(wxEventType evtType, int item, bool selected)

 {
 {

-    event.SetInt( item );
-    event.SetString( listbox->GetString( item ) );
-    if ( listbox->HasClientObjectData() )
-        event.SetClientObject( listbox->GetClientObject(item) );
-    else if ( listbox->HasClientUntypedData() )
-        event.SetClientData( listbox->GetClientData(item) );
-    listbox->HandleWindowEvent( event );
+    wxCommandEvent event(evtType, GetId());
+    event.SetEventObject(this);
+
+    event.SetInt(item);
+    event.SetString(GetString(item));
+    event.SetExtraLong(selected);
+
+    if ( HasClientObjectData() )
+        event.SetClientObject(GetClientObject(item));
+    else if ( HasClientUntypedData() )
+        event.SetClientData(GetClientData(item));
+
+    return HandleWindowEvent(event);

 }
 
 }
 

-void wxListBoxBase::CalcAndSendEvent()
+bool wxListBoxBase::DoChangeSingleSelection(int item)

 {
 {

-    wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, GetId() );
-    event.SetEventObject( this );
+    // 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;
+    }

 
 

+    m_oldSelections.clear();
+    m_oldSelections.push_back(item);
+
+    return true;
+}
+
+bool wxListBoxBase::CalcAndSendEvent()
+{

     wxArrayInt selections;
     wxArrayInt selections;

-    GetSelections( selections );
-        
-        if ((selections.GetCount() == 0) && (m_oldSelections.GetCount() == 0))
-        {
-            // nothing changed, just leave
-            return;
-        }
-        
-        if (selections.GetCount() == m_oldSelections.GetCount())
+    GetSelections(selections);
+    bool selected = true;
+
+    if ( selections.empty() && m_oldSelections.empty() )
+    {
+        // nothing changed, just leave
+        return false;
+    }
+
+    const size_t countSel = selections.size(),
+                 countSelOld = m_oldSelections.size();
+    if ( countSel == countSelOld )
+    {
+        bool changed = false;
+        for ( size_t idx = 0; idx < countSel; idx++ )

         {
         {

-            bool changed = false;
-            size_t idx;
-            for (idx = 0; idx < selections.GetCount(); idx++)
+            if (selections[idx] != m_oldSelections[idx])

             {
             {

-                if (selections[idx] != m_oldSelections[idx])
-                {
-                    changed = true;
-                    break;
-                }
+                changed = true;
+                break;

             }
             }

-            
-            // nothing changed, just leave
-            if (!changed)
-               return;

         }
 
         }
 

-        if (selections.GetCount() == 0)
-        {
-            // indicate that this is a deselection
-            event.SetExtraLong( 0 );
-            int item = m_oldSelections[0];
-            m_oldSelections = selections;
-            LBSendEvent( event, this, item );
-            return;
-        }
-        
-        int item;
+        // nothing changed, just leave
+        if ( !changed )
+           return false;
+    }
+
+    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;
         // Now test if any new item is selected
         bool any_new_selected = false;

-        size_t idx;
-        for (idx = 0; idx < selections.GetCount(); idx++)
+        for ( size_t idx = 0; idx < countSel; idx++ )

         {
             item = selections[idx];
         {
             item = selections[idx];

-            if (m_oldSelections.Index(item) == wxNOT_FOUND)
+            if ( m_oldSelections.Index(item) == wxNOT_FOUND )

             {
                 any_new_selected = true;
                 break;
             }
         }
             {
                 any_new_selected = true;
                 break;
             }
         }

-        
-        if (any_new_selected)
-        {
-            // indicate that this is a selection
-            event.SetExtraLong( 1 );
-            m_oldSelections = selections;
-            LBSendEvent( event, this, item );
-            return;
-        }
-        
-        // Now test if any new item is deselected
-        bool any_new_deselected = false;
-        for (idx = 0; idx < m_oldSelections.GetCount(); idx++)
+
+        if ( !any_new_selected )

         {
         {

-            item = m_oldSelections[idx];
-            if (selections.Index(item) == wxNOT_FOUND)
+            // 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++ )

             {
             {

-                any_new_deselected = true;
-                break;
+                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

             }
         }
             }
         }

-        
-        if (any_new_deselected)
-        {
-            // indicate that this is a selection
-            event.SetExtraLong( 0 );
-            m_oldSelections = selections;
-            LBSendEvent( event, this, item );
-            return;
-        }
-        
-        wxLogError( wxT("Wrong wxListBox selection") );
+    }
+
+    wxASSERT_MSG( item != wxNOT_FOUND,
+                  "Logic error in wxListBox selection event generation code" );
+
+    m_oldSelections = selections;
+
+    return SendEvent(wxEVT_COMMAND_LISTBOX_SELECTED, item, selected);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -197,7 +305,7 @@ void wxListBoxBase::CalcAndSendEvent()
 void wxListBoxBase::Command(wxCommandEvent& event)
 {
     SetSelection(event.GetInt(), event.GetExtraLong() != 0);
 void wxListBoxBase::Command(wxCommandEvent& event)
 {
     SetSelection(event.GetInt(), event.GetExtraLong() != 0);

-    (void)ProcessEvent(event);
+    (void)GetEventHandler()->ProcessEvent(event);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------