X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/97c611f84745e193ac2b156a92dd127aaa9c7d51..96c9640205933ad0673d5af2c96af0816c50160c:/src/msw/listctrl.cpp diff --git a/src/msw/listctrl.cpp b/src/msw/listctrl.cpp index c3193b7198..1b0a6c74ac 100644 --- a/src/msw/listctrl.cpp +++ b/src/msw/listctrl.cpp @@ -2,7 +2,7 @@ // Name: src/msw/listctrl.cpp // Purpose: wxListCtrl // Author: Julian Smart -// Modified by: +// Modified by: Agron Selimaj // Created: 04/01/98 // RCS-ID: $Id$ // Copyright: (c) Julian Smart @@ -17,11 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "listctrl.h" - #pragma implementation "listctrlbase.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -29,23 +24,28 @@ #pragma hdrstop #endif -#if wxUSE_LISTCTRL && defined(__WIN95__) +#if wxUSE_LISTCTRL + +#include "wx/listctrl.h" #ifndef WX_PRECOMP + #include "wx/msw/wrapcctl.h" // include "properly" #include "wx/app.h" #include "wx/intl.h" #include "wx/log.h" #include "wx/settings.h" + #include "wx/stopwatch.h" + #include "wx/dcclient.h" + #include "wx/textctrl.h" #endif -#include "wx/textctrl.h" #include "wx/imaglist.h" -#include "wx/listctrl.h" -#include "wx/dcclient.h" +#include "wx/vector.h" #include "wx/msw/private.h" +#include "wx/msw/private/keyboard.h" -#if defined(__WXWINCE__) +#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) #include #include #if _WIN32_WCE < 400 @@ -53,8 +53,15 @@ #endif #endif -// include "properly" -#include "wx/msw/wrapcctl.h" +// Currently gcc and watcom don't define NMLVFINDITEM, and DMC only defines +// it by its old name NM_FINDTIEM. +// +#if defined(__VISUALC__) || defined(__BORLANDC__) || defined(NMLVFINDITEM) + #define HAVE_NMLVFINDITEM 1 +#elif defined(__DMC__) || defined(NM_FINDITEM) + #define HAVE_NMLVFINDITEM 1 + #define NMLVFINDITEM NM_FINDITEM +#endif // ---------------------------------------------------------------------------- // private functions @@ -73,9 +80,38 @@ static void wxConvertFromMSWListItem(HWND hwndListCtrl, /* const */ LV_ITEM& lvItem); // convert our wxListItem to LV_COLUMN -static void wxConvertToMSWListCol(int col, const wxListItem& item, +static void wxConvertToMSWListCol(HWND hwndList, + int col, + const wxListItem& item, LV_COLUMN& lvCol); +namespace +{ + +// replacement for ListView_GetSubItemRect() which provokes warnings like +// "the address of 'rc' will always evaluate as 'true'" when used with mingw32 +// 4.3+ +// +// this function does no error checking on item and subitem parameters, notice +// that subitem 0 means the whole item so there is no way to retrieve the +// rectangle of the first subitem using this function, in particular notice +// that the index is *not* 1-based, in spite of what MSDN says +inline bool +wxGetListCtrlSubItemRect(HWND hwnd, int item, int subitem, int flags, RECT& rect) +{ + rect.top = subitem; + rect.left = flags; + return ::SendMessage(hwnd, LVM_GETSUBITEMRECT, item, (LPARAM)&rect) != 0; +} + +inline bool +wxGetListCtrlItemRect(HWND hwnd, int item, int flags, RECT& rect) +{ + return wxGetListCtrlSubItemRect(hwnd, item, 0, flags, rect); +} + +} // anonymous namespace + // ---------------------------------------------------------------------------- // private helper classes // ---------------------------------------------------------------------------- @@ -108,20 +144,20 @@ public: // init without conversion void Init(LV_ITEM_NATIVE& item) { - wxASSERT_MSG( !m_pItem, _T("Init() called twice?") ); + wxASSERT_MSG( !m_pItem, wxT("Init() called twice?") ); m_pItem = &item; } // init with conversion - void Init(LV_ITEM_OTHER& item) + void Init(const LV_ITEM_OTHER& item) { // avoid unnecessary dynamic memory allocation, jjust make m_pItem // point to our own m_item // memcpy() can't work if the struct sizes are different wxCOMPILE_TIME_ASSERT( sizeof(LV_ITEM_OTHER) == sizeof(LV_ITEM_NATIVE), - CodeCantWorkIfDiffSizes); + CodeCantWorkIfDiffSizes); memcpy(&m_item, &item, sizeof(LV_ITEM_NATIVE)); @@ -153,7 +189,7 @@ private: LV_ITEM_NATIVE *m_pItem; LV_ITEM_NATIVE m_item; - DECLARE_NO_COPY_CLASS(wxLV_ITEM) + wxDECLARE_NO_COPY_CLASS(wxLV_ITEM); }; /////////////////////////////////////////////////////// @@ -161,158 +197,38 @@ private: // The MSW version had problems with SetTextColour() et // al as the wxListItemAttr's were stored keyed on the // item index. If a item was inserted anywhere but the end -// of the list the the text attributes (colour etc) for +// of the list the text attributes (colour etc) for // the following items were out of sync. // // Solution: // Under MSW the only way to associate data with a List -// item independant of its position in the list is to +// item independent of its position in the list is to // store a pointer to it in its lParam attribute. However // user programs are already using this (via the // SetItemData() GetItemData() calls). // // However what we can do is store a pointer to a // structure which contains the attributes we want *and* -// a lParam for the users data, e.g. -// -// class wxListItemInternalData -// { -// public: -// wxListItemAttr *attr; -// long lParam; // user data -// }; +// a lParam -- and this is what wxMSWListItemData does. // -// To conserve memory, a wxListItemInternalData is +// To conserve memory, a wxMSWListItemData is // only allocated for a LV_ITEM if text attributes or // user data(lparam) are being set. - - -// class wxListItemInternalData -class wxListItemInternalData +class wxMSWListItemData { public: - wxListItemAttr *attr; - LPARAM lParam; // user data + wxMSWListItemData() : attr(NULL), lParam(0) {} + ~wxMSWListItemData() { delete attr; } - wxListItemInternalData() : attr(NULL), lParam(0) {} - ~wxListItemInternalData() - { - if (attr) - delete attr; - }; + wxListItemAttr *attr; + LPARAM lParam; // real user data - DECLARE_NO_COPY_CLASS(wxListItemInternalData) + wxDECLARE_NO_COPY_CLASS(wxMSWListItemData); }; -// Get the internal data structure -static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId); -static wxListItemInternalData *wxGetInternalData(const wxListCtrl *ctl, long itemId); -static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId); -static void wxDeleteInternalData(wxListCtrl* ctl, long itemId); - - -// ---------------------------------------------------------------------------- -// events -// ---------------------------------------------------------------------------- - -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) - -#if wxUSE_EXTENDED_RTTI -WX_DEFINE_FLAGS( wxListCtrlStyle ) - -wxBEGIN_FLAGS( wxListCtrlStyle ) - // 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(wxLC_LIST) - wxFLAGS_MEMBER(wxLC_REPORT) - wxFLAGS_MEMBER(wxLC_ICON) - wxFLAGS_MEMBER(wxLC_SMALL_ICON) - wxFLAGS_MEMBER(wxLC_ALIGN_TOP) - wxFLAGS_MEMBER(wxLC_ALIGN_LEFT) - wxFLAGS_MEMBER(wxLC_AUTOARRANGE) - wxFLAGS_MEMBER(wxLC_USER_TEXT) - wxFLAGS_MEMBER(wxLC_EDIT_LABELS) - wxFLAGS_MEMBER(wxLC_NO_HEADER) - wxFLAGS_MEMBER(wxLC_SINGLE_SEL) - wxFLAGS_MEMBER(wxLC_SORT_ASCENDING) - wxFLAGS_MEMBER(wxLC_SORT_DESCENDING) - wxFLAGS_MEMBER(wxLC_VIRTUAL) - -wxEND_FLAGS( wxListCtrlStyle ) - -IMPLEMENT_DYNAMIC_CLASS_XTI(wxListCtrl, wxControl,"wx/listctrl.h") - -wxBEGIN_PROPERTIES_TABLE(wxListCtrl) - wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent ) - - wxPROPERTY_FLAGS( WindowStyle , wxListCtrlStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style -wxEND_PROPERTIES_TABLE() - -wxBEGIN_HANDLERS_TABLE(wxListCtrl) -wxEND_HANDLERS_TABLE() - -wxCONSTRUCTOR_5( wxListCtrl , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle ) - -/* - TODO : Expose more information of a list's layout etc. via appropriate objects (à la NotebookPageInfo) -*/ -#else -IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl) -#endif - -IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl) -IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject) - -IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent) - -BEGIN_EVENT_TABLE(wxListCtrl, wxControl) +BEGIN_EVENT_TABLE(wxListCtrl, wxListCtrlBase) EVT_PAINT(wxListCtrl::OnPaint) + EVT_CHAR_HOOK(wxListCtrl::OnCharHook) END_EVENT_TABLE() // ============================================================================ @@ -325,16 +241,18 @@ END_EVENT_TABLE() void wxListCtrl::Init() { - m_imageListNormal = NULL; - m_imageListSmall = NULL; + m_imageListNormal = + m_imageListSmall = m_imageListState = NULL; - m_ownsImageListNormal = m_ownsImageListSmall = m_ownsImageListState = FALSE; + m_ownsImageListNormal = + m_ownsImageListSmall = + m_ownsImageListState = false; + m_colCount = 0; m_count = 0; - m_ignoreChangeMessages = FALSE; m_textCtrl = NULL; - m_AnyInternalData = FALSE; - m_hasAnyAttr = FALSE; + + m_hasAnyAttr = false; } bool wxListCtrl::Create(wxWindow *parent, @@ -346,48 +264,64 @@ bool wxListCtrl::Create(wxWindow *parent, const wxString& name) { if ( !CreateControl(parent, id, pos, size, style, validator, name) ) - return FALSE; + return false; - if ( !MSWCreateControl(WC_LISTVIEW, _T(""), pos, size) ) - return FALSE; + if ( !MSWCreateControl(WC_LISTVIEW, wxEmptyString, pos, size) ) + return false; // explicitly say that we want to use Unicode because otherwise we get ANSI // versions of _some_ messages (notably LVN_GETDISPINFOA) in MSLU build -#if wxUSE_UNICODE - ::SendMessage(GetHwnd(), LVM_SETUNICODEFORMAT, TRUE, 0); -#endif + wxSetCCUnicodeFormat(GetHwnd()); - // for comctl32.dll v 4.70+ we want to have this attribute because it's - // prettier (and also because wxGTK does it like this) - if ( HasFlag(wxLC_REPORT) && wxTheApp->GetComCtl32Version() >= 470 ) - { - ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE, - 0, LVS_EX_FULLROWSELECT); - } + // We must set the default text colour to the system/theme color, otherwise + // GetTextColour will always return black + SetTextColour(GetDefaultAttributes().colFg); + + if ( InReportView() ) + MSWSetExListStyles(); - // inherit foreground colour but our background should be the same as for - // listboxes and other such "container" windows and not inherited - SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW)); - SetForegroundColour(GetParent()->GetForegroundColour()); + return true; +} - return TRUE; +void wxListCtrl::MSWSetExListStyles() +{ + // for comctl32.dll v 4.70+ we want to have some non default extended + // styles because it's prettier (and also because wxGTK does it like this) + if ( wxApp::GetComCtl32Version() >= 470 ) + { + ::SendMessage + ( + GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE, 0, + // LVS_EX_LABELTIP shouldn't be used under Windows CE where it's + // not defined in the SDK headers +#ifdef LVS_EX_LABELTIP + LVS_EX_LABELTIP | +#endif + LVS_EX_FULLROWSELECT | + LVS_EX_SUBITEMIMAGES | + // normally this should be governed by a style as it's probably not + // always appropriate, but we don't have any free styles left and + // it seems better to enable it by default than disable + LVS_EX_HEADERDRAGDROP + ); + } } WXDWORD wxListCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const { - WXDWORD wstyle = wxControl::MSWGetStyle(style, exstyle); + WXDWORD wstyle = wxListCtrlBase::MSWGetStyle(style, exstyle); wstyle |= LVS_SHAREIMAGELISTS | LVS_SHOWSELALWAYS; -#ifdef __WXDEBUG__ +#if wxDEBUG_LEVEL size_t nModes = 0; #define MAP_MODE_STYLE(wx, ms) \ if ( style & (wx) ) { wstyle |= (ms); nModes++; } -#else // !__WXDEBUG__ +#else // !wxDEBUG_LEVEL #define MAP_MODE_STYLE(wx, ms) \ if ( style & (wx) ) wstyle |= (ms); -#endif // __WXDEBUG__ +#endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL MAP_MODE_STYLE(wxLC_ICON, LVS_ICON) MAP_MODE_STYLE(wxLC_SMALL_ICON, LVS_SMALLICON) @@ -395,7 +329,7 @@ WXDWORD wxListCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const MAP_MODE_STYLE(wxLC_REPORT, LVS_REPORT) wxASSERT_MSG( nModes == 1, - _T("wxListCtrl style should have exactly one mode bit set") ); + wxT("wxListCtrl style should have exactly one mode bit set") ); #undef MAP_MODE_STYLE @@ -425,7 +359,7 @@ WXDWORD wxListCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const wstyle |= LVS_SORTASCENDING; wxASSERT_MSG( !(style & wxLC_SORT_DESCENDING), - _T("can't sort in ascending and descending orders at once") ); + wxT("can't sort in ascending and descending orders at once") ); } else if ( style & wxLC_SORT_DESCENDING ) wstyle |= LVS_SORTDESCENDING; @@ -433,7 +367,7 @@ WXDWORD wxListCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) ) if ( style & wxLC_VIRTUAL ) { - int ver = wxTheApp->GetComCtl32Version(); + int ver = wxApp::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."), @@ -454,48 +388,61 @@ void wxListCtrl::UpdateStyle() // The new window view style DWORD dwStyleNew = MSWGetStyle(m_windowStyle, NULL); + // some styles are not returned by MSWGetStyle() + if ( IsShown() ) + dwStyleNew |= WS_VISIBLE; + // Get the current window style. DWORD dwStyleOld = ::GetWindowLong(GetHwnd(), GWL_STYLE); + // we don't have wxVSCROLL style, but the list control may have it, + // don't change it then + dwStyleNew |= dwStyleOld & (WS_HSCROLL | WS_VSCROLL); + // Only set the window style if the view bits have changed. if ( dwStyleOld != dwStyleNew ) { ::SetWindowLong(GetHwnd(), GWL_STYLE, dwStyleNew); + + // if we switched to the report view, set the extended styles for + // it too + if ( !(dwStyleOld & LVS_REPORT) && (dwStyleNew & LVS_REPORT) ) + MSWSetExListStyles(); } } } void wxListCtrl::FreeAllInternalData() { - if (m_AnyInternalData) - { - int n = GetItemCount(); - int i = 0; - - m_ignoreChangeMessages = TRUE; - for (i = 0; i < n; i++) - wxDeleteInternalData(this, i); - m_ignoreChangeMessages = FALSE; + const unsigned count = m_internalData.size(); + for ( unsigned n = 0; n < count; n++ ) + delete m_internalData[n]; - m_AnyInternalData = FALSE; - } + m_internalData.clear(); } -wxListCtrl::~wxListCtrl() +void wxListCtrl::DeleteEditControl() { - FreeAllInternalData(); - if ( m_textCtrl ) { m_textCtrl->UnsubclassWin(); m_textCtrl->SetHWND(0); - delete m_textCtrl; - m_textCtrl = NULL; + wxDELETE(m_textCtrl); } +} + +wxListCtrl::~wxListCtrl() +{ + FreeAllInternalData(); + + DeleteEditControl(); - if (m_ownsImageListNormal) delete m_imageListNormal; - if (m_ownsImageListSmall) delete m_imageListSmall; - if (m_ownsImageListState) delete m_imageListState; + if (m_ownsImageListNormal) + delete m_imageListNormal; + if (m_ownsImageListSmall) + delete m_imageListSmall; + if (m_ownsImageListState) + delete m_imageListState; } // ---------------------------------------------------------------------------- @@ -518,52 +465,58 @@ void wxListCtrl::SetSingleStyle(long style, bool add) flag = flag & ~wxLC_MASK_SORT; } - if ( flag & style ) - { - if ( !add ) - flag -= style; - } + if ( add ) + flag |= style; else - { - if ( add ) - { - flag |= style; - } - } - - m_windowStyle = flag; + flag &= ~style; - UpdateStyle(); + SetWindowStyleFlag(flag); } // Set the whole window style void wxListCtrl::SetWindowStyleFlag(long flag) { - m_windowStyle = flag; + if ( flag != m_windowStyle ) + { + wxListCtrlBase::SetWindowStyleFlag(flag); + + UpdateStyle(); - UpdateStyle(); + Refresh(); + } } // ---------------------------------------------------------------------------- // accessors // ---------------------------------------------------------------------------- +/* static */ wxVisualAttributes +wxListCtrl::GetClassDefaultAttributes(wxWindowVariant variant) +{ + wxVisualAttributes attrs = GetCompositeControlsDefaultAttributes(variant); + + // common controls have their own default font + attrs.font = wxGetCCDefaultFont(); + + return attrs; +} + // Sets the foreground, i.e. text, colour bool wxListCtrl::SetForegroundColour(const wxColour& col) { if ( !wxWindow::SetForegroundColour(col) ) - return FALSE; + return false; ListView_SetTextColor(GetHwnd(), wxColourToRGB(col)); - return TRUE; + return true; } // Sets the background colour bool wxListCtrl::SetBackgroundColour(const wxColour& col) { if ( !wxWindow::SetBackgroundColour(col) ) - return FALSE; + return false; // we set the same colour for both the "empty" background and the items // background @@ -571,7 +524,7 @@ bool wxListCtrl::SetBackgroundColour(const wxColour& col) ListView_SetBkColor(GetHwnd(), color); ListView_SetTextBkColor(GetHwnd(), color); - return TRUE; + return true; } // Gets information about this column @@ -643,10 +596,10 @@ bool wxListCtrl::GetColumn(int col, wxListItem& item) const } // Sets information about this column -bool wxListCtrl::SetColumn(int col, wxListItem& item) +bool wxListCtrl::SetColumn(int col, const wxListItem& item) { LV_COLUMN lvCol; - wxConvertToMSWListCol(col, item, lvCol); + wxConvertToMSWListCol(GetHwnd(), col, item, lvCol); return ListView_SetColumn(GetHwnd(), col, &lvCol) != 0; } @@ -660,19 +613,78 @@ int wxListCtrl::GetColumnWidth(int col) const // Sets the column width bool wxListCtrl::SetColumnWidth(int col, int width) { - int col2 = col; if ( m_windowStyle & wxLC_LIST ) - col2 = -1; + col = 0; + + if ( width == wxLIST_AUTOSIZE) + width = LVSCW_AUTOSIZE; + else if ( width == wxLIST_AUTOSIZE_USEHEADER) + width = LVSCW_AUTOSIZE_USEHEADER; + + return ListView_SetColumnWidth(GetHwnd(), col, width) != 0; +} + +// ---------------------------------------------------------------------------- +// columns order +// ---------------------------------------------------------------------------- + +int wxListCtrl::GetColumnIndexFromOrder(int order) const +{ + const int numCols = GetColumnCount(); + wxCHECK_MSG( order >= 0 && order < numCols, -1, + wxT("Column position out of bounds") ); + + wxArrayInt indexArray(numCols); + if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &indexArray[0]) ) + return -1; + + return indexArray[order]; +} + +int wxListCtrl::GetColumnOrder(int col) const +{ + const int numCols = GetColumnCount(); + wxASSERT_MSG( col >= 0 && col < numCols, wxT("Column index out of bounds") ); + + wxArrayInt indexArray(numCols); + if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &indexArray[0]) ) + return -1; + + for ( int pos = 0; pos < numCols; pos++ ) + { + if ( indexArray[pos] == col ) + return pos; + } + + wxFAIL_MSG( wxT("no column with with given order?") ); + + return -1; +} + +// Gets the column order for all columns +wxArrayInt wxListCtrl::GetColumnsOrder() const +{ + const int numCols = GetColumnCount(); + + wxArrayInt orders(numCols); + if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &orders[0]) ) + orders.clear(); - int width2 = width; - if ( width2 == wxLIST_AUTOSIZE) - width2 = LVSCW_AUTOSIZE; - else if ( width2 == wxLIST_AUTOSIZE_USEHEADER) - width2 = LVSCW_AUTOSIZE_USEHEADER; + return orders; +} + +// Sets the column order for all columns +bool wxListCtrl::SetColumnsOrder(const wxArrayInt& orders) +{ + const int numCols = GetColumnCount(); + + wxCHECK_MSG( orders.size() == (size_t)numCols, false, + wxT("wrong number of elements in column orders array") ); - return ListView_SetColumnWidth(GetHwnd(), col2, width2) != 0; + return ListView_SetColumnOrderArray(GetHwnd(), numCols, &orders[0]) != 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 @@ -685,6 +697,25 @@ int wxListCtrl::GetCountPerPage() const // Gets the edit control for editing labels. wxTextCtrl* wxListCtrl::GetEditControl() const { + // first check corresponds to the case when the label editing was started + // by user and hence m_textCtrl wasn't created by EditLabel() at all, while + // the second case corresponds to us being called from inside EditLabel() + // (e.g. from a user wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT handler): in this + // case EditLabel() did create the control but it didn't have an HWND to + // initialize it with yet + if ( !m_textCtrl || !m_textCtrl->GetHWND() ) + { + HWND hwndEdit = ListView_GetEditControl(GetHwnd()); + if ( hwndEdit ) + { + wxListCtrl * const self = const_cast(this); + + if ( !m_textCtrl ) + self->m_textCtrl = new wxTextCtrl; + self->InitEditControl((WXHWND)hwndEdit); + } + } + return m_textCtrl; } @@ -717,8 +748,7 @@ bool wxListCtrl::GetItem(wxListItem& info) const if ( info.m_mask & wxLIST_MASK_STATE ) { lvItem.mask |= LVIF_STATE; - // the other bits are hardly interesting anyhow - lvItem.stateMask = LVIS_SELECTED | LVIS_FOCUSED; + wxConvertToMSWFlags(0, info.m_stateMask, lvItem); } bool success = ListView_GetItem((HWND)GetHWND(), &lvItem) != 0; @@ -742,55 +772,60 @@ bool wxListCtrl::GetItem(wxListItem& info) const // Sets information about the item bool wxListCtrl::SetItem(wxListItem& info) { + const long id = info.GetId(); + wxCHECK_MSG( id >= 0 && id < GetItemCount(), false, + wxT("invalid item index in SetItem") ); + LV_ITEM item; wxConvertToMSWListItem(this, info, item); // we never update the lParam if it contains our pointer - // to the wxListItemInternalData structure + // to the wxMSWListItemData structure item.mask &= ~LVIF_PARAM; // check if setting attributes or lParam - if (info.HasAttributes() || (info.m_mask & wxLIST_MASK_DATA)) + if ( info.HasAttributes() || (info.m_mask & wxLIST_MASK_DATA) ) { // get internal item data - // perhaps a cache here ? - wxListItemInternalData *data = wxGetInternalData(this, info.m_itemId); + wxMSWListItemData *data = MSWGetItemData(id); - if (! data) + if ( !data ) { - // need to set it - m_AnyInternalData = TRUE; - data = new wxListItemInternalData(); + // need to allocate the internal data object + data = new wxMSWListItemData; + m_internalData.push_back(data); item.lParam = (LPARAM) data; item.mask |= LVIF_PARAM; - }; + } // user data - if (info.m_mask & wxLIST_MASK_DATA) + if ( info.m_mask & wxLIST_MASK_DATA ) data->lParam = info.m_data; // attributes - if (info.HasAttributes()) + if ( info.HasAttributes() ) { - if (data->attr) - *data->attr = *info.GetAttributes(); + const wxListItemAttr& attrNew = *info.GetAttributes(); + + // don't overwrite the already set attributes if we have them + if ( data->attr ) + data->attr->AssignFrom(attrNew); else - data->attr = new wxListItemAttr(*info.GetAttributes()); - }; - }; + data->attr = new wxListItemAttr(attrNew); + } + } // 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")); + wxLogDebug(wxT("ListView_SetItem() failed")); - return FALSE; + return false; } } @@ -800,10 +835,10 @@ bool wxListCtrl::SetItem(wxListItem& info) // check whether it has any custom attributes if ( info.HasAttributes() ) { - m_hasAnyAttr = TRUE; + m_hasAnyAttr = true; // if the colour has changed, we must redraw the item - updateNow = TRUE; + updateNow = true; } if ( updateNow ) @@ -812,7 +847,7 @@ bool wxListCtrl::SetItem(wxListItem& info) RefreshItem(item.iItem); } - return TRUE; + return true; } long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId) @@ -856,14 +891,15 @@ bool wxListCtrl::SetItemState(long item, long state, long stateMask) wxConvertToMSWFlags(state, stateMask, lvItem); + const bool changingFocus = (stateMask & wxLIST_STATE_FOCUSED) && + (state & wxLIST_STATE_FOCUSED); + // 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) ) + if ( IsVirtual() && changingFocus ) { focusOld = GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED); } @@ -875,9 +911,9 @@ bool wxListCtrl::SetItemState(long item, long state, long stateMask) if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE, (WPARAM)item, (LPARAM)&lvItem) ) { - wxLogLastError(_T("ListView_SetItemState")); + wxLogLastError(wxT("ListView_SetItemState")); - return FALSE; + return false; } if ( focusOld != -1 ) @@ -891,28 +927,46 @@ bool wxListCtrl::SetItemState(long item, long state, long stateMask) } } - return TRUE; + // we expect the selection anchor, i.e. the item from which multiple + // selection (such as performed with e.g. Shift-arrows) starts, to be the + // same as the currently focused item but the native control doesn't update + // it when we change focus and leaves at the last item it set itself focus + // to, so do it explicitly + if ( changingFocus && !HasFlag(wxLC_SINGLE_SEL) ) + { + ListView_SetSelectionMark(GetHwnd(), item); + } + + return true; } // Sets the item image bool wxListCtrl::SetItemImage(long item, int image, int WXUNUSED(selImage)) +{ + return SetItemColumnImage(item, 0, image); +} + +// Sets the item image +bool wxListCtrl::SetItemColumnImage(long item, long column, int image) { wxListItem info; info.m_mask = wxLIST_MASK_IMAGE; info.m_image = image; info.m_itemId = item; + info.m_col = column; return SetItem(info); } // Gets the item text -wxString wxListCtrl::GetItemText(long item) const +wxString wxListCtrl::GetItemText(long item, int col) const { wxListItem info; info.m_mask = wxLIST_MASK_TEXT; info.m_itemId = item; + info.m_col = col; if (!GetItem(info)) return wxEmptyString; @@ -931,8 +985,21 @@ void wxListCtrl::SetItemText(long item, const wxString& str) SetItem(info); } +// Gets the internal item data +wxMSWListItemData *wxListCtrl::MSWGetItemData(long itemId) const +{ + LV_ITEM it; + it.mask = LVIF_PARAM; + it.iItem = itemId; + + if ( !ListView_GetItem(GetHwnd(), &it) ) + return NULL; + + return (wxMSWListItemData *) it.lParam; +} + // Gets the item data -long wxListCtrl::GetItemData(long item) const +wxUIntPtr wxListCtrl::GetItemData(long item) const { wxListItem info; @@ -945,7 +1012,7 @@ long wxListCtrl::GetItemData(long item) const } // Sets the item data -bool wxListCtrl::SetItemData(long item, long data) +bool wxListCtrl::SetItemPtrData(long item, wxUIntPtr data) { wxListItem info; @@ -958,19 +1025,40 @@ bool wxListCtrl::SetItemData(long item, long data) wxRect wxListCtrl::GetViewRect() const { - wxASSERT_MSG( !HasFlag(wxLC_REPORT | wxLC_LIST), - _T("wxListCtrl::GetViewRect() only works in icon mode") ); + wxRect rect; - RECT rc; - if ( !ListView_GetViewRect(GetHwnd(), &rc) ) + // ListView_GetViewRect() can only be used in icon and small icon views + // (this is documented in MSDN and, indeed, it returns bogus results in + // report view, at least with comctl32.dll v6 under Windows 2003) + if ( HasFlag(wxLC_ICON | wxLC_SMALL_ICON) ) { - wxLogDebug(_T("ListView_GetViewRect() failed.")); + RECT rc; + if ( !ListView_GetViewRect(GetHwnd(), &rc) ) + { + wxLogDebug(wxT("ListView_GetViewRect() failed.")); + + wxZeroMemory(rc); + } - wxZeroMemory(rc); + wxCopyRECTToRect(rc, rect); } + else if ( HasFlag(wxLC_REPORT) ) + { + const long count = GetItemCount(); + if ( count ) + { + GetItemRect(wxMin(GetTopItem() + GetCountPerPage(), count - 1), rect); - wxRect rect; - wxCopyRECTToRect(rc, rect); + // extend the rectangle to start at the top (we include the column + // headers, if any, for compatibility with the generic version) + rect.height += rect.y; + rect.y = 0; + } + } + else + { + wxFAIL_MSG( wxT("not implemented in this mode") ); + } return rect; } @@ -978,7 +1066,21 @@ wxRect wxListCtrl::GetViewRect() const // Gets the item rectangle bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const { - RECT rectWin; + return GetSubItemRect( item, wxLIST_GETSUBITEMRECT_WHOLEITEM, rect, code) ; +} + +bool wxListCtrl::GetSubItemRect(long item, long subItem, wxRect& rect, int code) const +{ + // ListView_GetSubItemRect() doesn't do subItem error checking and returns + // true even for the out of range values of it (even if the results are + // completely bogus in this case), so we check item validity ourselves + wxCHECK_MSG( subItem == wxLIST_GETSUBITEMRECT_WHOLEITEM || + (subItem >= 0 && subItem < GetColumnCount()), + false, wxT("invalid sub item index") ); + + // use wxCHECK_MSG against "item" too, for coherency with the generic implementation: + wxCHECK_MSG( item >= 0 && item < GetItemCount(), false, + wxT("invalid item in GetSubItemRect") ); int codeWin; if ( code == wxLIST_RECT_BOUNDS ) @@ -989,21 +1091,37 @@ bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const codeWin = LVIR_LABEL; else { - wxFAIL_MSG( _T("incorrect code in GetItemRect()") ); - + wxFAIL_MSG( wxT("incorrect code in GetItemRect() / GetSubItemRect()") ); codeWin = LVIR_BOUNDS; } - bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0; + RECT rectWin; + if ( !wxGetListCtrlSubItemRect + ( + GetHwnd(), + item, + subItem == wxLIST_GETSUBITEMRECT_WHOLEITEM ? 0 : subItem, + codeWin, + rectWin + ) ) + { + return false; + } + + wxCopyRECTToRect(rectWin, rect); - rect.x = rectWin.left; - rect.y = rectWin.top; - rect.width = rectWin.right - rectWin.left; - rect.height = rectWin.bottom - rectWin.top; + // there is no way to retrieve the first sub item bounding rectangle using + // wxGetListCtrlSubItemRect() as 0 means the whole item, so we need to + // truncate it at first column ourselves + if ( subItem == 0 && code == wxLIST_RECT_BOUNDS ) + rect.width = GetColumnWidth(0); - return success; + return true; } + + + // Gets the item position bool wxListCtrl::GetItemPosition(long item, wxPoint& pos) const { @@ -1034,11 +1152,15 @@ wxSize wxListCtrl::GetItemSpacing() const return wxSize(LOWORD(spacing), HIWORD(spacing)); } +#if WXWIN_COMPATIBILITY_2_6 + int wxListCtrl::GetItemSpacing(bool isSmall) const { return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall); } +#endif // WXWIN_COMPATIBILITY_2_6 + void wxListCtrl::SetItemTextColour( long item, const wxColour &col ) { wxListItem info; @@ -1050,7 +1172,7 @@ void wxListCtrl::SetItemTextColour( long item, const wxColour &col ) wxColour wxListCtrl::GetItemTextColour( long item ) const { wxColour col; - wxListItemInternalData *data = wxGetInternalData(this, item); + wxMSWListItemData *data = MSWGetItemData(item); if ( data && data->attr ) col = data->attr->GetTextColour(); @@ -1068,13 +1190,31 @@ void wxListCtrl::SetItemBackgroundColour( long item, const wxColour &col ) wxColour wxListCtrl::GetItemBackgroundColour( long item ) const { wxColour col; - wxListItemInternalData *data = wxGetInternalData(this, item); + wxMSWListItemData *data = MSWGetItemData(item); if ( data && data->attr ) col = data->attr->GetBackgroundColour(); return col; } +void wxListCtrl::SetItemFont( long item, const wxFont &f ) +{ + wxListItem info; + info.m_itemId = item; + info.SetFont( f ); + SetItem( info ); +} + +wxFont wxListCtrl::GetItemFont( long item ) const +{ + wxFont f; + wxMSWListItemData *data = MSWGetItemData(item); + if ( data && data->attr ) + f = data->attr->GetFont(); + + return f; +} + // Gets the number of selected items in the list control int wxListCtrl::GetSelectedItemCount() const { @@ -1163,34 +1303,57 @@ void wxListCtrl::SetImageList(wxImageList *imageList, int which) flags = LVSIL_NORMAL; if (m_ownsImageListNormal) delete m_imageListNormal; m_imageListNormal = imageList; - m_ownsImageListNormal = FALSE; + m_ownsImageListNormal = false; } else if ( which == wxIMAGE_LIST_SMALL ) { flags = LVSIL_SMALL; if (m_ownsImageListSmall) delete m_imageListSmall; m_imageListSmall = imageList; - m_ownsImageListSmall = FALSE; + m_ownsImageListSmall = false; } else if ( which == wxIMAGE_LIST_STATE ) { flags = LVSIL_STATE; if (m_ownsImageListState) delete m_imageListState; m_imageListState = imageList; - m_ownsImageListState = FALSE; + m_ownsImageListState = false; } - ListView_SetImageList(GetHwnd(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags); + (void) 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; + m_ownsImageListNormal = true; else if ( which == wxIMAGE_LIST_SMALL ) - m_ownsImageListSmall = TRUE; + m_ownsImageListSmall = true; else if ( which == wxIMAGE_LIST_STATE ) - m_ownsImageListState = TRUE; + m_ownsImageListState = true; +} + +// ---------------------------------------------------------------------------- +// Geometry +// ---------------------------------------------------------------------------- + +wxSize wxListCtrl::MSWGetBestViewRect(int x, int y) const +{ + const DWORD rc = ListView_ApproximateViewRect(GetHwnd(), x, y, -1); + + wxSize size(LOWORD(rc), HIWORD(rc)); + + // We have to add space for the scrollbars ourselves, they're not taken + // into account by ListView_ApproximateViewRect(), at least not with + // commctrl32.dll v6. + const DWORD mswStyle = ::GetWindowLong(GetHwnd(), GWL_STYLE); + + if ( mswStyle & WS_HSCROLL ) + size.y += wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y); + if ( mswStyle & WS_VSCROLL ) + size.x += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X); + + return size; } // ---------------------------------------------------------------------------- @@ -1218,11 +1381,11 @@ bool wxListCtrl::DeleteItem(long item) { if ( !ListView_DeleteItem(GetHwnd(), (int) item) ) { - wxLogLastError(_T("ListView_DeleteItem")); - return FALSE; + wxLogLastError(wxT("ListView_DeleteItem")); + return false; } - m_count -= 1; + m_count--; wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()), wxT("m_count should match ListView_GetItemCount")); @@ -1248,14 +1411,15 @@ bool wxListCtrl::DeleteItem(long item) RefreshRect(rectWin); } - return TRUE; + return true; } // Deletes all items bool wxListCtrl::DeleteAllItems() { - FreeAllInternalData(); - return ListView_DeleteAllItems(GetHwnd()) != 0; + // Calling ListView_DeleteAllItems() will always generate an event but we + // shouldn't do it if the control is empty + return !GetItemCount() || ListView_DeleteAllItems(GetHwnd()) != 0; } // Deletes all items @@ -1267,7 +1431,7 @@ bool wxListCtrl::DeleteAllColumns() { wxLogLastError(wxT("ListView_DeleteColumn")); - return FALSE; + return false; } m_colCount--; @@ -1275,7 +1439,7 @@ bool wxListCtrl::DeleteAllColumns() wxASSERT_MSG( m_colCount == 0, wxT("no columns should be left") ); - return TRUE; + return true; } // Deletes a column @@ -1296,54 +1460,77 @@ void wxListCtrl::ClearAll() DeleteAllColumns(); } +void wxListCtrl::InitEditControl(WXHWND hWnd) +{ + m_textCtrl->SetHWND(hWnd); + m_textCtrl->SubclassWin(hWnd); + m_textCtrl->SetParent(this); + + // we must disallow TABbing away from the control while the edit control is + // shown because this leaves it in some strange state (just try removing + // this line and then pressing TAB while editing an item in listctrl + // inside a panel) + m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle() | wxTE_PROCESS_TAB); +} + wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass) { - wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) ); + wxCHECK_MSG( textControlClass->IsKindOf(CLASSINFO(wxTextCtrl)), NULL, + "control used for label editing must be a wxTextCtrl" ); // ListView_EditLabel requires that the list has focus. SetFocus(); + // create m_textCtrl here before calling ListView_EditLabel() because it + // generates wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT event from inside it and + // the user handler for it can call GetEditControl() resulting in an on + // demand creation of a stock wxTextCtrl instead of the control of a + // (possibly) custom wxClassInfo + DeleteEditControl(); + m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject(); + WXHWND hWnd = (WXHWND) ListView_EditLabel(GetHwnd(), item); if ( !hWnd ) { // failed to start editing - return NULL; - } + wxDELETE(m_textCtrl); - // [re]create the text control wrapping the HWND we got - if ( m_textCtrl ) - { - m_textCtrl->UnsubclassWin(); - m_textCtrl->SetHWND(0); - delete m_textCtrl; + return NULL; } - m_textCtrl = (wxTextCtrl *)textControlClass->CreateObject(); - m_textCtrl->SetHWND(hWnd); - m_textCtrl->SubclassWin(hWnd); - m_textCtrl->SetParent(this); - - // we must disallow TABbing away from the control while the edit contol is - // shown because this leaves it in some strange state (just try removing - // this line and then pressing TAB while editing an item in listctrl - // inside a panel) - m_textCtrl->SetWindowStyle(m_textCtrl->GetWindowStyle() | wxTE_PROCESS_TAB); + // if GetEditControl() hasn't been called, we need to initialize the edit + // control ourselves + if ( !m_textCtrl->GetHWND() ) + InitEditControl(hWnd); return m_textCtrl; } // End label editing, optionally cancelling the edit -bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel)) +bool wxListCtrl::EndEditLabel(bool cancel) { - wxFAIL_MSG( _T("not implemented") ); + // m_textCtrl is not always ready, ie. in EVT_LIST_BEGIN_LABEL_EDIT + HWND hwnd = ListView_GetEditControl(GetHwnd()); + if ( !hwnd ) + return false; + + // Newer versions of Windows have a special ListView_CancelEditLabel() + // message for cancelling editing but it, rather counter-intuitively, keeps + // the last text entered in the dialog while cancelling as we do it below + // restores the original text which is the more expected behaviour. - return FALSE; + // We shouldn't destroy the control ourselves according to MSDN, which + // proposes WM_CANCELMODE to do this, but it doesn't seem to work so + // emulate the corresponding user action instead. + ::SendMessage(hwnd, WM_KEYDOWN, cancel ? VK_ESCAPE : VK_RETURN, 0); + + return true; } // 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) != FALSE; } // Find an item whose label matches this string, starting from the item after 'start' @@ -1355,34 +1542,53 @@ long wxListCtrl::FindItem(long start, const wxString& str, bool partial) findInfo.flags = LVFI_STRING; if ( partial ) findInfo.flags |= LVFI_PARTIAL; - findInfo.psz = str; + findInfo.psz = str.wx_str(); // 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); + return ListView_FindItem(GetHwnd(), start, &findInfo); } -// Find an item whose data matches this data, starting from the item after 'start' -// or the beginning if 'start' is -1. -// NOTE : Lindsay Mathieson - 14-July-2002 -// No longer use ListView_FindItem as the data attribute is now stored -// in a wxListItemInternalData structure refernced by the actual lParam -long wxListCtrl::FindItem(long start, long data) +// Find an item whose data matches this data, starting from the item after +// 'start' or the beginning if 'start' is -1. +long wxListCtrl::FindItem(long start, wxUIntPtr data) { - long idx = start + 1; - long count = GetItemCount(); - - while (idx < count) + // we can't use ListView_FindItem() directly as we don't store the data + // pointer itself in the control but rather our own internal data, so first + // we need to find the right value to search for (and there can be several + // of them) + int idx = wxNOT_FOUND; + const unsigned count = m_internalData.size(); + for ( unsigned n = 0; n < count; n++ ) { - if (GetItemData(idx) == data) - return idx; - idx++; - }; + if ( m_internalData[n]->lParam == (LPARAM)data ) + { + LV_FINDINFO findInfo; + findInfo.flags = LVFI_PARAM; + findInfo.lParam = (LPARAM)wxPtrToUInt(m_internalData[n]); - return -1; + int rc = ListView_FindItem(GetHwnd(), start, &findInfo); + if ( rc != -1 ) + { + if ( idx == wxNOT_FOUND || rc < idx ) + { + idx = rc; + if ( idx == start + 1 ) + { + // we can stop here, we don't risk finding a closer + // match + break; + } + } + //else: this item is after the previously found one + } + } + } + + return idx; } // Find an item nearest this position in the specified direction, starting from @@ -1405,62 +1611,96 @@ long wxListCtrl::FindItem(long start, const wxPoint& pt, int direction) else if ( direction == wxLIST_FIND_RIGHT ) findInfo.vkDirection = VK_RIGHT; - return ListView_FindItem(GetHwnd(), (int) start, & findInfo); + return ListView_FindItem(GetHwnd(), start, &findInfo); } // Determines which item (if any) is at the specified point, // giving details in 'flags' (see wxLIST_HITTEST_... flags above) -long wxListCtrl::HitTest(const wxPoint& point, int& flags) +long +wxListCtrl::HitTest(const wxPoint& point, int& flags, long *ptrSubItem) const { LV_HITTESTINFO hitTestInfo; hitTestInfo.pt.x = (int) point.x; hitTestInfo.pt.y = (int) point.y; - ListView_HitTest(GetHwnd(), & hitTestInfo); + long item; +#ifdef LVM_SUBITEMHITTEST + if ( ptrSubItem && wxApp::GetComCtl32Version() >= 470 ) + { + item = ListView_SubItemHitTest(GetHwnd(), &hitTestInfo); + *ptrSubItem = hitTestInfo.iSubItem; + } + else +#endif // LVM_SUBITEMHITTEST + { + item = ListView_HitTest(GetHwnd(), &hitTestInfo); + } flags = 0; + if ( hitTestInfo.flags & LVHT_ABOVE ) flags |= wxLIST_HITTEST_ABOVE; if ( hitTestInfo.flags & LVHT_BELOW ) flags |= wxLIST_HITTEST_BELOW; - if ( hitTestInfo.flags & LVHT_NOWHERE ) - flags |= wxLIST_HITTEST_NOWHERE; - if ( hitTestInfo.flags & LVHT_ONITEMICON ) - flags |= wxLIST_HITTEST_ONITEMICON; - if ( hitTestInfo.flags & LVHT_ONITEMLABEL ) - flags |= wxLIST_HITTEST_ONITEMLABEL; - if ( hitTestInfo.flags & LVHT_ONITEMSTATEICON ) - flags |= wxLIST_HITTEST_ONITEMSTATEICON; if ( hitTestInfo.flags & LVHT_TOLEFT ) flags |= wxLIST_HITTEST_TOLEFT; if ( hitTestInfo.flags & LVHT_TORIGHT ) flags |= wxLIST_HITTEST_TORIGHT; - return (long) hitTestInfo.iItem; + if ( hitTestInfo.flags & LVHT_NOWHERE ) + flags |= wxLIST_HITTEST_NOWHERE; + + // note a bug or at least a very strange feature of comtl32.dll (tested + // with version 4.0 under Win95 and 6.0 under Win 2003): if you click to + // the right of the item label, ListView_HitTest() returns a combination of + // LVHT_ONITEMICON, LVHT_ONITEMLABEL and LVHT_ONITEMSTATEICON -- filter out + // the bits which don't make sense + if ( hitTestInfo.flags & LVHT_ONITEMLABEL ) + { + flags |= wxLIST_HITTEST_ONITEMLABEL; + + // do not translate LVHT_ONITEMICON here, as per above + } + else + { + if ( hitTestInfo.flags & LVHT_ONITEMICON ) + flags |= wxLIST_HITTEST_ONITEMICON; + if ( hitTestInfo.flags & LVHT_ONITEMSTATEICON ) + flags |= wxLIST_HITTEST_ONITEMSTATEICON; + } + + return item; } + // Inserts an item, returning the index of the new item if successful, // -1 otherwise. -long wxListCtrl::InsertItem(wxListItem& info) +long wxListCtrl::InsertItem(const wxListItem& info) { - wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") ); + wxASSERT_MSG( !IsVirtual(), wxT("can't be used with virtual controls") ); + + // In 2.8 it was possible to succeed inserting an item without initializing + // its ID as it defaulted to 0. This was however never supported and in 2.9 + // the ID is -1 by default and inserting it simply fails, but it might be + // not obvious why does it happen, so check it proactively. + wxASSERT_MSG( info.m_itemId != -1, wxS("Item ID must be set.") ); LV_ITEM item; wxConvertToMSWListItem(this, info, item); item.mask &= ~LVIF_PARAM; - // check wether we need to allocate our internal data - bool needInternalData = ((info.m_mask & wxLIST_MASK_DATA) || info.HasAttributes()); - if (needInternalData) + // check whether we need to allocate our internal data + bool needInternalData = (info.m_mask & wxLIST_MASK_DATA) || + info.HasAttributes(); + if ( needInternalData ) { - m_AnyInternalData = TRUE; item.mask |= LVIF_PARAM; - // internal stucture that manages data - wxListItemInternalData *data = new wxListItemInternalData(); - item.lParam = (LPARAM) data; + wxMSWListItemData * const data = new wxMSWListItemData; + m_internalData.push_back(data); + item.lParam = (LPARAM)data; - if (info.m_mask & wxLIST_MASK_DATA) + if ( info.m_mask & wxLIST_MASK_DATA ) data->lParam = info.m_data; // check whether it has any custom attributes @@ -1470,11 +1710,14 @@ long wxListCtrl::InsertItem(wxListItem& info) data->attr = new wxListItemAttr(*info.GetAttributes()); // and remember that we have some now... - m_hasAnyAttr = TRUE; + m_hasAnyAttr = true; } - }; + } + + const long rv = ListView_InsertItem(GetHwnd(), & item); - long rv = ListView_InsertItem(GetHwnd(), & item); + // failing to insert the item is really unexpected + wxCHECK_MSG( rv != -1, rv, "failed to insert an item in wxListCtrl" ); m_count++; wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()), @@ -1508,18 +1751,27 @@ long wxListCtrl::InsertItem(long index, const wxString& label, int imageIndex) wxListItem info; info.m_image = imageIndex; info.m_text = label; - info.m_mask = wxLIST_MASK_IMAGE | wxLIST_MASK_TEXT; + info.m_mask = wxLIST_MASK_TEXT; + if (imageIndex > -1) + info.m_mask |= wxLIST_MASK_IMAGE; info.m_itemId = index; return InsertItem(info); } // For list view mode (only), inserts a column. -long wxListCtrl::InsertColumn(long col, wxListItem& item) +long wxListCtrl::DoInsertColumn(long col, const wxListItem& item) { LV_COLUMN lvCol; - wxConvertToMSWListCol(col, item, lvCol); + wxConvertToMSWListCol(GetHwnd(), col, item, lvCol); - if ( !(lvCol.mask & LVCF_WIDTH) ) + // LVSCW_AUTOSIZE_USEHEADER is not supported when inserting new column, + // we'll deal with it below instead. Plain LVSCW_AUTOSIZE is not supported + // neither but it doesn't need any special handling as we use fixed value + // for it here, both because we can't do anything else (there are no items + // with values in this column to compute the size from yet) and for + // compatibility as wxLIST_AUTOSIZE == -1 and -1 as InsertColumn() width + // parameter used to mean "arbitrary fixed width". + if ( !(lvCol.mask & LVCF_WIDTH) || lvCol.cx < 0 ) { // always give some width to the new column: this one is compatible // with the generic version @@ -1528,35 +1780,23 @@ long wxListCtrl::InsertColumn(long col, wxListItem& item) } long n = ListView_InsertColumn(GetHwnd(), col, &lvCol); - if ( n != -1 ) - { - m_colCount++; - } - else // failed to insert? + if ( n == -1 ) { wxLogDebug(wxT("Failed to insert the column '%s' into listview!"), lvCol.pszText); + return -1; } - return n; -} + m_colCount++; -long wxListCtrl::InsertColumn(long col, - const wxString& heading, - int format, - int width) -{ - wxListItem item; - item.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_FORMAT; - item.m_text = heading; - if ( width > -1 ) + // Now adjust the new column size. + if ( (item.GetMask() & wxLIST_MASK_WIDTH) && + (item.GetWidth() == wxLIST_AUTOSIZE_USEHEADER) ) { - item.m_mask |= wxLIST_MASK_WIDTH; - item.m_width = width; + SetColumnWidth(n, wxLIST_AUTOSIZE_USEHEADER); } - item.m_format = format; - return InsertColumn(col, item); + return n; } // scroll the control by the given number of pixels (exception: in list view, @@ -1565,12 +1805,12 @@ bool wxListCtrl::ScrollList(int dx, int dy) { if ( !ListView_Scroll(GetHwnd(), dx, dy) ) { - wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx, dy); + wxLogDebug(wxT("ListView_Scroll(%d, %d) failed"), dx, dy); - return FALSE; + return false; } - return TRUE; + return true; } // Sort items. @@ -1592,26 +1832,26 @@ bool wxListCtrl::ScrollList(int dx, int dy) struct wxInternalDataSort { wxListCtrlCompare user_fn; - long data; + wxIntPtr data; }; int CALLBACK wxInternalDataCompareFunc(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort) { - struct wxInternalDataSort *internalData = (struct wxInternalDataSort *) lParamSort; + wxInternalDataSort * const internalData = (wxInternalDataSort *) lParamSort; - wxListItemInternalData *data1 = (wxListItemInternalData *) lParam1; - wxListItemInternalData *data2 = (wxListItemInternalData *) lParam2; + wxMSWListItemData *data1 = (wxMSWListItemData *) lParam1; + wxMSWListItemData *data2 = (wxMSWListItemData *) lParam2; - long d1 = (data1 == NULL ? 0 : data1->lParam); - long d2 = (data2 == NULL ? 0 : data2->lParam); + wxIntPtr d1 = (data1 == NULL ? 0 : data1->lParam); + wxIntPtr d2 = (data2 == NULL ? 0 : data2->lParam); return internalData->user_fn(d1, d2, internalData->data); -}; +} -bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data) +bool wxListCtrl::SortItems(wxListCtrlCompare fn, wxIntPtr data) { - struct wxInternalDataSort internalData; + wxInternalDataSort internalData; internalData.user_fn = fn; internalData.data = data; @@ -1620,12 +1860,12 @@ bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data) wxInternalDataCompareFunc, (WPARAM) &internalData) ) { - wxLogDebug(_T("ListView_SortItems() failed")); + wxLogDebug(wxT("ListView_SortItems() failed")); - return FALSE; + return false; } - return TRUE; + return true; } @@ -1634,24 +1874,88 @@ bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data) // message processing // ---------------------------------------------------------------------------- -bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id) +bool wxListCtrl::MSWShouldPreProcessMessage(WXMSG* msg) { + if ( msg->message == WM_KEYDOWN ) + { + // Only eat VK_RETURN if not being used by the application in + // conjunction with modifiers + if ( msg->wParam == VK_RETURN && !wxIsAnyModifierDown() ) + { + // we need VK_RETURN to generate wxEVT_COMMAND_LIST_ITEM_ACTIVATED + return false; + } + } + return wxListCtrlBase::MSWShouldPreProcessMessage(msg); +} + +bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id_) +{ + const int id = (signed short)id_; if (cmd == EN_UPDATE) { wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id); event.SetEventObject( this ); ProcessCommand(event); - return TRUE; + return true; } else if (cmd == EN_KILLFOCUS) { wxCommandEvent event(wxEVT_KILL_FOCUS, id); event.SetEventObject( this ); ProcessCommand(event); - return TRUE; + return true; } else - return FALSE; + return false; +} + +// utility used by wxListCtrl::MSWOnNotify and by wxDataViewHeaderWindowMSW::MSWOnNotify +int WXDLLIMPEXP_CORE wxMSWGetColumnClicked(NMHDR *nmhdr, POINT *ptClick) +{ + // 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? +#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400 + if ( nmhdr->code == GN_CONTEXTMENU ) + { + *ptClick = ((NMRGINFO*)nmhdr)->ptAction; + } + else +#endif //__WXWINCE__ + { + wxGetCursorPosMSW(ptClick); + } + + // we need to use listctrl coordinates for the event point so this is what + // we return in ptClick, but for comparison with Header_GetItemRect() + // result below we need to use header window coordinates + POINT ptClickHeader = *ptClick; + if ( !::ScreenToClient(nmhdr->hwndFrom, &ptClickHeader) ) + { + wxLogLastError(wxT("ScreenToClient(listctrl header)")); + } + + if ( !::ScreenToClient(::GetParent(nmhdr->hwndFrom), ptClick) ) + { + wxLogLastError(wxT("ScreenToClient(listctrl)")); + } + + const int colCount = Header_GetItemCount(nmhdr->hwndFrom); + for ( int col = 0; col < colCount; col++ ) + { + RECT rect; + if ( Header_GetItemRect(nmhdr->hwndFrom, col, &rect) ) + { + if ( ::PtInRect(&rect, ptClickHeader) ) + { + return col; + } + } + } + + return wxNOT_FOUND; } bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) @@ -1682,29 +1986,50 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) event.m_itemIndex = -1; + bool ignore = false; 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! + // HDN_BEGINTRACKW and HDN_ENDTRACKA! // // 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...) // - // note that fr HDN_TRACK another possibility could be to use - // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when - // something other than the item width changes so we'd have to - // filter out the unwanted events then + // another problem is that HDN_TRACK is not sent at all by header + // with HDS_FULLDRAG style which is used by default by wxListCtrl + // under recent Windows versions (starting from at least XP) so we + // need to use HDN_ITEMCHANGING instead of it case HDN_BEGINTRACKA: case HDN_BEGINTRACKW: eventType = wxEVT_COMMAND_LIST_COL_BEGIN_DRAG; // fall through - case HDN_TRACKA: - case HDN_TRACKW: + case HDN_ITEMCHANGING: if ( eventType == wxEVT_NULL ) + { + if ( !nmHDR->pitem || !(nmHDR->pitem->mask & HDI_WIDTH) ) + { + // something other than the width is being changed, + // ignore it + ignore = true; + break; + } + + // also ignore the events sent when the width didn't really + // change: this is not just an optimization but also gets + // rid of a useless and unexpected DRAGGING event which + // would otherwise be sent after the END_DRAG one as we get + // an HDN_ITEMCHANGING after HDN_ENDTRACK for some reason + if ( nmHDR->pitem->cxy == GetColumnWidth(nmHDR->iItem) ) + { + ignore = true; + break; + } + eventType = wxEVT_COMMAND_LIST_COL_DRAGGING; + } // fall through case HDN_ENDTRACKA: @@ -1716,78 +2041,41 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) event.m_col = nmHDR->iItem; break; -#if defined(__WXWINCE__) && _WIN32_WCE < 400 +#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400 case GN_CONTEXTMENU: #endif //__WXWINCE__ 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 defined(__WXWINCE__) && _WIN32_WCE < 400 - if(nmhdr->code == GN_CONTEXTMENU) { - ptClick = ((NMRGINFO*)nmhdr)->ptAction; - } else -#endif //__WXWINCE__ - if ( !::GetCursorPos(&ptClick) ) - { - wxLogLastError(_T("GetCursorPos")); - } - - if ( !::ScreenToClient(hwndHdr, &ptClick) ) - { - wxLogLastError(_T("ScreenToClient(listctrl header)")); - } + eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK; + event.m_col = wxMSWGetColumnClicked(nmhdr, &ptClick); 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; case HDN_GETDISPINFOW: - { - LPNMHDDISPINFOW info = (LPNMHDDISPINFOW) lParam; - // This is a fix for a strange bug under XP. - // Normally, info->iItem is a valid index, but - // sometimes this is a silly (large) number - // and when we return FALSE via wxControl::MSWOnNotify - // to indicate that it hasn't yet been processed, - // there's a GPF in Windows. - // By returning TRUE here, we avoid further processing - // of this strange message. - if ( info->iItem >= GetColumnCount() ) - return TRUE; - } - // fall through + // letting Windows XP handle this message results in mysterious + // crashes in comctl32.dll seemingly because of bad message + // parameters + // + // I have no idea what is the real cause of the bug (which is, + // just to make things interesting, impossible to reproduce + // reliably) but ignoring all these messages does fix it and + // doesn't seem to have any negative consequences + return true; default: - return wxControl::MSWOnNotify(idCtrl, lParam, result); + ignore = true; } + + if ( ignore ) + return wxListCtrlBase::MSWOnNotify(idCtrl, lParam, result); } else #endif // defined(HDN_BEGINTRACKA) - if ( nmhdr->hwndFrom == GetHwnd() ) + if ( nmhdr->hwndFrom == GetHwnd() ) { // almost all messages use NM_LISTVIEW NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr; @@ -1795,28 +2083,18 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) const int iItem = nmLV->iItem; - // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be - // ignored for efficiency. It is done here because the internal data is in the - // process of being deleted so we don't want to try and access it below. - if ( m_ignoreChangeMessages && - ( (nmLV->hdr.code == LVN_ITEMCHANGED) || (nmLV->hdr.code == LVN_ITEMCHANGING))) - { - return TRUE; - } - - // If we have a valid item then check if there is a data value // associated with it and put it in the event. if ( iItem >= 0 && iItem < GetItemCount() ) { - wxListItemInternalData *internaldata = - wxGetInternalData(GetHwnd(), iItem); + wxMSWListItemData *internaldata = + MSWGetItemData(iItem); if ( internaldata ) event.m_item.m_data = internaldata->lParam; } - + bool processed = true; switch ( nmhdr->code ) { case LVN_BEGINRDRAG: @@ -1873,16 +2151,9 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) const LV_ITEM& lvi = (LV_ITEM)item; if ( !lvi.pszText || lvi.iItem == -1 ) { - // don't keep a stale wxTextCtrl around - if ( m_textCtrl ) - { - // EDIT control will be deleted by the list control itself so - // prevent us from deleting it as well - m_textCtrl->UnsubclassWin(); - m_textCtrl->SetHWND(0); - delete m_textCtrl; - m_textCtrl = NULL; - } + // EDIT control will be deleted by the list control + // itself so prevent us from deleting it as well + DeleteEditControl(); event.SetEditCanceled(true); } @@ -1900,29 +2171,21 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) break; case LVN_DELETEALLITEMS: - m_count = 0; eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS; event.m_itemIndex = -1; break; case LVN_DELETEITEM: - if (m_count == 0) - // this should be prevented by the post-processing code below, - // but "just in case" - return FALSE; + if ( m_count == 0 ) + { + // this should be prevented by the post-processing code + // below, but "just in case" + return false; + } eventType = wxEVT_COMMAND_LIST_DELETE_ITEM; event.m_itemIndex = iItem; - // delete the assoicated internal data - wxDeleteInternalData(this, iItem); - break; - case LVN_SETDISPINFO: - { - eventType = wxEVT_COMMAND_LIST_SET_INFO; - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item); - } break; case LVN_INSERTITEM: @@ -1932,7 +2195,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) case LVN_ITEMCHANGED: // we translate this catch all message into more interesting - // (and more easy to process) wxWindows events + // (and more easy to process) wxWidgets events // first of all, we deal with the state change events only and // only for valid items (item == -1 for the virtual list @@ -1964,7 +2227,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) // focus event from here and the selection one // below event.SetEventType(eventType); - (void)GetEventHandler()->ProcessEvent(event); + (void)HandleWindowEvent(event); } else // no focus event to send { @@ -1982,7 +2245,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) if ( eventType == wxEVT_NULL ) { // not an interesting event for us - return FALSE; + return false; } break; @@ -1998,11 +2261,11 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) 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) + // not with any modifiers as they have a predefined meaning + // then) if ( lItem != -1 && (wVKey == VK_RETURN || wVKey == VK_SPACE) && - !(wxIsShiftDown() || wxIsCtrlDown()) ) + !wxIsAnyModifierDown() ) { eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED; } @@ -2010,10 +2273,15 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) { 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_code = wxMSWKeyboard::VKToWX(wVKey); + + if ( event.m_code == WXK_NONE ) + { + // We can't translate this to a standard key code, + // until support for Unicode key codes is added to + // wxListEvent we just ignore them. + return false; + } } event.m_itemIndex = @@ -2031,9 +2299,9 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) case NM_DBLCLK: // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do // anything else - if ( wxControl::MSWOnNotify(idCtrl, lParam, result) ) + if ( wxListCtrlBase::MSWOnNotify(idCtrl, lParam, result) ) { - return TRUE; + return true; } // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event @@ -2041,7 +2309,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) if ( iItem == -1 ) { // not on item - return FALSE; + return false; } eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED; @@ -2050,29 +2318,34 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) event.m_item.m_data = GetItemData(iItem); break; -#if defined(__WXWINCE__) && _WIN32_WCE < 400 +#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400 case GN_CONTEXTMENU: #endif //__WXWINCE__ case NM_RCLICK: // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(), // don't do anything else - if ( wxControl::MSWOnNotify(idCtrl, lParam, result) ) + if ( wxListCtrlBase::MSWOnNotify(idCtrl, lParam, result) ) { - return TRUE; + return true; } // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event LV_HITTESTINFO lvhti; wxZeroMemory(lvhti); -#if defined(__WXWINCE__) && _WIN32_WCE < 400 - if(nmhdr->code == GN_CONTEXTMENU) { - lvhti.pt = ((NMRGINFO*)nmhdr)->ptAction; - } else +#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400 + if ( nmhdr->code == GN_CONTEXTMENU ) + { + lvhti.pt = ((NMRGINFO*)nmhdr)->ptAction; + } + else #endif //__WXWINCE__ - ::GetCursorPos(&(lvhti.pt)); - ::ScreenToClient(GetHwnd(),&(lvhti.pt)); - if ( ListView_HitTest(GetHwnd(),&lvhti) != -1 ) + { + wxGetCursorPosMSW(&(lvhti.pt)); + } + + ::ScreenToClient(GetHwnd(), &lvhti.pt); + if ( ListView_HitTest(GetHwnd(), &lvhti) != -1 ) { if ( lvhti.flags & LVHT_ONITEM ) { @@ -2088,7 +2361,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) case NM_CUSTOMDRAW: *result = OnCustomDraw(lParam); - return TRUE; + return *result != CDRF_DODEFAULT; #endif // _WIN32_IE >= 0x300 case LVN_ODCACHEHINT: @@ -2102,7 +2375,7 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) // deleting an item, for items in invalid range -- filter // this garbage out if ( cacheHint->iFrom > cacheHint->iTo ) - return FALSE; + return false; event.m_oldItemIndex = cacheHint->iFrom; @@ -2112,6 +2385,119 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) } break; +#ifdef HAVE_NMLVFINDITEM + case LVN_ODFINDITEM: + // Find an item in a (necessarily virtual) list control. + if ( IsVirtual() ) + { + NMLVFINDITEM* pFindInfo = (NMLVFINDITEM*)lParam; + + // no match by default + *result = -1; + + // we only handle string-based searches here + // + // TODO: what about LVFI_PARTIAL, should we handle this? + if ( !(pFindInfo->lvfi.flags & LVFI_STRING) ) + { + return false; + } + + const wxChar * const searchstr = pFindInfo->lvfi.psz; + const size_t len = wxStrlen(searchstr); + + // this is the first item we should examine, search from it + // wrapping if necessary + int startPos = pFindInfo->iStart; + const int maxPos = GetItemCount(); + + // Check that the index is valid to ensure that our loop + // below always terminates. + if ( startPos < 0 || startPos >= maxPos ) + { + // When the last item in the control is selected, + // iStart is really set to (invalid) maxPos index so + // accept this silently. + if ( startPos != maxPos ) + { + wxLogDebug(wxT("Ignoring invalid search start ") + wxT("position %d in list control with ") + wxT("%d items."), startPos, maxPos); + } + + startPos = 0; + } + + // Linear search in a control with a lot of items can take + // a long time so we limit the total time of the search to + // ensure that the program doesn't appear to hang. +#if wxUSE_STOPWATCH + wxStopWatch sw; +#endif // wxUSE_STOPWATCH + for ( int currentPos = startPos; ; ) + { + // does this item begin with searchstr? + if ( wxStrnicmp(searchstr, + GetItemText(currentPos), len) == 0 ) + { + *result = currentPos; + break; + } + + // Go to next item with wrapping if necessary. + if ( ++currentPos == maxPos ) + { + // Surprisingly, LVFI_WRAP seems to be never set in + // the flags so wrap regardless of it. + currentPos = 0; + } + + if ( currentPos == startPos ) + { + // We examined all items without finding anything. + // + // Notice that we still return true as we did + // perform the search, if we didn't do this the + // message would have been considered unhandled and + // the control seems to always select the first + // item by default in this case. + return true; + } + +#if wxUSE_STOPWATCH + // Check the time elapsed only every thousand + // iterations for performance reasons: if we did it + // more often calling wxStopWatch::Time() could take + // noticeable time on its own. + if ( !((currentPos - startPos)%1000) ) + { + // We use half a second to limit the search time + // which is about as long as we can take without + // annoying the user. + if ( sw.Time() > 500 ) + { + // As above, return true to prevent the control + // from selecting the first item by default. + return true; + } + } +#endif // wxUSE_STOPWATCH + + } + + SetItemState(*result, + wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED, + wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED); + EnsureVisible(*result); + return true; + } + else + { + processed = false; + } + break; +#endif // HAVE_NMLVFINDITEM + case LVN_GETDISPINFO: if ( IsVirtual() ) { @@ -2123,34 +2509,40 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) if ( lvi.mask & LVIF_TEXT ) { wxString text = OnGetItemText(item, lvi.iSubItem); - wxStrncpy(lvi.pszText, text, lvi.cchTextMax); + wxStrlcpy(lvi.pszText, text.c_str(), lvi.cchTextMax); } // see comment at the end of wxListCtrl::GetColumn() #ifdef NM_CUSTOMDRAW if ( lvi.mask & LVIF_IMAGE ) { - lvi.iImage = OnGetItemImage(item); + lvi.iImage = OnGetItemColumnImage(item, lvi.iSubItem); } #endif // NM_CUSTOMDRAW - // 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!") ); + // even though we never use LVM_SETCALLBACKMASK, we still + // can get messages with LVIF_STATE in lvi.mask under Vista + if ( lvi.mask & LVIF_STATE ) + { + // we don't have anything to return from here... + lvi.stateMask = 0; + } - return TRUE; + return true; } // fall through default: - return wxControl::MSWOnNotify(idCtrl, lParam, result); + processed = false; } + + if ( !processed ) + return wxListCtrlBase::MSWOnNotify(idCtrl, lParam, result); } else { // where did this one come from? - return FALSE; + return false; } // process the event @@ -2158,36 +2550,73 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) event.SetEventType(eventType); - bool processed = GetEventHandler()->ProcessEvent(event); + // fill in the item before passing it to the event handler if we do have a + // valid item index and haven't filled it yet (e.g. for LVN_ITEMCHANGED) + // and we're not using a virtual control as in this case the program + // already has the data anyhow and we don't want to call GetItem() for + // potentially many items + if ( event.m_itemIndex != -1 && !event.m_item.GetMask() + && !IsVirtual() ) + { + wxListItem& item = event.m_item; + + item.SetId(event.m_itemIndex); + item.SetMask(wxLIST_MASK_TEXT | wxLIST_MASK_IMAGE | wxLIST_MASK_DATA); + GetItem(item); + } + + bool processed = HandleWindowEvent(event); // post processing // --------------- switch ( nmhdr->code ) { case LVN_DELETEALLITEMS: - // always return TRUE to suppress all additional LVN_DELETEITEM + // 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; + + // also, we may free all user data now (couldn't do it before as + // the user should have access to it in OnDeleteAllItems() handler) + FreeAllInternalData(); + + // the control is empty now, synchronize the cached number of items + // with the real one + m_count = 0; + return true; + + case LVN_DELETEITEM: + // Delete the associated internal data. Notice that this can be + // done only after the event has been handled as the data could be + // accessed during the handling of the event. + if ( wxMSWListItemData *data = MSWGetItemData(event.m_itemIndex) ) + { + const unsigned count = m_internalData.size(); + for ( unsigned n = 0; n < count; n++ ) + { + if ( m_internalData[n] == data ) + { + m_internalData.erase(m_internalData.begin() + n); + wxDELETE(data); + break; + } + } + + wxASSERT_MSG( !data, "invalid internal data pointer?" ); + } + break; case LVN_ENDLABELEDITA: case LVN_ENDLABELEDITW: - // logic here is inversed compared to all the other messages + // logic here is inverted compared to all the other messages *result = event.IsAllowed(); - // don't keep a stale wxTextCtrl around - if ( m_textCtrl ) - { - // EDIT control will be deleted by the list control itself so - // prevent us from deleting it as well - m_textCtrl->UnsubclassWin(); - m_textCtrl->SetHWND(0); - delete m_textCtrl; - m_textCtrl = NULL; - } + // EDIT control will be deleted by the list control itself so + // prevent us from deleting it as well + DeleteEditControl(); - return TRUE; + return true; } if ( processed ) @@ -2196,13 +2625,257 @@ bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) return processed; } +// ---------------------------------------------------------------------------- +// custom draw stuff +// ---------------------------------------------------------------------------- + // see comment at the end of wxListCtrl::GetColumn() #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300 +static RECT GetCustomDrawnItemRect(const NMCUSTOMDRAW& nmcd) +{ + RECT rc; + wxGetListCtrlItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, LVIR_BOUNDS, rc); + + RECT rcIcon; + wxGetListCtrlItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, LVIR_ICON, rcIcon); + + // exclude the icon part, neither the selection background nor focus rect + // should cover it + rc.left = rcIcon.right; + + return rc; +} + +static +bool HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont, int colCount) +{ + NMCUSTOMDRAW& nmcd = pLVCD->nmcd; + + HDC hdc = nmcd.hdc; + HWND hwndList = nmcd.hdr.hwndFrom; + const int col = pLVCD->iSubItem; + const DWORD item = nmcd.dwItemSpec; + + // the font must be valid, otherwise we wouldn't be painting the item at all + SelectInHDC selFont(hdc, hfont); + + // get the rectangle to paint + int subitem = colCount ? col + 1 : col; + RECT rc; + wxGetListCtrlSubItemRect(hwndList, item, subitem, LVIR_BOUNDS, rc); + rc.left += 6; + + // get the image and text to draw + wxChar text[512]; + LV_ITEM it; + wxZeroMemory(it); + it.mask = LVIF_TEXT | LVIF_IMAGE; + it.iItem = item; + it.iSubItem = col; + it.pszText = text; + it.cchTextMax = WXSIZEOF(text); + ListView_GetItem(hwndList, &it); + + HIMAGELIST himl = ListView_GetImageList(hwndList, LVSIL_SMALL); + if ( himl && ImageList_GetImageCount(himl) ) + { + if ( it.iImage != -1 ) + { + ImageList_Draw(himl, it.iImage, hdc, rc.left, rc.top, + nmcd.uItemState & CDIS_SELECTED ? ILD_SELECTED + : ILD_TRANSPARENT); + } + + // notice that even if this item doesn't have any image, the list + // control still leaves space for the image in the first column if the + // image list is not empty (presumably so that items with and without + // images align?) + if ( it.iImage != -1 || it.iSubItem == 0 ) + { + int wImage, hImage; + ImageList_GetIconSize(himl, &wImage, &hImage); + + rc.left += wImage + 2; + } + } + + ::SetBkMode(hdc, TRANSPARENT); + + UINT fmt = DT_SINGLELINE | +#ifndef __WXWINCE__ + DT_WORD_ELLIPSIS | +#endif // __WXWINCE__ + DT_NOPREFIX | + DT_VCENTER; + + LV_COLUMN lvCol; + wxZeroMemory(lvCol); + lvCol.mask = LVCF_FMT; + if ( ListView_GetColumn(hwndList, col, &lvCol) ) + { + switch ( lvCol.fmt & LVCFMT_JUSTIFYMASK ) + { + case LVCFMT_LEFT: + fmt |= DT_LEFT; + break; + + case LVCFMT_CENTER: + fmt |= DT_CENTER; + break; + + case LVCFMT_RIGHT: + fmt |= DT_RIGHT; + break; + } + } + //else: failed to get alignment, assume it's DT_LEFT (default) + + DrawText(hdc, text, -1, &rc, fmt); + + return true; +} + +static void HandleItemPostpaint(NMCUSTOMDRAW nmcd) +{ + if ( nmcd.uItemState & CDIS_FOCUS ) + { + RECT rc = GetCustomDrawnItemRect(nmcd); + + // don't use the provided HDC, it's in some strange state by now + ::DrawFocusRect(WindowHDC(nmcd.hdr.hwndFrom), &rc); + } +} + +// pLVCD->clrText and clrTextBk should contain the colours to use +static void HandleItemPaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont) +{ + NMCUSTOMDRAW& nmcd = pLVCD->nmcd; // just a shortcut + + const HWND hwndList = nmcd.hdr.hwndFrom; + const int item = nmcd.dwItemSpec; + + // unfortunately we can't trust CDIS_SELECTED, it is often set even when + // the item is not at all selected for some reason (comctl32 6), but we + // also can't always trust ListView_GetItem() as it could return the old + // item status if we're called just after the (de)selection, so remember + // the last item to gain selection and also check for it here + for ( int i = -1;; ) + { + i = ListView_GetNextItem(hwndList, i, LVNI_SELECTED); + if ( i == -1 ) + { + nmcd.uItemState &= ~CDIS_SELECTED; + break; + } + + if ( i == item ) + { + nmcd.uItemState |= CDIS_SELECTED; + break; + } + } + + // same thing for CDIS_FOCUS (except simpler as there is only one of them) + // + // NB: cast is needed to work around the bug in mingw32 headers which don't + // have it inside ListView_GetNextItem() itself (unlike SDK ones) + if ( ::GetFocus() == hwndList && + ListView_GetNextItem( + hwndList, static_cast(-1), LVNI_FOCUSED) == item ) + { + nmcd.uItemState |= CDIS_FOCUS; + } + else + { + nmcd.uItemState &= ~CDIS_FOCUS; + } + + if ( nmcd.uItemState & CDIS_SELECTED ) + { + int syscolFg, syscolBg; + if ( ::GetFocus() == hwndList ) + { + syscolFg = COLOR_HIGHLIGHTTEXT; + syscolBg = COLOR_HIGHLIGHT; + } + else // selected but unfocused + { + syscolFg = COLOR_WINDOWTEXT; + syscolBg = COLOR_BTNFACE; + + // don't grey out the icon in this case neither + nmcd.uItemState &= ~CDIS_SELECTED; + } + + pLVCD->clrText = ::GetSysColor(syscolFg); + pLVCD->clrTextBk = ::GetSysColor(syscolBg); + } + //else: not selected, use normal colours from pLVCD + + HDC hdc = nmcd.hdc; + RECT rc = GetCustomDrawnItemRect(nmcd); + + ::SetTextColor(hdc, pLVCD->clrText); + ::FillRect(hdc, &rc, AutoHBRUSH(pLVCD->clrTextBk)); + + // we could use CDRF_NOTIFYSUBITEMDRAW here but it results in weird repaint + // problems so just draw everything except the focus rect from here instead + const int colCount = Header_GetItemCount(ListView_GetHeader(hwndList)); + for ( int col = 0; col < colCount; col++ ) + { + pLVCD->iSubItem = col; + HandleSubItemPrepaint(pLVCD, hfont, colCount); + } + + HandleItemPostpaint(nmcd); +} + +static WXLPARAM HandleItemPrepaint(wxListCtrl *listctrl, + LPNMLVCUSTOMDRAW pLVCD, + wxListItemAttr *attr) +{ + if ( !attr ) + { + // nothing to do for this item + return CDRF_DODEFAULT; + } + + + // set the colours to use for text drawing + pLVCD->clrText = attr->HasTextColour() + ? wxColourToRGB(attr->GetTextColour()) + : wxColourToRGB(listctrl->GetTextColour()); + pLVCD->clrTextBk = attr->HasBackgroundColour() + ? wxColourToRGB(attr->GetBackgroundColour()) + : wxColourToRGB(listctrl->GetBackgroundColour()); + + // select the font if non default one is specified + if ( attr->HasFont() ) + { + wxFont font = attr->GetFont(); + if ( font.GetEncoding() != wxFONTENCODING_SYSTEM ) + { + // the standard control ignores the font encoding/charset, at least + // with recent comctl32.dll versions (5 and 6, it uses to work with + // 4.something) so we have to draw the item entirely ourselves in + // this case + HandleItemPaint(pLVCD, GetHfontOf(font)); + return CDRF_SKIPDEFAULT; + } + + ::SelectObject(pLVCD->nmcd.hdc, GetHfontOf(font)); + + return CDRF_NEWFONT; + } + + return CDRF_DODEFAULT; +} + WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam) { - LPNMLVCUSTOMDRAW lplvcd = (LPNMLVCUSTOMDRAW)lParam; - NMCUSTOMDRAW& nmcd = lplvcd->nmcd; + LPNMLVCUSTOMDRAW pLVCD = (LPNMLVCUSTOMDRAW)lParam; + NMCUSTOMDRAW& nmcd = pLVCD->nmcd; switch ( nmcd.dwDrawStage ) { case CDDS_PREPAINT: @@ -2211,78 +2884,30 @@ WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam) // // 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; + if ( IsVirtual() || m_hasAnyAttr ) + return CDRF_NOTIFYITEMDRAW; + break; 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; - } + // get a message for each subitem + return CDRF_NOTIFYITEMDRAW; - wxListItemAttr *attr = - IsVirtual() ? OnGetItemAttr(item) - : wxGetInternalDataAttr(this, item); + case CDDS_SUBITEM | CDDS_ITEMPREPAINT: + const int item = nmcd.dwItemSpec; + const int column = pLVCD->iSubItem; - 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 + // we get this message with item == 0 for an empty control, we + // must ignore it as calling OnGetItemAttr() would be wrong + if ( item < 0 || item >= GetItemCount() ) + break; + // same for columns + if ( column < 0 || column >= GetColumnCount() ) + break; - default: - return CDRF_DODEFAULT; + return HandleItemPrepaint(this, pLVCD, DoGetItemColumnAttr(item, column)); } + + return CDRF_DODEFAULT; } #endif // NM_CUSTOMDRAW supported @@ -2290,39 +2915,38 @@ WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam) // Necessary for drawing hrules and vrules, if specified void wxListCtrl::OnPaint(wxPaintEvent& event) { + const int itemCount = GetItemCount(); + const bool drawHRules = HasFlag(wxLC_HRULES); + const bool drawVRules = HasFlag(wxLC_VRULES); + + if (!InReportView() || !(drawHRules || drawVRules) || !itemCount) + { + event.Skip(); + return; + } + wxPaintDC dc(this); - wxControl::OnPaint(event); + wxListCtrlBase::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::GetColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID); + wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT)); dc.SetPen(pen); dc.SetBrush(* wxTRANSPARENT_BRUSH); wxSize clientSize = GetClientSize(); wxRect itemRect; - int cy=0; - int itemCount = GetItemCount(); - int i; if (drawHRules) { - long top = GetTopItem(); - for (i = top; i < top + GetCountPerPage() + 1; i++) + const long top = GetTopItem(); + for ( int i = top; i < top + GetCountPerPage() + 1; i++ ) { if (GetItemRect(i, itemRect)) { - cy = itemRect.GetTop(); + int cy = itemRect.GetTop(); if (i != 0) // Don't draw the first one { dc.DrawLine(0, cy, clientSize.x, cy); @@ -2332,30 +2956,99 @@ void wxListCtrl::OnPaint(wxPaintEvent& event) { cy = itemRect.GetBottom(); dc.DrawLine(0, cy, clientSize.x, cy); + break; } } } } - i = itemCount - 1; - if (drawVRules && (i > -1)) + + if (drawVRules) { wxRect firstItemRect; GetItemRect(0, firstItemRect); - if (GetItemRect(i, itemRect)) + if (GetItemRect(itemCount - 1, itemRect)) { - int col; + // this is a fix for bug 673394: erase the pixels which we would + // otherwise leave on the screen + static const int gap = 2; + dc.SetPen(*wxTRANSPARENT_PEN); + dc.SetBrush(wxBrush(GetBackgroundColour())); + dc.DrawRectangle(0, firstItemRect.GetY() - gap, + clientSize.GetWidth(), gap); + + dc.SetPen(pen); + dc.SetBrush(*wxTRANSPARENT_BRUSH); + + const int numCols = GetColumnCount(); + wxVector indexArray(numCols); + if ( !ListView_GetColumnOrderArray(GetHwnd(), + numCols, + &indexArray[0]) ) + { + wxFAIL_MSG( wxT("invalid column index array in OnPaint()") ); + return; + } + int x = itemRect.GetX(); - for (col = 0; col < GetColumnCount(); col++) + for (int col = 0; col < numCols; col++) { - int colWidth = GetColumnWidth(col); + int colWidth = GetColumnWidth(indexArray[col]); x += colWidth ; - dc.DrawLine(x-1, firstItemRect.GetY() - 2, x-1, itemRect.GetBottom()); + dc.DrawLine(x-1, firstItemRect.GetY() - gap, + x-1, itemRect.GetBottom()); } } } } +void wxListCtrl::OnCharHook(wxKeyEvent& event) +{ + if ( GetEditControl() ) + { + // We need to ensure that Escape is not stolen from the in-place editor + // by the containing dialog. + // + // Notice that we don't have to care about Enter key here as we return + // false from MSWShouldPreProcessMessage() for it. + if ( event.GetKeyCode() == WXK_ESCAPE ) + { + EndEditLabel(true /* cancel */); + + // Don't call Skip() below. + return; + } + } + + event.Skip(); +} + +WXLRESULT +wxListCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) +{ + switch ( nMsg ) + { +#ifdef WM_PRINT + case WM_PRINT: + // we should bypass our own WM_PRINT handling as we don't handle + // PRF_CHILDREN flag, so leave it to the native control itself + return MSWDefWindowProc(nMsg, wParam, lParam); +#endif // WM_PRINT + + case WM_CONTEXTMENU: + // because this message is propagated upwards the child-parent + // chain, we get it for the right clicks on the header window but + // this is confusing in wx as right clicking there already + // generates a separate wxEVT_COMMAND_LIST_COL_RIGHT_CLICK event + // so just ignore them + if ( (HWND)wParam == ListView_GetHeader(GetHwnd()) ) + return 0; + //else: break + } + + return wxListCtrlBase::MSWWindowProc(nMsg, wParam, lParam); +} + // ---------------------------------------------------------------------------- // virtual list controls // ---------------------------------------------------------------------------- @@ -2364,15 +3057,23 @@ wxString wxListCtrl::OnGetItemText(long WXUNUSED(item), long WXUNUSED(col)) cons { // 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("wxListCtrl::OnGetItemText not supposed to be called") ); + wxFAIL_MSG( wxT("wxListCtrl::OnGetItemText not supposed to be called") ); return wxEmptyString; } int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const { - // same as above - wxFAIL_MSG( _T("wxListCtrl::OnGetItemImage not supposed to be called") ); + wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL), + -1, + wxT("List control has an image list, OnGetItemImage or OnGetItemColumnImage should be overridden.")); + return -1; +} + +int wxListCtrl::OnGetItemColumnImage(long item, long column) const +{ + if (!column) + return OnGetItemImage(item); return -1; } @@ -2380,20 +3081,29 @@ int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const wxListItemAttr *wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item)) const { wxASSERT_MSG( item >= 0 && item < GetItemCount(), - _T("invalid item index in OnGetItemAttr()") ); + wxT("invalid item index in OnGetItemAttr()") ); // no attributes by default return NULL; } +wxListItemAttr *wxListCtrl::DoGetItemColumnAttr(long item, long column) const +{ + if ( IsVirtual() ) + return OnGetItemColumnAttr(item, column); + + wxMSWListItemData * const data = MSWGetItemData(item); + return data ? data->attr : NULL; +} + void wxListCtrl::SetItemCount(long count) { - wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") ); + wxASSERT_MSG( IsVirtual(), wxT("this is for virtual controls only") ); if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count, LVSICF_NOSCROLL | LVSICF_NOINVALIDATEALL) ) { - wxLogLastError(_T("ListView_SetItemCount")); + wxLogLastError(wxT("ListView_SetItemCount")); } m_count = count; wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()), @@ -2402,74 +3112,12 @@ void wxListCtrl::SetItemCount(long count) 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 + RefreshItems(item, item); } 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); -} - -// ---------------------------------------------------------------------------- -// internal data stuff -// ---------------------------------------------------------------------------- - -static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId) -{ - LV_ITEM it; - it.mask = LVIF_PARAM; - it.iItem = itemId; - - if ( !ListView_GetItem(hwnd, &it) ) - return NULL; - - return (wxListItemInternalData *) it.lParam; -}; - -static -wxListItemInternalData *wxGetInternalData(const wxListCtrl *ctl, long itemId) -{ - return wxGetInternalData(GetHwndOf(ctl), itemId); -}; - -static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId) -{ - wxListItemInternalData *data = wxGetInternalData(ctl, itemId); - - return data ? data->attr : NULL; -}; - -static void wxDeleteInternalData(wxListCtrl* ctl, long itemId) -{ - wxListItemInternalData *data = wxGetInternalData(ctl, itemId); - if (data) - { - LV_ITEM item; - memset(&item, 0, sizeof(item)); - item.iItem = itemId; - item.mask = LVIF_PARAM; - item.lParam = (LPARAM) 0; - ListView_SetItem((HWND)ctl->GetHWND(), &item); - delete data; - } + ListView_RedrawItems(GetHwnd(), itemFrom, itemTo); } // ---------------------------------------------------------------------------- @@ -2480,8 +3128,8 @@ static void wxConvertFromMSWListItem(HWND hwndListCtrl, wxListItem& info, LV_ITEM& lvItem) { - wxListItemInternalData *internaldata = - (wxListItemInternalData *) lvItem.lParam; + wxMSWListItemData *internaldata = + (wxMSWListItemData *) lvItem.lParam; if (internaldata) info.m_data = internaldata->lParam; @@ -2493,13 +3141,13 @@ static void wxConvertFromMSWListItem(HWND hwndListCtrl, long oldMask = lvItem.mask; - bool needText = FALSE; + bool needText = false; if (hwndListCtrl != 0) { if ( lvItem.mask & LVIF_TEXT ) - needText = FALSE; + needText = false; else - needText = TRUE; + needText = true; if ( needText ) { @@ -2596,6 +3244,16 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl, const wxListItem& info, LV_ITEM& lvItem) { + if ( ctrl->InReportView() ) + { + wxASSERT_MSG( 0 <= info.m_col && info.m_col < ctrl->GetColumnCount(), + "wxListCtrl column index out of bounds" ); + } + else // not in report view + { + wxASSERT_MSG( info.m_col == 0, "columns only exist in report view" ); + } + lvItem.iItem = (int) info.m_itemId; lvItem.iImage = info.m_image; @@ -2614,16 +3272,16 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl, if (info.m_mask & wxLIST_MASK_TEXT) { lvItem.mask |= LVIF_TEXT; - if ( ctrl->GetWindowStyleFlag() & wxLC_USER_TEXT ) + if ( ctrl->HasFlag(wxLC_USER_TEXT) ) { lvItem.pszText = LPSTR_TEXTCALLBACK; } else { // pszText is not const, hence the cast - lvItem.pszText = (wxChar *)info.m_text.c_str(); + lvItem.pszText = (wxChar *)info.m_text.wx_str(); if ( lvItem.pszText ) - lvItem.cchTextMax = info.m_text.Length(); + lvItem.cchTextMax = info.m_text.length(); else lvItem.cchTextMax = 0; } @@ -2632,7 +3290,9 @@ static void wxConvertToMSWListItem(const wxListCtrl *ctrl, lvItem.mask |= LVIF_IMAGE; } -static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item, +static void wxConvertToMSWListCol(HWND hwndList, + int col, + const wxListItem& item, LV_COLUMN& lvCol) { wxZeroMemory(lvCol); @@ -2640,7 +3300,7 @@ static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item, if ( item.m_mask & wxLIST_MASK_TEXT ) { lvCol.mask |= LVCF_TEXT; - lvCol.pszText = (wxChar *)item.m_text.c_str(); // cast is safe + lvCol.pszText = (wxChar *)item.m_text.wx_str(); // cast is safe } if ( item.m_mask & wxLIST_MASK_FORMAT ) @@ -2670,18 +3330,36 @@ static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item, #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300 if ( item.m_mask & wxLIST_MASK_IMAGE ) { - if ( wxTheApp->GetComCtl32Version() >= 470 ) + if ( wxApp::GetComCtl32Version() >= 470 ) { - lvCol.mask |= LVCF_IMAGE | LVCF_FMT; + lvCol.mask |= LVCF_IMAGE; - // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right + // we use LVCFMT_BITMAP_ON_RIGHT because the images on the right // seem to be generally nicer than on the left and the generic // version only draws them on the right (we don't have a flag to // specify the image location anyhow) // // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to // make any difference in my tests -- but maybe we should? - lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT | LVCFMT_IMAGE; + if ( item.m_image != -1 ) + { + // as we're going to overwrite the format field, get its + // current value first -- unless we want to overwrite it anyhow + if ( !(lvCol.mask & LVCF_FMT) ) + { + LV_COLUMN lvColOld; + wxZeroMemory(lvColOld); + lvColOld.mask = LVCF_FMT; + if ( ListView_GetColumn(hwndList, col, &lvColOld) ) + { + lvCol.fmt = lvColOld.fmt; + } + + lvCol.mask |= LVCF_FMT; + } + + lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT | LVCFMT_IMAGE; + } lvCol.iImage = item.m_image; } @@ -2691,4 +3369,3 @@ static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item, } #endif // wxUSE_LISTCTRL -