X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5ea4780630b335a1b8b2d3a94c0b82e46f4c56f6..d0166913d81bcf0b3e47ea2406dfbc9da672e566:/src/msw/listctrl.cpp diff --git a/src/msw/listctrl.cpp b/src/msw/listctrl.cpp index 811fadec21..6b4a882131 100644 --- a/src/msw/listctrl.cpp +++ b/src/msw/listctrl.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: listctrl.cpp +// Name: src/msw/listctrl.cpp // Purpose: wxListCtrl // Author: Julian Smart // Modified by: @@ -19,6 +19,7 @@ #ifdef __GNUG__ #pragma implementation "listctrl.h" + #pragma implementation "listctrlbase.h" #endif // For compilers that support precompilation, includes "wx.h". @@ -28,38 +29,142 @@ #pragma hdrstop #endif +#if wxUSE_LISTCTRL && defined(__WIN95__) + #ifndef WX_PRECOMP - #include "wx/wx.h" + #include "wx/app.h" + #include "wx/intl.h" + #include "wx/log.h" + #include "wx/settings.h" #endif -#ifdef __WIN95__ - +#include "wx/textctrl.h" +#include "wx/imaglist.h" #include "wx/listctrl.h" -#include "wx/log.h" +#include "wx/dcclient.h" #include "wx/msw/private.h" -#ifdef __GNUWIN32__ +#if ((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__)) #include "wx/msw/gnuwin32/extra.h" #else #include #endif +#ifndef LVHT_ONITEM + #define LVHT_ONITEM \ + (LVHT_ONITEMICON | LVHT_ONITEMLABEL | LVHT_ONITEMSTATEICON) +#endif + +#ifndef LVM_SETEXTENDEDLISTVIEWSTYLE + #define LVM_SETEXTENDEDLISTVIEWSTYLE (0x1000 + 54) +#endif + +#ifndef LVS_EX_FULLROWSELECT + #define LVS_EX_FULLROWSELECT 0x00000020 +#endif + +#ifndef LVS_OWNERDATA + #define LVS_OWNERDATA 0x1000 +#endif + +// mingw32/cygwin don't have declarations for comctl32.dll 4.70+ stuff +#ifndef NM_CACHEHINT + typedef struct tagNMLVCACHEHINT + { + NMHDR hdr; + int iFrom; + int iTo; + } NMLVCACHEHINT; + + #define NM_CACHEHINT NMLVCACHEHINT +#endif + +#ifndef LVN_ODCACHEHINT + #define LVN_ODCACHEHINT (-113) +#endif + +#ifndef ListView_GetHeader + #define ListView_GetHeader(w) (HWND)SendMessage((w),LVM_GETHEADER,0,0) +#endif + +#ifndef LVM_GETHEADER + #define LVM_GETHEADER (LVM_FIRST+31) +#endif + +#ifndef Header_GetItemRect + #define Header_GetItemRect(w,i,r) \ + (BOOL)SendMessage((w),HDM_GETITEMRECT,(WPARAM)(i),(LPARAM)(r)) +#endif + +#ifndef HDM_GETITEMRECT + #define HDM_GETITEMRECT (HDM_FIRST+7) +#endif + +#ifndef LVCF_IMAGE + #define LVCF_IMAGE 0x0010 +#endif + +#ifndef LVCFMT_BITMAP_ON_RIGHT + #define LVCFMT_BITMAP_ON_RIGHT 0x1000 +#endif + // ---------------------------------------------------------------------------- // private functions // ---------------------------------------------------------------------------- -static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& tvItem); -static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& tvItem, HWND getFullInfo = 0); +// convert our state and mask flags to LV_ITEM constants +static void wxConvertToMSWFlags(long state, long mask, LV_ITEM& lvItem); + +// convert wxListItem to LV_ITEM +static void wxConvertToMSWListItem(const wxListCtrl *ctrl, + const wxListItem& info, LV_ITEM& lvItem); + +// convert LV_ITEM to wxListItem +static void wxConvertFromMSWListItem(HWND hwndListCtrl, + wxListItem& info, + /* const */ LV_ITEM& lvItem); + +// convert our wxListItem to LV_COLUMN +static void wxConvertToMSWListCol(int col, const wxListItem& item, + LV_COLUMN& lvCol); // ---------------------------------------------------------------------------- -// macros +// events // ---------------------------------------------------------------------------- -#if !USE_SHARED_LIBRARY - IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl) - IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject) -#endif // USE_SHARED_LIBRARY +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED) +DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT) + +IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl) +IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl) +IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject) + +IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent) + +BEGIN_EVENT_TABLE(wxListCtrl, wxControl) + EVT_PAINT(wxListCtrl::OnPaint) +END_EVENT_TABLE() // ============================================================================ // implementation @@ -69,14 +174,16 @@ static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, L // wxListCtrl construction // ---------------------------------------------------------------------------- -wxListCtrl::wxListCtrl() +void wxListCtrl::Init() { m_imageListNormal = NULL; m_imageListSmall = NULL; m_imageListState = NULL; + m_ownsImageListNormal = m_ownsImageListSmall = m_ownsImageListState = FALSE; m_baseStyle = 0; m_colCount = 0; m_textCtrl = NULL; + m_hasAnyAttr = FALSE; } bool wxListCtrl::Create(wxWindow *parent, @@ -87,13 +194,10 @@ bool wxListCtrl::Create(wxWindow *parent, const wxValidator& validator, const wxString& name) { - m_imageListNormal = NULL; - m_imageListSmall = NULL; - m_imageListState = NULL; - m_textCtrl = NULL; - m_colCount = 0; - +#if wxUSE_VALIDATORS SetValidator(validator); +#endif // wxUSE_VALIDATORS + SetName(name); int x = pos.x; @@ -118,6 +222,10 @@ bool wxListCtrl::Create(wxWindow *parent, DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP | LVS_SHAREIMAGELISTS | LVS_SHOWSELALWAYS; + + if ( m_windowStyle & wxCLIP_SIBLINGS ) + wstyle |= WS_CLIPSIBLINGS; + if ( wxStyleHasBorder(m_windowStyle) ) wstyle |= WS_BORDER; m_baseStyle = wstyle; @@ -149,7 +257,7 @@ bool wxListCtrl::DoCreateControl(int x, int y, int w, int h) // Create the ListView control. m_hWnd = (WXHWND)CreateWindowEx(exStyle, WC_LISTVIEW, - _T(""), + wxT(""), wstyle, x, y, w, h, GetWinHwnd(GetParent()), @@ -159,23 +267,20 @@ bool wxListCtrl::DoCreateControl(int x, int y, int w, int h) if ( !m_hWnd ) { - wxLogError(_T("Can't create list control window.")); + wxLogError(_("Can't create list control window, check that comctl32.dll is installed.")); return FALSE; } // for comctl32.dll v 4.70+ we want to have this attribute because it's // prettier (and also because wxGTK does it like this) -#ifdef ListView_SetExtendedListViewStyle - if ( wstyle & LVS_REPORT ) + if ( (wstyle & LVS_REPORT) && wxTheApp->GetComCtl32Version() >= 470 ) { - ListView_SetExtendedListViewStyle(GetHwnd(), - LVS_EX_FULLROWSELECT); + ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE, + 0, LVS_EX_FULLROWSELECT); } -#endif // ListView_SetExtendedListViewStyle - wxSystemSettings settings; - SetBackgroundColour(settings.GetSystemColour(wxSYS_COLOUR_WINDOW)); + SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW)); SetForegroundColour(GetParent()->GetForegroundColour()); SubclassWin(m_hWnd); @@ -203,15 +308,40 @@ void wxListCtrl::UpdateStyle() } } +void wxListCtrl::FreeAllAttrs(bool dontRecreate) +{ + if ( m_hasAnyAttr ) + { + for ( wxNode *node = m_attrs.Next(); node; node = m_attrs.Next() ) + { + delete (wxListItemAttr *)node->Data(); + } + + m_attrs.Destroy(); + if ( !dontRecreate ) + { + m_attrs.Create(wxKEY_INTEGER, 1000); // just as def ctor + } + + m_hasAnyAttr = FALSE; + } +} + wxListCtrl::~wxListCtrl() { - if (m_textCtrl) + FreeAllAttrs(TRUE /* no need to recreate hash any more */); + + if ( m_textCtrl ) { - m_textCtrl->UnsubclassWin(); m_textCtrl->SetHWND(0); + m_textCtrl->UnsubclassWin(); delete m_textCtrl; m_textCtrl = NULL; } + + if (m_ownsImageListNormal) delete m_imageListNormal; + if (m_ownsImageListSmall) delete m_imageListSmall; + if (m_ownsImageListState) delete m_imageListState; } // ---------------------------------------------------------------------------- @@ -326,12 +456,6 @@ long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const if ( style & wxLC_AUTOARRANGE ) wstyle |= LVS_AUTOARRANGE; - // Apparently, no such style (documentation wrong?) - /* - if ( style & wxLC_BUTTON ) - wstyle |= LVS_BUTTON; - */ - if ( style & wxLC_NO_SORT_HEADER ) wstyle |= LVS_NOSORTHEADER; @@ -358,6 +482,20 @@ long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const wstyle |= LVS_SORTDESCENDING; } +#if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) ) + if ( style & wxLC_VIRTUAL ) + { + int ver = wxTheApp->GetComCtl32Version(); + if ( ver < 470 ) + { + wxLogWarning(_("Please install a newer version of comctl32.dll\n(at least version 4.70 is required but you have %d.%02d)\nor this program won't operate correctly."), + ver / 100, ver % 100); + } + + wstyle |= LVS_OWNERDATA; + } +#endif + return wstyle; } @@ -365,14 +503,28 @@ long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const // accessors // ---------------------------------------------------------------------------- -// Sets the background colour (GetBackgroundColour already implicit in -// wxWindow class) +// Sets the foreground, i.e. text, colour +bool wxListCtrl::SetForegroundColour(const wxColour& col) +{ + if ( !wxWindow::SetForegroundColour(col) ) + return FALSE; + + ListView_SetTextColor(GetHwnd(), wxColourToRGB(col)); + + return TRUE; +} + +// Sets the background colour bool wxListCtrl::SetBackgroundColour(const wxColour& col) { if ( !wxWindow::SetBackgroundColour(col) ) return FALSE; - ListView_SetBkColor(GetHwnd(), PALETTERGB(col.Red(), col.Green(), col.Blue())); + // we set the same colour for both the "empty" background and the items + // background + COLORREF color = wxColourToRGB(col); + ListView_SetBkColor(GetHwnd(), color); + ListView_SetTextBkColor(GetHwnd(), color); return TRUE; } @@ -381,9 +533,7 @@ bool wxListCtrl::SetBackgroundColour(const wxColour& col) bool wxListCtrl::GetColumn(int col, wxListItem& item) const { LV_COLUMN lvCol; - lvCol.mask = 0; - lvCol.fmt = 0; - lvCol.pszText = NULL; + wxZeroMemory(lvCol); if ( item.m_mask & wxLIST_MASK_TEXT ) { @@ -392,7 +542,7 @@ bool wxListCtrl::GetColumn(int col, wxListItem& item) const lvCol.cchTextMax = 512; } - bool success = (ListView_GetColumn(GetHwnd(), col, & lvCol) != 0); + bool success = ListView_GetColumn(GetHwnd(), col, & lvCol) != 0; // item.m_subItem = lvCol.iSubItem; item.m_width = lvCol.cx; @@ -420,41 +570,9 @@ bool wxListCtrl::GetColumn(int col, wxListItem& item) const bool wxListCtrl::SetColumn(int col, wxListItem& item) { LV_COLUMN lvCol; - lvCol.mask = 0; - lvCol.fmt = 0; - lvCol.pszText = NULL; - - if ( item.m_mask & wxLIST_MASK_TEXT ) - { - lvCol.mask |= LVCF_TEXT; - lvCol.pszText = WXSTRINGCAST item.m_text; - lvCol.cchTextMax = 0; // Ignored - } - if ( item.m_mask & wxLIST_MASK_FORMAT ) - { - lvCol.mask |= LVCF_FMT; - - if ( item.m_format == wxLIST_FORMAT_LEFT ) - lvCol.fmt = LVCFMT_LEFT; - if ( item.m_format == wxLIST_FORMAT_RIGHT ) - lvCol.fmt = LVCFMT_RIGHT; - if ( item.m_format == wxLIST_FORMAT_CENTRE ) - lvCol.fmt = LVCFMT_CENTER; - } + wxConvertToMSWListCol(col, item, lvCol); - if ( item.m_mask & wxLIST_MASK_WIDTH ) - { - lvCol.mask |= LVCF_WIDTH; - lvCol.cx = item.m_width; - - if ( lvCol.cx == wxLIST_AUTOSIZE) - lvCol.cx = LVSCW_AUTOSIZE; - else if ( lvCol.cx == wxLIST_AUTOSIZE_USEHEADER) - lvCol.cx = LVSCW_AUTOSIZE_USEHEADER; - } - lvCol.mask |= LVCF_SUBITEM; - lvCol.iSubItem = col; - return (ListView_SetColumn(GetHwnd(), col, & lvCol) != 0); + return ListView_SetColumn(GetHwnd(), col, &lvCol) != 0; } // Gets the column width @@ -476,20 +594,20 @@ bool wxListCtrl::SetColumnWidth(int col, int width) else if ( width2 == wxLIST_AUTOSIZE_USEHEADER) width2 = LVSCW_AUTOSIZE_USEHEADER; - return (ListView_SetColumnWidth(GetHwnd(), col2, width2) != 0); + return ListView_SetColumnWidth(GetHwnd(), col2, width2) != 0; } // Gets the number of items that can fit vertically in the // visible area of the list control (list or report view) // or the total number of items in the list control (icon // or small icon view) -int wxListCtrl::GetCountPerPage(void) const +int wxListCtrl::GetCountPerPage() const { return ListView_GetCountPerPage(GetHwnd()); } // Gets the edit control for editing labels. -wxTextCtrl* wxListCtrl::GetEditControl(void) const +wxTextCtrl* wxListCtrl::GetEditControl() const { return m_textCtrl; } @@ -498,11 +616,7 @@ wxTextCtrl* wxListCtrl::GetEditControl(void) const bool wxListCtrl::GetItem(wxListItem& info) const { LV_ITEM lvItem; -#ifdef __GNUWIN32__ - memset(&lvItem, 0, sizeof(lvItem)); -#else - ZeroMemory(&lvItem, sizeof(lvItem)); // must set all fields to 0 -#endif + wxZeroMemory(lvItem); lvItem.iItem = info.m_itemId; lvItem.iSubItem = info.m_col; @@ -521,6 +635,9 @@ bool wxListCtrl::GetItem(wxListItem& info) const if (info.m_mask & wxLIST_MASK_DATA) lvItem.mask |= LVIF_PARAM; + if (info.m_mask & wxLIST_MASK_IMAGE) + lvItem.mask |= LVIF_IMAGE; + if ( info.m_mask & wxLIST_MASK_STATE ) { lvItem.mask |= LVIF_STATE; @@ -536,7 +653,8 @@ bool wxListCtrl::GetItem(wxListItem& info) const } else { - wxConvertFromMSWListItem(this, info, lvItem); + // give NULL as hwnd as we already have everything we need + wxConvertFromMSWListItem(NULL, info, lvItem); } if (lvItem.pszText) @@ -550,15 +668,46 @@ bool wxListCtrl::SetItem(wxListItem& info) { LV_ITEM item; wxConvertToMSWListItem(this, info, item); - item.cchTextMax = 0; - bool ok = ListView_SetItem(GetHwnd(), &item) != 0; - if ( ok && (info.m_mask & wxLIST_MASK_IMAGE) ) + + // we could be changing only the attribute in which case we don't need to + // call ListView_SetItem() at all + if ( item.mask ) + { + item.cchTextMax = 0; + if ( !ListView_SetItem(GetHwnd(), &item) ) + { + wxLogDebug(_T("ListView_SetItem() failed")); + + return FALSE; + } + } + + // we need to update the item immediately to show the new image + bool updateNow = (info.m_mask & wxLIST_MASK_IMAGE) != 0; + + // check whether it has any custom attributes + if ( info.HasAttributes() ) + { + wxListItemAttr *attr = (wxListItemAttr *)m_attrs.Get(item.iItem); + + if ( attr == NULL ) + m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes())); + else + *attr = *info.GetAttributes(); + + m_hasAnyAttr = TRUE; + + // if the colour has changed, we must redraw the item + updateNow = TRUE; + } + + if ( updateNow ) { - // make the change visible - ListView_Update(GetHwnd(), item.iItem); + // we need this to make the change visible right now + RefreshItem(item.iItem); } - return ok; + return TRUE; } long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId) @@ -595,18 +744,53 @@ int wxListCtrl::GetItemState(long item, long stateMask) const // Sets the item state bool wxListCtrl::SetItemState(long item, long state, long stateMask) { - wxListItem info; + // NB: don't use SetItem() here as it doesn't work with the virtual list + // controls + LV_ITEM lvItem; + wxZeroMemory(lvItem); + + wxConvertToMSWFlags(state, stateMask, lvItem); + + // for the virtual list controls we need to refresh the previously focused + // item manually when changing focus without changing selection + // programmatically because otherwise it keeps its focus rectangle until + // next repaint (yet another comctl32 bug) + long focusOld; + if ( IsVirtual() && + (stateMask & wxLIST_STATE_FOCUSED) && + (state & wxLIST_STATE_FOCUSED) ) + { + focusOld = GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED); + } + else + { + focusOld = -1; + } - info.m_mask = wxLIST_MASK_STATE; - info.m_state = state; - info.m_stateMask = stateMask; - info.m_itemId = item; + if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE, + (WPARAM)item, (LPARAM)&lvItem) ) + { + wxLogLastError(_T("ListView_SetItemState")); - return SetItem(info); + return FALSE; + } + + if ( focusOld != -1 ) + { + // no need to refresh the item if it was previously selected, it would + // only result in annoying flicker + if ( !(GetItemState(focusOld, + wxLIST_STATE_SELECTED) & wxLIST_STATE_SELECTED) ) + { + RefreshItem(focusOld); + } + } + + return TRUE; } // Sets the item image -bool wxListCtrl::SetItemImage(long item, int image, int selImage) +bool wxListCtrl::SetItemImage(long item, int image, int WXUNUSED(selImage)) { wxListItem info; @@ -670,26 +854,33 @@ bool wxListCtrl::SetItemData(long item, long data) // Gets the item rectangle bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const { - RECT rect2; + RECT rectWin; - int code2 = LVIR_BOUNDS; + int codeWin; if ( code == wxLIST_RECT_BOUNDS ) - code2 = LVIR_BOUNDS; + codeWin = LVIR_BOUNDS; else if ( code == wxLIST_RECT_ICON ) - code2 = LVIR_ICON; + codeWin = LVIR_ICON; else if ( code == wxLIST_RECT_LABEL ) - code2 = LVIR_LABEL; + codeWin = LVIR_LABEL; + else + { + wxFAIL_MSG( _T("incorrect code in GetItemRect()") ); + + codeWin = LVIR_BOUNDS; + } #ifdef __WXWINE__ - bool success = (ListView_GetItemRect(GetHwnd(), (int) item, &rect2 ) != 0); + bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin ) != 0; #else - bool success = (ListView_GetItemRect(GetHwnd(), (int) item, &rect2, code2) != 0); + bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0; #endif - rect.x = rect2.left; - rect.y = rect2.top; - rect.width = rect2.right - rect2.left; - rect.height = rect2.bottom - rect2.left; + rect.x = rectWin.left; + rect.y = rectWin.top; + rect.width = rectWin.right - rectWin.left; + rect.height = rectWin.bottom - rectWin.top; + return success; } @@ -711,7 +902,7 @@ bool wxListCtrl::SetItemPosition(long item, const wxPoint& pos) } // Gets the number of items in the list control -int wxListCtrl::GetItemCount(void) const +int wxListCtrl::GetItemCount() const { return ListView_GetItemCount(GetHwnd()); } @@ -725,13 +916,13 @@ int wxListCtrl::GetItemSpacing(bool isSmall) const } // Gets the number of selected items in the list control -int wxListCtrl::GetSelectedItemCount(void) const +int wxListCtrl::GetSelectedItemCount() const { return ListView_GetSelectedCount(GetHwnd()); } // Gets the text colour of the listview -wxColour wxListCtrl::GetTextColour(void) const +wxColour wxListCtrl::GetTextColour() const { COLORREF ref = ListView_GetTextColor(GetHwnd()); wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref)); @@ -746,7 +937,7 @@ void wxListCtrl::SetTextColour(const wxColour& col) // Gets the index of the topmost visible item when in // list or report view -long wxListCtrl::GetTopItem(void) const +long wxListCtrl::GetTopItem() const { return (long) ListView_GetTopIndex(GetHwnd()); } @@ -810,21 +1001,38 @@ void wxListCtrl::SetImageList(wxImageList *imageList, int which) if ( which == wxIMAGE_LIST_NORMAL ) { flags = LVSIL_NORMAL; + if (m_ownsImageListNormal) delete m_imageListNormal; m_imageListNormal = imageList; + m_ownsImageListNormal = FALSE; } else if ( which == wxIMAGE_LIST_SMALL ) { flags = LVSIL_SMALL; + if (m_ownsImageListSmall) delete m_imageListSmall; m_imageListSmall = imageList; + m_ownsImageListSmall = FALSE; } else if ( which == wxIMAGE_LIST_STATE ) { flags = LVSIL_STATE; + if (m_ownsImageListState) delete m_imageListState; m_imageListState = imageList; + m_ownsImageListState = FALSE; } ListView_SetImageList(GetHwnd(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags); } +void wxListCtrl::AssignImageList(wxImageList *imageList, int which) +{ + SetImageList(imageList, which); + if ( which == wxIMAGE_LIST_NORMAL ) + m_ownsImageListNormal = TRUE; + else if ( which == wxIMAGE_LIST_SMALL ) + m_ownsImageListSmall = TRUE; + else if ( which == wxIMAGE_LIST_STATE ) + m_ownsImageListState = TRUE; +} + // ---------------------------------------------------------------------------- // Operations // ---------------------------------------------------------------------------- @@ -848,13 +1056,41 @@ bool wxListCtrl::Arrange(int flag) // Deletes an item bool wxListCtrl::DeleteItem(long item) { - return (ListView_DeleteItem(GetHwnd(), (int) item) != 0); + if ( !ListView_DeleteItem(GetHwnd(), (int) item) ) + { + wxLogLastError(_T("ListView_DeleteItem")); + return FALSE; + } + + // the virtual list control doesn't refresh itself correctly, help it + if ( IsVirtual() ) + { + // we need to refresh all the lines below the one which was deleted + wxRect rectItem; + if ( item > 0 && GetItemCount() ) + { + GetItemRect(item - 1, rectItem); + } + else + { + rectItem.y = + rectItem.height = 0; + } + + wxRect rectWin = GetRect(); + rectWin.height = rectWin.GetBottom() - rectItem.GetBottom(); + rectWin.y = rectItem.GetBottom(); + + RefreshRect(rectWin); + } + + return TRUE; } // Deletes all items bool wxListCtrl::DeleteAllItems() { - return (ListView_DeleteAllItems(GetHwnd()) != 0); + return ListView_DeleteAllItems(GetHwnd()) != 0; } // Deletes all items @@ -864,7 +1100,7 @@ bool wxListCtrl::DeleteAllColumns() { if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 ) { - wxLogLastError("ListView_DeleteColumn"); + wxLogLastError(wxT("ListView_DeleteColumn")); return FALSE; } @@ -872,7 +1108,7 @@ bool wxListCtrl::DeleteAllColumns() m_colCount--; } - wxASSERT_MSG( m_colCount == 0, _T("no columns should be left") ); + wxASSERT_MSG( m_colCount == 0, wxT("no columns should be left") ); return TRUE; } @@ -899,12 +1135,14 @@ wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass) { wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) ); + // VS: ListView_EditLabel requires that the list has focus. + SetFocus(); HWND hWnd = (HWND) ListView_EditLabel(GetHwnd(), item); if (m_textCtrl) { - m_textCtrl->UnsubclassWin(); m_textCtrl->SetHWND(0); + m_textCtrl->UnsubclassWin(); delete m_textCtrl; m_textCtrl = NULL; } @@ -917,31 +1155,17 @@ wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass) } // End label editing, optionally cancelling the edit -bool wxListCtrl::EndEditLabel(bool cancel) -{ - wxFAIL; - - /* I don't know how to implement this: there's no such macro as ListView_EndEditLabelNow. - * ??? - bool success = (ListView_EndEditLabelNow(GetHwnd(), cancel) != 0); - - if (m_textCtrl) - { - m_textCtrl->UnsubclassWin(); - m_textCtrl->SetHWND(0); - delete m_textCtrl; - m_textCtrl = NULL; - } - return success; - */ +bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel)) +{ + wxFAIL_MSG( _T("not implemented") ); + return FALSE; } - // Ensures this item is visible bool wxListCtrl::EnsureVisible(long item) { - return (ListView_EnsureVisible(GetHwnd(), (int) item, FALSE) != 0); + return ListView_EnsureVisible(GetHwnd(), (int) item, FALSE) != 0; } // Find an item whose label matches this string, starting from the item after 'start' @@ -952,10 +1176,15 @@ long wxListCtrl::FindItem(long start, const wxString& str, bool partial) findInfo.flags = LVFI_STRING; if ( partial ) - findInfo.flags |= LVFI_STRING; - findInfo.psz = WXSTRINGCAST str; + findInfo.flags |= LVFI_PARTIAL; + findInfo.psz = str; - return ListView_FindItem(GetHwnd(), (int) start, & findInfo); + // ListView_FindItem() excludes the first item from search and to look + // through all the items you need to start from -1 which is unnatural and + // inconsistent with the generic version - so we adjust the index + if (start != -1) + start --; + return ListView_FindItem(GetHwnd(), (int) start, &findInfo); } // Find an item whose data matches this data, starting from the item after 'start' @@ -1028,9 +1257,27 @@ long wxListCtrl::HitTest(const wxPoint& point, int& flags) // -1 otherwise. long wxListCtrl::InsertItem(wxListItem& info) { + wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") ); + LV_ITEM item; wxConvertToMSWListItem(this, info, item); + // check whether it has any custom attributes + if ( info.HasAttributes() ) + { + + wxListItemAttr *attr; + attr = (wxListItemAttr*) m_attrs.Get(item.iItem); + + if (attr == NULL) + + m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes())); + + else *attr = *info.GetAttributes(); + + m_hasAnyAttr = TRUE; + } + return (long) ListView_InsertItem(GetHwnd(), & item); } @@ -1068,64 +1315,50 @@ long wxListCtrl::InsertItem(long index, const wxString& label, int imageIndex) long wxListCtrl::InsertColumn(long col, wxListItem& item) { LV_COLUMN lvCol; - lvCol.mask = 0; - lvCol.fmt = 0; - lvCol.pszText = NULL; - - if ( item.m_mask & wxLIST_MASK_TEXT ) - { - lvCol.mask |= LVCF_TEXT; - lvCol.pszText = WXSTRINGCAST item.m_text; - lvCol.cchTextMax = 0; // Ignored - } - if ( item.m_mask & wxLIST_MASK_FORMAT ) - { - lvCol.mask |= LVCF_FMT; - - if ( item.m_format == wxLIST_FORMAT_LEFT ) - lvCol.fmt = LVCFMT_LEFT; - if ( item.m_format == wxLIST_FORMAT_RIGHT ) - lvCol.fmt = LVCFMT_RIGHT; - if ( item.m_format == wxLIST_FORMAT_CENTRE ) - lvCol.fmt = LVCFMT_CENTER; - } + wxConvertToMSWListCol(col, item, lvCol); - lvCol.mask |= LVCF_WIDTH; - if ( item.m_mask & wxLIST_MASK_WIDTH ) - { - if ( item.m_width == wxLIST_AUTOSIZE) - lvCol.cx = LVSCW_AUTOSIZE; - else if ( item.m_width == wxLIST_AUTOSIZE_USEHEADER) - lvCol.cx = LVSCW_AUTOSIZE_USEHEADER; - else - lvCol.cx = item.m_width; - } - else + if ( !(lvCol.mask & LVCF_WIDTH) ) { // always give some width to the new column: this one is compatible - // with wxGTK + // with the generic version + lvCol.mask |= LVCF_WIDTH; lvCol.cx = 80; } - lvCol.mask |= LVCF_SUBITEM; - lvCol.iSubItem = col; + // when we insert a column which can contain an image, we must specify this + // flag right now as doing it later in SetColumn() has no effect + // + // we use LVCFMT_BITMAP_ON_RIGHT by default because without it there is no + // way to dynamically set/clear the bitmap as the column without a bitmap + // on the left looks ugly (there is a hole) + // + // unfortunately with my version of comctl32.dll (5.80), the left column + // image is always on the left and it seems that it's a "feature" - I + // didn't find any way to work around it in any case + if ( lvCol.mask & LVCF_IMAGE ) + { + lvCol.mask |= LVCF_FMT; + lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT; + } - bool success = ListView_InsertColumn(GetHwnd(), col, & lvCol) != -1; + bool success = ListView_InsertColumn(GetHwnd(), col, &lvCol) != -1; if ( success ) { m_colCount++; } else { - wxLogDebug(_T("Failed to insert the column '%s' into listview!"), + wxLogDebug(wxT("Failed to insert the column '%s' into listview!"), lvCol.pszText); } return success; } -long wxListCtrl::InsertColumn(long col, const wxString& heading, int format, - int width) +long wxListCtrl::InsertColumn(long col, + const wxString& heading, + int format, + int width) { wxListItem item; item.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_FORMAT; @@ -1161,11 +1394,74 @@ bool wxListCtrl::ScrollList(int dx, int dy) // or zero if the two items are equivalent. // data is arbitrary data to be passed to the sort function. + +// FIXME: this is horrible and MT-unsafe and everything else but I don't have +// time for anything better right now (VZ) +static long gs_sortData = 0; +static wxListCtrl *gs_sortCtrl = NULL; +static wxListCtrlCompare gs_sortFunction = NULL; + +int wxCMPFUNC_CONV wxListCtrlCompareFn(const void *arg1, const void *arg2) +{ + int n1 = *(const int *)arg1, + n2 = *(const int *)arg2; + + return gs_sortFunction(gs_sortCtrl->GetItemData(n1), + gs_sortCtrl->GetItemData(n2), + gs_sortData); +} + bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data) { - return (ListView_SortItems(GetHwnd(), (PFNLVCOMPARE) fn, data) != 0); + // sort the attributes too + if ( m_hasAnyAttr ) + { + int n, + count = GetItemCount(); + int *aItems = new int[count]; + for ( n = 0; n < count; n++ ) + { + aItems[n] = n; + } + + gs_sortData = data; + gs_sortCtrl = this; + gs_sortFunction = fn; + + qsort(aItems, count, sizeof(int), wxListCtrlCompareFn); + + gs_sortData = 0; + gs_sortCtrl = NULL; + gs_sortFunction = NULL; + + wxHashTable attrsNew(wxKEY_INTEGER, 1000); + for ( n = 0; n < count; n++ ) + { + wxObject *attr = m_attrs.Delete(aItems[n]); + if ( attr ) + { + attrsNew.Put(n, attr); + } + } + + m_attrs.Destroy(); + m_attrs = attrsNew; + + delete [] aItems; + } + + if ( !ListView_SortItems(GetHwnd(), (PFNLVCOMPARE)fn, data) ) + { + wxLogDebug(_T("ListView_SortItems() failed")); + + return FALSE; + } + + return TRUE; } + + // ---------------------------------------------------------------------------- // message processing // ---------------------------------------------------------------------------- @@ -1192,207 +1488,660 @@ bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id) bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) { + // prepare the event + // ----------------- + wxListEvent event(wxEVT_NULL, m_windowId); + event.SetEventObject(this); + wxEventType eventType = wxEVT_NULL; - NMHDR *hdr1 = (NMHDR *) lParam; - switch ( hdr1->code ) - { - case LVN_BEGINRDRAG: - eventType = wxEVT_COMMAND_LIST_BEGIN_RDRAG; - // fall through - case LVN_BEGINDRAG: - if ( eventType == wxEVT_NULL ) - { - eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG; - } + NMHDR *nmhdr = (NMHDR *)lParam; - { - NM_LISTVIEW *hdr = (NM_LISTVIEW *)lParam; - event.m_itemIndex = hdr->iItem; - event.m_pointDrag.x = hdr->ptAction.x; - event.m_pointDrag.y = hdr->ptAction.y; - } - break; + // if your compiler is as broken as this, you should really change it: this + // code is needed for normal operation! #ifdef below is only useful for + // automatic rebuilds which are done with a very old compiler version +#ifdef LVM_FIRST - case LVN_BEGINLABELEDIT: - { - eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT; - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - wxConvertFromMSWListItem(this, event.m_item, info->item, GetHwnd()); - break; - } + // check for messages from the header (in report view) + HWND hwndHdr = ListView_GetHeader(GetHwnd()); - case LVN_COLUMNCLICK: - { - eventType = wxEVT_COMMAND_LIST_COL_CLICK; - NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - event.m_itemIndex = -1; - event.m_col = hdr->iSubItem; + // is it a message from the header? + if ( nmhdr->hwndFrom == hwndHdr ) + { +#ifdef __WATCOMC__ + HD_NOTIFY *nmHDR = (HD_NOTIFY *)nmhdr; +#else + NMHEADER *nmHDR = (NMHEADER *)nmhdr; +#endif + event.m_itemIndex = -1; + + switch ( nmhdr->code ) + { + // yet another comctl32.dll bug: under NT/W2K it sends Unicode + // TRACK messages even to ANSI programs: on my system I get + // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all! + // + // work around is to simply catch both versions and hope that it + // works (why should this message exist in ANSI and Unicode is + // beyond me as it doesn't deal with strings at all...) + case HDN_BEGINTRACKA: + case HDN_BEGINTRACKW: + eventType = wxEVT_COMMAND_LIST_COL_BEGIN_DRAG; + // fall through + + case HDN_TRACKA: + case HDN_TRACKW: + if ( eventType == wxEVT_NULL ) + eventType = wxEVT_COMMAND_LIST_COL_DRAGGING; + // fall through + + case HDN_ENDTRACKA: + case HDN_ENDTRACKW: + if ( eventType == wxEVT_NULL ) + eventType = wxEVT_COMMAND_LIST_COL_END_DRAG; + event.m_col = nmHDR->iItem; break; - } - case LVN_DELETEALLITEMS: - // what's the sense of generating a wxWin event for this when - // it's absolutely not portable? -#if 0 - eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS; - event.m_itemIndex = -1; -#endif // 0 + case NM_RCLICK: + { + eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK; + event.m_col = -1; + + // find the column clicked: we have to search for it + // ourselves as the notification message doesn't provide + // this info + + // where did the click occur? + POINT ptClick; + if ( !::GetCursorPos(&ptClick) ) + { + wxLogLastError(_T("GetCursorPos")); + } + + if ( !::ScreenToClient(hwndHdr, &ptClick) ) + { + wxLogLastError(_T("ScreenToClient(listctrl header)")); + } + + event.m_pointDrag.x = ptClick.x; + event.m_pointDrag.y = ptClick.y; + + int colCount = Header_GetItemCount(hwndHdr); + + RECT rect; + for ( int col = 0; col < colCount; col++ ) + { + if ( Header_GetItemRect(hwndHdr, col, &rect) ) + { + if ( ::PtInRect(&rect, ptClick) ) + { + event.m_col = col; + break; + } + } + } + } + break; - // return TRUE to suppress all additional LVN_DELETEITEM - // notifications - this makes deleting all items from a list ctrl - // much faster - *result = TRUE; - return TRUE; + default: + return wxControl::MSWOnNotify(idCtrl, lParam, result); + } + } + else +#endif // defined(LVM_FIRST) + if ( nmhdr->hwndFrom == GetHwnd() ) + { + // almost all messages use NM_LISTVIEW + NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr; - case LVN_DELETEITEM: - { + // this is true for almost all events + event.m_item.m_data = nmLV->lParam; + + switch ( nmhdr->code ) + { + case LVN_BEGINRDRAG: + eventType = wxEVT_COMMAND_LIST_BEGIN_RDRAG; + // fall through + + case LVN_BEGINDRAG: + if ( eventType == wxEVT_NULL ) + { + eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG; + } + + event.m_itemIndex = nmLV->iItem; + event.m_pointDrag.x = nmLV->ptAction.x; + event.m_pointDrag.y = nmLV->ptAction.y; + break; + + case LVN_BEGINLABELEDIT: + { + eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT; + LV_DISPINFO *info = (LV_DISPINFO *)lParam; + wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item); + event.m_itemIndex = event.m_item.m_itemId; + } + break; + + case LVN_COLUMNCLICK: + eventType = wxEVT_COMMAND_LIST_COL_CLICK; + event.m_itemIndex = -1; + event.m_col = nmLV->iSubItem; + break; + + case LVN_DELETEALLITEMS: + eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS; + event.m_itemIndex = -1; + + FreeAllAttrs(); + + break; + + case LVN_DELETEITEM: eventType = wxEVT_COMMAND_LIST_DELETE_ITEM; - NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - event.m_itemIndex = hdr->iItem; + event.m_itemIndex = nmLV->iItem; + + if ( m_hasAnyAttr ) + { + delete (wxListItemAttr *)m_attrs.Delete(nmLV->iItem); + } break; - } - case LVN_ENDLABELEDIT: - { - eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT; - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - wxConvertFromMSWListItem(this, event.m_item, info->item, GetHwnd()); - if ( info->item.pszText == NULL || info->item.iItem == -1 ) - event.m_cancelled = TRUE; + + case LVN_ENDLABELEDIT: + { + eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT; + LV_DISPINFO *info = (LV_DISPINFO *)lParam; + wxConvertFromMSWListItem(NULL, event.m_item, info->item); + if ( info->item.pszText == NULL || info->item.iItem == -1 ) + return FALSE; + + event.m_itemIndex = event.m_item.m_itemId; + } break; - } - case LVN_GETDISPINFO: - return FALSE; - // this provokes stack overflow: indeed, wxConvertFromMSWListItem() - // sends us WM_NOTIFY! As it doesn't do anything for now, just leave - // it out. -#if 0 - { - // TODO: some text buffering here, I think - // TODO: API for getting Windows to retrieve values - // on demand. - eventType = wxEVT_COMMAND_LIST_GET_INFO; - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - wxConvertFromMSWListItem(this, event.m_item, info->item, GetHwnd()); + case LVN_SETDISPINFO: + { + eventType = wxEVT_COMMAND_LIST_SET_INFO; + LV_DISPINFO *info = (LV_DISPINFO *)lParam; + wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item); + } break; - } -#endif // 0 - case LVN_INSERTITEM: - { + case LVN_INSERTITEM: eventType = wxEVT_COMMAND_LIST_INSERT_ITEM; - NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - event.m_itemIndex = hdr->iItem; + event.m_itemIndex = nmLV->iItem; break; - } - case LVN_ITEMCHANGED: - { - // This needs to be sent to wxListCtrl as a rather more - // concrete event. For now, just detect a selection - // or deselection. - NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - if ( (hdr->uNewState & LVIS_SELECTED) && !(hdr->uOldState & LVIS_SELECTED) ) + + case LVN_ITEMCHANGED: + // we translate this catch all message into more interesting + // (and more easy to process) wxWindows events + + // first of all, we deal with the state change events only + if ( nmLV->uChanged & LVIF_STATE ) { - eventType = wxEVT_COMMAND_LIST_ITEM_SELECTED; - event.m_itemIndex = hdr->iItem; + // temp vars for readability + const UINT stOld = nmLV->uOldState; + const UINT stNew = nmLV->uNewState; + + // has the focus changed? + if ( !(stOld & LVIS_FOCUSED) && (stNew & LVIS_FOCUSED) ) + { + eventType = wxEVT_COMMAND_LIST_ITEM_FOCUSED; + event.m_itemIndex = nmLV->iItem; + } + + if ( (stNew & LVIS_SELECTED) != (stOld & LVIS_SELECTED) ) + { + if ( eventType != wxEVT_NULL ) + { + // focus and selection have both changed: send the + // focus event from here and the selection one + // below + event.SetEventType(eventType); + (void)GetEventHandler()->ProcessEvent(event); + } + else // no focus event to send + { + // then need to set m_itemIndex as it wasn't done + // above + event.m_itemIndex = nmLV->iItem; + } + + eventType = stNew & LVIS_SELECTED + ? wxEVT_COMMAND_LIST_ITEM_SELECTED + : wxEVT_COMMAND_LIST_ITEM_DESELECTED; + } } - else if ( !(hdr->uNewState & LVIS_SELECTED) && (hdr->uOldState & LVIS_SELECTED) ) + + if ( eventType == wxEVT_NULL ) { - eventType = wxEVT_COMMAND_LIST_ITEM_DESELECTED; - event.m_itemIndex = hdr->iItem; - } - else + // not an interesting event for us return FALSE; + } + break; - } - case LVN_KEYDOWN: - { - LV_KEYDOWN *info = (LV_KEYDOWN *)lParam; - WORD wVKey = info->wVKey; + case LVN_KEYDOWN: + { + LV_KEYDOWN *info = (LV_KEYDOWN *)lParam; + WORD wVKey = info->wVKey; + + // get the current selection + long lItem = GetNextItem(-1, + wxLIST_NEXT_ALL, + wxLIST_STATE_SELECTED); + + // or activate the selected item if any (but + // not with Shift and/or Ctrl as then they have a predefined + // meaning for the list view) + if ( lItem != -1 && + (wVKey == VK_RETURN || wVKey == VK_SPACE) && + !(wxIsShiftDown() || wxIsCtrlDown()) ) + { + eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED; + } + else + { + eventType = wxEVT_COMMAND_LIST_KEY_DOWN; + + // wxCharCodeMSWToWX() returns 0 if the key is an ASCII + // value which should be used as is + int code = wxCharCodeMSWToWX(wVKey); + event.m_code = code ? code : wVKey; + } + + event.m_itemIndex = + event.m_item.m_itemId = lItem; + + if ( lItem != -1 ) + { + // fill the other fields too + event.m_item.m_text = GetItemText(lItem); + event.m_item.m_data = GetItemData(lItem); + } + } + break; - // get the current selection - long lItem = GetNextItem(-1, - wxLIST_NEXT_ALL, - wxLIST_STATE_SELECTED); + case NM_DBLCLK: + // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do + // anything else + if ( wxControl::MSWOnNotify(idCtrl, lParam, result) ) + { + return TRUE; + } - // or activate the selected item if any - if ( lItem != -1 && (wVKey == VK_RETURN || wVKey == VK_SPACE) ) + // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event + // if it happened on an item (and not on empty place) + if ( nmLV->iItem == -1 ) { - // TODO this behaviour probably should be optional - eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED; - event.m_itemIndex = lItem; + // not on item + return FALSE; } - else + + eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED; + event.m_itemIndex = nmLV->iItem; + event.m_item.m_text = GetItemText(nmLV->iItem); + event.m_item.m_data = GetItemData(nmLV->iItem); + break; + + case NM_RCLICK: + // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(), + // don't do anything else + if ( wxControl::MSWOnNotify(idCtrl, lParam, result) ) { - eventType = wxEVT_COMMAND_LIST_KEY_DOWN; - event.m_code = wxCharCodeMSWToWX(wVKey); + return TRUE; + } + + // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event + LV_HITTESTINFO lvhti; + wxZeroMemory(lvhti); + + ::GetCursorPos(&(lvhti.pt)); + ::ScreenToClient(GetHwnd(),&(lvhti.pt)); + if ( ListView_HitTest(GetHwnd(),&lvhti) != -1 ) + { + if ( lvhti.flags & LVHT_ONITEM ) + { + eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK; + event.m_itemIndex = lvhti.iItem; + event.m_pointDrag.x = lvhti.pt.x; + event.m_pointDrag.y = lvhti.pt.y; + } } break; - } - case NM_DBLCLK: - // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do - // anything else - if ( wxControl::MSWOnNotify(idCtrl, lParam, result) ) - { - return TRUE; - } +#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \ + && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) ) + case NM_CUSTOMDRAW: + *result = OnCustomDraw(lParam); - // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event - eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED; - break; + return TRUE; +#endif // _WIN32_IE >= 0x300 - case LVN_SETDISPINFO: - { - eventType = wxEVT_COMMAND_LIST_SET_INFO; - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - wxConvertFromMSWListItem(this, event.m_item, info->item, GetHwnd()); + case LVN_ODCACHEHINT: + { + const NM_CACHEHINT *cacheHint = (NM_CACHEHINT *)lParam; + + eventType = wxEVT_COMMAND_LIST_CACHE_HINT; + + // we get some really stupid cache hints like ones for items in + // range 0..0 for an empty control or, after deleting an item, + // for items in invalid range - filter this garbage out + if ( cacheHint->iFrom < cacheHint->iTo ) + { + event.m_oldItemIndex = cacheHint->iFrom; + + long iMax = GetItemCount(); + event.m_itemIndex = cacheHint->iTo < iMax ? cacheHint->iTo + : iMax - 1; + } + else + { + return FALSE; + } + } break; - } - default: - return wxControl::MSWOnNotify(idCtrl, lParam, result); + case LVN_GETDISPINFO: + if ( IsVirtual() ) + { + LV_DISPINFO *info = (LV_DISPINFO *)lParam; + + LV_ITEM& lvi = info->item; + long item = lvi.iItem; + + if ( lvi.mask & LVIF_TEXT ) + { + wxString text = OnGetItemText(item, lvi.iSubItem); + wxStrncpy(lvi.pszText, text, lvi.cchTextMax); + } + +#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \ + && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 1 ) ) + if ( lvi.mask & LVIF_IMAGE ) + { + lvi.iImage = OnGetItemImage(item); + } +#endif + + // a little dose of healthy paranoia: as we never use + // LVM_SETCALLBACKMASK we're not supposed to get these ones + wxASSERT_MSG( !(lvi.mask & LVIF_STATE), + _T("we don't support state callbacks yet!") ); + + return TRUE; + } + // fall through + + default: + return wxControl::MSWOnNotify(idCtrl, lParam, result); + } + } + else + { + // where did this one come from? + return FALSE; } - event.SetEventObject( this ); + // process the event + // ----------------- + event.SetEventType(eventType); if ( !GetEventHandler()->ProcessEvent(event) ) return FALSE; - if (hdr1->code == LVN_GETDISPINFO) + // post processing + // --------------- + + switch ( nmhdr->code ) + { + case LVN_DELETEALLITEMS: + // always return TRUE to suppress all additional LVN_DELETEITEM + // notifications - this makes deleting all items from a list ctrl + // much faster + *result = TRUE; + + return TRUE; + + case LVN_ENDLABELEDIT: + // logic here is inversed compared to all the other messages + *result = event.IsAllowed(); + + return TRUE; + } + + *result = !event.IsAllowed(); + + return TRUE; +} + +#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 + +WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam) +{ + LPNMLVCUSTOMDRAW lplvcd = (LPNMLVCUSTOMDRAW)lParam; + NMCUSTOMDRAW& nmcd = lplvcd->nmcd; + switch ( nmcd.dwDrawStage ) + { + case CDDS_PREPAINT: + // if we've got any items with non standard attributes, + // notify us before painting each item + // + // for virtual controls, always suppose that we have attributes as + // there is no way to check for this + return IsVirtual() || m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW + : CDRF_DODEFAULT; + + case CDDS_ITEMPREPAINT: + { + size_t item = (size_t)nmcd.dwItemSpec; + if ( item >= (size_t)GetItemCount() ) + { + // we get this message with item == 0 for an empty control, + // we must ignore it as calling OnGetItemAttr() would be + // wrong + return CDRF_DODEFAULT; + } + + wxListItemAttr *attr = + IsVirtual() ? OnGetItemAttr(item) + : (wxListItemAttr *)m_attrs.Get(item); + + if ( !attr ) + { + // nothing to do for this item + return CDRF_DODEFAULT; + } + + HFONT hFont; + wxColour colText, colBack; + if ( attr->HasFont() ) + { + wxFont font = attr->GetFont(); + hFont = (HFONT)font.GetResourceHandle(); + } + else + { + hFont = 0; + } + + if ( attr->HasTextColour() ) + { + colText = attr->GetTextColour(); + } + else + { + colText = GetTextColour(); + } + + if ( attr->HasBackgroundColour() ) + { + colBack = attr->GetBackgroundColour(); + } + else + { + colBack = GetBackgroundColour(); + } + + lplvcd->clrText = wxColourToRGB(colText); + lplvcd->clrTextBk = wxColourToRGB(colBack); + + // note that if we wanted to set colours for + // individual columns (subitems), we would have + // returned CDRF_NOTIFYSUBITEMREDRAW from here + if ( hFont ) + { + ::SelectObject(nmcd.hdc, hFont); + + return CDRF_NEWFONT; + } + } + // fall through to return CDRF_DODEFAULT + + default: + return CDRF_DODEFAULT; + } +} + +#endif // NM_CUSTOMDRAW supported + +// Necessary for drawing hrules and vrules, if specified +void wxListCtrl::OnPaint(wxPaintEvent& event) +{ + wxPaintDC dc(this); + + wxControl::OnPaint(event); + + // Reset the device origin since it may have been set + dc.SetDeviceOrigin(0, 0); + + bool drawHRules = ((GetWindowStyle() & wxLC_HRULES) != 0); + bool drawVRules = ((GetWindowStyle() & wxLC_VRULES) != 0); + + if (!drawHRules && !drawVRules) + return; + if ((GetWindowStyle() & wxLC_REPORT) == 0) + return; + + wxPen pen(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID); + dc.SetPen(pen); + dc.SetBrush(* wxTRANSPARENT_BRUSH); + + wxSize clientSize = GetClientSize(); + wxRect itemRect; + int cy=0; + + int itemCount = GetItemCount(); + int i; + if (drawHRules) { - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - if ( info->item.mask & LVIF_TEXT ) + long top = GetTopItem(); + for (i = top; i < top + GetCountPerPage() + 1; i++) { - if ( !event.m_item.m_text.IsNull() ) + if (GetItemRect(i, itemRect)) { - info->item.pszText = AddPool(event.m_item.m_text); - info->item.cchTextMax = wxStrlen(info->item.pszText) + 1; + cy = itemRect.GetTop(); + if (i != 0) // Don't draw the first one + { + dc.DrawLine(0, cy, clientSize.x, cy); + } + // Draw last line + if (i == itemCount - 1) + { + cy = itemRect.GetBottom(); + dc.DrawLine(0, cy, clientSize.x, cy); + } } } - // wxConvertToMSWListItem(this, event.m_item, info->item); } + i = itemCount - 1; + if (drawVRules && (i > -1)) + { + wxRect firstItemRect; + GetItemRect(0, firstItemRect); - *result = !event.IsAllowed(); + if (GetItemRect(i, itemRect)) + { + int col; + int x = itemRect.GetX(); + for (col = 0; col < GetColumnCount(); col++) + { + int colWidth = GetColumnWidth(col); + x += colWidth ; + dc.DrawLine(x, firstItemRect.GetY() - 2, x, itemRect.GetBottom()); + } + } + } +} - return TRUE; +// ---------------------------------------------------------------------------- +// virtual list controls +// ---------------------------------------------------------------------------- + +wxString wxListCtrl::OnGetItemText(long WXUNUSED(item), long WXUNUSED(col)) const +{ + // this is a pure virtual function, in fact - which is not really pure + // because the controls which are not virtual don't need to implement it + wxFAIL_MSG( _T("not supposed to be called") ); + + return wxEmptyString; +} + +int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const +{ + // same as above + wxFAIL_MSG( _T("not supposed to be called") ); + + return -1; +} + +wxListItemAttr *wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item)) const +{ + wxASSERT_MSG( item >= 0 && item < GetItemCount(), + _T("invalid item index in OnGetItemAttr()") ); + + // no attributes by default + return NULL; } -wxChar *wxListCtrl::AddPool(const wxString& str) +void wxListCtrl::SetItemCount(long count) { - // Remove the first element if 3 strings exist - if ( m_stringPool.Number() == 3 ) + wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") ); + + if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count, 0) ) { - wxNode *node = m_stringPool.First(); - delete[] (char *)node->Data(); - delete node; + wxLogLastError(_T("ListView_SetItemCount")); } - wxNode *node = m_stringPool.Add(WXSTRINGCAST str); - return (wxChar *)node->Data(); +} + +void wxListCtrl::RefreshItem(long item) +{ + // strangely enough, ListView_Update() results in much more flicker here + // than a dumb Refresh() -- why? +#if 0 + if ( !ListView_Update(GetHwnd(), item) ) + { + wxLogLastError(_T("ListView_Update")); + } +#else // 1 + wxRect rect; + GetItemRect(item, rect); + RefreshRect(rect); +#endif // 0/1 +} + +void wxListCtrl::RefreshItems(long itemFrom, long itemTo) +{ + wxRect rect1, rect2; + GetItemRect(itemFrom, rect1); + GetItemRect(itemTo, rect2); + + wxRect rect = rect1; + rect.height = rect2.GetBottom() - rect1.GetTop(); + + RefreshRect(rect); } // ---------------------------------------------------------------------------- @@ -1412,9 +2161,36 @@ wxListItem::wxListItem() m_format = wxLIST_FORMAT_CENTRE; m_width = 0; + + m_attr = NULL; } -static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& lvItem, HWND getFullInfo) +void wxListItem::Clear() +{ + m_mask = 0; + m_itemId = 0; + m_col = 0; + m_state = 0; + m_stateMask = 0; + m_image = 0; + m_data = 0; + m_format = wxLIST_FORMAT_CENTRE; + m_width = 0; + m_text = wxEmptyString; + + if (m_attr) delete m_attr; + m_attr = NULL; +} + +void wxListItem::ClearAttributes() +{ + if (m_attr) delete m_attr; + m_attr = NULL; +} + +static void wxConvertFromMSWListItem(HWND hwndListCtrl, + wxListItem& info, + LV_ITEM& lvItem) { info.m_data = lvItem.lParam; info.m_mask = 0; @@ -1425,7 +2201,7 @@ static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, L long oldMask = lvItem.mask; bool needText = FALSE; - if (getFullInfo != 0) + if (hwndListCtrl != 0) { if ( lvItem.mask & LVIF_TEXT ) needText = FALSE; @@ -1437,9 +2213,8 @@ static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, L lvItem.pszText = new wxChar[513]; lvItem.cchTextMax = 512; } - // lvItem.mask |= TVIF_HANDLE | TVIF_STATE | TVIF_TEXT | TVIF_IMAGE | TVIF_SELECTEDIMAGE | TVIF_CHILDREN | TVIF_PARAM; lvItem.mask |= LVIF_TEXT | LVIF_IMAGE | LVIF_PARAM; - ::SendMessage(getFullInfo, LVM_GETITEM, 0, (LPARAM)& lvItem); + ::SendMessage(hwndListCtrl, LVM_GETITEM, 0, (LPARAM)& lvItem); } if ( lvItem.mask & LVIF_STATE ) @@ -1496,7 +2271,37 @@ static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, L lvItem.mask = oldMask; } -static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& lvItem) +static void wxConvertToMSWFlags(long state, long stateMask, LV_ITEM& lvItem) +{ + if (stateMask & wxLIST_STATE_CUT) + { + lvItem.stateMask |= LVIS_CUT; + if (state & wxLIST_STATE_CUT) + lvItem.state |= LVIS_CUT; + } + if (stateMask & wxLIST_STATE_DROPHILITED) + { + lvItem.stateMask |= LVIS_DROPHILITED; + if (state & wxLIST_STATE_DROPHILITED) + lvItem.state |= LVIS_DROPHILITED; + } + if (stateMask & wxLIST_STATE_FOCUSED) + { + lvItem.stateMask |= LVIS_FOCUSED; + if (state & wxLIST_STATE_FOCUSED) + lvItem.state |= LVIS_FOCUSED; + } + if (stateMask & wxLIST_STATE_SELECTED) + { + lvItem.stateMask |= LVIS_SELECTED; + if (state & wxLIST_STATE_SELECTED) + lvItem.state |= LVIS_SELECTED; + } +} + +static void wxConvertToMSWListItem(const wxListCtrl *ctrl, + const wxListItem& info, + LV_ITEM& lvItem) { lvItem.iItem = (int) info.m_itemId; @@ -1510,30 +2315,8 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ if (info.m_mask & wxLIST_MASK_STATE) { lvItem.mask |= LVIF_STATE; - if (info.m_stateMask & wxLIST_STATE_CUT) - { - lvItem.stateMask |= LVIS_CUT; - if (info.m_state & wxLIST_STATE_CUT) - lvItem.state |= LVIS_CUT; - } - if (info.m_stateMask & wxLIST_STATE_DROPHILITED) - { - lvItem.stateMask |= LVIS_DROPHILITED; - if (info.m_state & wxLIST_STATE_DROPHILITED) - lvItem.state |= LVIS_DROPHILITED; - } - if (info.m_stateMask & wxLIST_STATE_FOCUSED) - { - lvItem.stateMask |= LVIS_FOCUSED; - if (info.m_state & wxLIST_STATE_FOCUSED) - lvItem.state |= LVIS_FOCUSED; - } - if (info.m_stateMask & wxLIST_STATE_SELECTED) - { - lvItem.stateMask |= LVIS_SELECTED; - if (info.m_state & wxLIST_STATE_SELECTED) - lvItem.state |= LVIS_SELECTED; - } + + wxConvertToMSWFlags(info.m_state, info.m_stateMask, lvItem); } if (info.m_mask & wxLIST_MASK_TEXT) @@ -1545,7 +2328,8 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ } else { - lvItem.pszText = WXSTRINGCAST info.m_text; + // pszText is not const, hence the cast + lvItem.pszText = (wxChar *)info.m_text.c_str(); if ( lvItem.pszText ) lvItem.cchTextMax = info.m_text.Length(); else @@ -1558,20 +2342,52 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ lvItem.mask |= LVIF_PARAM; } -// ---------------------------------------------------------------------------- -// List event -// ---------------------------------------------------------------------------- +static void wxConvertToMSWListCol(int col, const wxListItem& item, + LV_COLUMN& lvCol) +{ + wxZeroMemory(lvCol); -IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent) + if ( item.m_mask & wxLIST_MASK_TEXT ) + { + lvCol.mask |= LVCF_TEXT; + lvCol.pszText = (wxChar *)item.m_text.c_str(); // cast is safe + } -wxListEvent::wxListEvent(wxEventType commandType, int id) - : wxNotifyEvent(commandType, id) -{ - m_code = 0; - m_itemIndex = 0; - m_col = 0; - m_cancelled = FALSE; -} + if ( item.m_mask & wxLIST_MASK_FORMAT ) + { + lvCol.mask |= LVCF_FMT; + + if ( item.m_format == wxLIST_FORMAT_LEFT ) + lvCol.fmt = LVCFMT_LEFT; + else if ( item.m_format == wxLIST_FORMAT_RIGHT ) + lvCol.fmt = LVCFMT_RIGHT; + else if ( item.m_format == wxLIST_FORMAT_CENTRE ) + lvCol.fmt = LVCFMT_CENTER; + } -#endif // __WIN95__ + if ( item.m_mask & wxLIST_MASK_WIDTH ) + { + lvCol.mask |= LVCF_WIDTH; + if ( item.m_width == wxLIST_AUTOSIZE) + lvCol.cx = LVSCW_AUTOSIZE; + else if ( item.m_width == wxLIST_AUTOSIZE_USEHEADER) + lvCol.cx = LVSCW_AUTOSIZE_USEHEADER; + else + lvCol.cx = item.m_width; + } + +#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \ + && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 1 ) ) + if ( item.m_mask & wxLIST_MASK_IMAGE ) + { + if ( wxTheApp->GetComCtl32Version() >= 470 ) + { + lvCol.mask |= LVCF_IMAGE; + lvCol.iImage = item.m_image; + } + //else: it doesn't support item images anyhow + } +#endif +} +#endif // wxUSE_LISTCTRL