X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f83528074b280304e9a73d0e93057db8f4f2ee8c..9d5507f7a2701395e1d5c121bd877bb9066ee6ea:/src/msw/listctrl.cpp diff --git a/src/msw/listctrl.cpp b/src/msw/listctrl.cpp index 8f0b1544b9..cdc5123074 100644 --- a/src/msw/listctrl.cpp +++ b/src/msw/listctrl.cpp @@ -1,461 +1,750 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: listctrl.cpp +// 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 and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "listctrl.h" -#endif +// ============================================================================ +// declarations +// ============================================================================ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif +#if wxUSE_LISTCTRL + +#include "wx/listctrl.h" + #ifndef WX_PRECOMP -#include "wx.h" + #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/dcclient.h" + #include "wx/textctrl.h" #endif -#if defined(__WIN95__) - -#include "wx/listctrl.h" -#include "wx/log.h" +#include "wx/imaglist.h" #include "wx/msw/private.h" -#ifndef __GNUWIN32__ -#include +#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) + #include + #include + #if _WIN32_WCE < 400 + #include + #endif #endif -#ifdef __GNUWIN32__ -#include "wx/msw/gnuwin32/extra.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 -static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& tvItem); -static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& tvItem, HWND getFullInfo = 0); +// ---------------------------------------------------------------------------- +// private functions +// ---------------------------------------------------------------------------- + +// convert our state and mask flags to LV_ITEM constants +static void wxConvertToMSWFlags(long state, long mask, LV_ITEM& lvItem); + +// convert wxListItem to LV_ITEM +static void wxConvertToMSWListItem(const wxListCtrl *ctrl, + const wxListItem& info, LV_ITEM& lvItem); + +// convert LV_ITEM to wxListItem +static void wxConvertFromMSWListItem(HWND hwndListCtrl, + wxListItem& info, + /* const */ LV_ITEM& lvItem); + +// convert our wxListItem to LV_COLUMN +static void wxConvertToMSWListCol(HWND hwndList, + int col, + const wxListItem& item, + LV_COLUMN& lvCol); + +// ---------------------------------------------------------------------------- +// private helper classes +// ---------------------------------------------------------------------------- + +// We have to handle both fooW and fooA notifications in several cases +// because of broken comctl32.dll and/or unicows.dll. This class is used to +// convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or +// LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed +// by wxConvertToMSWListItem(). +#if wxUSE_UNICODE + #define LV_ITEM_NATIVE LV_ITEMW + #define LV_ITEM_OTHER LV_ITEMA + + #define LV_CONV_TO_WX cMB2WX + #define LV_CONV_BUF wxMB2WXbuf +#else // ANSI + #define LV_ITEM_NATIVE LV_ITEMA + #define LV_ITEM_OTHER LV_ITEMW + + #define LV_CONV_TO_WX cWC2WX + #define LV_CONV_BUF wxWC2WXbuf +#endif // Unicode/ANSI + +class wxLV_ITEM +{ +public: + // default ctor, use Init() later + wxLV_ITEM() { m_buf = NULL; m_pItem = NULL; } + + // init without conversion + void Init(LV_ITEM_NATIVE& item) + { + wxASSERT_MSG( !m_pItem, _T("Init() called twice?") ); + + m_pItem = &item; + } + + // init with conversion + 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); + + memcpy(&m_item, &item, sizeof(LV_ITEM_NATIVE)); + + // convert text from ANSI to Unicod if necessary + if ( (item.mask & LVIF_TEXT) && item.pszText ) + { + m_buf = new LV_CONV_BUF(wxConvLocal.LV_CONV_TO_WX(item.pszText)); + m_item.pszText = (wxChar *)m_buf->data(); + } + } + + // ctor without conversion + wxLV_ITEM(LV_ITEM_NATIVE& item) : m_buf(NULL), m_pItem(&item) { } + + // ctor with conversion + wxLV_ITEM(LV_ITEM_OTHER& item) : m_buf(NULL) + { + Init(item); + } + + ~wxLV_ITEM() { delete m_buf; } + + // conversion to the real LV_ITEM + operator LV_ITEM_NATIVE&() const { return *m_pItem; } + +private: + LV_CONV_BUF *m_buf; + + LV_ITEM_NATIVE *m_pItem; + LV_ITEM_NATIVE m_item; + + DECLARE_NO_COPY_CLASS(wxLV_ITEM) +}; + +/////////////////////////////////////////////////////// +// Problem: +// 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 +// the following items were out of sync. +// +// Solution: +// Under MSW the only way to associate data with a List +// 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 +// }; +// +// To conserve memory, a wxListItemInternalData is +// only allocated for a LV_ITEM if text attributes or +// user data(lparam) are being set. + + +// class wxListItemInternalData +class wxListItemInternalData +{ +public: + wxListItemAttr *attr; + LPARAM lParam; // user data + + wxListItemInternalData() : attr(NULL), lParam(0) {} + ~wxListItemInternalData() + { + if (attr) + delete attr; + } + + DECLARE_NO_COPY_CLASS(wxListItemInternalData) +}; + +// Get the internal data structure +static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId); +static wxListItemInternalData *wxGetInternalData(const wxListCtrl *ctl, long itemId); +static wxListItemAttr *wxGetInternalDataAttr(const wxListCtrl *ctl, long itemId); +static void wxDeleteInternalData(wxListCtrl* ctl, long itemId); + + +#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 , EMPTY_MACROVALUE , 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 ) -#if !USE_SHARED_LIBRARY +/* + TODO : Expose more information of a list's layout etc. via appropriate objects (a la NotebookPageInfo) +*/ +#else IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl) +#endif + +IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl) IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject) -#endif +IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent) + +BEGIN_EVENT_TABLE(wxListCtrl, wxControl) + EVT_PAINT(wxListCtrl::OnPaint) +END_EVENT_TABLE() + +// ============================================================================ +// implementation +// ============================================================================ -wxListCtrl::wxListCtrl(void) +// ---------------------------------------------------------------------------- +// wxListCtrl construction +// ---------------------------------------------------------------------------- + +void wxListCtrl::Init() { - m_imageListNormal = NULL; - m_imageListSmall = NULL; - m_imageListState = NULL; - m_baseStyle = 0; + m_imageListNormal = NULL; + m_imageListSmall = NULL; + m_imageListState = NULL; + 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; +} + +bool wxListCtrl::Create(wxWindow *parent, + wxWindowID id, + const wxPoint& pos, + const wxSize& size, + long style, + const wxValidator& validator, + const wxString& name) +{ + if ( !CreateControl(parent, id, pos, size, style, validator, name) ) + 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 + wxSetCCUnicodeFormat(GetHwnd()); + + // We must set the default text colour to the system/theme color, otherwise + // GetTextColour will always return black + SetTextColour(GetDefaultAttributes().colFg); + + // 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 ( InReportView() && wxApp::GetComCtl32Version() >= 470 ) + { + ::SendMessage + ( + GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE, 0, + LVS_EX_LABELTIP | + 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 + ); + } + + return true; } -bool wxListCtrl::Create(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, - long style, const wxValidator& validator, const wxString& name) +WXDWORD wxListCtrl::MSWGetStyle(long style, WXDWORD *exstyle) const { - m_imageListNormal = NULL; - m_imageListSmall = NULL; - m_imageListState = NULL; - m_textCtrl = NULL; - m_colCount = 0; + WXDWORD wstyle = wxControl::MSWGetStyle(style, exstyle); + + wstyle |= LVS_SHAREIMAGELISTS | LVS_SHOWSELALWAYS; + +#ifdef __WXDEBUG__ + size_t nModes = 0; + + #define MAP_MODE_STYLE(wx, ms) \ + if ( style & (wx) ) { wstyle |= (ms); nModes++; } +#else // !__WXDEBUG__ + #define MAP_MODE_STYLE(wx, ms) \ + if ( style & (wx) ) wstyle |= (ms); +#endif // __WXDEBUG__ + + MAP_MODE_STYLE(wxLC_ICON, LVS_ICON) + MAP_MODE_STYLE(wxLC_SMALL_ICON, LVS_SMALLICON) + MAP_MODE_STYLE(wxLC_LIST, LVS_LIST) + MAP_MODE_STYLE(wxLC_REPORT, LVS_REPORT) + + wxASSERT_MSG( nModes == 1, + _T("wxListCtrl style should have exactly one mode bit set") ); + +#undef MAP_MODE_STYLE + + if ( style & wxLC_ALIGN_LEFT ) + wstyle |= LVS_ALIGNLEFT; + + if ( style & wxLC_ALIGN_TOP ) + wstyle |= LVS_ALIGNTOP; + + if ( style & wxLC_AUTOARRANGE ) + wstyle |= LVS_AUTOARRANGE; - SetValidator(validator); - SetName(name); + if ( style & wxLC_NO_SORT_HEADER ) + wstyle |= LVS_NOSORTHEADER; - int x = pos.x; - int y = pos.y; - int width = size.x; - int height = size.y; + if ( style & wxLC_NO_HEADER ) + wstyle |= LVS_NOCOLUMNHEADER; - m_windowStyle = style; + if ( style & wxLC_EDIT_LABELS ) + wstyle |= LVS_EDITLABELS; - SetParent(parent); + if ( style & wxLC_SINGLE_SEL ) + wstyle |= LVS_SINGLESEL; - if (width <= 0) - width = 100; - if (height <= 0) - height = 30; - if (x < 0) - x = 0; - if (y < 0) - y = 0; + if ( style & wxLC_SORT_ASCENDING ) + { + wstyle |= LVS_SORTASCENDING; - m_windowId = (id == -1) ? NewControlId() : id; + wxASSERT_MSG( !(style & wxLC_SORT_DESCENDING), + _T("can't sort in ascending and descending orders at once") ); + } + else if ( style & wxLC_SORT_DESCENDING ) + wstyle |= LVS_SORTDESCENDING; - DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP; - - bool want3D; - WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D) ; +#if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) ) + if ( style & wxLC_VIRTUAL ) + { + 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."), + ver / 100, ver % 100); + } + + wstyle |= LVS_OWNERDATA; + } +#endif // ancient cygwin - // Even with extended styles, need to combine with WS_BORDER - // for them to look right. - if (want3D || (m_windowStyle & wxSIMPLE_BORDER) || (m_windowStyle & wxRAISED_BORDER) || - (m_windowStyle & wxSUNKEN_BORDER) || (m_windowStyle & wxDOUBLE_BORDER)) - wstyle |= WS_BORDER; + return wstyle; +} - wstyle |= LVS_SHAREIMAGELISTS; - m_baseStyle = wstyle; +void wxListCtrl::UpdateStyle() +{ + if ( GetHwnd() ) + { + // The new window view style + DWORD dwStyleNew = MSWGetStyle(m_windowStyle, NULL); - long oldStyle = 0; // Dummy - wstyle |= ConvertToMSWStyle(oldStyle, m_windowStyle); + // some styles are not returned by MSWGetStyle() + if ( IsShown() ) + dwStyleNew |= WS_VISIBLE; - // Create the ListView control. - m_hWnd = (WXHWND)CreateWindowEx(exStyle, - WC_LISTVIEW, - "", - wstyle, - x, y, width, height, - (HWND) parent->GetHWND(), - (HMENU)m_windowId, - wxGetInstance(), - NULL); + // Get the current window style. + DWORD dwStyleOld = ::GetWindowLong(GetHwnd(), GWL_STYLE); - if ( !m_hWnd ) { - wxLogError("Can't create list control window."); + // we don't have wxVSCROLL style, but the list control may have it, + // don't change it then + dwStyleNew |= dwStyleOld & (WS_HSCROLL | WS_VSCROLL); - return FALSE; - } + // Only set the window style if the view bits have changed. + if ( dwStyleOld != dwStyleNew ) + { + ::SetWindowLong(GetHwnd(), GWL_STYLE, dwStyleNew); + } + } +} - wxSystemSettings settings; - SetBackgroundColour(settings.GetSystemColour(wxSYS_COLOUR_WINDOW)); - SetForegroundColour(parent->GetDefaultForegroundColour()); +void wxListCtrl::FreeAllInternalData() +{ + if (m_AnyInternalData) + { + int n = GetItemCount(); - if (parent) parent->AddChild(this); - - SubclassWin((WXHWND) m_hWnd); + m_ignoreChangeMessages = true; + for (int i = 0; i < n; i++) + wxDeleteInternalData(this, i); + m_ignoreChangeMessages = false; - return TRUE; + m_AnyInternalData = false; + } } -wxListCtrl::~wxListCtrl(void) +wxListCtrl::~wxListCtrl() { - if (m_textCtrl) + FreeAllInternalData(); + + if ( m_textCtrl ) { - m_textCtrl->UnsubclassWin(); - m_textCtrl->SetHWND(0); - delete m_textCtrl; - m_textCtrl = NULL; + m_textCtrl->UnsubclassWin(); + m_textCtrl->SetHWND(0); + delete m_textCtrl; + m_textCtrl = NULL; } + + if (m_ownsImageListNormal) + delete m_imageListNormal; + if (m_ownsImageListSmall) + delete m_imageListSmall; + if (m_ownsImageListState) + delete m_imageListState; } +// ---------------------------------------------------------------------------- +// set/get/change style +// ---------------------------------------------------------------------------- + // Add or remove a single window style void wxListCtrl::SetSingleStyle(long style, bool add) { - long flag = GetWindowStyleFlag(); + long flag = GetWindowStyleFlag(); - // Get rid of conflicting styles - if ( add ) - { - if ( style & wxLC_MASK_TYPE) - flag = flag & ~wxLC_MASK_TYPE ; - if ( style & wxLC_MASK_ALIGN ) - flag = flag & ~wxLC_MASK_ALIGN ; - if ( style & wxLC_MASK_SORT ) - flag = flag & ~wxLC_MASK_SORT ; + // Get rid of conflicting styles + if ( add ) + { + if ( style & wxLC_MASK_TYPE) + flag = flag & ~wxLC_MASK_TYPE; + if ( style & wxLC_MASK_ALIGN ) + flag = flag & ~wxLC_MASK_ALIGN; + if ( style & wxLC_MASK_SORT ) + flag = flag & ~wxLC_MASK_SORT; } - if ( flag & style ) - { - if ( !add ) - flag -= style; - } - else - { - if ( add ) - { - flag |= style; - } - } + if ( add ) + flag |= style; + else + flag &= ~style; - m_windowStyle = flag; - - RecreateWindow(); + SetWindowStyleFlag(flag); } // Set the whole window style void wxListCtrl::SetWindowStyleFlag(long flag) { - m_windowStyle = flag; - - RecreateWindow(); -} - -void wxListCtrl::RecreateWindow(void) -{ - if ( GetHWND() ) - { - long oldStyle = 0; - long style = ConvertToMSWStyle(oldStyle, m_windowStyle); - style |= m_baseStyle; -// ::SetWindowLong((HWND) GetHWND(), GWL_STYLE, style); - - // The following recreation of the window appears to be necessary - // because SetWindowLong doesn't seem to do it. - - int x, y, width, height; - GetPosition(&x, &y); - GetSize(&width, &height); - - UnsubclassWin(); - ::DestroyWindow((HWND) GetHWND()); - - // Experimental - // Recreate the ListView control: unfortunately I can't - // make it work by using SetWindowLong. - bool want3D; - WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D) ; - HWND hWndListControl = CreateWindowEx(exStyle, - WC_LISTVIEW, - "", - style, - x, y, width, height, - (HWND) GetParent()->GetHWND(), - (HMENU)m_windowId, - wxGetInstance(), - NULL ); - - m_hWnd = (WXHWND) hWndListControl; - SubclassWin((WXHWND) m_hWnd); - - if ( m_imageListNormal ) - SetImageList(m_imageListNormal, wxIMAGE_LIST_NORMAL); - if ( m_imageListSmall ) - SetImageList(m_imageListSmall, wxIMAGE_LIST_SMALL); - if ( m_imageListState ) - SetImageList(m_imageListState, wxIMAGE_LIST_STATE); - } -} - -// Can be just a single style, or a bitlist -long wxListCtrl::ConvertToMSWStyle(long& oldStyle, long style) const -{ - long wstyle = 0; - if ( style & wxLC_ICON ) - { - if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON ) - oldStyle -= LVS_SMALLICON; - if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT ) - oldStyle -= LVS_REPORT; - if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST ) - oldStyle -= LVS_LIST; - wstyle |= LVS_ICON; - } - - if ( style & wxLC_SMALL_ICON ) - { - if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON ) - oldStyle -= LVS_ICON; - if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT ) - oldStyle -= LVS_REPORT; - if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST ) - oldStyle -= LVS_LIST; - wstyle |= LVS_SMALLICON; - } - - if ( style & wxLC_LIST ) - { - if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON ) - oldStyle -= LVS_ICON; - if ( (oldStyle & LVS_TYPEMASK) == LVS_REPORT ) - oldStyle -= LVS_REPORT; - if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON ) - oldStyle -= LVS_SMALLICON; - wstyle |= LVS_LIST; - } - - if ( style & wxLC_REPORT ) - { - if ( (oldStyle & LVS_TYPEMASK) == LVS_ICON ) - oldStyle -= LVS_ICON; - if ( (oldStyle & LVS_TYPEMASK) == LVS_LIST ) - oldStyle -= LVS_LIST; - if ( (oldStyle & LVS_TYPEMASK) == LVS_SMALLICON ) - oldStyle -= LVS_SMALLICON; - wstyle |= LVS_REPORT; - } - - if ( style & wxLC_ALIGN_LEFT ) - { - if ( oldStyle & LVS_ALIGNTOP ) - oldStyle -= LVS_ALIGNTOP; - wstyle |= LVS_ALIGNLEFT; - } - - if ( style & wxLC_ALIGN_TOP ) - { - if ( oldStyle & LVS_ALIGNLEFT ) - oldStyle -= LVS_ALIGNLEFT; - wstyle |= LVS_ALIGNTOP; - } - - if ( style & wxLC_AUTOARRANGE ) - wstyle |= LVS_AUTOARRANGE; - - // Apparently, no such style (documentation wrong?) -/* - if ( style & wxLC_BUTTON ) - wstyle |= LVS_BUTTON; -*/ + if ( flag != m_windowStyle ) + { + m_windowStyle = flag; + + UpdateStyle(); + + Refresh(); + } +} - if ( style & wxLC_NO_SORT_HEADER ) - wstyle |= LVS_NOSORTHEADER; +// ---------------------------------------------------------------------------- +// accessors +// ---------------------------------------------------------------------------- - if ( style & wxLC_NO_HEADER ) - wstyle |= LVS_NOCOLUMNHEADER; +/* static */ wxVisualAttributes +wxListCtrl::GetClassDefaultAttributes(wxWindowVariant variant) +{ + wxVisualAttributes attrs = GetCompositeControlsDefaultAttributes(variant); - if ( style & wxLC_EDIT_LABELS ) - wstyle |= LVS_EDITLABELS; + // common controls have their own default font + attrs.font = wxGetCCDefaultFont(); - if ( style & wxLC_SINGLE_SEL ) - wstyle |= LVS_SINGLESEL; + return attrs; +} - if ( style & wxLC_SORT_ASCENDING ) - { - if ( oldStyle & LVS_SORTDESCENDING ) - oldStyle -= LVS_SORTDESCENDING; - wstyle |= LVS_SORTASCENDING; - } +// Sets the foreground, i.e. text, colour +bool wxListCtrl::SetForegroundColour(const wxColour& col) +{ + if ( !wxWindow::SetForegroundColour(col) ) + return false; - if ( style & wxLC_SORT_DESCENDING ) - { - if ( oldStyle & LVS_SORTASCENDING ) - oldStyle -= LVS_SORTASCENDING; - wstyle |= LVS_SORTDESCENDING; - } + ListView_SetTextColor(GetHwnd(), wxColourToRGB(col)); - return wstyle; + return true; } -// Sets the background colour (GetBackgroundColour already implicit in -// wxWindow class) -void wxListCtrl::SetBackgroundColour(const wxColour& col) +// Sets the background colour +bool wxListCtrl::SetBackgroundColour(const wxColour& col) { - wxWindow::SetBackgroundColour(col); + if ( !wxWindow::SetBackgroundColour(col) ) + return false; + + // we set the same colour for both the "empty" background and the items + // background + COLORREF color = wxColourToRGB(col); + ListView_SetBkColor(GetHwnd(), color); + ListView_SetTextBkColor(GetHwnd(), color); - ListView_SetBkColor((HWND) GetHWND(), PALETTERGB(col.Red(), col.Green(), col.Blue())); + return true; } // Gets information about this column bool wxListCtrl::GetColumn(int col, wxListItem& item) const { - LV_COLUMN lvCol; - lvCol.mask = 0; - lvCol.fmt = 0; - lvCol.pszText = NULL; + LV_COLUMN lvCol; + wxZeroMemory(lvCol); + + lvCol.mask = LVCF_WIDTH; + + if ( item.m_mask & wxLIST_MASK_TEXT ) + { + lvCol.mask |= LVCF_TEXT; + lvCol.pszText = new wxChar[513]; + lvCol.cchTextMax = 512; + } - if ( item.m_mask & wxLIST_MASK_TEXT ) - { - lvCol.mask |= LVCF_TEXT; - lvCol.pszText = new char[513]; - lvCol.cchTextMax = 512; - } + if ( item.m_mask & wxLIST_MASK_FORMAT ) + { + lvCol.mask |= LVCF_FMT; + } + + if ( item.m_mask & wxLIST_MASK_IMAGE ) + { + lvCol.mask |= LVCF_IMAGE; + } + + bool success = ListView_GetColumn(GetHwnd(), col, &lvCol) != 0; - bool success = (ListView_GetColumn((HWND) GetHWND(), col, & lvCol) != 0); + // item.m_subItem = lvCol.iSubItem; + item.m_width = lvCol.cx; -// item.m_subItem = lvCol.iSubItem; - item.m_width = lvCol.cx; + if ( (item.m_mask & wxLIST_MASK_TEXT) && lvCol.pszText ) + { + item.m_text = lvCol.pszText; + delete[] lvCol.pszText; + } - if ( (item.m_mask & wxLIST_MASK_TEXT) && lvCol.pszText ) - { - item.m_text = lvCol.pszText; - delete[] lvCol.pszText; - } + if ( item.m_mask & wxLIST_MASK_FORMAT ) + { + switch (lvCol.fmt & LVCFMT_JUSTIFYMASK) { + case LVCFMT_LEFT: + item.m_format = wxLIST_FORMAT_LEFT; + break; + case LVCFMT_RIGHT: + item.m_format = wxLIST_FORMAT_RIGHT; + break; + case LVCFMT_CENTER: + item.m_format = wxLIST_FORMAT_CENTRE; + break; + default: + item.m_format = -1; // Unknown? + break; + } + } - if ( item.m_mask & wxLIST_MASK_FORMAT ) - { - if (lvCol.fmt == LVCFMT_LEFT) - item.m_format = wxLIST_FORMAT_LEFT; - else if (lvCol.fmt == LVCFMT_RIGHT) - item.m_format = wxLIST_FORMAT_RIGHT; - else if (lvCol.fmt == LVCFMT_CENTER) - item.m_format = wxLIST_FORMAT_CENTRE; + // the column images were not supported in older versions but how to check + // for this? we can't use _WIN32_IE because we always define it to a very + // high value, so see if another symbol which is only defined starting from + // comctl32.dll 4.70 is available +#ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300 + if ( item.m_mask & wxLIST_MASK_IMAGE ) + { + item.m_image = lvCol.iImage; } +#endif // LVCOLUMN::iImage exists - return success; + return success; } // Sets information about this column -bool wxListCtrl::SetColumn(int col, wxListItem& item) -{ - LV_COLUMN lvCol; - lvCol.mask = 0; - lvCol.fmt = 0; - lvCol.pszText = NULL; - - if ( item.m_mask & wxLIST_MASK_TEXT ) - { - lvCol.mask |= LVCF_TEXT; - lvCol.pszText = WXSTRINGCAST item.m_text; - lvCol.cchTextMax = 0; // Ignored - } - if ( item.m_mask & wxLIST_MASK_FORMAT ) - { - lvCol.mask |= LVCF_FMT; - - if ( item.m_format == wxLIST_FORMAT_LEFT ) - lvCol.fmt = LVCFMT_LEFT; - if ( item.m_format == wxLIST_FORMAT_RIGHT ) - lvCol.fmt = LVCFMT_RIGHT; - if ( item.m_format == wxLIST_FORMAT_CENTRE ) - lvCol.fmt = LVCFMT_CENTER; - } - - if ( item.m_mask & wxLIST_MASK_WIDTH ) - { - lvCol.mask |= LVCF_WIDTH; - lvCol.cx = item.m_width; - - if ( lvCol.cx == wxLIST_AUTOSIZE) - lvCol.cx = LVSCW_AUTOSIZE; - else if ( lvCol.cx == wxLIST_AUTOSIZE_USEHEADER) - lvCol.cx = LVSCW_AUTOSIZE_USEHEADER; - } - lvCol.mask |= LVCF_SUBITEM; - lvCol.iSubItem = col; - return (ListView_SetColumn((HWND) GetHWND(), col, & lvCol) != 0); +bool wxListCtrl::SetColumn(int col, const wxListItem& item) +{ + LV_COLUMN lvCol; + wxConvertToMSWListCol(GetHwnd(), col, item, lvCol); + + return ListView_SetColumn(GetHwnd(), col, &lvCol) != 0; } // Gets the column width int wxListCtrl::GetColumnWidth(int col) const { - return ListView_GetColumnWidth((HWND) GetHWND(), col); + return ListView_GetColumnWidth(GetHwnd(), col); } // Sets the column width bool wxListCtrl::SetColumnWidth(int col, int width) { - int col2 = col; - if ( m_windowStyle & wxLC_LIST ) - col2 = -1; + if ( m_windowStyle & wxLC_LIST ) + 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::GetColumnOrder(int col) const +{ + const int numCols = GetColumnCount(); + wxCHECK_MSG( col >= 0 && col < numCols, -1, _T("Col index out of bounds") ); + + wxArrayInt indexArray(numCols); + + if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &indexArray[0]) ) + return -1; + + return indexArray[col]; +} + +int wxListCtrl::GetColumnIndexFromOrder(int order) const +{ + const int numCols = GetColumnCount(); + wxASSERT_MSG( order >= 0 && order < numCols, _T("Col order out of bounds") ); + + wxArrayInt indexArray(numCols); + + if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols, &indexArray[0]) ) + return -1; + + for ( int col = 0; col < numCols; col++ ) + { + if ( indexArray[col] == order ) + return col; + } + + wxFAIL_MSG( _T("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(); + + return orders; +} + +// Sets the column order for all columns +bool wxListCtrl::SetColumnsOrder(const wxArrayInt& orders) +{ + const int numCols = GetColumnCount(); - int width2 = width; - if ( width2 == wxLIST_AUTOSIZE) - width2 = LVSCW_AUTOSIZE; - else if ( width2 == wxLIST_AUTOSIZE_USEHEADER) - width2 = LVSCW_AUTOSIZE_USEHEADER; + wxCHECK_MSG( orders.size() == (size_t)numCols, false, + _T("wrong number of elements in column orders array") ); - return (ListView_SetColumnWidth((HWND) 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 // or small icon view) -int wxListCtrl::GetCountPerPage(void) const +int wxListCtrl::GetCountPerPage() const { - return ListView_GetCountPerPage((HWND) GetHWND()); + return ListView_GetCountPerPage(GetHwnd()); } // Gets the edit control for editing labels. -wxTextCtrl* wxListCtrl::GetEditControl(void) const +wxTextCtrl* wxListCtrl::GetEditControl() const { return m_textCtrl; } @@ -463,224 +752,483 @@ wxTextCtrl* wxListCtrl::GetEditControl(void) const // Gets information about the item bool wxListCtrl::GetItem(wxListItem& info) const { - LV_ITEM lvItem; - lvItem.pszText = NULL; - if ( info.m_mask & wxLIST_MASK_TEXT ) - { - lvItem.pszText = new char[513]; - lvItem.cchTextMax = 512; - } - bool success = (::SendMessage((HWND) GetHWND(), LVM_GETITEM, 0, (LPARAM)& lvItem) != 0); - - if ( !success ) - { - if (lvItem.pszText) - delete[] lvItem.pszText; + LV_ITEM lvItem; + wxZeroMemory(lvItem); + + lvItem.iItem = info.m_itemId; + lvItem.iSubItem = info.m_col; + + if ( info.m_mask & wxLIST_MASK_TEXT ) + { + lvItem.mask |= LVIF_TEXT; + lvItem.pszText = new wxChar[513]; + lvItem.cchTextMax = 512; + } + else + { + lvItem.pszText = NULL; + } + + if (info.m_mask & wxLIST_MASK_DATA) + lvItem.mask |= LVIF_PARAM; - return FALSE; - } + if (info.m_mask & wxLIST_MASK_IMAGE) + lvItem.mask |= LVIF_IMAGE; + + if ( info.m_mask & wxLIST_MASK_STATE ) + { + lvItem.mask |= LVIF_STATE; + wxConvertToMSWFlags(0, info.m_stateMask, lvItem); + } - wxConvertFromMSWListItem(this, info, lvItem); + bool success = ListView_GetItem((HWND)GetHWND(), &lvItem) != 0; + if ( !success ) + { + wxLogError(_("Couldn't retrieve information about list control item %d."), + lvItem.iItem); + } + else + { + // give NULL as hwnd as we already have everything we need + wxConvertFromMSWListItem(NULL, info, lvItem); + } if (lvItem.pszText) - delete[] lvItem.pszText; + delete[] lvItem.pszText; - return success; + return success; } // Sets information about the item bool wxListCtrl::SetItem(wxListItem& info) { - LV_ITEM item; + const long id = info.GetId(); + wxCHECK_MSG( id >= 0 && id < GetItemCount(), false, + _T("invalid item index in SetItem") ); + + LV_ITEM item; wxConvertToMSWListItem(this, info, item); - item.cchTextMax = 0; - return (ListView_SetItem((HWND) GetHWND(), &item) != 0); + + // we never update the lParam if it contains our pointer + // to the wxListItemInternalData structure + item.mask &= ~LVIF_PARAM; + + // check if setting attributes or lParam + if (info.HasAttributes() || (info.m_mask & wxLIST_MASK_DATA)) + { + // get internal item data + // perhaps a cache here ? + wxListItemInternalData *data = wxGetInternalData(this, id); + + if (! data) + { + // need to set it + m_AnyInternalData = true; + data = new wxListItemInternalData(); + item.lParam = (LPARAM) data; + item.mask |= LVIF_PARAM; + }; + + + // user data + if (info.m_mask & wxLIST_MASK_DATA) + data->lParam = info.m_data; + + // attributes + if ( info.HasAttributes() ) + { + 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(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")); + + return false; + } + } + + // we need to update the item immediately to show the new image + bool updateNow = (info.m_mask & wxLIST_MASK_IMAGE) != 0; + + // check whether it has any custom attributes + if ( info.HasAttributes() ) + { + m_hasAnyAttr = true; + + // if the colour has changed, we must redraw the item + updateNow = true; + } + + if ( updateNow ) + { + // we need this to make the change visible right now + RefreshItem(item.iItem); + } + + return true; } long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId) { - wxListItem info; - info.m_text = label; - info.m_mask = wxLIST_MASK_TEXT; - info.m_itemId = index; - info.m_col = col; - if ( imageId > -1 ) - { - info.m_image = imageId; - info.m_mask |= wxLIST_MASK_IMAGE; - } - return SetItem(info); + wxListItem info; + info.m_text = label; + info.m_mask = wxLIST_MASK_TEXT; + info.m_itemId = index; + info.m_col = col; + if ( imageId > -1 ) + { + info.m_image = imageId; + info.m_mask |= wxLIST_MASK_IMAGE; + } + return SetItem(info); } // Gets the item state int wxListCtrl::GetItemState(long item, long stateMask) const { - wxListItem info; + wxListItem info; - info.m_mask = wxLIST_MASK_STATE ; - info.m_stateMask = stateMask; - info.m_itemId = item; + info.m_mask = wxLIST_MASK_STATE; + info.m_stateMask = stateMask; + info.m_itemId = item; - if (!GetItem(info)) - return 0; + if (!GetItem(info)) + return 0; - return info.m_state; + return info.m_state; } // Sets the item state bool wxListCtrl::SetItemState(long item, long state, long stateMask) { - wxListItem info; + // NB: don't use SetItem() here as it doesn't work with the virtual list + // controls + LV_ITEM lvItem; + wxZeroMemory(lvItem); + + wxConvertToMSWFlags(state, stateMask, lvItem); + + // for the virtual list controls we need to refresh the previously focused + // item manually when changing focus without changing selection + // programmatically because otherwise it keeps its focus rectangle until + // next repaint (yet another comctl32 bug) + long focusOld; + if ( IsVirtual() && + (stateMask & wxLIST_STATE_FOCUSED) && + (state & wxLIST_STATE_FOCUSED) ) + { + focusOld = GetNextItem(-1, wxLIST_NEXT_ALL, wxLIST_STATE_FOCUSED); + } + else + { + focusOld = -1; + } - info.m_mask = wxLIST_MASK_STATE ; - info.m_state = state; - info.m_stateMask = stateMask; - info.m_itemId = item; + if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE, + (WPARAM)item, (LPARAM)&lvItem) ) + { + wxLogLastError(_T("ListView_SetItemState")); + + return false; + } + + if ( focusOld != -1 ) + { + // no need to refresh the item if it was previously selected, it would + // only result in annoying flicker + if ( !(GetItemState(focusOld, + wxLIST_STATE_SELECTED) & wxLIST_STATE_SELECTED) ) + { + RefreshItem(focusOld); + } + } + + return true; +} - return SetItem(info); +// 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::SetItemImage(long item, int image, int selImage) +bool wxListCtrl::SetItemColumnImage(long item, long column, int image) { - wxListItem info; + wxListItem info; - info.m_mask = wxLIST_MASK_IMAGE ; - info.m_image = image; - info.m_itemId = item; + info.m_mask = wxLIST_MASK_IMAGE; + info.m_image = image; + info.m_itemId = item; + info.m_col = column; - return SetItem(info); + return SetItem(info); } // Gets the item text wxString wxListCtrl::GetItemText(long item) const { - wxListItem info; + wxListItem info; - info.m_mask = wxLIST_MASK_TEXT ; - info.m_itemId = item; + info.m_mask = wxLIST_MASK_TEXT; + info.m_itemId = item; - if (!GetItem(info)) - return wxString(""); - return info.m_text; + if (!GetItem(info)) + return wxEmptyString; + return info.m_text; } // Sets the item text void wxListCtrl::SetItemText(long item, const wxString& str) { - wxListItem info; + wxListItem info; - info.m_mask = wxLIST_MASK_TEXT ; - info.m_itemId = item; - info.m_text = str; + info.m_mask = wxLIST_MASK_TEXT; + info.m_itemId = item; + info.m_text = str; - SetItem(info); + SetItem(info); } // Gets the item data -long wxListCtrl::GetItemData(long item) const +wxUIntPtr wxListCtrl::GetItemData(long item) const { - wxListItem info; + wxListItem info; - info.m_mask = wxLIST_MASK_DATA ; - info.m_itemId = item; + info.m_mask = wxLIST_MASK_DATA; + info.m_itemId = item; - if (!GetItem(info)) - return 0; - return info.m_data; + if (!GetItem(info)) + return 0; + return info.m_data; } // Sets the item data -bool wxListCtrl::SetItemData(long item, long data) +bool wxListCtrl::SetItemPtrData(long item, wxUIntPtr data) { - wxListItem info; + wxListItem info; - info.m_mask = wxLIST_MASK_DATA ; - info.m_itemId = item; - info.m_data = data; + info.m_mask = wxLIST_MASK_DATA; + info.m_itemId = item; + info.m_data = data; - return SetItem(info); + return SetItem(info); } -// Gets the item rectangle -bool wxListCtrl::GetItemRect(long item, wxRectangle& rect, int code) const +wxRect wxListCtrl::GetViewRect() const { - RECT rect2; + wxASSERT_MSG( !HasFlag(wxLC_REPORT | wxLC_LIST), + _T("wxListCtrl::GetViewRect() only works in icon mode") ); + + RECT rc; + if ( !ListView_GetViewRect(GetHwnd(), &rc) ) + { + wxLogDebug(_T("ListView_GetViewRect() failed.")); + + wxZeroMemory(rc); + } + + wxRect rect; + wxCopyRECTToRect(rc, rect); - int code2 = LVIR_BOUNDS; - if ( code == wxLIST_RECT_BOUNDS ) - code2 = LVIR_BOUNDS; - else if ( code == wxLIST_RECT_ICON ) - code2 = LVIR_ICON; - else if ( code == wxLIST_RECT_LABEL ) - code2 = LVIR_LABEL; + return rect; +} + +// Gets the item rectangle +bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const +{ + return GetSubItemRect( item, wxLIST_GETSUBITEMRECT_WHOLEITEM, rect, code) ; +} + +/*! + * Retrieve coordinates and size of a specified subitem of a listview control. + * This function only works if the listview control is in the report mode. + * + * @param item : Item number + * @param subItem : Subitem or column number, use -1 for the whole row including + * all columns or subitems + * @param rect : A pointer to an allocated wxRect object + * @param code : Specify the part of the subitem coordinates you need. Choices are + * wxLIST_RECT_BOUNDS, wxLIST_RECT_ICON, wxLIST_RECT_LABEL + * + * @return bool : True if successful. + */ +bool wxListCtrl::GetSubItemRect(long item, long subItem, wxRect& rect, int code) const +{ + RECT rectWin; + + int codeWin; + if ( code == wxLIST_RECT_BOUNDS ) + codeWin = LVIR_BOUNDS; + else if ( code == wxLIST_RECT_ICON ) + codeWin = LVIR_ICON; + else if ( code == wxLIST_RECT_LABEL ) + codeWin = LVIR_LABEL; + else + { + wxFAIL_MSG( _T("incorrect code in GetItemRect() / GetSubItemRect()") ); + codeWin = LVIR_BOUNDS; + } + + bool success; + if( subItem == wxLIST_GETSUBITEMRECT_WHOLEITEM) + { + success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0; + } + else if( subItem >= 0) + { + success = ListView_GetSubItemRect( GetHwnd(), (int) item, (int) subItem, codeWin, &rectWin) != 0; + } + else + { + wxFAIL_MSG( _T("incorrect subItem number in GetSubItemRect()") ); + return false; + } - bool success = (ListView_GetItemRect((HWND) GetHWND(), (int) item, &rect2, code2) != 0); + rect.x = rectWin.left; + rect.y = rectWin.top; + rect.width = rectWin.right - rectWin.left; + rect.height = rectWin.bottom - rectWin.top; - rect.x = rect2.left; - rect.y = rect2.top; - rect.width = rect2.right - rect2.left; - rect.height = rect2.bottom - rect2.left; - return success; + return success; } + + + // Gets the item position bool wxListCtrl::GetItemPosition(long item, wxPoint& pos) const { - POINT pt; + POINT pt; - bool success = (ListView_GetItemPosition((HWND) GetHWND(), (int) item, &pt) != 0); + bool success = (ListView_GetItemPosition(GetHwnd(), (int) item, &pt) != 0); - pos.x = pt.x; pos.y = pt.y; - return success; + pos.x = pt.x; pos.y = pt.y; + return success; } // Sets the item position. bool wxListCtrl::SetItemPosition(long item, const wxPoint& pos) { - return (ListView_SetItemPosition((HWND) GetHWND(), (int) item, pos.x, pos.y) != 0); + return (ListView_SetItemPosition(GetHwnd(), (int) item, pos.x, pos.y) != 0); } // Gets the number of items in the list control -int wxListCtrl::GetItemCount(void) const +int wxListCtrl::GetItemCount() const +{ + return m_count; +} + +wxSize wxListCtrl::GetItemSpacing() const { - return ListView_GetItemCount((HWND) GetHWND()); + const int spacing = ListView_GetItemSpacing(GetHwnd(), (BOOL)HasFlag(wxLC_SMALL_ICON)); + + return wxSize(LOWORD(spacing), HIWORD(spacing)); } -// Retrieves the spacing between icons in pixels. -// If small is TRUE, gets the spacing for the small icon -// view, otherwise the large icon view. +#if WXWIN_COMPATIBILITY_2_6 + int wxListCtrl::GetItemSpacing(bool isSmall) const { - return ListView_GetItemSpacing((HWND) GetHWND(), (BOOL) isSmall); + return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall); +} + +#endif // WXWIN_COMPATIBILITY_2_6 + +void wxListCtrl::SetItemTextColour( long item, const wxColour &col ) +{ + wxListItem info; + info.m_itemId = item; + info.SetTextColour( col ); + SetItem( info ); +} + +wxColour wxListCtrl::GetItemTextColour( long item ) const +{ + wxColour col; + wxListItemInternalData *data = wxGetInternalData(this, item); + if ( data && data->attr ) + col = data->attr->GetTextColour(); + + return col; +} + +void wxListCtrl::SetItemBackgroundColour( long item, const wxColour &col ) +{ + wxListItem info; + info.m_itemId = item; + info.SetBackgroundColour( col ); + SetItem( info ); +} + +wxColour wxListCtrl::GetItemBackgroundColour( long item ) const +{ + wxColour col; + wxListItemInternalData *data = wxGetInternalData(this, 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; + wxListItemInternalData *data = wxGetInternalData(this, item); + if ( data && data->attr ) + f = data->attr->GetFont(); + + return f; } // Gets the number of selected items in the list control -int wxListCtrl::GetSelectedItemCount(void) const +int wxListCtrl::GetSelectedItemCount() const { - return ListView_GetSelectedCount((HWND) GetHWND()); + return ListView_GetSelectedCount(GetHwnd()); } // Gets the text colour of the listview -wxColour wxListCtrl::GetTextColour(void) const +wxColour wxListCtrl::GetTextColour() const { - COLORREF ref = ListView_GetTextColor((HWND) GetHWND()); - wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref)); - return col; + COLORREF ref = ListView_GetTextColor(GetHwnd()); + wxColour col(GetRValue(ref), GetGValue(ref), GetBValue(ref)); + return col; } // Sets the text colour of the listview void wxListCtrl::SetTextColour(const wxColour& col) { - ListView_SetTextColor((HWND) GetHWND(), PALETTERGB(col.Red(), col.Blue(), col.Green())); + ListView_SetTextColor(GetHwnd(), PALETTERGB(col.Red(), col.Green(), col.Blue())); } // Gets the index of the topmost visible item when in // list or report view -long wxListCtrl::GetTopItem(void) const +long wxListCtrl::GetTopItem() const { - return (long) ListView_GetTopIndex((HWND) GetHWND()); + return (long) ListView_GetTopIndex(GetHwnd()); } // Searches for an item, starting from 'item'. @@ -693,117 +1241,175 @@ long wxListCtrl::GetTopItem(void) const // Returns the item or -1 if unsuccessful. long wxListCtrl::GetNextItem(long item, int geom, int state) const { - long flags = 0; + long flags = 0; - if ( geom == wxLIST_NEXT_ABOVE ) - flags |= LVNI_ABOVE; - if ( geom == wxLIST_NEXT_ALL ) - flags |= LVNI_ALL; - if ( geom == wxLIST_NEXT_BELOW ) - flags |= LVNI_BELOW; - if ( geom == wxLIST_NEXT_LEFT ) - flags |= LVNI_TOLEFT; - if ( geom == wxLIST_NEXT_RIGHT ) - flags |= LVNI_TORIGHT; + if ( geom == wxLIST_NEXT_ABOVE ) + flags |= LVNI_ABOVE; + if ( geom == wxLIST_NEXT_ALL ) + flags |= LVNI_ALL; + if ( geom == wxLIST_NEXT_BELOW ) + flags |= LVNI_BELOW; + if ( geom == wxLIST_NEXT_LEFT ) + flags |= LVNI_TOLEFT; + if ( geom == wxLIST_NEXT_RIGHT ) + flags |= LVNI_TORIGHT; - if ( state & wxLIST_STATE_CUT ) - flags |= LVNI_CUT; - if ( state & wxLIST_STATE_DROPHILITED ) - flags |= LVNI_DROPHILITED; - if ( state & wxLIST_STATE_FOCUSED ) - flags |= LVNI_FOCUSED; - if ( state & wxLIST_STATE_SELECTED ) - flags |= LVNI_SELECTED; + if ( state & wxLIST_STATE_CUT ) + flags |= LVNI_CUT; + if ( state & wxLIST_STATE_DROPHILITED ) + flags |= LVNI_DROPHILITED; + if ( state & wxLIST_STATE_FOCUSED ) + flags |= LVNI_FOCUSED; + if ( state & wxLIST_STATE_SELECTED ) + flags |= LVNI_SELECTED; - return (long) ListView_GetNextItem((HWND) GetHWND(), item, flags); + return (long) ListView_GetNextItem(GetHwnd(), item, flags); } wxImageList *wxListCtrl::GetImageList(int which) const { - if ( which == wxIMAGE_LIST_NORMAL ) + if ( which == wxIMAGE_LIST_NORMAL ) { - return m_imageListNormal; - } - else if ( which == wxIMAGE_LIST_SMALL ) + return m_imageListNormal; + } + else if ( which == wxIMAGE_LIST_SMALL ) { - return m_imageListSmall; - } - else if ( which == wxIMAGE_LIST_STATE ) + return m_imageListSmall; + } + else if ( which == wxIMAGE_LIST_STATE ) { - return m_imageListState; - } - return NULL; + return m_imageListState; + } + return NULL; } void wxListCtrl::SetImageList(wxImageList *imageList, int which) { - int flags = 0; - if ( which == wxIMAGE_LIST_NORMAL ) + int flags = 0; + if ( which == wxIMAGE_LIST_NORMAL ) { - flags = LVSIL_NORMAL; - m_imageListNormal = imageList; - } - else if ( which == wxIMAGE_LIST_SMALL ) + flags = LVSIL_NORMAL; + if (m_ownsImageListNormal) delete m_imageListNormal; + m_imageListNormal = imageList; + m_ownsImageListNormal = false; + } + else if ( which == wxIMAGE_LIST_SMALL ) { - flags = LVSIL_SMALL; - m_imageListSmall = imageList; - } - else if ( which == wxIMAGE_LIST_STATE ) + flags = LVSIL_SMALL; + if (m_ownsImageListSmall) delete m_imageListSmall; + m_imageListSmall = imageList; + m_ownsImageListSmall = false; + } + else if ( which == wxIMAGE_LIST_STATE ) { - flags = LVSIL_STATE; - m_imageListState = imageList; - } - ListView_SetImageList((HWND) GetHWND(), (HIMAGELIST) imageList ? imageList->GetHIMAGELIST() : 0, flags); + flags = LVSIL_STATE; + if (m_ownsImageListState) delete m_imageListState; + m_imageListState = imageList; + m_ownsImageListState = false; + } + (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; + else if ( which == wxIMAGE_LIST_SMALL ) + m_ownsImageListSmall = true; + else if ( which == wxIMAGE_LIST_STATE ) + m_ownsImageListState = true; } +// ---------------------------------------------------------------------------- // Operations -//////////////////////////////////////////////////////////////////////////// +// ---------------------------------------------------------------------------- // Arranges the items bool wxListCtrl::Arrange(int flag) { - UINT code = 0; - if ( flag == wxLIST_ALIGN_LEFT ) - code = LVA_ALIGNLEFT; - else if ( flag == wxLIST_ALIGN_TOP ) - code = LVA_ALIGNTOP; - else if ( flag == wxLIST_ALIGN_DEFAULT ) - code = LVA_DEFAULT; - else if ( flag == wxLIST_ALIGN_SNAP_TO_GRID ) - code = LVA_SNAPTOGRID; + UINT code = 0; + if ( flag == wxLIST_ALIGN_LEFT ) + code = LVA_ALIGNLEFT; + else if ( flag == wxLIST_ALIGN_TOP ) + code = LVA_ALIGNTOP; + else if ( flag == wxLIST_ALIGN_DEFAULT ) + code = LVA_DEFAULT; + else if ( flag == wxLIST_ALIGN_SNAP_TO_GRID ) + code = LVA_SNAPTOGRID; - return (ListView_Arrange((HWND) GetHWND(), code) != 0); + return (ListView_Arrange(GetHwnd(), code) != 0); } // Deletes an item bool wxListCtrl::DeleteItem(long item) { - return (ListView_DeleteItem((HWND) GetHWND(), (int) item) != 0); + if ( !ListView_DeleteItem(GetHwnd(), (int) item) ) + { + wxLogLastError(_T("ListView_DeleteItem")); + return false; + } + + m_count--; + wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()), + wxT("m_count should match ListView_GetItemCount")); + + // the virtual list control doesn't refresh itself correctly, help it + if ( IsVirtual() ) + { + // we need to refresh all the lines below the one which was deleted + wxRect rectItem; + if ( item > 0 && GetItemCount() ) + { + GetItemRect(item - 1, rectItem); + } + else + { + rectItem.y = + rectItem.height = 0; + } + + wxRect rectWin = GetRect(); + rectWin.height = rectWin.GetBottom() - rectItem.GetBottom(); + rectWin.y = rectItem.GetBottom(); + + RefreshRect(rectWin); + } + + return true; } // Deletes all items -bool wxListCtrl::DeleteAllItems(void) +bool wxListCtrl::DeleteAllItems() { - return (ListView_DeleteAllItems((HWND) GetHWND()) != 0); + return ListView_DeleteAllItems(GetHwnd()) != 0; } // Deletes all items -bool wxListCtrl::DeleteAllColumns(void) +bool wxListCtrl::DeleteAllColumns() { - int i; - for ( i = 0; i < m_colCount; i++) + while ( m_colCount > 0 ) { - if (ListView_DeleteColumn((HWND) GetHWND(), 0) != 0) - m_colCount --; + if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 ) + { + wxLogLastError(wxT("ListView_DeleteColumn")); + + return false; + } + + m_colCount--; } - return (m_colCount == 0); + + wxASSERT_MSG( m_colCount == 0, wxT("no columns should be left") ); + + return true; } // Deletes a column bool wxListCtrl::DeleteColumn(int col) { - bool success = (ListView_DeleteColumn((HWND) GetHWND(), col) != 0); + bool success = (ListView_DeleteColumn(GetHwnd(), col) != 0); if ( success && (m_colCount > 0) ) m_colCount --; @@ -811,7 +1417,7 @@ bool wxListCtrl::DeleteColumn(int col) } // Clears items, and columns if there are any. -void wxListCtrl::ClearAll(void) +void wxListCtrl::ClearAll() { DeleteAllItems(); if ( m_colCount > 0 ) @@ -822,19 +1428,34 @@ wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass) { wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) ); - HWND hWnd = (HWND) ListView_EditLabel((HWND) GetHWND(), item); + // ListView_EditLabel requires that the list has focus. + SetFocus(); + + WXHWND hWnd = (WXHWND) ListView_EditLabel(GetHwnd(), item); + if ( !hWnd ) + { + // failed to start editing + return NULL; + } - if (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; - m_textCtrl = NULL; + m_textCtrl->UnsubclassWin(); + m_textCtrl->SetHWND(0); + delete m_textCtrl; } - m_textCtrl = (wxTextCtrl*) textControlClass->CreateObject(); - m_textCtrl->SetHWND((WXHWND) hWnd); - m_textCtrl->SubclassWin((WXHWND) hWnd); + 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); return m_textCtrl; } @@ -842,220 +1463,282 @@ wxTextCtrl* wxListCtrl::EditLabel(long item, wxClassInfo* textControlClass) // End label editing, optionally cancelling the edit bool wxListCtrl::EndEditLabel(bool cancel) { - wxASSERT( FALSE); + // m_textCtrl is not always ready, ie. in EVT_LIST_BEGIN_LABEL_EDIT + HWND hwnd = ListView_GetEditControl(GetHwnd()); + if ( !hwnd ) + return false; -/* I don't know how to implement this: there's no such macro as ListView_EndEditLabelNow. - * ??? - bool success = (ListView_EndEditLabelNow((HWND) GetHWND(), cancel) != 0); + if ( cancel ) + ::SetWindowText(hwnd, wxEmptyString); // dubious but better than nothing - if (m_textCtrl) - { - m_textCtrl->UnsubclassWin(); - m_textCtrl->SetHWND(0); - delete m_textCtrl; - m_textCtrl = NULL; - } - return success; -*/ - 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 + // + // posting WM_CLOSE to it does seem to work without any side effects + ::PostMessage(hwnd, WM_CLOSE, 0, 0); + return true; +} // Ensures this item is visible bool wxListCtrl::EnsureVisible(long item) { - return (ListView_EnsureVisible((HWND) 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' // or the beginning if 'start' is -1. long wxListCtrl::FindItem(long start, const wxString& str, bool partial) { - LV_FINDINFO findInfo; + LV_FINDINFO findInfo; - findInfo.flags = LVFI_STRING; - if ( partial ) - findInfo.flags |= LVFI_STRING; - findInfo.psz = WXSTRINGCAST str; + findInfo.flags = LVFI_STRING; + if ( partial ) + findInfo.flags |= LVFI_PARTIAL; + findInfo.psz = str.wx_str(); - return ListView_FindItem((HWND) GetHWND(), (int) start, & findInfo); + // ListView_FindItem() excludes the first item from search and to look + // through all the items you need to start from -1 which is unnatural and + // inconsistent with the generic version - so we adjust the index + if (start != -1) + start --; + return ListView_FindItem(GetHwnd(), (int) start, &findInfo); } // Find an item whose data matches this data, starting from the item after 'start' // or the beginning if 'start' is -1. -long wxListCtrl::FindItem(long start, long data) +// 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, wxUIntPtr data) { - LV_FINDINFO findInfo; + long idx = start + 1; + long count = GetItemCount(); - findInfo.flags = LVFI_PARAM; - findInfo.lParam = data; + while (idx < count) + { + if (GetItemData(idx) == data) + return idx; + idx++; + }; - return ListView_FindItem((HWND) GetHWND(), (int) start, & findInfo); + return -1; } // Find an item nearest this position in the specified direction, starting from // the item after 'start' or the beginning if 'start' is -1. long wxListCtrl::FindItem(long start, const wxPoint& pt, int direction) { - LV_FINDINFO findInfo; + LV_FINDINFO findInfo; - findInfo.flags = LVFI_NEARESTXY; - findInfo.pt.x = pt.x; - findInfo.pt.y = pt.y; - findInfo.vkDirection = VK_RIGHT; + findInfo.flags = LVFI_NEARESTXY; + findInfo.pt.x = pt.x; + findInfo.pt.y = pt.y; + findInfo.vkDirection = VK_RIGHT; - if ( direction == wxLIST_FIND_UP ) - findInfo.vkDirection = VK_UP; - else if ( direction == wxLIST_FIND_DOWN ) - findInfo.vkDirection = VK_DOWN; - else if ( direction == wxLIST_FIND_LEFT ) - findInfo.vkDirection = VK_LEFT; - else if ( direction == wxLIST_FIND_RIGHT ) - findInfo.vkDirection = VK_RIGHT; + if ( direction == wxLIST_FIND_UP ) + findInfo.vkDirection = VK_UP; + else if ( direction == wxLIST_FIND_DOWN ) + findInfo.vkDirection = VK_DOWN; + else if ( direction == wxLIST_FIND_LEFT ) + findInfo.vkDirection = VK_LEFT; + else if ( direction == wxLIST_FIND_RIGHT ) + findInfo.vkDirection = VK_RIGHT; - return ListView_FindItem((HWND) GetHWND(), (int) start, & findInfo); + return ListView_FindItem(GetHwnd(), (int) 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((HWND) 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 ; -} + hitTestInfo.pt.x = (int) point.x; + hitTestInfo.pt.y = (int) point.y; -// Inserts an item, returning the index of the new item if successful, -// -1 otherwise. -long wxListCtrl::InsertItem(wxListItem& info) -{ - LV_ITEM item; - wxConvertToMSWListItem(this, info, item); + 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_TOLEFT ) + flags |= wxLIST_HITTEST_TOLEFT; + if ( hitTestInfo.flags & LVHT_TORIGHT ) + flags |= wxLIST_HITTEST_TORIGHT; + + 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(const wxListItem& info) +{ + wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") ); + + 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) + { + m_AnyInternalData = true; + item.mask |= LVIF_PARAM; + + // internal stucture that manages data + wxListItemInternalData *data = new wxListItemInternalData(); + item.lParam = (LPARAM) data; + + if (info.m_mask & wxLIST_MASK_DATA) + data->lParam = info.m_data; + + // check whether it has any custom attributes + if ( info.HasAttributes() ) + { + // take copy of attributes + data->attr = new wxListItemAttr(*info.GetAttributes()); + + // and remember that we have some now... + m_hasAnyAttr = true; + } + }; - return (long) ListView_InsertItem((HWND) GetHWND(), & item); + long rv = ListView_InsertItem(GetHwnd(), & item); + + m_count++; + wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()), + wxT("m_count should match ListView_GetItemCount")); + + return rv; } long wxListCtrl::InsertItem(long index, const wxString& label) { - wxListItem info; - info.m_text = label; - info.m_mask = wxLIST_MASK_TEXT; - info.m_itemId = index; - return InsertItem(info); + wxListItem info; + info.m_text = label; + info.m_mask = wxLIST_MASK_TEXT; + info.m_itemId = index; + return InsertItem(info); } // Inserts an image item long wxListCtrl::InsertItem(long index, int imageIndex) { - wxListItem info; - info.m_image = imageIndex; - info.m_mask = wxLIST_MASK_IMAGE; - info.m_itemId = index; - return InsertItem(info); + wxListItem info; + info.m_image = imageIndex; + info.m_mask = wxLIST_MASK_IMAGE; + info.m_itemId = index; + return InsertItem(info); } // Inserts an image/string item 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_itemId = index; - return InsertItem(info); + wxListItem info; + info.m_image = imageIndex; + info.m_text = label; + info.m_mask = wxLIST_MASK_IMAGE | wxLIST_MASK_TEXT; + info.m_itemId = index; + return InsertItem(info); } // For list view mode (only), inserts a column. -long wxListCtrl::InsertColumn(long col, wxListItem& item) -{ - LV_COLUMN lvCol; - lvCol.mask = 0; - lvCol.fmt = 0; - lvCol.pszText = NULL; - - if ( item.m_mask & wxLIST_MASK_TEXT ) - { - lvCol.mask |= LVCF_TEXT; - lvCol.pszText = WXSTRINGCAST item.m_text; - lvCol.cchTextMax = 0; // Ignored - } - if ( item.m_mask & wxLIST_MASK_FORMAT ) - { - lvCol.mask |= LVCF_FMT; - - if ( item.m_format == wxLIST_FORMAT_LEFT ) - lvCol.fmt = LVCFMT_LEFT; - if ( item.m_format == wxLIST_FORMAT_RIGHT ) - lvCol.fmt = LVCFMT_RIGHT; - if ( item.m_format == wxLIST_FORMAT_CENTRE ) - lvCol.fmt = LVCFMT_CENTER; - } - - if ( item.m_mask & wxLIST_MASK_WIDTH ) - { - lvCol.mask |= LVCF_WIDTH; - lvCol.cx = item.m_width; - - if ( lvCol.cx == wxLIST_AUTOSIZE) - lvCol.cx = LVSCW_AUTOSIZE; - else if ( lvCol.cx == wxLIST_AUTOSIZE_USEHEADER) - lvCol.cx = LVSCW_AUTOSIZE_USEHEADER; - } - lvCol.mask |= LVCF_SUBITEM; - lvCol.iSubItem = col; - - bool success = (ListView_InsertColumn((HWND) GetHWND(), col, & lvCol) != 0); - if ( success ) - m_colCount ++; - return success; +long wxListCtrl::InsertColumn(long col, const wxListItem& item) +{ + LV_COLUMN lvCol; + wxConvertToMSWListCol(GetHwnd(), col, item, lvCol); + + if ( !(lvCol.mask & LVCF_WIDTH) ) + { + // always give some width to the new column: this one is compatible + // with the generic version + lvCol.mask |= LVCF_WIDTH; + lvCol.cx = 80; + } + + long n = ListView_InsertColumn(GetHwnd(), col, &lvCol); + if ( n != -1 ) + { + m_colCount++; + } + else // failed to insert? + { + wxLogDebug(wxT("Failed to insert the column '%s' into listview!"), + lvCol.pszText); + } + + return n; } -long wxListCtrl::InsertColumn(long col, const wxString& heading, int format, - int width) +long wxListCtrl::InsertColumn(long col, + const wxString& heading, + int format, + int width) { - wxListItem item; - item.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_FORMAT; - item.m_text = heading; - if ( width > -1 ) - { - item.m_mask |= wxLIST_MASK_WIDTH; - item.m_width = width; - } - item.m_format = format; + wxListItem item; + item.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_FORMAT; + item.m_text = heading; + if ( width > -1 ) + { + item.m_mask |= wxLIST_MASK_WIDTH; + item.m_width = width; + } + item.m_format = format; - return InsertColumn(col, item); + return InsertColumn(col, item); } -// Scrolls the list control. If in icon, small icon or report view mode, -// x specifies the number of pixels to scroll. If in list view mode, x -// specifies the number of columns to scroll. -// If in icon, small icon or list view mode, y specifies the number of pixels -// to scroll. If in report view mode, y specifies the number of lines to scroll. +// scroll the control by the given number of pixels (exception: in list view, +// dx is interpreted as number of columns) bool wxListCtrl::ScrollList(int dx, int dy) { - return (ListView_Scroll((HWND) GetHWND(), dx, dy) != 0); + if ( !ListView_Scroll(GetHwnd(), dx, dy) ) + { + wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx, dy); + + return false; + } + + return true; } // Sort items. @@ -1069,357 +1752,1469 @@ bool wxListCtrl::ScrollList(int dx, int dy) // or zero if the two items are equivalent. // data is arbitrary data to be passed to the sort function. + +// Internal structures for proxying the user compare function +// so that we can pass it the *real* user data + +// translate lParam data and call user func +struct wxInternalDataSort +{ + wxListCtrlCompare user_fn; + long data; +}; + +int CALLBACK wxInternalDataCompareFunc(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort) +{ + struct wxInternalDataSort *internalData = (struct wxInternalDataSort *) lParamSort; + + wxListItemInternalData *data1 = (wxListItemInternalData *) lParam1; + wxListItemInternalData *data2 = (wxListItemInternalData *) lParam2; + + long d1 = (data1 == NULL ? 0 : data1->lParam); + long d2 = (data2 == NULL ? 0 : data2->lParam); + + return internalData->user_fn(d1, d2, internalData->data); + +} + bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data) { - return (ListView_SortItems((HWND) GetHWND(), (PFNLVCOMPARE) fn, data) != 0); -} - -bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id) -{ - if (cmd == EN_UPDATE) - { - wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, id); - event.SetEventObject( this ); - ProcessCommand(event); - return TRUE; - } - else if (cmd == EN_KILLFOCUS) - { - wxCommandEvent event(wxEVT_KILL_FOCUS, id); - event.SetEventObject( this ); - ProcessCommand(event); - return TRUE; - } - else return FALSE; -} - -bool wxListCtrl::MSWNotify(WXWPARAM wParam, WXLPARAM lParam) -{ - wxListEvent event(wxEVT_NULL, m_windowId); - wxEventType eventType = wxEVT_NULL; - NMHDR *hdr1 = (NMHDR *) lParam; - switch ( hdr1->code ) - { - case LVN_BEGINDRAG: - { - eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG; - NM_LISTVIEW *hdr = (NM_LISTVIEW *)lParam; - event.m_itemIndex = hdr->iItem; - event.m_pointDrag.x = hdr->ptAction.x; - event.m_pointDrag.y = hdr->ptAction.y; - break; - } - case LVN_BEGINLABELEDIT: - { - eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT; - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - wxConvertFromMSWListItem(this, event.m_item, info->item, (HWND) GetHWND()); - break; - } - case LVN_BEGINRDRAG: - { - eventType = wxEVT_COMMAND_LIST_BEGIN_RDRAG; - NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - event.m_itemIndex = hdr->iItem; - event.m_pointDrag.x = hdr->ptAction.x; - event.m_pointDrag.y = hdr->ptAction.y; - break; - } - case LVN_COLUMNCLICK: - { - eventType = wxEVT_COMMAND_LIST_COL_CLICK; - NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - event.m_itemIndex = -1; - event.m_col = hdr->iSubItem; - break; - } - case LVN_DELETEALLITEMS: - { - eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS; -// NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - event.m_itemIndex = -1; - break; - } - case LVN_DELETEITEM: - { - eventType = wxEVT_COMMAND_LIST_DELETE_ITEM; - NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - event.m_itemIndex = hdr->iItem; - break; - } - case LVN_ENDLABELEDIT: - { - eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT; - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - wxConvertFromMSWListItem(this, event.m_item, info->item, (HWND) GetHWND()); - if ( info->item.pszText == NULL || info->item.iItem == -1 ) - event.m_cancelled = TRUE; - break; - } - case LVN_GETDISPINFO: - { -// return FALSE; - // TODO: some text buffering here, I think - // TODO: API for getting Windows to retrieve values - // on demand. - eventType = wxEVT_COMMAND_LIST_GET_INFO; - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - wxConvertFromMSWListItem(this, event.m_item, info->item, (HWND) GetHWND()); - break; - } - case LVN_INSERTITEM: - { - eventType = wxEVT_COMMAND_LIST_INSERT_ITEM; - NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - event.m_itemIndex = hdr->iItem; - break; - } - case LVN_ITEMCHANGED: - { - // This needs to be sent to wxListCtrl as a rather more - // concrete event. For now, just detect a selection - // or deselection. - NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam; - if ( (hdr->uNewState & LVIS_SELECTED) && !(hdr->uOldState & LVIS_SELECTED) ) - { - eventType = wxEVT_COMMAND_LIST_ITEM_SELECTED; - event.m_itemIndex = hdr->iItem; - } - else if ( !(hdr->uNewState & LVIS_SELECTED) && (hdr->uOldState & LVIS_SELECTED) ) - { - eventType = wxEVT_COMMAND_LIST_ITEM_DESELECTED; - event.m_itemIndex = hdr->iItem; - } - else - return FALSE; - break; - } - case LVN_KEYDOWN: - { - eventType = wxEVT_COMMAND_LIST_KEY_DOWN; - LV_KEYDOWN *info = (LV_KEYDOWN *)lParam; - event.m_code = wxCharCodeMSWToWX(info->wVKey); - break; - } - case LVN_SETDISPINFO: - { - eventType = wxEVT_COMMAND_LIST_SET_INFO; - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - wxConvertFromMSWListItem(this, event.m_item, info->item, (HWND) GetHWND()); - break; - } - - default : - return wxControl::MSWNotify(wParam, lParam); - break; - } - - event.SetEventObject( this ); - event.SetEventType(eventType); - - if ( !GetEventHandler()->ProcessEvent(event) ) - return FALSE; - - if (hdr1->code == LVN_GETDISPINFO) - { - LV_DISPINFO *info = (LV_DISPINFO *)lParam; - if ( info->item.mask & LVIF_TEXT ) - { - if ( !event.m_item.m_text.IsNull() ) - { - info->item.pszText = AddPool(event.m_item.m_text); - info->item.cchTextMax = strlen(info->item.pszText) + 1; - } - } -// wxConvertToMSWListItem(this, event.m_item, info->item); - } - - return TRUE; -} - -char *wxListCtrl::AddPool(const wxString& str) -{ - // Remove the first element if 3 strings exist - if ( m_stringPool.Number() == 3 ) - { - wxNode *node = m_stringPool.First(); - delete[] (char *)node->Data(); - delete node; - } - wxNode *node = m_stringPool.Add((char *) (const char *)str); - return (char *)node->Data(); -} - -// List item structure -wxListItem::wxListItem(void) -{ - m_mask = 0; - m_itemId = 0; - m_col = 0; - m_state = 0; - m_stateMask = 0; - m_image = 0; - m_data = 0; - - m_format = wxLIST_FORMAT_CENTRE; - m_width = 0; -} - -static void wxConvertFromMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& lvItem, HWND getFullInfo) -{ - info.m_data = lvItem.lParam; - info.m_mask = 0; - info.m_state = 0; - info.m_stateMask = 0; - info.m_itemId = lvItem.iItem; - - long oldMask = lvItem.mask; - - bool needText = FALSE; - if (getFullInfo != 0) - { - if ( lvItem.mask & LVIF_TEXT ) - needText = FALSE; - else - needText = TRUE; - - if ( needText ) - { - lvItem.pszText = new char[513]; - lvItem.cchTextMax = 512; - } -// lvItem.mask |= TVIF_HANDLE | TVIF_STATE | TVIF_TEXT | TVIF_IMAGE | TVIF_SELECTEDIMAGE | TVIF_CHILDREN | TVIF_PARAM ; - lvItem.mask |= LVIF_TEXT | LVIF_IMAGE | LVIF_PARAM ; - ::SendMessage(getFullInfo, LVM_GETITEM, 0, (LPARAM)& lvItem) ; - } - - if ( lvItem.mask & LVIF_STATE ) - { - info.m_mask |= wxLIST_MASK_STATE; - - if ( lvItem.stateMask & LVIS_CUT) - { - info.m_stateMask |= wxLIST_STATE_CUT ; - if ( lvItem.state & LVIS_CUT ) - info.m_state |= wxLIST_STATE_CUT ; - } - if ( lvItem.stateMask & LVIS_DROPHILITED) - { - info.m_stateMask |= wxLIST_STATE_DROPHILITED ; - if ( lvItem.state & LVIS_DROPHILITED ) - info.m_state |= wxLIST_STATE_DROPHILITED ; - } - if ( lvItem.stateMask & LVIS_FOCUSED) - { - info.m_stateMask |= wxLIST_STATE_FOCUSED ; - if ( lvItem.state & LVIS_FOCUSED ) - info.m_state |= wxLIST_STATE_FOCUSED ; - } - if ( lvItem.stateMask & LVIS_SELECTED) - { - info.m_stateMask |= wxLIST_STATE_SELECTED ; - if ( lvItem.state & LVIS_SELECTED ) - info.m_state |= wxLIST_STATE_SELECTED ; - } - } - - if ( lvItem.mask & LVIF_TEXT ) - { - info.m_mask |= wxLIST_MASK_TEXT; - info.m_text = lvItem.pszText; - } - if ( lvItem.mask & LVIF_IMAGE ) - { - info.m_mask |= wxLIST_MASK_IMAGE; - info.m_image = lvItem.iImage; - } - if ( lvItem.mask & LVIF_PARAM ) - info.m_mask |= wxLIST_MASK_DATA; - if ( lvItem.mask & LVIF_DI_SETITEM ) - info.m_mask |= wxLIST_SET_ITEM; - info.m_col = lvItem.iSubItem; - - if (needText) - { - if (lvItem.pszText) - delete[] lvItem.pszText; - } - lvItem.mask = oldMask ; -} - -static void wxConvertToMSWListItem(const wxListCtrl *ctrl, wxListItem& info, LV_ITEM& lvItem) -{ - lvItem.iItem = (int) info.m_itemId ; - - lvItem.iImage = info.m_image ; - lvItem.lParam = info.m_data; - lvItem.stateMask = 0; - lvItem.state = 0; - lvItem.mask = 0; - lvItem.iSubItem = info.m_col; - - if (info.m_mask & wxLIST_MASK_STATE) - { - lvItem.mask |= LVIF_STATE ; - if (info.m_stateMask & wxLIST_STATE_CUT) - { - lvItem.stateMask |= LVIS_CUT ; - if (info.m_state & wxLIST_STATE_CUT) - lvItem.state |= LVIS_CUT; - } - if (info.m_stateMask & wxLIST_STATE_DROPHILITED) - { - lvItem.stateMask |= LVIS_DROPHILITED; - if (info.m_state & wxLIST_STATE_DROPHILITED) - lvItem.state |= LVIS_DROPHILITED; - } - if (info.m_stateMask & wxLIST_STATE_FOCUSED) - { - lvItem.stateMask |= LVIS_FOCUSED; - if (info.m_state & wxLIST_STATE_FOCUSED) - lvItem.state |= LVIS_FOCUSED; - } - if (info.m_stateMask & wxLIST_STATE_SELECTED) - { - lvItem.stateMask |= LVIS_SELECTED; - if (info.m_state & wxLIST_STATE_SELECTED) - lvItem.state |= LVIS_SELECTED; - } - } - - if (info.m_mask & wxLIST_MASK_TEXT) - { - lvItem.mask |= LVIF_TEXT ; - if ( ctrl->GetWindowStyleFlag() & wxLC_USER_TEXT ) - { - lvItem.pszText = LPSTR_TEXTCALLBACK; - } - else - { - lvItem.pszText = (char *) (const char *)info.m_text ; - if ( lvItem.pszText ) - lvItem.cchTextMax = info.m_text.Length(); - else - lvItem.cchTextMax = 0; - } - } - if (info.m_mask & wxLIST_MASK_IMAGE) - lvItem.mask |= LVIF_IMAGE ; - if (info.m_mask & wxLIST_MASK_DATA) - lvItem.mask |= LVIF_PARAM ; -} - -// List event -IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxCommandEvent) - -wxListEvent::wxListEvent(wxEventType commandType, int id): - wxCommandEvent(commandType, id) -{ - m_code = 0; - m_itemIndex = 0; - m_col = 0; - m_cancelled = FALSE; + struct wxInternalDataSort internalData; + internalData.user_fn = fn; + internalData.data = data; + + // WPARAM cast is needed for mingw/cygwin + if ( !ListView_SortItems(GetHwnd(), + wxInternalDataCompareFunc, + (WPARAM) &internalData) ) + { + wxLogDebug(_T("ListView_SortItems() failed")); + + return false; + } + + return true; +} + + + +// ---------------------------------------------------------------------------- +// message processing +// ---------------------------------------------------------------------------- + +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 wxControl::MSWShouldPreProcessMessage(msg); } -#endif +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; + } + else if (cmd == EN_KILLFOCUS) + { + wxCommandEvent event(wxEVT_KILL_FOCUS, id); + event.SetEventObject( this ); + ProcessCommand(event); + return true; + } + else + return false; +} + +// utility used by wxListCtrl::MSWOnNotify and by wxDataViewHeaderWindowMSW::MSWOnNotify +int WXDLLIMPEXP_CORE wxMSWGetColumnClicked(NMHDR *nmhdr, POINT *ptClick) +{ + wxASSERT(nmhdr && 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__ + if ( !::GetCursorPos(ptClick) ) + { + wxLogLastError(_T("GetCursorPos")); + } + + if ( !::ScreenToClient(nmhdr->hwndFrom, ptClick) ) + { + wxLogLastError(_T("ScreenToClient(header)")); + } + + int colCount = Header_GetItemCount(nmhdr->hwndFrom); + + RECT rect; + for ( int col = 0; col < colCount; col++ ) + { + if ( Header_GetItemRect(nmhdr->hwndFrom, col, &rect) ) + { + if ( ::PtInRect(&rect, *ptClick) ) + { + return col; + } + } + } + + return wxNOT_FOUND; +} + +bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result) +{ + + // prepare the event + // ----------------- + + wxListEvent event(wxEVT_NULL, m_windowId); + event.SetEventObject(this); + + wxEventType eventType = wxEVT_NULL; + + NMHDR *nmhdr = (NMHDR *)lParam; + + // if your compiler is as broken as this, you should really change it: this + // code is needed for normal operation! #ifdef below is only useful for + // automatic rebuilds which are done with a very old compiler version +#ifdef HDN_BEGINTRACKA + + // check for messages from the header (in report view) + HWND hwndHdr = ListView_GetHeader(GetHwnd()); + + // is it a message from the header? + if ( nmhdr->hwndFrom == hwndHdr ) + { + HD_NOTIFY *nmHDR = (HD_NOTIFY *)nmhdr; + + event.m_itemIndex = -1; + + switch ( nmhdr->code ) + { + // yet another comctl32.dll bug: under NT/W2K it sends Unicode + // TRACK messages even to ANSI programs: on my system I get + // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all! + // + // work around is to simply catch both versions and hope that it + // works (why should this message exist in ANSI and Unicode is + // beyond me as it doesn't deal with strings at all...) + // + // 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 + case HDN_BEGINTRACKA: + case HDN_BEGINTRACKW: + eventType = wxEVT_COMMAND_LIST_COL_BEGIN_DRAG; + // fall through + + case HDN_TRACKA: + case HDN_TRACKW: + if ( eventType == wxEVT_NULL ) + eventType = wxEVT_COMMAND_LIST_COL_DRAGGING; + // fall through + + case HDN_ENDTRACKA: + case HDN_ENDTRACKW: + if ( eventType == wxEVT_NULL ) + eventType = wxEVT_COMMAND_LIST_COL_END_DRAG; + + event.m_item.m_width = nmHDR->pitem->cxy; + event.m_col = nmHDR->iItem; + break; + +#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400 + case GN_CONTEXTMENU: +#endif //__WXWINCE__ + case NM_RCLICK: + { + POINT ptClick; + + 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; + } + break; + + case HDN_GETDISPINFOW: + // 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); + } + } + else +#endif // defined(HDN_BEGINTRACKA) + if ( nmhdr->hwndFrom == GetHwnd() ) + { + // almost all messages use NM_LISTVIEW + NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr; + + 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); + + if ( internaldata ) + event.m_item.m_data = internaldata->lParam; + } + + bool processed = true; + switch ( nmhdr->code ) + { + case LVN_BEGINRDRAG: + eventType = wxEVT_COMMAND_LIST_BEGIN_RDRAG; + // fall through + + case LVN_BEGINDRAG: + if ( eventType == wxEVT_NULL ) + { + eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG; + } + + event.m_itemIndex = iItem; + event.m_pointDrag.x = nmLV->ptAction.x; + event.m_pointDrag.y = nmLV->ptAction.y; + break; + + // NB: we have to handle both *A and *W versions here because some + // versions of comctl32.dll send ANSI messages even to the + // Unicode windows + case LVN_BEGINLABELEDITA: + case LVN_BEGINLABELEDITW: + { + wxLV_ITEM item; + if ( nmhdr->code == LVN_BEGINLABELEDITA ) + { + item.Init(((LV_DISPINFOA *)lParam)->item); + } + else // LVN_BEGINLABELEDITW + { + item.Init(((LV_DISPINFOW *)lParam)->item); + } + + eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT; + wxConvertFromMSWListItem(GetHwnd(), event.m_item, item); + event.m_itemIndex = event.m_item.m_itemId; + } + break; + + case LVN_ENDLABELEDITA: + case LVN_ENDLABELEDITW: + { + wxLV_ITEM item; + if ( nmhdr->code == LVN_ENDLABELEDITA ) + { + item.Init(((LV_DISPINFOA *)lParam)->item); + } + else // LVN_ENDLABELEDITW + { + item.Init(((LV_DISPINFOW *)lParam)->item); + } + + // was editing cancelled? + 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; + } + + event.SetEditCanceled(true); + } + + eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT; + wxConvertFromMSWListItem(NULL, event.m_item, item); + event.m_itemIndex = event.m_item.m_itemId; + } + break; + + case LVN_COLUMNCLICK: + eventType = wxEVT_COMMAND_LIST_COL_CLICK; + event.m_itemIndex = -1; + event.m_col = nmLV->iSubItem; + break; + + case LVN_DELETEALLITEMS: + eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS; + event.m_itemIndex = -1; + break; + + case LVN_DELETEITEM: + 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_INSERTITEM: + eventType = wxEVT_COMMAND_LIST_INSERT_ITEM; + event.m_itemIndex = iItem; + break; + + case LVN_ITEMCHANGED: + // we translate this catch all message into more interesting + // (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 + // control) + if ( nmLV->uChanged & LVIF_STATE && iItem != -1 ) + { + // temp vars for readability + const UINT stOld = nmLV->uOldState; + const UINT stNew = nmLV->uNewState; + + event.m_item.SetId(iItem); + event.m_item.SetMask(wxLIST_MASK_TEXT | + wxLIST_MASK_IMAGE | + wxLIST_MASK_DATA); + GetItem(event.m_item); + + // has the focus changed? + if ( !(stOld & LVIS_FOCUSED) && (stNew & LVIS_FOCUSED) ) + { + eventType = wxEVT_COMMAND_LIST_ITEM_FOCUSED; + event.m_itemIndex = iItem; + } + + if ( (stNew & LVIS_SELECTED) != (stOld & LVIS_SELECTED) ) + { + if ( eventType != wxEVT_NULL ) + { + // focus and selection have both changed: send the + // focus event from here and the selection one + // below + event.SetEventType(eventType); + (void)HandleWindowEvent(event); + } + else // no focus event to send + { + // then need to set m_itemIndex as it wasn't done + // above + event.m_itemIndex = iItem; + } + + eventType = stNew & LVIS_SELECTED + ? wxEVT_COMMAND_LIST_ITEM_SELECTED + : wxEVT_COMMAND_LIST_ITEM_DESELECTED; + } + } + + if ( eventType == wxEVT_NULL ) + { + // not an interesting event for us + return false; + } + + break; + + case LVN_KEYDOWN: + { + LV_KEYDOWN *info = (LV_KEYDOWN *)lParam; + WORD wVKey = info->wVKey; + + // get the current selection + long lItem = GetNextItem(-1, + wxLIST_NEXT_ALL, + wxLIST_STATE_SELECTED); + + // or activate the selected item if any (but + // not with Shift and/or Ctrl as then they have a predefined + // meaning for the list view) + if ( lItem != -1 && + (wVKey == VK_RETURN || wVKey == VK_SPACE) && + !(wxIsShiftDown() || wxIsCtrlDown()) ) + { + eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED; + } + else + { + eventType = wxEVT_COMMAND_LIST_KEY_DOWN; + + // wxCharCodeMSWToWX() returns 0 if the key is an ASCII + // value which should be used as is + int code = wxCharCodeMSWToWX(wVKey); + event.m_code = code ? code : wVKey; + } + + event.m_itemIndex = + event.m_item.m_itemId = lItem; + + if ( lItem != -1 ) + { + // fill the other fields too + event.m_item.m_text = GetItemText(lItem); + event.m_item.m_data = GetItemData(lItem); + } + } + break; + + case NM_DBLCLK: + // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do + // anything else + if ( wxControl::MSWOnNotify(idCtrl, lParam, result) ) + { + return true; + } + + // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event + // if it happened on an item (and not on empty place) + if ( iItem == -1 ) + { + // not on item + return false; + } + + eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED; + event.m_itemIndex = iItem; + event.m_item.m_text = GetItemText(iItem); + event.m_item.m_data = GetItemData(iItem); + break; + +#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) ) + { + return true; + } + + // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event + LV_HITTESTINFO lvhti; + wxZeroMemory(lvhti); + +#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 ) + { + if ( lvhti.flags & LVHT_ONITEM ) + { + eventType = wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK; + event.m_itemIndex = lvhti.iItem; + event.m_pointDrag.x = lvhti.pt.x; + event.m_pointDrag.y = lvhti.pt.y; + } + } + break; + +#ifdef NM_CUSTOMDRAW + case NM_CUSTOMDRAW: + *result = OnCustomDraw(lParam); + + return *result != CDRF_DODEFAULT; +#endif // _WIN32_IE >= 0x300 + + case LVN_ODCACHEHINT: + { + const NM_CACHEHINT *cacheHint = (NM_CACHEHINT *)lParam; + + eventType = wxEVT_COMMAND_LIST_CACHE_HINT; + + // we get some really stupid cache hints like ones for + // items in range 0..0 for an empty control or, after + // deleting an item, for items in invalid range -- filter + // this garbage out + if ( cacheHint->iFrom > cacheHint->iTo ) + return false; + + event.m_oldItemIndex = cacheHint->iFrom; + + const long iMax = GetItemCount(); + event.m_itemIndex = cacheHint->iTo < iMax ? cacheHint->iTo + : iMax - 1; + } + break; + +#ifdef HAVE_NMLVFINDITEM + case LVN_ODFINDITEM: + // this message is only used with the virtual list control but + // even there we don't want to always use it: in a control with + // sufficiently big number of items (defined as > 1000 here), + // accidentally pressing a key could result in hanging an + // application waiting while it performs linear search + if ( IsVirtual() && GetItemCount() <= 1000 ) + { + 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 + const int startPos = pFindInfo->iStart; + const int maxPos = GetItemCount(); + wxCHECK_MSG( startPos <= maxPos, false, + _T("bad starting position in LVN_ODFINDITEM") ); + + int currentPos = startPos; + do + { + // wrap to the beginning if necessary + if ( currentPos == maxPos ) + { + // somewhat surprizingly, LVFI_WRAP isn't set in + // flags but we still should wrap + currentPos = 0; + } + + // does this item begin with searchstr? + if ( wxStrnicmp(searchstr, + GetItemText(currentPos), len) == 0 ) + { + *result = currentPos; + break; + } + } + while ( ++currentPos != startPos ); + + if ( *result == -1 ) + { + // not found + return false; + } + + 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() ) + { + LV_DISPINFO *info = (LV_DISPINFO *)lParam; + + LV_ITEM& lvi = info->item; + long item = lvi.iItem; + + if ( lvi.mask & LVIF_TEXT ) + { + wxString text = OnGetItemText(item, lvi.iSubItem); + wxStrncpy(lvi.pszText, text, lvi.cchTextMax); + } + + // see comment at the end of wxListCtrl::GetColumn() +#ifdef NM_CUSTOMDRAW + if ( lvi.mask & LVIF_IMAGE ) + { + lvi.iImage = OnGetItemColumnImage(item, lvi.iSubItem); + } +#endif // NM_CUSTOMDRAW + + // 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; + } + // fall through + + default: + processed = false; + } + + if ( !processed ) + return wxControl::MSWOnNotify(idCtrl, lParam, result); + } + else + { + // where did this one come from? + return false; + } + + // process the event + // ----------------- + + event.SetEventType(eventType); + + bool processed = HandleWindowEvent(event); + + // post processing + // --------------- + switch ( nmhdr->code ) + { + case LVN_DELETEALLITEMS: + // always return true to suppress all additional LVN_DELETEITEM + // notifications - this makes deleting all items from a list ctrl + // much faster + *result = TRUE; + + // 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_ENDLABELEDITA: + case LVN_ENDLABELEDITW: + // 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; + } + + return true; + } + + if ( processed ) + *result = !event.IsAllowed(); + + 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; + ListView_GetItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, &rc, LVIR_BOUNDS); + + RECT rcIcon; + ListView_GetItemRect(nmcd.hdr.hwndFrom, nmcd.dwItemSpec, &rcIcon, LVIR_ICON); + + // 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 + RECT rc; + ListView_GetSubItemRect(hwndList, item, col, LVIR_BOUNDS, &rc); + if ( !col && colCount > 1 ) + { + // broken ListView_GetSubItemRect() returns the entire item rect for + // 0th subitem while we really need just the part for this column + RECT rc2; + ListView_GetSubItemRect(hwndList, item, 1, LVIR_BOUNDS, &rc2); + + rc.right = rc2.left; + rc.left += 4; + } + else // not first subitem + { + 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) + if ( ::GetFocus() == hwndList && + ListView_GetNextItem(hwndList, (WPARAM)-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 pLVCD = (LPNMLVCUSTOMDRAW)lParam; + NMCUSTOMDRAW& nmcd = pLVCD->nmcd; + switch ( nmcd.dwDrawStage ) + { + case CDDS_PREPAINT: + // if we've got any items with non standard attributes, + // notify us before painting each item + // + // for virtual controls, always suppose that we have attributes as + // there is no way to check for this + if ( IsVirtual() || m_hasAnyAttr ) + return CDRF_NOTIFYITEMDRAW; + break; + + case CDDS_ITEMPREPAINT: + const int item = nmcd.dwItemSpec; + + // 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; + + return HandleItemPrepaint(this, pLVCD, DoGetItemAttr(item)); + } + + return CDRF_DODEFAULT; +} + +#endif // NM_CUSTOMDRAW supported + +// Necessary for drawing hrules and vrules, if specified +void wxListCtrl::OnPaint(wxPaintEvent& event) +{ + bool drawHRules = HasFlag(wxLC_HRULES); + bool drawVRules = HasFlag(wxLC_VRULES); + + if (!InReportView() || !drawHRules && !drawVRules) + { + event.Skip(); + return; + } + + wxPaintDC dc(this); + + wxControl::OnPaint(event); + + // Reset the device origin since it may have been set + dc.SetDeviceOrigin(0, 0); + + wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID); + dc.SetPen(pen); + dc.SetBrush(* wxTRANSPARENT_BRUSH); + + wxSize clientSize = GetClientSize(); + wxRect itemRect; + + int itemCount = GetItemCount(); + int i; + if (drawHRules) + { + long top = GetTopItem(); + for (i = top; i < top + GetCountPerPage() + 1; i++) + { + if (GetItemRect(i, itemRect)) + { + int cy = itemRect.GetTop(); + if (i != 0) // Don't draw the first one + { + dc.DrawLine(0, cy, clientSize.x, cy); + } + // Draw last line + if (i == itemCount - 1) + { + cy = itemRect.GetBottom(); + dc.DrawLine(0, cy, clientSize.x, cy); + } + } + } + } + i = itemCount - 1; + if (drawVRules && (i > -1)) + { + wxRect firstItemRect; + GetItemRect(0, firstItemRect); + + if (GetItemRect(i, itemRect)) + { + // 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); + + int numCols = GetColumnCount(); + int* indexArray = new int[numCols]; + if ( !ListView_GetColumnOrderArray( GetHwnd(), numCols, indexArray) ) + { + wxFAIL_MSG( _T("invalid column index array in OnPaint()") ); + } + + int x = itemRect.GetX(); + for (int col = 0; col < numCols; col++) + { + int colWidth = GetColumnWidth(indexArray[col]); + x += colWidth ; + dc.DrawLine(x-1, firstItemRect.GetY() - gap, + x-1, itemRect.GetBottom()); + } + + delete indexArray; + } + } +} + +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 wxControl::MSWWindowProc(nMsg, wParam, lParam); +} + +// ---------------------------------------------------------------------------- +// virtual list controls +// ---------------------------------------------------------------------------- + +wxString wxListCtrl::OnGetItemText(long WXUNUSED(item), long WXUNUSED(col)) const +{ + // this is a pure virtual function, in fact - which is not really pure + // because the controls which are not virtual don't need to implement it + wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") ); + + return wxEmptyString; +} + +int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const +{ + 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; +} + +wxListItemAttr *wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item)) const +{ + wxASSERT_MSG( item >= 0 && item < GetItemCount(), + _T("invalid item index in OnGetItemAttr()") ); + + // no attributes by default + return NULL; +} + +wxListItemAttr *wxListCtrl::DoGetItemAttr(long item) const +{ + return IsVirtual() ? OnGetItemAttr(item) + : wxGetInternalDataAttr(this, item); +} + +void wxListCtrl::SetItemCount(long count) +{ + wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") ); + + if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count, + LVSICF_NOSCROLL | LVSICF_NOINVALIDATEALL) ) + { + wxLogLastError(_T("ListView_SetItemCount")); + } + m_count = count; + wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()), + wxT("m_count should match ListView_GetItemCount")); +} + +void wxListCtrl::RefreshItem(long item) +{ + RefreshItems(item, item); +} + +void wxListCtrl::RefreshItems(long itemFrom, long itemTo) +{ + ListView_RedrawItems(GetHwnd(), itemFrom, itemTo); +} + +// ---------------------------------------------------------------------------- +// 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(const 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; + } +} + +// ---------------------------------------------------------------------------- +// wxWin <-> MSW items conversions +// ---------------------------------------------------------------------------- + +static void wxConvertFromMSWListItem(HWND hwndListCtrl, + wxListItem& info, + LV_ITEM& lvItem) +{ + wxListItemInternalData *internaldata = + (wxListItemInternalData *) lvItem.lParam; + + if (internaldata) + info.m_data = internaldata->lParam; + + info.m_mask = 0; + info.m_state = 0; + info.m_stateMask = 0; + info.m_itemId = lvItem.iItem; + + long oldMask = lvItem.mask; + + bool needText = false; + if (hwndListCtrl != 0) + { + if ( lvItem.mask & LVIF_TEXT ) + needText = false; + else + needText = true; + + if ( needText ) + { + lvItem.pszText = new wxChar[513]; + lvItem.cchTextMax = 512; + } + lvItem.mask |= LVIF_TEXT | LVIF_IMAGE | LVIF_PARAM; + ::SendMessage(hwndListCtrl, LVM_GETITEM, 0, (LPARAM)& lvItem); + } + + if ( lvItem.mask & LVIF_STATE ) + { + info.m_mask |= wxLIST_MASK_STATE; + + if ( lvItem.stateMask & LVIS_CUT) + { + info.m_stateMask |= wxLIST_STATE_CUT; + if ( lvItem.state & LVIS_CUT ) + info.m_state |= wxLIST_STATE_CUT; + } + if ( lvItem.stateMask & LVIS_DROPHILITED) + { + info.m_stateMask |= wxLIST_STATE_DROPHILITED; + if ( lvItem.state & LVIS_DROPHILITED ) + info.m_state |= wxLIST_STATE_DROPHILITED; + } + if ( lvItem.stateMask & LVIS_FOCUSED) + { + info.m_stateMask |= wxLIST_STATE_FOCUSED; + if ( lvItem.state & LVIS_FOCUSED ) + info.m_state |= wxLIST_STATE_FOCUSED; + } + if ( lvItem.stateMask & LVIS_SELECTED) + { + info.m_stateMask |= wxLIST_STATE_SELECTED; + if ( lvItem.state & LVIS_SELECTED ) + info.m_state |= wxLIST_STATE_SELECTED; + } + } + + if ( lvItem.mask & LVIF_TEXT ) + { + info.m_mask |= wxLIST_MASK_TEXT; + info.m_text = lvItem.pszText; + } + if ( lvItem.mask & LVIF_IMAGE ) + { + info.m_mask |= wxLIST_MASK_IMAGE; + info.m_image = lvItem.iImage; + } + if ( lvItem.mask & LVIF_PARAM ) + info.m_mask |= wxLIST_MASK_DATA; + if ( lvItem.mask & LVIF_DI_SETITEM ) + info.m_mask |= wxLIST_SET_ITEM; + info.m_col = lvItem.iSubItem; + + if (needText) + { + if (lvItem.pszText) + delete[] lvItem.pszText; + } + lvItem.mask = oldMask; +} + +static void wxConvertToMSWFlags(long state, long stateMask, LV_ITEM& lvItem) +{ + if (stateMask & wxLIST_STATE_CUT) + { + lvItem.stateMask |= LVIS_CUT; + if (state & wxLIST_STATE_CUT) + lvItem.state |= LVIS_CUT; + } + if (stateMask & wxLIST_STATE_DROPHILITED) + { + lvItem.stateMask |= LVIS_DROPHILITED; + if (state & wxLIST_STATE_DROPHILITED) + lvItem.state |= LVIS_DROPHILITED; + } + if (stateMask & wxLIST_STATE_FOCUSED) + { + lvItem.stateMask |= LVIS_FOCUSED; + if (state & wxLIST_STATE_FOCUSED) + lvItem.state |= LVIS_FOCUSED; + } + if (stateMask & wxLIST_STATE_SELECTED) + { + lvItem.stateMask |= LVIS_SELECTED; + if (state & wxLIST_STATE_SELECTED) + lvItem.state |= LVIS_SELECTED; + } +} + +static void wxConvertToMSWListItem(const wxListCtrl *ctrl, + const wxListItem& info, + LV_ITEM& lvItem) +{ + lvItem.iItem = (int) info.m_itemId; + + lvItem.iImage = info.m_image; + lvItem.stateMask = 0; + lvItem.state = 0; + lvItem.mask = 0; + lvItem.iSubItem = info.m_col; + + if (info.m_mask & wxLIST_MASK_STATE) + { + lvItem.mask |= LVIF_STATE; + + wxConvertToMSWFlags(info.m_state, info.m_stateMask, lvItem); + } + + if (info.m_mask & wxLIST_MASK_TEXT) + { + lvItem.mask |= LVIF_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.wx_str(); + if ( lvItem.pszText ) + lvItem.cchTextMax = info.m_text.length(); + else + lvItem.cchTextMax = 0; + } + } + if (info.m_mask & wxLIST_MASK_IMAGE) + lvItem.mask |= LVIF_IMAGE; +} + +static void wxConvertToMSWListCol(HWND hwndList, + int col, + const wxListItem& item, + LV_COLUMN& lvCol) +{ + wxZeroMemory(lvCol); + + if ( item.m_mask & wxLIST_MASK_TEXT ) + { + lvCol.mask |= LVCF_TEXT; + lvCol.pszText = (wxChar *)item.m_text.wx_str(); // cast is safe + } + + if ( item.m_mask & wxLIST_MASK_FORMAT ) + { + lvCol.mask |= LVCF_FMT; + + if ( item.m_format == wxLIST_FORMAT_LEFT ) + lvCol.fmt = LVCFMT_LEFT; + else if ( item.m_format == wxLIST_FORMAT_RIGHT ) + lvCol.fmt = LVCFMT_RIGHT; + else if ( item.m_format == wxLIST_FORMAT_CENTRE ) + lvCol.fmt = LVCFMT_CENTER; + } + + if ( item.m_mask & wxLIST_MASK_WIDTH ) + { + lvCol.mask |= LVCF_WIDTH; + if ( item.m_width == wxLIST_AUTOSIZE) + lvCol.cx = LVSCW_AUTOSIZE; + else if ( item.m_width == wxLIST_AUTOSIZE_USEHEADER) + lvCol.cx = LVSCW_AUTOSIZE_USEHEADER; + else + lvCol.cx = item.m_width; + } + + // see comment at the end of wxListCtrl::GetColumn() +#ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300 + if ( item.m_mask & wxLIST_MASK_IMAGE ) + { + if ( wxApp::GetComCtl32Version() >= 470 ) + { + lvCol.mask |= LVCF_IMAGE; + + // 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? + 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; + } + //else: it doesn't support item images anyhow + } +#endif // _WIN32_IE >= 0x0300 +} +#endif // wxUSE_LISTCTRL