added a section about Connect(), improve/streamline the one about event tables

[wxWidgets.git] / src / msw / listbox.cpp

diff --git a/src/msw/listbox.cpp b/src/msw/listbox.cpp
index 578f993b1a78713498d28ea7b9e82242bb180770..5a93bc577c3e8e022510a5acafd1469151cec212 100644 (file)
--- a/src/msw/listbox.cpp
+++ b/src/msw/listbox.cpp
@@ -18,23 +18,24 @@
 
 #if wxUSE_LISTBOX
 
 
 #if wxUSE_LISTBOX
 

-#ifndef WX_PRECOMP

 #include "wx/listbox.h"
 #include "wx/listbox.h"

-#include "wx/settings.h"
-#include "wx/brush.h"
-#include "wx/font.h"
-#include "wx/dc.h"
-#include "wx/utils.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/dynarray.h"
+    #include "wx/settings.h"
+    #include "wx/brush.h"
+    #include "wx/font.h"
+    #include "wx/dc.h"
+    #include "wx/utils.h"
+    #include "wx/log.h"
+    #include "wx/window.h"

 #endif
 
 #endif
 

-#include "wx/window.h"

 #include "wx/msw/private.h"
 #include "wx/msw/private.h"

+#include "wx/msw/dc.h"

 
 #include <windowsx.h>
 
 
 #include <windowsx.h>
 

-#include "wx/dynarray.h"
-#include "wx/log.h"
-

 #if wxUSE_OWNER_DRAWN
     #include  "wx/ownerdrw.h"
 #endif
 #if wxUSE_OWNER_DRAWN
     #include  "wx/ownerdrw.h"
 #endif


@@ -80,7 +81,7 @@ wxBEGIN_FLAGS( wxListBoxStyle )
 
 wxEND_FLAGS( wxListBoxStyle )
 
 
 wxEND_FLAGS( wxListBoxStyle )
 

-IMPLEMENT_DYNAMIC_CLASS_XTI(wxListBox, wxControl,"wx/listbox.h")
+IMPLEMENT_DYNAMIC_CLASS_XTI(wxListBox, wxControlWithItems,"wx/listbox.h")

 
 wxBEGIN_PROPERTIES_TABLE(wxListBox)
     wxEVENT_PROPERTY( Select , wxEVT_COMMAND_LISTBOX_SELECTED , wxCommandEvent )
 
 wxBEGIN_PROPERTIES_TABLE(wxListBox)
     wxEVENT_PROPERTY( Select , wxEVT_COMMAND_LISTBOX_SELECTED , wxCommandEvent )


