// 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
#if wxUSE_LISTCTRL
+#include "wx/listctrl.h"
+
#ifndef WX_PRECOMP
+ #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
#include "wx/app.h"
#include "wx/intl.h"
#include "wx/log.h"
#include "wx/settings.h"
+ #include "wx/dcclient.h"
+ #include "wx/textctrl.h"
#endif
-#include "wx/textctrl.h"
#include "wx/imaglist.h"
-#include "wx/listctrl.h"
-#include "wx/dcclient.h"
#include "wx/msw/private.h"
#endif
#endif
-// include <commctrl.h> "properly"
-#include "wx/msw/wrapcctl.h"
-
// Currently gcc and watcom don't define NMLVFINDITEM, and DMC only defines
// it by its old name NM_FINDTIEM.
//
{
if (attr)
delete attr;
- };
+ }
DECLARE_NO_COPY_CLASS(wxListItemInternalData)
};
static void wxDeleteInternalData(wxListCtrl* ctl, long itemId);
-// ----------------------------------------------------------------------------
-// events
-// ----------------------------------------------------------------------------
-
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS)
-#if WXWIN_COMPATIBILITY_2_4
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO)
-#endif
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT)
-
#if wxUSE_EXTENDED_RTTI
WX_DEFINE_FLAGS( wxListCtrlStyle )
// 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);
}
}
// Sets the item data
-bool wxListCtrl::SetItemData(long item, long data)
+bool wxListCtrl::SetItemPtrData(long item, wxUIntPtr data)
{
wxListItem 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;
{
// 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;
+ if ( !hwnd )
+ return false;
+
+ if ( cancel )
+ ::SetWindowText(hwnd, wxEmptyString); // dubious but better than nothing
+
+ // we shouldn't destroy the control ourselves according to MSDN, which
+ // proposes WM_CANCELMODE to do this, but it doesn't seem to work
+ //
+ // posting WM_CLOSE to it does seem to work without any side effects
+ ::PostMessage(hwnd, WM_CLOSE, 0, 0);
+
+ return true;
}
// Ensures this item is visible
// 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)
// message processing
// ----------------------------------------------------------------------------
+bool wxListCtrl::MSWShouldPreProcessMessage(WXMSG* msg)
+{
+ if ( msg->message == WM_KEYDOWN )
+ {
+ if ( msg->wParam == VK_RETURN )
+ {
+ // We need VK_RETURN to generate wxEVT_COMMAND_LIST_ITEM_ACTIVATED,
+ // but only if none of the modifiers is down. We'll let normal
+ // accelerators handle those.
+ if ( !wxIsCtrlDown() && !wxIsCtrlDown() &&
+ !((HIWORD(msg->lParam) & KF_ALTDOWN) == KF_ALTDOWN))
+ return false;
+ }
+ }
+
+ return wxControl::MSWShouldPreProcessMessage(msg);
+}
+
bool wxListCtrl::MSWCommand(WXUINT cmd, WXWORD id)
{
if (cmd == EN_UPDATE)
return false;
}
+// utility used by wxListCtrl::MSWOnNotify and by wxDataViewHeaderWindowMSW::MSWOnNotify
+int WXDLLIMPEXP_CORE wxMSWGetColumnClicked(NMHDR *nmhdr, POINT *ptClick)
+{
+ wxASSERT(nmhdr && ptClick);
+
+ // find the column clicked: we have to search for it
+ // ourselves as the notification message doesn't provide
+ // this info
+
+ // where did the click occur?
+#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
+ if (nmhdr->code == GN_CONTEXTMENU)
+ {
+ *ptClick = ((NMRGINFO*)nmhdr)->ptAction;
+ }
+ else
+#endif //__WXWINCE__
+ if ( !::GetCursorPos(ptClick) )
+ {
+ wxLogLastError(_T("GetCursorPos"));
+ }
+
+ if ( !::ScreenToClient(nmhdr->hwndFrom, ptClick) )
+ {
+ wxLogLastError(_T("ScreenToClient(header)"));
+ }
+
+ int colCount = Header_GetItemCount(nmhdr->hwndFrom);
+
+ RECT rect;
+ for ( int col = 0; col < colCount; col++ )
+ {
+ if ( Header_GetItemRect(nmhdr->hwndFrom, col, &rect) )
+ {
+ if ( ::PtInRect(&rect, *ptClick) )
+ {
+ return col;
+ }
+ }
+ }
+
+ return wxNOT_FOUND;
+}
+
bool wxListCtrl::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result)
{
#endif //__WXWINCE__
case NM_RCLICK:
{
- eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
- event.m_col = -1;
-
- // find the column clicked: we have to search for it
- // ourselves as the notification message doesn't provide
- // this info
-
- // where did the click occur?
POINT ptClick;
-#if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
- if(nmhdr->code == GN_CONTEXTMENU) {
- ptClick = ((NMRGINFO*)nmhdr)->ptAction;
- } else
-#endif //__WXWINCE__
- if ( !::GetCursorPos(&ptClick) )
- {
- wxLogLastError(_T("GetCursorPos"));
- }
-
- if ( !::ScreenToClient(GetHwnd(), &ptClick) )
- {
- wxLogLastError(_T("ScreenToClient(listctrl header)"));
- }
+ eventType = wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
+ event.m_col = wxMSWGetColumnClicked(nmhdr, &ptClick);
event.m_pointDrag.x = ptClick.x;
event.m_pointDrag.y = ptClick.y;
-
- int colCount = Header_GetItemCount(hwndHdr);
-
- RECT rect;
- for ( int col = 0; col < colCount; col++ )
- {
- if ( Header_GetItemRect(hwndHdr, col, &rect) )
- {
- if ( ::PtInRect(&rect, ptClick) )
- {
- event.m_col = col;
- break;
- }
- }
- }
}
break;
// parameters
//
// I have no idea what is the real cause of the bug (which is,
- // just to make things interesting, is impossible to reproduce
+ // just to make things interesting, impossible to reproduce
// reliably) but ignoring all these messages does fix it and
// doesn't seem to have any negative consequences
return true;
}
else
#endif // defined(HDN_BEGINTRACKA)
- if ( nmhdr->hwndFrom == GetHwnd() )
+ if ( nmhdr->hwndFrom == GetHwnd() )
{
// almost all messages use NM_LISTVIEW
NM_LISTVIEW *nmLV = (NM_LISTVIEW *)nmhdr;
wxDeleteInternalData(this, iItem);
break;
-#if WXWIN_COMPATIBILITY_2_4
- case LVN_SETDISPINFO:
- {
- eventType = wxEVT_COMMAND_LIST_SET_INFO;
- LV_DISPINFO *info = (LV_DISPINFO *)lParam;
- wxConvertFromMSWListItem(GetHwnd(), event.m_item, info->item);
- }
- break;
-#endif
-
case LVN_INSERTITEM:
eventType = wxEVT_COMMAND_LIST_INSERT_ITEM;
event.m_itemIndex = iItem;
}
#endif // NM_CUSTOMDRAW
- // a little dose of healthy paranoia: as we never use
- // LVM_SETCALLBACKMASK we're not supposed to get these ones
- wxASSERT_MSG( !(lvi.mask & LVIF_STATE),
- _T("we don't support state callbacks yet!") );
+ // even though we never use LVM_SETCALLBACKMASK, we still
+ // can get messages with LVIF_STATE in lvi.mask under Vista
+ if ( lvi.mask & LVIF_STATE )
+ {
+ // we don't have anything to return from here...
+ lvi.stateMask = 0;
+ }
return true;
}
return rc;
}
-static void HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
+static bool HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD, HFONT hfont)
{
NMCUSTOMDRAW& nmcd = pLVCD->nmcd;
HDC hdc = nmcd.hdc;
HWND hwndList = nmcd.hdr.hwndFrom;
+ const int col = pLVCD->iSubItem;
const DWORD item = nmcd.dwItemSpec;
-
// the font must be valid, otherwise we wouldn't be painting the item at all
SelectInHDC selFont(hdc, hfont);
// get the rectangle to paint
RECT rc;
- ListView_GetSubItemRect(hwndList, item, pLVCD->iSubItem, LVIR_BOUNDS, &rc);
- if ( !pLVCD->iSubItem )
+ ListView_GetSubItemRect(hwndList, item, col, LVIR_BOUNDS, &rc);
+ if ( !col )
{
// broken ListView_GetSubItemRect() returns the entire item rect for
// 0th subitem while we really need just the part for this column
wxZeroMemory(it);
it.mask = LVIF_TEXT | LVIF_IMAGE;
it.iItem = item;
- it.iSubItem = pLVCD->iSubItem;
+ it.iSubItem = col;
it.pszText = text;
it.cchTextMax = WXSIZEOF(text);
ListView_GetItem(hwndList, &it);
- if ( it.iImage != -1 )
+ HIMAGELIST himl = ListView_GetImageList(hwndList, LVSIL_SMALL);
+ if ( himl && ImageList_GetImageCount(himl) )
{
- HIMAGELIST himl = ListView_GetImageList(hwndList, LVSIL_SMALL);
-
- ImageList_Draw(himl, it.iImage, hdc, rc.left, rc.top,
- nmcd.uItemState & CDIS_SELECTED ? ILD_SELECTED
- : ILD_TRANSPARENT);
+ if ( it.iImage != -1 )
+ {
+ ImageList_Draw(himl, it.iImage, hdc, rc.left, rc.top,
+ nmcd.uItemState & CDIS_SELECTED ? ILD_SELECTED
+ : ILD_TRANSPARENT);
+ }
- int wImage, hImage;
- ImageList_GetIconSize(himl, &wImage, &hImage);
+ // 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;
+ rc.left += wImage + 2;
+ }
}
::SetBkMode(hdc, TRANSPARENT);
- // TODO: support for centred/right aligned columns
- ::DrawText(hdc, text, -1, &rc,
- DT_WORD_ELLIPSIS | DT_NOPREFIX | DT_SINGLELINE | DT_VCENTER);
+ UINT fmt = DT_SINGLELINE |
+#ifndef __WXWINCE__
+ DT_WORD_ELLIPSIS |
+#endif // __WXWINCE__
+ DT_NOPREFIX |
+ DT_VCENTER;
+
+ LV_COLUMN lvCol;
+ wxZeroMemory(lvCol);
+ lvCol.mask = LVCF_FMT;
+ if ( ListView_GetColumn(hwndList, col, &lvCol) )
+ {
+ switch ( lvCol.fmt & LVCFMT_JUSTIFYMASK )
+ {
+ case LVCFMT_LEFT:
+ fmt |= DT_LEFT;
+ break;
+
+ case LVCFMT_CENTER:
+ fmt |= DT_CENTER;
+ break;
+
+ case LVCFMT_RIGHT:
+ fmt |= DT_RIGHT;
+ break;
+ }
+ }
+ //else: failed to get alignment, assume it's DT_LEFT (default)
+
+ DrawText(hdc, text, -1, &rc, fmt);
+
+ return true;
}
static void HandleItemPostpaint(NMCUSTOMDRAW nmcd)
{
NMCUSTOMDRAW& nmcd = pLVCD->nmcd; // just a shortcut
- HWND hwndList = nmcd.hdr.hwndFrom;
+ 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
break;
}
- if ( (DWORD)i == nmcd.dwItemSpec )
+ 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;
// set the colours to use for text drawing
- pLVCD->clrText = wxColourToRGB(attr->HasTextColour()
- ? attr->GetTextColour()
- : listctrl->GetTextColour());
- pLVCD->clrTextBk = wxColourToRGB(attr->HasBackgroundColour()
- ? attr->GetBackgroundColour()
- : listctrl->GetBackgroundColour());
+ 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() )
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);
}
else
{
// pszText is not const, hence the cast
- lvItem.pszText = (wxChar *)info.m_text.c_str();
+ lvItem.pszText = (wxChar *)info.m_text.wx_str();
if ( lvItem.pszText )
lvItem.cchTextMax = info.m_text.length();
else
if ( item.m_mask & wxLIST_MASK_TEXT )
{
lvCol.mask |= LVCF_TEXT;
- lvCol.pszText = (wxChar *)item.m_text.c_str(); // cast is safe
+ lvCol.pszText = (wxChar *)item.m_text.wx_str(); // cast is safe
}
if ( item.m_mask & wxLIST_MASK_FORMAT )
#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;