/////////////////////////////////////////////////////////////////////////////
-// Name: listctrl.cpp
+// Name: src/msw/listctrl.cpp
// Purpose: wxListCtrl
// Author: Julian Smart
// Modified by:
// Created: 04/01/98
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) Julian Smart
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
#include <commctrl.h>
#endif
-#ifndef LVHT_ONITEM
- #define LVHT_ONITEM \
- (LVHT_ONITEMICON | LVHT_ONITEMLABEL | LVHT_ONITEMSTATEICON)
-#endif
-
-#ifndef LVM_SETEXTENDEDLISTVIEWSTYLE
- #define LVM_SETEXTENDEDLISTVIEWSTYLE (0x1000 + 54)
-#endif
-
-#ifndef LVS_EX_FULLROWSELECT
- #define LVS_EX_FULLROWSELECT 0x00000020
-#endif
-
-#ifndef LVS_OWNERDATA
- #define LVS_OWNERDATA 0x1000
-#endif
-
-// mingw32/cygwin don't have declarations for comctl32.dll 4.70+ stuff
-#ifndef NM_CACHEHINT
- typedef struct tagNMLVCACHEHINT
- {
- NMHDR hdr;
- int iFrom;
- int iTo;
- } NMLVCACHEHINT;
-
- #define NM_CACHEHINT NMLVCACHEHINT
-#endif
-
-#ifndef LVN_ODCACHEHINT
- #define LVN_ODCACHEHINT (-113)
-#endif
-
-#ifndef ListView_GetHeader
- #define ListView_GetHeader(w) (HWND)SendMessage((w),LVM_GETHEADER,0,0)
-#endif
-
-#ifndef LVM_GETHEADER
- #define LVM_GETHEADER (LVM_FIRST+31)
-#endif
-
-#ifndef Header_GetItemRect
- #define Header_GetItemRect(w,i,r) \
- (BOOL)SendMessage((w),HDM_GETITEMRECT,(WPARAM)(i),(LPARAM)(r))
-#endif
-
-#ifndef HDM_GETITEMRECT
- #define HDM_GETITEMRECT (HDM_FIRST+7)
-#endif
-
-#ifndef LVCF_IMAGE
- #define LVCF_IMAGE 0x0010
-#endif
-
-#ifndef LVCFMT_BITMAP_ON_RIGHT
- #define LVCFMT_BITMAP_ON_RIGHT 0x1000
-#endif
+#include "wx/msw/missing.h"
// ----------------------------------------------------------------------------
// private functions
static void wxConvertToMSWListCol(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 commctl.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().
+class wxLV_ITEM
+{
+public:
+ ~wxLV_ITEM() { delete m_buf; }
+ operator LV_ITEM&() const { return *m_item; }
+
+#if wxUSE_UNICODE
+ wxLV_ITEM(LV_ITEMW &item) : m_buf(NULL), m_item(&item) {}
+ wxLV_ITEM(LV_ITEMA &item)
+ {
+ m_item = new LV_ITEM((LV_ITEM&)item);
+ if ( (item.mask & LVIF_TEXT) && item.pszText )
+ {
+ m_buf = new wxMB2WXbuf(wxConvLocal.cMB2WX(item.pszText));
+ m_item->pszText = (wxChar*)m_buf->data();
+ }
+ else
+ m_buf = NULL;
+ }
+private:
+ wxMB2WXbuf *m_buf;
+
+#else // !wxUSE_UNICODE
+ wxLV_ITEM(LV_ITEMW &item)
+ {
+ m_item = new LV_ITEM((LV_ITEM&)item);
+
+ // the code below doesn't compile without wxUSE_WCHAR_T and as I don't
+ // know if it's useful to have it at all (do we ever get Unicode
+ // notifications in ANSI mode? I don't think so...) I'm not going to
+ // write alternative implementation right now
+ //
+ // but if it is indeed used, we should simply directly use
+ // ::WideCharToMultiByte() here
+#if wxUSE_WCHAR_T
+ if ( (item.mask & LVIF_TEXT) && item.pszText )
+ {
+ m_buf = new wxWC2WXbuf(wxConvLocal.cWC2WX(item.pszText));
+ m_item->pszText = (wxChar*)m_buf->data();
+ }
+ else
+#endif // wxUSE_WCHAR_T
+ m_buf = NULL;
+ }
+ wxLV_ITEM(LV_ITEMA &item) : m_buf(NULL), m_item(&item) {}
+private:
+ wxWC2WXbuf *m_buf;
+#endif // wxUSE_UNICODE/!wxUSE_UNICODE
+
+ LV_ITEM *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 independant 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(wxListCtrl *ctl, long itemId);
+static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId);
+static void wxDeleteInternalData(wxListCtrl* ctl, long itemId);
+
+
// ----------------------------------------------------------------------------
// events
// ----------------------------------------------------------------------------
DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT)
IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl)
IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject)
+IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent)
+
BEGIN_EVENT_TABLE(wxListCtrl, wxControl)
EVT_PAINT(wxListCtrl::OnPaint)
END_EVENT_TABLE()
// implementation
// ============================================================================
-// ----------------------------------------------------------------------------
-// wxListEvent
-// ----------------------------------------------------------------------------
-
-void wxListEvent::CopyObject(wxObject& object_dest) const
-{
- wxListEvent *obj = (wxListEvent *)&object_dest;
-
- wxNotifyEvent::CopyObject(object_dest);
-
- obj->m_code = m_code;
- obj->m_itemIndex = m_itemIndex;
- obj->m_oldItemIndex = m_oldItemIndex;
- obj->m_col = m_col;
- obj->m_cancelled = m_cancelled;
- obj->m_pointDrag = m_pointDrag;
- obj->m_item.m_mask = m_item.m_mask;
- obj->m_item.m_itemId = m_item.m_itemId;
- obj->m_item.m_col = m_item.m_col;
- obj->m_item.m_state = m_item.m_state;
- obj->m_item.m_stateMask = m_item.m_stateMask;
- obj->m_item.m_text = m_item.m_text;
- obj->m_item.m_image = m_item.m_image;
- obj->m_item.m_data = m_item.m_data;
- obj->m_item.m_format = m_item.m_format;
- obj->m_item.m_width = m_item.m_width;
-
- if ( m_item.HasAttributes() )
- {
- obj->m_item.SetTextColour(m_item.GetTextColour());
- obj->m_item.SetBackgroundColour(m_item.GetBackgroundColour());
- obj->m_item.SetFont(m_item.GetFont());
- }
-}
-
// ----------------------------------------------------------------------------
// wxListCtrl construction
// ----------------------------------------------------------------------------
m_ownsImageListNormal = m_ownsImageListSmall = m_ownsImageListState = FALSE;
m_baseStyle = 0;
m_colCount = 0;
+ m_count = 0;
+ m_ignoreChangeMessages = FALSE;
m_textCtrl = NULL;
+ m_AnyInternalData = FALSE;
m_hasAnyAttr = FALSE;
}
if ( m_windowStyle & wxCLIP_SIBLINGS )
wstyle |= WS_CLIPSIBLINGS;
+/*
if ( wxStyleHasBorder(m_windowStyle) )
wstyle |= WS_BORDER;
+*/
+
m_baseStyle = wstyle;
if ( !DoCreateControl(x, y, width, height) )
{
DWORD wstyle = m_baseStyle;
- bool want3D;
- WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D);
-
- // Even with extended styles, need to combine with WS_BORDER
- // for them to look right.
- if ( want3D )
- wstyle |= WS_BORDER;
+ WXDWORD exStyle = 0;
+ (void) MSWGetStyle(GetWindowStyle(), & exStyle) ;
long oldStyle = 0; // Dummy
wstyle |= ConvertToMSWStyle(oldStyle, m_windowStyle);
0, LVS_EX_FULLROWSELECT);
}
- SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW));
+ SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
SetForegroundColour(GetParent()->GetForegroundColour());
SubclassWin(m_hWnd);
}
}
-void wxListCtrl::FreeAllAttrs(bool dontRecreate)
+void wxListCtrl::FreeAllInternalData()
{
- if ( m_hasAnyAttr )
+ if (m_AnyInternalData)
{
- for ( wxNode *node = m_attrs.Next(); node; node = m_attrs.Next() )
- {
- delete (wxListItemAttr *)node->Data();
- }
+ int n = GetItemCount();
+ int i = 0;
- m_attrs.Destroy();
- if ( !dontRecreate )
- {
- m_attrs.Create(wxKEY_INTEGER, 1000); // just as def ctor
- }
+ m_ignoreChangeMessages = TRUE;
+ for (i = 0; i < n; i++)
+ wxDeleteInternalData(this, i);
+ m_ignoreChangeMessages = FALSE;
- m_hasAnyAttr = FALSE;
+ m_AnyInternalData = FALSE;
}
}
wxListCtrl::~wxListCtrl()
{
- FreeAllAttrs(TRUE /* no need to recreate hash any more */);
+ FreeAllInternalData();
if ( m_textCtrl )
{
- m_textCtrl->SetHWND(0);
m_textCtrl->UnsubclassWin();
+ m_textCtrl->SetHWND(0);
delete m_textCtrl;
m_textCtrl = NULL;
}
LV_COLUMN lvCol;
wxZeroMemory(lvCol);
+ lvCol.mask = LVCF_WIDTH;
+
if ( item.m_mask & wxLIST_MASK_TEXT )
{
lvCol.mask |= LVCF_TEXT;
lvCol.cchTextMax = 512;
}
- bool success = ListView_GetColumn(GetHwnd(), col, & lvCol) != 0;
+ 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;
// item.m_subItem = lvCol.iSubItem;
item.m_width = lvCol.cx;
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;
+ 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 _WIN32_IE >= 0x0300
+ if ( item.m_mask & wxLIST_MASK_IMAGE )
+ {
+ item.m_image = lvCol.iImage;
}
+#endif
return success;
}
LV_ITEM item;
wxConvertToMSWListItem(this, info, item);
- item.cchTextMax = 0;
- if ( !ListView_SetItem(GetHwnd(), &item) )
+ // 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))
{
- wxLogDebug(_T("ListView_SetItem() failed"));
+ // get internal item data
+ // perhaps a cache here ?
+ wxListItemInternalData *data = wxGetInternalData(this, info.m_itemId);
- return FALSE;
+ 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())
+ {
+ if (data->attr)
+ *data->attr = *info.GetAttributes();
+ else
+ data->attr = new wxListItemAttr(*info.GetAttributes());
+ };
+ };
+
+
+ // 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
// check whether it has any custom attributes
if ( info.HasAttributes() )
{
- wxListItemAttr *attr = (wxListItemAttr *)m_attrs.Get(item.iItem);
-
- if ( attr == NULL )
- m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes()));
- else
- *attr = *info.GetAttributes();
-
m_hasAnyAttr = TRUE;
// if the colour has changed, we must redraw the item
if ( updateNow )
{
// we need this to make the change visible right now
- ListView_Update(GetHwnd(), item.iItem);
+ RefreshItem(item.iItem);
}
return TRUE;
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;
+ }
+
if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE,
(WPARAM)item, (LPARAM)&lvItem) )
{
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;
}
info.m_itemId = item;
if (!GetItem(info))
- return wxString("");
+ return wxEmptyString;
return info.m_text;
}
// Gets the item rectangle
bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
{
- RECT rect2;
+ RECT rectWin;
- int code2 = LVIR_BOUNDS;
+ int codeWin;
if ( code == wxLIST_RECT_BOUNDS )
- code2 = LVIR_BOUNDS;
+ codeWin = LVIR_BOUNDS;
else if ( code == wxLIST_RECT_ICON )
- code2 = LVIR_ICON;
+ codeWin = LVIR_ICON;
else if ( code == wxLIST_RECT_LABEL )
- code2 = LVIR_LABEL;
+ codeWin = LVIR_LABEL;
+ else
+ {
+ wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
-#ifdef __WXWINE__
- bool success = (ListView_GetItemRect(GetHwnd(), (int) item, &rect2 ) != 0);
-#else
- bool success = (ListView_GetItemRect(GetHwnd(), (int) item, &rect2, code2) != 0);
-#endif
+ codeWin = LVIR_BOUNDS;
+ }
+
+ bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 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.top;
return success;
}
// Gets the number of items in the list control
int wxListCtrl::GetItemCount() const
{
- return ListView_GetItemCount(GetHwnd());
+ return m_count;
}
// Retrieves the spacing between icons in pixels.
return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall);
}
+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
+{
+ wxListItem info;
+ info.m_itemId = item;
+ GetItem( info );
+ return info.GetTextColour();
+}
+
+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
+{
+ wxListItem info;
+ info.m_itemId = item;
+ GetItem( info );
+ return info.GetBackgroundColour();
+}
+
// Gets the number of selected items in the list control
int wxListCtrl::GetSelectedItemCount() const
{
// Deletes an item
bool wxListCtrl::DeleteItem(long item)
{
- return (ListView_DeleteItem(GetHwnd(), (int) item) != 0);
+ if ( !ListView_DeleteItem(GetHwnd(), (int) item) )
+ {
+ wxLogLastError(_T("ListView_DeleteItem"));
+ return FALSE;
+ }
+
+ m_count -= 1;
+ 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()
{
- return (ListView_DeleteAllItems(GetHwnd()) != 0);
+ FreeAllInternalData();
+ return ListView_DeleteAllItems(GetHwnd()) != 0;
}
// Deletes all items
{
wxASSERT( (textControlClass->IsKindOf(CLASSINFO(wxTextCtrl))) );
- // VS: ListView_EditLabel requires that the list has focus.
+ // ListView_EditLabel requires that the list has focus.
SetFocus();
- HWND hWnd = (HWND) ListView_EditLabel(GetHwnd(), item);
- if (m_textCtrl)
+ WXHWND hWnd = (WXHWND) ListView_EditLabel(GetHwnd(), item);
+ if ( !hWnd )
+ {
+ // failed to start editing
+ return NULL;
+ }
+
+ // [re]create the text control wrapping the HWND we got
+ if ( m_textCtrl )
{
- m_textCtrl->SetHWND(0);
m_textCtrl->UnsubclassWin();
+ m_textCtrl->SetHWND(0);
delete m_textCtrl;
- m_textCtrl = NULL;
}
- 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;
}
// Find an item whose data matches this data, starting from the item after 'start'
// or the beginning if 'start' is -1.
+// NOTE : Lindsay Mathieson - 14-July-2002
+// No longer use ListView_FindItem as the data attribute is now stored
+// in a wxListItemInternalData structure refernced by the actual lParam
long wxListCtrl::FindItem(long start, long data)
{
- 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(GetHwnd(), (int) start, & findInfo);
+ return -1;
}
// Find an item nearest this position in the specified direction, starting from
LV_ITEM item;
wxConvertToMSWListItem(this, info, item);
+ item.mask &= ~LVIF_PARAM;
- // check whether it has any custom attributes
- if ( info.HasAttributes() )
+ // 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;
- wxListItemAttr *attr;
- attr = (wxListItemAttr*) m_attrs.Get(item.iItem);
-
- if (attr == NULL)
+ // internal stucture that manages data
+ wxListItemInternalData *data = new wxListItemInternalData();
+ item.lParam = (LPARAM) data;
- m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes()));
+ if (info.m_mask & wxLIST_MASK_DATA)
+ data->lParam = info.m_data;
- else *attr = *info.GetAttributes();
-
- m_hasAnyAttr = TRUE;
+ // check whether it has any custom attributes
+ if ( info.HasAttributes() )
+ {
+ // take copy of attributes
+ data->attr = new wxListItemAttr(*info.GetAttributes());
}
+ };
- return (long) ListView_InsertItem(GetHwnd(), & item);
+ long rv = ListView_InsertItem(GetHwnd(), & item);
+ m_count += 1;
+ wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
+ wxT("m_count should match ListView_GetItemCount"));
+
+ return rv;
}
long wxListCtrl::InsertItem(long index, const wxString& label)
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(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.
// data is arbitrary data to be passed to the sort function.
-// FIXME: this is horrible and MT-unsafe and everything else but I don't have
-// time for anything better right now (VZ)
-static long gs_sortData = 0;
-static wxListCtrl *gs_sortCtrl = NULL;
-static wxListCtrlCompare gs_sortFunction = NULL;
+// Internal structures for proxying the user compare function
+// so that we can pass it the *real* user data
-int wxCMPFUNC_CONV wxListCtrlCompareFn(const void *arg1, const void *arg2)
+// translate lParam data and call user func
+struct wxInternalDataSort
{
- int n1 = *(const int *)arg1,
- n2 = *(const int *)arg2;
+ wxListCtrlCompare user_fn;
+ long data;
+};
- return gs_sortFunction(gs_sortCtrl->GetItemData(n1),
- gs_sortCtrl->GetItemData(n2),
- gs_sortData);
-}
-
-bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data)
+int CALLBACK wxInternalDataCompareFunc(LPARAM lParam1, LPARAM lParam2, LPARAM lParamSort)
{
- // sort the attributes too
- if ( m_hasAnyAttr )
- {
- int n,
- count = GetItemCount();
- int *aItems = new int[count];
- for ( n = 0; n < count; n++ )
- {
- aItems[n] = n;
- }
-
- gs_sortData = data;
- gs_sortCtrl = this;
- gs_sortFunction = fn;
+ struct wxInternalDataSort *internalData = (struct wxInternalDataSort *) lParamSort;
- qsort(aItems, count, sizeof(int), wxListCtrlCompareFn);
+ wxListItemInternalData *data1 = (wxListItemInternalData *) lParam1;
+ wxListItemInternalData *data2 = (wxListItemInternalData *) lParam2;
- gs_sortData = 0;
- gs_sortCtrl = NULL;
- gs_sortFunction = NULL;
+ long d1 = (data1 == NULL ? 0 : data1->lParam);
+ long d2 = (data2 == NULL ? 0 : data2->lParam);
- wxHashTable attrsNew(wxKEY_INTEGER, 1000);
- for ( n = 0; n < count; n++ )
- {
- wxObject *attr = m_attrs.Delete(aItems[n]);
- if ( attr )
- {
- attrsNew.Put(n, attr);
- }
- }
+ return internalData->user_fn(d1, d2, internalData->data);
- m_attrs.Destroy();
- m_attrs = attrsNew;
+};
- delete [] aItems;
- }
+bool wxListCtrl::SortItems(wxListCtrlCompare fn, long data)
+{
+ struct wxInternalDataSort internalData;
+ internalData.user_fn = fn;
+ internalData.data = data;
- if ( !ListView_SortItems(GetHwnd(), (PFNLVCOMPARE)fn, data) )
+ // WPARAM cast is needed for mingw/cygwin
+ if ( !ListView_SortItems(GetHwnd(),
+ wxInternalDataCompareFunc,
+ (WPARAM) &internalData) )
{
wxLogDebug(_T("ListView_SortItems() failed"));
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 )
{
- NMHEADER *nmHDR = (NMHEADER *)nmhdr;
+ HD_NOTIFY *nmHDR = (HD_NOTIFY *)nmhdr;
+
event.m_itemIndex = -1;
switch ( nmhdr->code )
// 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;
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;
}
break;
+ case HDN_GETDISPINFOW:
+ {
+ LPNMHDDISPINFOW info = (LPNMHDDISPINFOW) lParam;
+ // This is a fix for a strange bug under XP.
+ // Normally, info->iItem is a valid index, but
+ // sometimes this is a silly (large) number
+ // and when we return FALSE via wxControl::MSWOnNotify
+ // to indicate that it hasn't yet been processed,
+ // there's a GPF in Windows.
+ // By returning TRUE here, we avoid further processing
+ // of this strange message.
+ if ( info->iItem >= GetColumnCount() )
+ return TRUE;
+ }
+ // fall through
+
default:
return wxControl::MSWOnNotify(idCtrl, lParam, result);
}
}
- else if ( nmhdr->hwndFrom == GetHwnd() )
+ else
+#endif // defined(HDN_BEGINTRACKA)
+ if ( nmhdr->hwndFrom == GetHwnd() )
{
// almost all messages use NM_LISTVIEW
NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
- // this is true for almost all events
- event.m_item.m_data = nmLV->lParam;
+ 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;
+ }
+
switch ( nmhdr->code )
{
eventType = wxEVT_COMMAND_LIST_BEGIN_DRAG;
}
- event.m_itemIndex = nmLV->iItem;
+ event.m_itemIndex = iItem;
event.m_pointDrag.x = nmLV->ptAction.x;
event.m_pointDrag.y = nmLV->ptAction.y;
break;
- case LVN_BEGINLABELEDIT:
+ // NB: we have to handle both *A and *W versions here because some
+ // versions of comctl32.dll send ANSI message to an Unicode app
+ case LVN_BEGINLABELEDITA:
{
eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
- LV_DISPINFO *info = (LV_DISPINFO *)lParam;
- wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item);
+ wxLV_ITEM item(((LV_DISPINFOA *)lParam)->item);
+ wxConvertFromMSWListItem(GetHwnd(), event.m_item, item);
+ event.m_itemIndex = event.m_item.m_itemId;
+ }
+ break;
+ case LVN_BEGINLABELEDITW:
+ {
+ eventType = wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
+ wxLV_ITEM item(((LV_DISPINFOW *)lParam)->item);
+ wxConvertFromMSWListItem(GetHwnd(), event.m_item, item);
+ event.m_itemIndex = event.m_item.m_itemId;
+ }
+ break;
+
+ case LVN_ENDLABELEDITA:
+ {
+ eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
+ wxLV_ITEM item(((LV_DISPINFOA *)lParam)->item);
+ wxConvertFromMSWListItem(NULL, event.m_item, item);
+ if ( ((LV_ITEM)item).pszText == NULL ||
+ ((LV_ITEM)item).iItem == -1 )
+ return FALSE;
+
+ event.m_itemIndex = event.m_item.m_itemId;
+ }
+ break;
+ case LVN_ENDLABELEDITW:
+ {
+ eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
+ wxLV_ITEM item(((LV_DISPINFOW *)lParam)->item);
+ wxConvertFromMSWListItem(NULL, event.m_item, item);
+ if ( ((LV_ITEM)item).pszText == NULL ||
+ ((LV_ITEM)item).iItem == -1 )
+ return FALSE;
+
event.m_itemIndex = event.m_item.m_itemId;
}
break;
break;
case LVN_DELETEALLITEMS:
+ m_count = 0;
eventType = wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
event.m_itemIndex = -1;
-
- FreeAllAttrs();
-
break;
case LVN_DELETEITEM:
- eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
- event.m_itemIndex = nmLV->iItem;
-
- if ( m_hasAnyAttr )
- {
- delete (wxListItemAttr *)m_attrs.Delete(nmLV->iItem);
- }
- break;
-
- case LVN_ENDLABELEDIT:
- {
- eventType = wxEVT_COMMAND_LIST_END_LABEL_EDIT;
- LV_DISPINFO *info = (LV_DISPINFO *)lParam;
- wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item);
- if ( info->item.pszText == NULL || info->item.iItem == -1 )
- return FALSE;
+ if (m_count == 0)
+ // this should be prevented by the post-processing code below,
+ // but "just in case"
+ return FALSE;
- event.m_itemIndex = event.m_item.m_itemId;
- }
+ eventType = wxEVT_COMMAND_LIST_DELETE_ITEM;
+ event.m_itemIndex = iItem;
+ // delete the assoicated internal data
+ wxDeleteInternalData(this, iItem);
break;
case LVN_SETDISPINFO:
case LVN_INSERTITEM:
eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
- event.m_itemIndex = nmLV->iItem;
+ event.m_itemIndex = 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.
- if ( (nmLV->uNewState & LVIS_SELECTED) && !(nmLV->uOldState & LVIS_SELECTED) )
- {
- eventType = wxEVT_COMMAND_LIST_ITEM_SELECTED;
- event.m_itemIndex = nmLV->iItem;
- }
- else if ( !(nmLV->uNewState & LVIS_SELECTED) && (nmLV->uOldState & LVIS_SELECTED) )
+ // we translate this catch all message into more interesting
+ // (and more easy to process) wxWindows events
+
+ // first of all, we deal with the state change events only and
+ // only for valid items (item == -1 for the virtual list
+ // control)
+ if ( nmLV->uChanged & LVIF_STATE && iItem != -1 )
{
- eventType = wxEVT_COMMAND_LIST_ITEM_DESELECTED;
- event.m_itemIndex = nmLV->iItem;
+ // 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)GetEventHandler()->ProcessEvent(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;
+ }
}
- else
+
+ if ( eventType == wxEVT_NULL )
{
+ // not an interesting event for us
return FALSE;
}
+
break;
case LVN_KEYDOWN:
else
{
eventType = wxEVT_COMMAND_LIST_KEY_DOWN;
- event.m_code = wxCharCodeMSWToWX(wVKey);
+
+ // 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 =
// else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
// if it happened on an item (and not on empty place)
- if ( nmLV->iItem == -1 )
+ if ( iItem == -1 )
{
// not on item
return FALSE;
}
eventType = wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
- event.m_itemIndex = nmLV->iItem;
- event.m_item.m_text = GetItemText(nmLV->iItem);
- event.m_item.m_data = GetItemData(nmLV->iItem);
+ event.m_itemIndex = iItem;
+ event.m_item.m_text = GetItemText(iItem);
+ event.m_item.m_data = GetItemData(iItem);
break;
case NM_RCLICK:
// process the event
// -----------------
- event.SetEventObject( this );
event.SetEventType(eventType);
- if ( !GetEventHandler()->ProcessEvent(event) )
- return FALSE;
+ bool processed = GetEventHandler()->ProcessEvent(event);
// post processing
// ---------------
-
switch ( nmhdr->code )
{
case LVN_DELETEALLITEMS:
// notifications - this makes deleting all items from a list ctrl
// much faster
*result = TRUE;
-
return TRUE;
- case LVN_ENDLABELEDIT:
+ case LVN_ENDLABELEDITA:
+ case LVN_ENDLABELEDITW:
// logic here is inversed 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;
}
- *result = !event.IsAllowed();
+ if ( processed )
+ *result = !event.IsAllowed();
- return TRUE;
+ return processed;
}
#if defined(_WIN32_IE) && _WIN32_IE >= 0x300
wxListItemAttr *attr =
IsVirtual() ? OnGetItemAttr(item)
- : (wxListItemAttr *)m_attrs.Get(item);
+ : wxGetInternalDataAttr(this, item);
if ( !attr )
{
if ((GetWindowStyle() & wxLC_REPORT) == 0)
return;
- wxPen pen(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID);
+ wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID);
dc.SetPen(pen);
dc.SetBrush(* wxTRANSPARENT_BRUSH);
{
int colWidth = GetColumnWidth(col);
x += colWidth ;
- dc.DrawLine(x, firstItemRect.GetY() - 2, x, itemRect.GetBottom());
+ dc.DrawLine(x-1, firstItemRect.GetY() - 2, x-1, itemRect.GetBottom());
}
}
}
{
// this is a pure virtual function, in fact - which is not really pure
// because the controls which are not virtual don't need to implement it
- wxFAIL_MSG( _T("not supposed to be called") );
+ wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") );
return wxEmptyString;
}
int wxListCtrl::OnGetItemImage(long WXUNUSED(item)) const
{
// same as above
- wxFAIL_MSG( _T("not supposed to be called") );
+ wxFAIL_MSG( _T("wxListCtrl::OnGetItemImage not supposed to be called") );
return -1;
}
{
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)
{
+ // strangely enough, ListView_Update() results in much more flicker here
+ // than a dumb Refresh() -- why?
+#if 0
if ( !ListView_Update(GetHwnd(), item) )
{
wxLogLastError(_T("ListView_Update"));
}
+#else // 1
+ wxRect rect;
+ GetItemRect(item, rect);
+ RefreshRect(rect);
+#endif // 0/1
}
void wxListCtrl::RefreshItems(long itemFrom, long itemTo)
RefreshRect(rect);
}
-// ----------------------------------------------------------------------------
-// wxListItem
-// ----------------------------------------------------------------------------
-
-// List item structure
-wxListItem::wxListItem()
+static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId)
{
- m_mask = 0;
- m_itemId = 0;
- m_col = 0;
- m_state = 0;
- m_stateMask = 0;
- m_image = 0;
- m_data = 0;
+ LV_ITEM it;
+ it.mask = LVIF_PARAM;
+ it.iItem = itemId;
- m_format = wxLIST_FORMAT_CENTRE;
- m_width = 0;
-
- m_attr = NULL;
-}
+ bool success = ListView_GetItem(hwnd, &it) != 0;
+ if (success)
+ return (wxListItemInternalData *) it.lParam;
+ else
+ return NULL;
+};
-void wxListItem::Clear()
+static wxListItemInternalData *wxGetInternalData(wxListCtrl *ctl, long itemId)
{
- m_mask = 0;
- m_itemId = 0;
- m_col = 0;
- m_state = 0;
- m_stateMask = 0;
- m_image = 0;
- m_data = 0;
- m_format = wxLIST_FORMAT_CENTRE;
- m_width = 0;
- m_text = wxEmptyString;
+ return wxGetInternalData((HWND) ctl->GetHWND(), itemId);
+};
- if (m_attr) delete m_attr;
- m_attr = NULL;
-}
+static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId)
+{
+ wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
+ if (data)
+ return data->attr;
+ else
+ return NULL;
+};
-void wxListItem::ClearAttributes()
+static void wxDeleteInternalData(wxListCtrl* ctl, long itemId)
{
- if (m_attr) delete m_attr;
- m_attr = NULL;
+ 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;
+ }
}
static void wxConvertFromMSWListItem(HWND hwndListCtrl,
wxListItem& info,
LV_ITEM& lvItem)
{
- info.m_data = lvItem.lParam;
+ wxListItemInternalData *internaldata =
+ (wxListItemInternalData *) lvItem.lParam;
+
+ if (internaldata)
+ info.m_data = internaldata->lParam;
+
info.m_mask = 0;
info.m_state = 0;
info.m_stateMask = 0;
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;
}
if (info.m_mask & wxLIST_MASK_IMAGE)
lvItem.mask |= LVIF_IMAGE;
- if (info.m_mask & wxLIST_MASK_DATA)
- lvItem.mask |= LVIF_PARAM;
}
-static void wxConvertToMSWListCol(int col, const wxListItem& item,
+static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
LV_COLUMN& lvCol)
{
wxZeroMemory(lvCol);
#endif
}
-// ----------------------------------------------------------------------------
-// List event
-// ----------------------------------------------------------------------------
-
-IMPLEMENT_DYNAMIC_CLASS(wxListEvent, wxNotifyEvent)
-
-wxListEvent::wxListEvent(wxEventType commandType, int id)
- : wxNotifyEvent(commandType, id)
-{
- m_code = 0;
- m_itemIndex = 0;
- m_oldItemIndex = 0;
- m_col = 0;
- m_cancelled = FALSE;
-}
-
#endif // wxUSE_LISTCTRL
projects / wxWidgets.git / blobdiff