@@ -97,7 +98,7 @@ wxEND_HANDLERS_TABLE()
 
 wxCONSTRUCTOR_4( wxListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
 #else
 
 wxCONSTRUCTOR_4( wxListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
 #else

-IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControlWithItems)

 #endif
 
 /*
 #endif
 
 /*


@@ -177,7 +178,7 @@ bool wxListBox::Create(wxWindow *parent,
     }
 
     // now we can compute our best size correctly, so do it if necessary
     }
 
     // now we can compute our best size correctly, so do it if necessary

-    SetBestSize(size);
+    SetInitialSize(size);

 
     return true;
 }
 
     return true;
 }


@@ -198,7 +199,7 @@ bool wxListBox::Create(wxWindow *parent,
 
 wxListBox::~wxListBox()
 {
 
 wxListBox::~wxListBox()
 {

-    Free();
+    Clear();

 }
 
 WXDWORD wxListBox::MSWGetStyle(long style, WXDWORD *exstyle) const
 }
 
 WXDWORD wxListBox::MSWGetStyle(long style, WXDWORD *exstyle) const


@@ -256,96 +257,15 @@ void wxListBox::DoSetFirstItem(int N)
     SendMessage(GetHwnd(), LB_SETTOPINDEX, (WPARAM)N, (LPARAM)0);
 }
 
     SendMessage(GetHwnd(), LB_SETTOPINDEX, (WPARAM)N, (LPARAM)0);
 }
 

-void wxListBox::Delete(unsigned int n)
+void wxListBox::DoDeleteOneItem(unsigned int n)

 {
     wxCHECK_RET( IsValid(n),
                  wxT("invalid index in wxListBox::Delete") );
 
 {
     wxCHECK_RET( IsValid(n),
                  wxT("invalid index in wxListBox::Delete") );
 

-    // for owner drawn objects, the data is used for storing wxOwnerDrawn
-    // pointers and we shouldn't touch it
-#if !wxUSE_OWNER_DRAWN
-    if ( !(m_windowStyle & wxLB_OWNERDRAW) )
-#endif // !wxUSE_OWNER_DRAWN
-        if ( HasClientObjectData() )
-        {
-            delete GetClientObject(n);
-        }
-

     SendMessage(GetHwnd(), LB_DELETESTRING, n, 0);
     m_noItems--;
 
     SetHorizontalExtent(wxEmptyString);
     SendMessage(GetHwnd(), LB_DELETESTRING, n, 0);
     m_noItems--;
 
     SetHorizontalExtent(wxEmptyString);

-
-    InvalidateBestSize();
-}
-
-int wxListBox::DoAppend(const wxString& item)
-{
-    int index = ListBox_AddString(GetHwnd(), item);
-    m_noItems++;
-
-#if wxUSE_OWNER_DRAWN
-    if ( m_windowStyle & wxLB_OWNERDRAW ) {
-        wxOwnerDrawn *pNewItem = CreateLboxItem(index); // dummy argument
-        pNewItem->SetName(item);
-        m_aItems.Insert(pNewItem, index);
-        ListBox_SetItemData(GetHwnd(), index, pNewItem);
-        pNewItem->SetFont(GetFont());
-    }
-#endif // wxUSE_OWNER_DRAWN
-
-    SetHorizontalExtent(item);
-
-    InvalidateBestSize();
-    return index;
-}
-
-void wxListBox::DoSetItems(const wxArrayString& choices, void** clientData)
-{
-    // avoid flicker - but don't need to do this for a hidden listbox
-    bool hideAndShow = IsShown();
-    if ( hideAndShow )
-    {
-        ShowWindow(GetHwnd(), SW_HIDE);
-    }
-
-    ListBox_ResetContent(GetHwnd());
-
-    m_noItems = choices.GetCount();
-    unsigned int i;
-    for (i = 0; i < m_noItems; i++)
-    {
-        ListBox_AddString(GetHwnd(), choices[i]);
-        if ( clientData )
-        {
-            SetClientData(i, clientData[i]);
-        }
-    }
-
-#if wxUSE_OWNER_DRAWN
-    if ( m_windowStyle & wxLB_OWNERDRAW ) {
-        // first delete old items
-        WX_CLEAR_ARRAY(m_aItems);
-
-        // then create new ones
-        for ( unsigned int ui = 0; ui < m_noItems; ui++ ) {
-            wxOwnerDrawn *pNewItem = CreateLboxItem(ui);
-            pNewItem->SetName(choices[ui]);
-            m_aItems.Add(pNewItem);
-            ListBox_SetItemData(GetHwnd(), ui, pNewItem);
-        }
-    }
-#endif // wxUSE_OWNER_DRAWN
-
-    SetHorizontalExtent();
-
-    if ( hideAndShow )
-    {
-        // show the listbox back if we hid it
-        ShowWindow(GetHwnd(), SW_SHOW);
-    }
-
-    InvalidateBestSize();

 }
 
 int wxListBox::FindString(const wxString& s, bool bCase) const
 }
 
 int wxListBox::FindString(const wxString& s, bool bCase) const


@@ -354,14 +274,14 @@ int wxListBox::FindString(const wxString& s, bool bCase) const
     if (bCase)
        return wxItemContainerImmutable::FindString( s, bCase );
 
     if (bCase)
        return wxItemContainerImmutable::FindString( s, bCase );
 

-    int pos = ListBox_FindStringExact(GetHwnd(), -1, s);
+    int pos = ListBox_FindStringExact(GetHwnd(), -1, s.wx_str());

     if (pos == LB_ERR)
         return wxNOT_FOUND;
     else
         return pos;
 }
 
     if (pos == LB_ERR)
         return wxNOT_FOUND;
     else
         return pos;
 }
 

-void wxListBox::Clear()
+void wxListBox::DoClear()

 {
     Free();
 
 {
     Free();
 


@@ -369,8 +289,6 @@ void wxListBox::Clear()
 
     m_noItems = 0;
     SetHorizontalExtent();
 
     m_noItems = 0;
     SetHorizontalExtent();

-
-    InvalidateBestSize();

 }
 
 void wxListBox::Free()
 }
 
 void wxListBox::Free()


@@ -380,15 +298,7 @@ void wxListBox::Free()
     {
         WX_CLEAR_ARRAY(m_aItems);
     }
     {
         WX_CLEAR_ARRAY(m_aItems);
     }

-    else

 #endif // wxUSE_OWNER_DRAWN
 #endif // wxUSE_OWNER_DRAWN

-    if ( HasClientObjectData() )
-    {
-        for ( unsigned int n = 0; n < m_noItems; n++ )
-        {
-            delete GetClientObject(n);
-        }
-    }

 }
 
 void wxListBox::DoSetSelection(int N, bool select)
 }
 
 void wxListBox::DoSetSelection(int N, bool select)


@@ -414,11 +324,6 @@ bool wxListBox::IsSelected(int N) const
     return SendMessage(GetHwnd(), LB_GETSEL, N, 0) == 0 ? false : true;
 }
 
     return SendMessage(GetHwnd(), LB_GETSEL, N, 0) == 0 ? false : true;
 }
 

-wxClientData* wxListBox::DoGetItemClientObject(unsigned int n) const
-{
-    return (wxClientData *)DoGetItemClientData(n);
-}
-

 void *wxListBox::DoGetItemClientData(unsigned int n) const
 {
     wxCHECK_MSG( IsValid(n), NULL,
 void *wxListBox::DoGetItemClientData(unsigned int n) const
 {
     wxCHECK_MSG( IsValid(n), NULL,


@@ -427,11 +332,6 @@ void *wxListBox::DoGetItemClientData(unsigned int n) const
     return (void *)SendMessage(GetHwnd(), LB_GETITEMDATA, n, 0);
 }
 
     return (void *)SendMessage(GetHwnd(), LB_GETITEMDATA, n, 0);
 }
 

-void wxListBox::DoSetItemClientObject(unsigned int n, wxClientData* clientData)
-{
-    DoSetItemClientData(n, clientData);
-}
-

 void wxListBox::DoSetItemClientData(unsigned int n, void *clientData)
 {
     wxCHECK_RET( IsValid(n),
 void wxListBox::DoSetItemClientData(unsigned int n, void *clientData)
 {
     wxCHECK_RET( IsValid(n),


@@ -518,37 +418,53 @@ wxString wxListBox::GetString(unsigned int n) const
     return result;
 }
 
     return result;
 }
 

-void
-wxListBox::DoInsertItems(const wxArrayString& items, unsigned int pos)
+int wxListBox::DoInsertItems(const wxArrayStringsAdapter & items,
+                             unsigned int pos,
+                             void **clientData,
+                             wxClientDataType type)

 {
 {

-    wxCHECK_RET( IsValidInsert(pos),
-                 wxT("invalid index in wxListBox::InsertItems") );
+    MSWAllocStorage(items, LB_INITSTORAGE);
+
+    const bool append = pos == GetCount();
+
+    // we must use CB_ADDSTRING when appending as only it works correctly for
+    // the sorted controls
+    const unsigned msg = append ? LB_ADDSTRING : LB_INSERTSTRING;

 
 

-    unsigned int nItems = items.GetCount();
-    for ( unsigned int i = 0; i < nItems; i++ )
+    if ( append )
+        pos = 0;
+
+    int n = wxNOT_FOUND;
+
+    const unsigned int numItems = items.GetCount();
+    for ( unsigned int i = 0; i < numItems; i++ )

     {
     {

-        int idx = ListBox_InsertString(GetHwnd(), i + pos, items[i]);
+        n = MSWInsertOrAppendItem(pos, items[i], msg);
+        if ( n == wxNOT_FOUND )
+            return n;
+
+        if ( !append )
+            pos++;
+
+        ++m_noItems;

 
 #if wxUSE_OWNER_DRAWN
 
 #if wxUSE_OWNER_DRAWN

-        if ( m_windowStyle & wxLB_OWNERDRAW )
+        if ( HasFlag(wxLB_OWNERDRAW) )

         {
         {

-            wxOwnerDrawn *pNewItem = CreateLboxItem(idx);
+            wxOwnerDrawn *pNewItem = CreateLboxItem(n);

             pNewItem->SetName(items[i]);
             pNewItem->SetFont(GetFont());
             pNewItem->SetName(items[i]);
             pNewItem->SetFont(GetFont());

-            m_aItems.Insert(pNewItem, idx);
+            m_aItems.Insert(pNewItem, n);

 
 

-            ListBox_SetItemData(GetHwnd(), idx, pNewItem);
+            ListBox_SetItemData(GetHwnd(), n, pNewItem);

         }
         }

-#else
-        wxUnusedVar(idx);

 #endif // wxUSE_OWNER_DRAWN
 #endif // wxUSE_OWNER_DRAWN

+        AssignNewItemClientData(n, clientData, i, type);

     }
 
     }
 

-    m_noItems += nItems;
-

     SetHorizontalExtent();
 
     SetHorizontalExtent();
 

-    InvalidateBestSize();
+    return n;

 }
 
 int wxListBox::DoListHitTest(const wxPoint& point) const
 }
 
 int wxListBox::DoListHitTest(const wxPoint& point) const


@@ -571,9 +487,9 @@ void wxListBox::SetString(unsigned int n, const wxString& s)
 
     void *oldData = NULL;
     wxClientData *oldObjData = NULL;
 
     void *oldData = NULL;
     wxClientData *oldObjData = NULL;

-    if ( m_clientDataItemsType == wxClientData_Void )
+    if ( HasClientUntypedData() )

         oldData = GetClientData(n);
         oldData = GetClientData(n);

-    else if ( m_clientDataItemsType == wxClientData_Object )
+    else if ( HasClientObjectData() )

         oldObjData = GetClientObject(n);
 
     // delete and recreate it
         oldObjData = GetClientObject(n);
 
     // delete and recreate it


@@ -583,7 +499,7 @@ void wxListBox::SetString(unsigned int n, const wxString& s)
     if ( n == (m_noItems - 1) )
         newN = -1;
 
     if ( n == (m_noItems - 1) )
         newN = -1;
 

-    ListBox_InsertString(GetHwnd(), newN, s);
+    ListBox_InsertString(GetHwnd(), newN, s.wx_str());

 
     // restore the client data
     if ( oldData )
 
     // restore the client data
     if ( oldData )


@@ -606,7 +522,7 @@ void wxListBox::SetString(unsigned int n, const wxString& s)
     if ( wasSelected )
         Select(n);
 
     if ( wasSelected )
         Select(n);
 

-    InvalidateBestSize();
+    SetHorizontalExtent();

 }
 
 unsigned int wxListBox::GetCount() const
 }
 
 unsigned int wxListBox::GetCount() const


@@ -615,64 +531,56 @@ unsigned int wxListBox::GetCount() const
 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// helpers
+// size-related stuff

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-// Windows-specific code to set the horizontal extent of the listbox, if
-// necessary. If s is non-NULL, it's used to calculate the horizontal extent.
-// Otherwise, all strings are used.

 void wxListBox::SetHorizontalExtent(const wxString& s)
 {
 void wxListBox::SetHorizontalExtent(const wxString& s)
 {

-    // Only necessary if we want a horizontal scrollbar
-    if (!(m_windowStyle & wxHSCROLL))
+    // in any case, our best size could have changed
+    InvalidateBestSize();
+
+    // the rest is only necessary if we want a horizontal scrollbar
+    if ( !HasFlag(wxHSCROLL) )

         return;
         return;

-    TEXTMETRIC lpTextMetric;

 
 

-    if ( !s.empty() )
-    {
-        int existingExtent = (int)SendMessage(GetHwnd(), LB_GETHORIZONTALEXTENT, 0, 0L);
-        HDC dc = GetWindowDC(GetHwnd());
-        HFONT oldFont = 0;
-        if (GetFont().Ok() && GetFont().GetResourceHandle() != 0)
-            oldFont = (HFONT) ::SelectObject(dc, (HFONT) GetFont().GetResourceHandle());
-
-        GetTextMetrics(dc, &lpTextMetric);
-        SIZE extentXY;
-        ::GetTextExtentPoint32(dc, (LPTSTR) (const wxChar *)s, s.length(), &extentXY);
-        int extentX = (int)(extentXY.cx + lpTextMetric.tmAveCharWidth);

 
 

-        if (oldFont)
-            ::SelectObject(dc, oldFont);
+    WindowHDC dc(GetHwnd());
+    SelectInHDC selFont(dc, GetHfontOf(GetFont()));

 
 

-        ReleaseDC(GetHwnd(), dc);
-        if (extentX > existingExtent)
-            SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT, LOWORD(extentX), 0L);
-    }
-    else
-    {
-        int largestExtent = 0;
-        HDC dc = GetWindowDC(GetHwnd());
-        HFONT oldFont = 0;
-        if (GetFont().Ok() && GetFont().GetResourceHandle() != 0)
-            oldFont = (HFONT) ::SelectObject(dc, (HFONT) GetFont().GetResourceHandle());
+    TEXTMETRIC lpTextMetric;
+    ::GetTextMetrics(dc, &lpTextMetric);

 
 

-        GetTextMetrics(dc, &lpTextMetric);
+    int largestExtent = 0;
+    SIZE extentXY;

 
 

-        for (unsigned int i = 0; i < m_noItems; i++)
+    if ( s.empty() )
+    {
+        // set extent to the max length of all strings
+        for ( unsigned int i = 0; i < m_noItems; i++ )

         {
         {

-            wxString str = GetString(i);
-            SIZE extentXY;
+            const wxString str = GetString(i);

             ::GetTextExtentPoint32(dc, str.c_str(), str.length(), &extentXY);
             ::GetTextExtentPoint32(dc, str.c_str(), str.length(), &extentXY);

+

             int extentX = (int)(extentXY.cx + lpTextMetric.tmAveCharWidth);
             int extentX = (int)(extentXY.cx + lpTextMetric.tmAveCharWidth);

-            if (extentX > largestExtent)
+            if ( extentX > largestExtent )

                 largestExtent = extentX;
         }
                 largestExtent = extentX;
         }

-        if (oldFont)
-            ::SelectObject(dc, oldFont);
+    }
+    else // just increase the extent to the length of this string
+    {
+        int existingExtent = (int)SendMessage(GetHwnd(),
+                                              LB_GETHORIZONTALEXTENT, 0, 0L);

 
 

-        ReleaseDC(GetHwnd(), dc);
-        SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT, LOWORD(largestExtent), 0L);
+        ::GetTextExtentPoint32(dc, s.c_str(), s.length(), &extentXY);
+
+        int extentX = (int)(extentXY.cx + lpTextMetric.tmAveCharWidth);
+        if ( extentX > existingExtent )
+            largestExtent = extentX;

     }
     }

+
+    if ( largestExtent )
+        SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT, LOWORD(largestExtent), 0L);
+    //else: it shouldn't change

 }
 
 wxSize wxListBox::DoGetBestSize() const
 }
 
 wxSize wxListBox::DoGetBestSize() const


@@ -751,7 +659,7 @@ bool wxListBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 
     event.SetInt(n);
 
 
     event.SetInt(n);
 

-    return GetEventHandler()->ProcessEvent(event);
+    return HandleWindowEvent(event);

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


@@ -815,7 +723,7 @@ bool wxListBox::MSWOnDraw(WXDRAWITEMSTRUCT *item)
     if ( itemID == (UINT)-1 )
         return false;
 
     if ( itemID == (UINT)-1 )
         return false;
 

-    long data = ListBox_GetItemData(GetHwnd(), pStruct->itemID);
+    LRESULT data = ListBox_GetItemData(GetHwnd(), pStruct->itemID);

 
     wxCHECK( data && (data != LB_ERR), false );
 
 
     wxCHECK( data && (data != LB_ERR), false );