// 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
#include "wx/intl.h"
#include "wx/log.h"
#include "wx/settings.h"
+ #include "wx/dcclient.h"
+ #include "wx/textctrl.h"
#endif
-#include "wx/textctrl.h"
#include "wx/imaglist.h"
#include "wx/listctrl.h"
-#include "wx/dcclient.h"
#include "wx/msw/private.h"
/* const */ LV_ITEM& lvItem);
// convert our wxListItem to LV_COLUMN
-static void wxConvertToMSWListCol(int col, const wxListItem& item,
+static void wxConvertToMSWListCol(HWND hwndList,
+ int col,
+ const wxListItem& item,
LV_COLUMN& lvCol);
// ----------------------------------------------------------------------------
// Get the internal data structure
static wxListItemInternalData *wxGetInternalData(HWND hwnd, long itemId);
static wxListItemInternalData *wxGetInternalData(const wxListCtrl *ctl, long itemId);
-static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId);
+static wxListItemAttr *wxGetInternalDataAttr(const wxListCtrl *ctl, long itemId);
static void wxDeleteInternalData(wxListCtrl* ctl, long itemId);
bool wxListCtrl::SetColumn(int col, const wxListItem& item)
{
LV_COLUMN lvCol;
- wxConvertToMSWListCol(col, item, lvCol);
+ wxConvertToMSWListCol(GetHwnd(), col, item, lvCol);
return ListView_SetColumn(GetHwnd(), col, &lvCol) != 0;
}
// Sets information about the item
bool wxListCtrl::SetItem(wxListItem& info)
{
+ 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);
{
// get internal item data
// perhaps a cache here ?
- wxListItemInternalData *data = wxGetInternalData(this, info.m_itemId);
+ wxListItemInternalData *data = wxGetInternalData(this, id);
if (! data)
{
// Sets the item image
bool wxListCtrl::SetItemImage(long item, int image, int WXUNUSED(selImage))
+{
+ return SetItemColumnImage(item, 0, image);
+}
+
+// Sets the item image
+bool wxListCtrl::SetItemColumnImage(long item, long column, int image)
{
wxListItem info;
info.m_mask = wxLIST_MASK_IMAGE;
info.m_image = image;
info.m_itemId = item;
+ info.m_col = column;
return SetItem(info);
}
// Gets the item 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;
codeWin = LVIR_LABEL;
else
{
- wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
-
+ wxFAIL_MSG( _T("incorrect code in GetItemRect() / GetSubItemRect()") );
codeWin = LVIR_BOUNDS;
}
- bool success = ListView_GetItemRect(GetHwnd(), (int) item, &rectWin, codeWin) != 0;
+ 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;
+ }
rect.x = rectWin.left;
rect.y = rectWin.top;
return success;
}
+
+
+
// Gets the item position
bool wxListCtrl::GetItemPosition(long item, wxPoint& pos) const
{
return wxSize(LOWORD(spacing), HIWORD(spacing));
}
+#if WXWIN_COMPATIBILITY_2_6
+
int wxListCtrl::GetItemSpacing(bool isSmall) const
{
return ListView_GetItemSpacing(GetHwnd(), (BOOL) isSmall);
}
+#endif // WXWIN_COMPATIBILITY_2_6
+
void wxListCtrl::SetItemTextColour( long item, const wxColour &col )
{
wxListItem info;
}
// End label editing, optionally cancelling the edit
-bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel))
+bool wxListCtrl::EndEditLabel(bool cancel)
{
- wxFAIL_MSG( _T("not implemented") );
-
- return false;
+ // m_textCtrl is not always ready, ie. in EVT_LIST_BEGIN_LABEL_EDIT
+ HWND hwnd = ListView_GetEditControl(GetHwnd());
+ bool b = (hwnd != NULL);
+ if (b)
+ {
+ 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;
+ }
+ ::DestroyWindow(hwnd);
+ }
+ return b;
}
// Ensures this item is visible
// Determines which item (if any) is at the specified point,
// giving details in 'flags' (see wxLIST_HITTEST_... flags above)
-long wxListCtrl::HitTest(const wxPoint& point, int& flags)
+long
+wxListCtrl::HitTest(const wxPoint& point, int& flags, long *ptrSubItem) const
{
LV_HITTESTINFO hitTestInfo;
hitTestInfo.pt.x = (int) point.x;
hitTestInfo.pt.y = (int) point.y;
- ListView_HitTest(GetHwnd(), & hitTestInfo);
+ long item;
+#ifdef LVM_SUBITEMHITTEST
+ if ( ptrSubItem && wxApp::GetComCtl32Version() >= 470 )
+ {
+ item = ListView_SubItemHitTest(GetHwnd(), &hitTestInfo);
+ *ptrSubItem = hitTestInfo.iSubItem;
+ }
+ else
+#endif // LVM_SUBITEMHITTEST
+ {
+ item = ListView_HitTest(GetHwnd(), &hitTestInfo);
+ }
flags = 0;
flags |= wxLIST_HITTEST_ONITEMSTATEICON;
}
- return (long) hitTestInfo.iItem;
+ return item;
}
+
// Inserts an item, returning the index of the new item if successful,
// -1 otherwise.
long wxListCtrl::InsertItem(const wxListItem& info)
long wxListCtrl::InsertColumn(long col, const wxListItem& item)
{
LV_COLUMN lvCol;
- wxConvertToMSWListCol(col, item, lvCol);
+ wxConvertToMSWListCol(GetHwnd(), col, item, lvCol);
if ( !(lvCol.mask & LVCF_WIDTH) )
{
case NM_CUSTOMDRAW:
*result = OnCustomDraw(lParam);
- return true;
+ return *result != CDRF_DODEFAULT;
#endif // _WIN32_IE >= 0x300
case LVN_ODCACHEHINT:
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 void HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
+{
+ NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
+
+ HDC hdc = nmcd.hdc;
+ HWND hwndList = nmcd.hdr.hwndFrom;
+ 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, pLVCD->iSubItem, LVIR_BOUNDS, &rc);
+ if ( !pLVCD->iSubItem )
+ {
+ // 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 = pLVCD->iSubItem;
+ 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);
+
+ // TODO: support for centred/right aligned columns
+ ::DrawText(hdc, text, -1, &rc,
+#ifndef __WXWINCE__
+ DT_WORD_ELLIPSIS |
+#endif // __WXWINCE__
+ DT_NOPREFIX | DT_SINGLELINE | DT_VCENTER);
+}
+
+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);
+ }
+
+ HandleItemPostpaint(nmcd);
+}
+
+static WXLPARAM HandleItemPrepaint(wxListCtrl *listctrl,
+ LPNMLVCUSTOMDRAW pLVCD,
+ wxListItemAttr *attr)
+{
+ if ( !attr )
+ {
+ // nothing to do for this item
+ return CDRF_DODEFAULT;
+ }
+
+
+ // set the colours to use for text drawing
+ pLVCD->clrText = attr->HasTextColour()
+ ? wxColourToRGB(attr->GetTextColour())
+ : wxColourToRGB(listctrl->GetTextColour());
+ pLVCD->clrTextBk = attr->HasBackgroundColour()
+ ? wxColourToRGB(attr->GetBackgroundColour())
+ : wxColourToRGB(listctrl->GetBackgroundColour());
+
+ // select the font if non default one is specified
+ if ( attr->HasFont() )
+ {
+ wxFont font = attr->GetFont();
+ if ( font.GetEncoding() != wxFONTENCODING_SYSTEM )
+ {
+ // the standard control ignores the font encoding/charset, at least
+ // with recent comctl32.dll versions (5 and 6, it uses to work with
+ // 4.something) so we have to draw the item entirely ourselves in
+ // this case
+ HandleItemPaint(pLVCD, GetHfontOf(font));
+ return CDRF_SKIPDEFAULT;
+ }
+
+ ::SelectObject(pLVCD->nmcd.hdc, GetHfontOf(font));
+
+ return CDRF_NEWFONT;
+ }
+
+ return CDRF_DODEFAULT;
+}
+
WXLPARAM wxListCtrl::OnCustomDraw(WXLPARAM lParam)
{
- LPNMLVCUSTOMDRAW lplvcd = (LPNMLVCUSTOMDRAW)lParam;
- NMCUSTOMDRAW& nmcd = lplvcd->nmcd;
+ LPNMLVCUSTOMDRAW pLVCD = (LPNMLVCUSTOMDRAW)lParam;
+ NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
switch ( nmcd.dwDrawStage )
{
case CDDS_PREPAINT:
//
// for virtual controls, always suppose that we have attributes as
// there is no way to check for this
- return IsVirtual() || m_hasAnyAttr ? CDRF_NOTIFYITEMDRAW
- : CDRF_DODEFAULT;
+ if ( IsVirtual() || m_hasAnyAttr )
+ return CDRF_NOTIFYITEMDRAW;
+ break;
case CDDS_ITEMPREPAINT:
- {
- size_t item = (size_t)nmcd.dwItemSpec;
- if ( item >= (size_t)GetItemCount() )
- {
- // we get this message with item == 0 for an empty control,
- // we must ignore it as calling OnGetItemAttr() would be
- // wrong
- return CDRF_DODEFAULT;
- }
-
- wxListItemAttr *attr =
- IsVirtual() ? OnGetItemAttr(item)
- : wxGetInternalDataAttr(this, item);
-
- if ( !attr )
- {
- // nothing to do for this item
- return CDRF_DODEFAULT;
- }
-
- HFONT hFont;
- wxColour colText, colBack;
- if ( attr->HasFont() )
- {
- wxFont font = attr->GetFont();
- hFont = (HFONT)font.GetResourceHandle();
- }
- else
- {
- hFont = 0;
- }
-
- if ( attr->HasTextColour() )
- {
- colText = attr->GetTextColour();
- }
- else
- {
- colText = GetTextColour();
- }
-
- if ( attr->HasBackgroundColour() )
- {
- colBack = attr->GetBackgroundColour();
- }
- else
- {
- colBack = GetBackgroundColour();
- }
-
- lplvcd->clrText = wxColourToRGB(colText);
- lplvcd->clrTextBk = wxColourToRGB(colBack);
+ const int item = nmcd.dwItemSpec;
- // note that if we wanted to set colours for
- // individual columns (subitems), we would have
- // returned CDRF_NOTIFYSUBITEMREDRAW from here
- if ( hFont )
- {
- ::SelectObject(nmcd.hdc, hFont);
-
- return CDRF_NEWFONT;
- }
- }
- // fall through to return CDRF_DODEFAULT
+ // we get this message with item == 0 for an empty control, we
+ // must ignore it as calling OnGetItemAttr() would be wrong
+ if ( item < 0 || item >= GetItemCount() )
+ break;
- default:
- return CDRF_DODEFAULT;
+ 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);
- bool drawHRules = HasFlag(wxLC_HRULES);
- bool drawVRules = HasFlag(wxLC_VRULES);
-
- if (!InReportView() || !drawHRules && !drawVRules)
- return;
-
wxPen pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT), 1, wxSOLID);
dc.SetPen(pen);
dc.SetBrush(* wxTRANSPARENT_BRUSH);
WXLRESULT
wxListCtrl::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
{
-#ifdef WM_PRINT
- if ( nMsg == WM_PRINT )
+ switch ( nMsg )
{
- // 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);
- }
+#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);
}
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") );
return wxGetInternalData(GetHwndOf(ctl), itemId);
}
-static wxListItemAttr *wxGetInternalDataAttr(wxListCtrl *ctl, long itemId)
+static
+wxListItemAttr *wxGetInternalDataAttr(const wxListCtrl *ctl, long itemId)
{
wxListItemInternalData *data = wxGetInternalData(ctl, itemId);
lvItem.mask |= LVIF_IMAGE;
}
-static void wxConvertToMSWListCol(int WXUNUSED(col), const wxListItem& item,
+static void wxConvertToMSWListCol(HWND hwndList,
+ int col,
+ const wxListItem& item,
LV_COLUMN& lvCol)
{
wxZeroMemory(lvCol);
#ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
if ( item.m_mask & wxLIST_MASK_IMAGE )
{
- if ( wxTheApp->GetComCtl32Version() >= 470 )
+ if ( wxApp::GetComCtl32Version() >= 470 )
{
- lvCol.mask |= LVCF_IMAGE | LVCF_FMT;
+ lvCol.mask |= LVCF_IMAGE;
- // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right
+ // we use LVCFMT_BITMAP_ON_RIGHT because the images on the right
// seem to be generally nicer than on the left and the generic
// version only draws them on the right (we don't have a flag to
// specify the image location anyhow)
// we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
// make any difference in my tests -- but maybe we should?
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;
}