// 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
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "listctrl.h"
#pragma implementation "listctrlbase.h"
#endif
#include "wx/msw/private.h"
-#if ((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
- #include "wx/msw/gnuwin32/extra.h"
-#else
- #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
-
-#ifndef LVM_FIRST
- #define LVM_FIRST 0x1000
-#endif
-
-#ifndef HDM_FIRST
- #define HDM_FIRST 0x1200
-#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 <commctrl.h> "properly"
+#include "wx/msw/wrapcctl.h"
// ----------------------------------------------------------------------------
// private functions
// 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
+// 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
}
else
m_buf = NULL;
- }
+ }
private:
wxMB2WXbuf *m_buf;
-#else
+#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
+#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_FOCUSED)
DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT)
+#if wxUSE_EXTENDED_RTTI
+WX_DEFINE_FLAGS( wxListCtrlStyle )
+
+wxBEGIN_FLAGS( wxListCtrlStyle )
+ // new style border flags, we put them first to
+ // use them for streaming out
+ wxFLAGS_MEMBER(wxBORDER_SIMPLE)
+ wxFLAGS_MEMBER(wxBORDER_SUNKEN)
+ wxFLAGS_MEMBER(wxBORDER_DOUBLE)
+ wxFLAGS_MEMBER(wxBORDER_RAISED)
+ wxFLAGS_MEMBER(wxBORDER_STATIC)
+ wxFLAGS_MEMBER(wxBORDER_NONE)
+
+ // old style border flags
+ wxFLAGS_MEMBER(wxSIMPLE_BORDER)
+ wxFLAGS_MEMBER(wxSUNKEN_BORDER)
+ wxFLAGS_MEMBER(wxDOUBLE_BORDER)
+ wxFLAGS_MEMBER(wxRAISED_BORDER)
+ wxFLAGS_MEMBER(wxSTATIC_BORDER)
+ wxFLAGS_MEMBER(wxBORDER)
+
+ // standard window styles
+ wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
+ wxFLAGS_MEMBER(wxCLIP_CHILDREN)
+ wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
+ wxFLAGS_MEMBER(wxWANTS_CHARS)
+ wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
+ wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
+ wxFLAGS_MEMBER(wxVSCROLL)
+ wxFLAGS_MEMBER(wxHSCROLL)
+
+ wxFLAGS_MEMBER(wxLC_LIST)
+ wxFLAGS_MEMBER(wxLC_REPORT)
+ wxFLAGS_MEMBER(wxLC_ICON)
+ wxFLAGS_MEMBER(wxLC_SMALL_ICON)
+ wxFLAGS_MEMBER(wxLC_ALIGN_TOP)
+ wxFLAGS_MEMBER(wxLC_ALIGN_LEFT)
+ wxFLAGS_MEMBER(wxLC_AUTOARRANGE)
+ wxFLAGS_MEMBER(wxLC_USER_TEXT)
+ wxFLAGS_MEMBER(wxLC_EDIT_LABELS)
+ wxFLAGS_MEMBER(wxLC_NO_HEADER)
+ wxFLAGS_MEMBER(wxLC_SINGLE_SEL)
+ wxFLAGS_MEMBER(wxLC_SORT_ASCENDING)
+ wxFLAGS_MEMBER(wxLC_SORT_DESCENDING)
+ wxFLAGS_MEMBER(wxLC_VIRTUAL)
+
+wxEND_FLAGS( wxListCtrlStyle )
+
+IMPLEMENT_DYNAMIC_CLASS_XTI(wxListCtrl, wxControl,"wx/listctrl.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxListCtrl)
+ wxEVENT_PROPERTY( TextUpdated , wxEVT_COMMAND_TEXT_UPDATED , wxCommandEvent )
+
+ wxPROPERTY_FLAGS( WindowStyle , wxListCtrlStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
+wxEND_PROPERTIES_TABLE()
+
+wxBEGIN_HANDLERS_TABLE(wxListCtrl)
+wxEND_HANDLERS_TABLE()
+
+wxCONSTRUCTOR_5( wxListCtrl , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size , long , WindowStyle )
+
+/*
+ TODO : Expose more information of a list's layout etc. via appropriate objects (à la NotebookPageInfo)
+*/
+#else
IMPLEMENT_DYNAMIC_CLASS(wxListCtrl, wxControl)
+#endif
+
IMPLEMENT_DYNAMIC_CLASS(wxListView, wxListCtrl)
IMPLEMENT_DYNAMIC_CLASS(wxListItem, wxObject)
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;
}
const wxPoint& pos,
const wxSize& size,
long style,
- const wxValidator& validator,
+ const wxValidator& wxVALIDATOR_PARAM(validator),
const wxString& name)
{
#if wxUSE_VALIDATORS
DWORD wstyle = WS_VISIBLE | WS_CHILD | WS_TABSTOP |
LVS_SHAREIMAGELISTS | LVS_SHOWSELALWAYS;
- if ( m_windowStyle & wxCLIP_SIBLINGS )
- wstyle |= WS_CLIPSIBLINGS;
-
- if ( wxStyleHasBorder(m_windowStyle) )
- wstyle |= WS_BORDER;
m_baseStyle = wstyle;
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;
+ WXDWORD standardStyle = MSWGetStyle(GetWindowStyle(), & exStyle) ;
long oldStyle = 0; // Dummy
wstyle |= ConvertToMSWStyle(oldStyle, m_windowStyle);
+ wstyle |= standardStyle;
// Create the ListView control.
m_hWnd = (WXHWND)CreateWindowEx(exStyle,
WC_LISTVIEW,
- wxT(""),
+ wxEmptyString,
wstyle,
x, y, w, h,
GetWinHwnd(GetParent()),
return FALSE;
}
+ // explicitly say that we want to use Unicode because otherwise we get ANSI
+ // versions of _some_ messages (notably LVN_GETDISPINFOA) in MSLU build
+#if wxUSE_UNICODE
+ ::SendMessage(GetHwnd(), LVM_SETUNICODEFORMAT, TRUE, 0);
+#endif
+
// for comctl32.dll v 4.70+ we want to have this attribute because it's
// prettier (and also because wxGTK does it like this)
if ( (wstyle & LVS_REPORT) && wxTheApp->GetComCtl32Version() >= 470 )
}
}
-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;
+ }
}
+ // 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;
}
LV_ITEM item;
wxConvertToMSWListItem(this, info, 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))
+ {
+ // get internal item data
+ // perhaps a cache here ?
+ wxListItemInternalData *data = wxGetInternalData(this, info.m_itemId);
+
+ 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 )
// 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
info.m_itemId = item;
if (!GetItem(info))
- return wxString("");
+ return wxEmptyString;
return info.m_text;
}
return SetItem(info);
}
+wxRect wxListCtrl::GetViewRect() const
+{
+ 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);
+
+ return rect;
+}
+
// Gets the item rectangle
bool wxListCtrl::GetItemRect(long item, wxRect& rect, int code) const
{
codeWin = LVIR_BOUNDS;
}
-#ifdef __WXWINE__
- bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin ) != 0;
-#else
bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0;
-#endif
rect.x = rectWin.left;
rect.y = rectWin.top;
// Gets the number of items in the list control
int wxListCtrl::GetItemCount() const
{
- return ListView_GetItemCount(GetHwnd());
+ return m_count;
+}
+
+wxSize wxListCtrl::GetItemSpacing() const
+{
+ 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.
int wxListCtrl::GetItemSpacing(bool isSmall) const
{
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
{
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() )
{
// Deletes all items
bool wxListCtrl::DeleteAllItems()
{
+ FreeAllInternalData();
return ListView_DeleteAllItems(GetHwnd()) != 0;
}
{
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);
+ // internal stucture that manages data
+ wxListItemInternalData *data = new wxListItemInternalData();
+ item.lParam = (LPARAM) data;
- if (attr == NULL)
+ if (info.m_mask & wxLIST_MASK_DATA)
+ data->lParam = info.m_data;
- m_attrs.Put(item.iItem, (wxObject *)new wxListItemAttr(*info.GetAttributes()));
+ // check whether it has any custom attributes
+ if ( info.HasAttributes() )
+ {
+ // take copy of attributes
+ data->attr = new wxListItemAttr(*info.GetAttributes());
+ }
+ };
- else *attr = *info.GetAttributes();
+ long rv = ListView_InsertItem(GetHwnd(), & item);
- m_hasAnyAttr = TRUE;
- }
+ m_count++;
+ wxASSERT_MSG( m_count == ListView_GetItemCount(GetHwnd()),
+ wxT("m_count should match ListView_GetItemCount"));
- return (long) ListView_InsertItem(GetHwnd(), & item);
+ return rv;
}
long wxListCtrl::InsertItem(long index, const wxString& label)
lvCol.cx = 80;
}
- // when we insert a column which can contain an image, we must specify this
- // flag right now as doing it later in SetColumn() has no effect
- //
- // we use LVCFMT_BITMAP_ON_RIGHT by default because without it there is no
- // way to dynamically set/clear the bitmap as the column without a bitmap
- // on the left looks ugly (there is a hole)
- //
- // unfortunately with my version of comctl32.dll (5.80), the left column
- // image is always on the left and it seems that it's a "feature" - I
- // didn't find any way to work around it in any case
- if ( lvCol.mask & LVCF_IMAGE )
- {
- lvCol.mask |= LVCF_FMT;
- lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT;
- }
-
- bool success = ListView_InsertColumn(GetHwnd(), col, &lvCol) != -1;
- if ( success )
+ long n = ListView_InsertColumn(GetHwnd(), col, &lvCol);
+ if ( n != -1 )
{
m_colCount++;
}
- else
+ else // failed to insert?
{
wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
lvCol.pszText);
}
- return success;
+ return n;
}
long wxListCtrl::InsertColumn(long col,
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;
-
- return gs_sortFunction(gs_sortCtrl->GetItemData(n1),
- gs_sortCtrl->GetItemData(n2),
- gs_sortData);
-}
+ wxListCtrlCompare user_fn;
+ long data;
+};
-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
// -----------------
// 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);
}
// 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;
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 ||
+ if ( ((LV_ITEM)item).pszText == NULL ||
((LV_ITEM)item).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;
+ }
return FALSE;
+ }
event.m_itemIndex = event.m_item.m_itemId;
}
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 ||
+ if ( ((LV_ITEM)item).pszText == NULL ||
((LV_ITEM)item).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;
+ }
return FALSE;
+ }
event.m_itemIndex = event.m_item.m_itemId;
}
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_count == 0)
+ // this should be prevented by the post-processing code below,
+ // but "just in case"
+ return FALSE;
- if ( m_hasAnyAttr )
- {
- delete (wxListItemAttr *)m_attrs.Delete(nmLV->iItem);
- }
+ 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:
// we translate this catch all message into more interesting
// (and more easy to process) wxWindows events
- // first of all, we deal with the state change events only
- if ( nmLV->uChanged & LVIF_STATE )
+ // 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 = nmLV->iItem;
+ event.m_itemIndex = iItem;
}
if ( (stNew & LVIS_SELECTED) != (stOld & LVIS_SELECTED) )
{
// then need to set m_itemIndex as it wasn't done
// above
- event.m_itemIndex = nmLV->iItem;
+ event.m_itemIndex = iItem;
}
eventType = stNew & LVIS_SELECTED
// 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:
}
break;
-#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \
- && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
+#ifdef NM_CUSTOMDRAW
case NM_CUSTOMDRAW:
*result = OnCustomDraw(lParam);
eventType = wxEVT_COMMAND_LIST_CACHE_HINT;
- // we get some really stupid cache hints like ones for items in
- // range 0..0 for an empty control or, after deleting an item,
- // for items in invalid range - filter this garbage out
- if ( cacheHint->iFrom < cacheHint->iTo )
- {
- event.m_oldItemIndex = cacheHint->iFrom;
-
- long iMax = GetItemCount();
- event.m_itemIndex = cacheHint->iTo < iMax ? cacheHint->iTo
- : iMax - 1;
- }
- else
- {
+ // 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;
wxStrncpy(lvi.pszText, text, lvi.cchTextMax);
}
-#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \
- && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 1 ) )
+ // see comment at the end of wxListCtrl::GetColumn()
+#ifdef NM_CUSTOMDRAW
if ( lvi.mask & LVIF_IMAGE )
{
lvi.iImage = OnGetItemImage(item);
}
-#endif
+#endif // NM_CUSTOMDRAW
// a little dose of healthy paranoia: as we never use
// LVM_SETCALLBACKMASK we're not supposed to get these ones
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_ENDLABELEDITA:
// 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
+// see comment at the end of wxListCtrl::GetColumn()
+#ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
{
wxListItemAttr *attr =
IsVirtual() ? OnGetItemAttr(item)
- : (wxListItemAttr *)m_attrs.Get(item);
+ : wxGetInternalDataAttr(this, item);
if ( !attr )
{
{
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;
}
{
wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
- if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count, 0) )
+ if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT, (WPARAM)count, LVSICF_NOSCROLL) )
{
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)
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;
-
- m_format = wxLIST_FORMAT_CENTRE;
- m_width = 0;
+ LV_ITEM it;
+ it.mask = LVIF_PARAM;
+ it.iItem = itemId;
- 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 WXUNUSED(col), const wxListItem& item,
lvCol.cx = item.m_width;
}
-#if defined(_WIN32_IE) && _WIN32_IE >= 0x300 \
- && !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 1 ) )
+ // see comment at the end of wxListCtrl::GetColumn()
+#ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
if ( item.m_mask & wxLIST_MASK_IMAGE )
{
if ( wxTheApp->GetComCtl32Version() >= 470 )
{
- lvCol.mask |= LVCF_IMAGE;
+ lvCol.mask |= LVCF_IMAGE | LVCF_FMT;
+
+ // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right
+ // seem to be generally nicer than on the left and the generic
+ // version only draws them on the right (we don't have a flag to
+ // specify the image location anyhow)
+ //
+ // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
+ // make any difference in my tests -- but maybe we should?
+ lvCol.fmt |= LVCFMT_BITMAP_ON_RIGHT | LVCFMT_IMAGE;
+
lvCol.iImage = item.m_image;
}
//else: it doesn't support item images anyhow
}
-#endif
+#endif // _WIN32_IE >= 0x0300
}
#endif // wxUSE_LISTCTRL
+
projects / wxWidgets.git / blobdiff