1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/listctrl.cpp
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
33 #include "wx/settings.h"
36 #include "wx/textctrl.h"
37 #include "wx/imaglist.h"
38 #include "wx/listctrl.h"
39 #include "wx/dcclient.h"
41 #include "wx/msw/private.h"
43 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__)
51 // include <commctrl.h> "properly"
52 #include "wx/msw/wrapcctl.h"
54 // Currently gcc and watcom don't define NMLVFINDITEM, and DMC only defines
55 // it by its old name NM_FINDTIEM.
57 #if defined(__VISUALC__) || defined(__BORLANDC__) || defined(NMLVFINDITEM)
58 #define HAVE_NMLVFINDITEM 1
59 #elif defined(__DMC__) || defined(NM_FINDITEM)
60 #define HAVE_NMLVFINDITEM 1
61 #define NMLVFINDITEM NM_FINDITEM
64 // ----------------------------------------------------------------------------
66 // ----------------------------------------------------------------------------
68 // convert our state and mask flags to LV_ITEM constants
69 static void wxConvertToMSWFlags(long state
, long mask
, LV_ITEM
& lvItem
);
71 // convert wxListItem to LV_ITEM
72 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
73 const wxListItem
& info
, LV_ITEM
& lvItem
);
75 // convert LV_ITEM to wxListItem
76 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
78 /* const */ LV_ITEM
& lvItem
);
80 // convert our wxListItem to LV_COLUMN
81 static void wxConvertToMSWListCol(int col
, const wxListItem
& item
,
84 // ----------------------------------------------------------------------------
85 // private helper classes
86 // ----------------------------------------------------------------------------
88 // We have to handle both fooW and fooA notifications in several cases
89 // because of broken comctl32.dll and/or unicows.dll. This class is used to
90 // convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or
91 // LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed
92 // by wxConvertToMSWListItem().
94 #define LV_ITEM_NATIVE LV_ITEMW
95 #define LV_ITEM_OTHER LV_ITEMA
97 #define LV_CONV_TO_WX cMB2WX
98 #define LV_CONV_BUF wxMB2WXbuf
100 #define LV_ITEM_NATIVE LV_ITEMA
101 #define LV_ITEM_OTHER LV_ITEMW
103 #define LV_CONV_TO_WX cWC2WX
104 #define LV_CONV_BUF wxWC2WXbuf
105 #endif // Unicode/ANSI
110 // default ctor, use Init() later
111 wxLV_ITEM() { m_buf
= NULL
; m_pItem
= NULL
; }
113 // init without conversion
114 void Init(LV_ITEM_NATIVE
& item
)
116 wxASSERT_MSG( !m_pItem
, _T("Init() called twice?") );
121 // init with conversion
122 void Init(const LV_ITEM_OTHER
& item
)
124 // avoid unnecessary dynamic memory allocation, jjust make m_pItem
125 // point to our own m_item
127 // memcpy() can't work if the struct sizes are different
128 wxCOMPILE_TIME_ASSERT( sizeof(LV_ITEM_OTHER
) == sizeof(LV_ITEM_NATIVE
),
129 CodeCantWorkIfDiffSizes
);
131 memcpy(&m_item
, &item
, sizeof(LV_ITEM_NATIVE
));
133 // convert text from ANSI to Unicod if necessary
134 if ( (item
.mask
& LVIF_TEXT
) && item
.pszText
)
136 m_buf
= new LV_CONV_BUF(wxConvLocal
.LV_CONV_TO_WX(item
.pszText
));
137 m_item
.pszText
= (wxChar
*)m_buf
->data();
141 // ctor without conversion
142 wxLV_ITEM(LV_ITEM_NATIVE
& item
) : m_buf(NULL
), m_pItem(&item
) { }
144 // ctor with conversion
145 wxLV_ITEM(LV_ITEM_OTHER
& item
) : m_buf(NULL
)
150 ~wxLV_ITEM() { delete m_buf
; }
152 // conversion to the real LV_ITEM
153 operator LV_ITEM_NATIVE
&() const { return *m_pItem
; }
158 LV_ITEM_NATIVE
*m_pItem
;
159 LV_ITEM_NATIVE m_item
;
161 DECLARE_NO_COPY_CLASS(wxLV_ITEM
)
164 ///////////////////////////////////////////////////////
166 // The MSW version had problems with SetTextColour() et
167 // al as the wxListItemAttr's were stored keyed on the
168 // item index. If a item was inserted anywhere but the end
169 // of the list the the text attributes (colour etc) for
170 // the following items were out of sync.
173 // Under MSW the only way to associate data with a List
174 // item independent of its position in the list is to
175 // store a pointer to it in its lParam attribute. However
176 // user programs are already using this (via the
177 // SetItemData() GetItemData() calls).
179 // However what we can do is store a pointer to a
180 // structure which contains the attributes we want *and*
181 // a lParam for the users data, e.g.
183 // class wxListItemInternalData
186 // wxListItemAttr *attr;
187 // long lParam; // user data
190 // To conserve memory, a wxListItemInternalData is
191 // only allocated for a LV_ITEM if text attributes or
192 // user data(lparam) are being set.
195 // class wxListItemInternalData
196 class wxListItemInternalData
199 wxListItemAttr
*attr
;
200 LPARAM lParam
; // user data
202 wxListItemInternalData() : attr(NULL
), lParam(0) {}
203 ~wxListItemInternalData()
209 DECLARE_NO_COPY_CLASS(wxListItemInternalData
)
212 // Get the internal data structure
213 static wxListItemInternalData
*wxGetInternalData(HWND hwnd
, long itemId
);
214 static wxListItemInternalData
*wxGetInternalData(const wxListCtrl
*ctl
, long itemId
);
215 static wxListItemAttr
*wxGetInternalDataAttr(wxListCtrl
*ctl
, long itemId
);
216 static void wxDeleteInternalData(wxListCtrl
* ctl
, long itemId
);
219 // ----------------------------------------------------------------------------
221 // ----------------------------------------------------------------------------
223 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG
)
224 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG
)
225 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
)
226 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT
)
227 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM
)
228 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
)
229 #if WXWIN_COMPATIBILITY_2_4
230 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO
)
231 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO
)
233 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED
)
234 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED
)
235 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN
)
236 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM
)
237 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK
)
238 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
)
239 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
)
240 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING
)
241 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG
)
242 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
)
243 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK
)
244 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED
)
245 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED
)
246 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT
)
248 #if wxUSE_EXTENDED_RTTI
249 WX_DEFINE_FLAGS( wxListCtrlStyle
)
251 wxBEGIN_FLAGS( wxListCtrlStyle
)
252 // new style border flags, we put them first to
253 // use them for streaming out
254 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
255 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
256 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
257 wxFLAGS_MEMBER(wxBORDER_RAISED
)
258 wxFLAGS_MEMBER(wxBORDER_STATIC
)
259 wxFLAGS_MEMBER(wxBORDER_NONE
)
261 // old style border flags
262 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
263 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
264 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
265 wxFLAGS_MEMBER(wxRAISED_BORDER
)
266 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
267 wxFLAGS_MEMBER(wxBORDER
)
269 // standard window styles
270 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
271 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
272 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
273 wxFLAGS_MEMBER(wxWANTS_CHARS
)
274 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
275 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
276 wxFLAGS_MEMBER(wxVSCROLL
)
277 wxFLAGS_MEMBER(wxHSCROLL
)
279 wxFLAGS_MEMBER(wxLC_LIST
)
280 wxFLAGS_MEMBER(wxLC_REPORT
)
281 wxFLAGS_MEMBER(wxLC_ICON
)
282 wxFLAGS_MEMBER(wxLC_SMALL_ICON
)
283 wxFLAGS_MEMBER(wxLC_ALIGN_TOP
)
284 wxFLAGS_MEMBER(wxLC_ALIGN_LEFT
)
285 wxFLAGS_MEMBER(wxLC_AUTOARRANGE
)
286 wxFLAGS_MEMBER(wxLC_USER_TEXT
)
287 wxFLAGS_MEMBER(wxLC_EDIT_LABELS
)
288 wxFLAGS_MEMBER(wxLC_NO_HEADER
)
289 wxFLAGS_MEMBER(wxLC_SINGLE_SEL
)
290 wxFLAGS_MEMBER(wxLC_SORT_ASCENDING
)
291 wxFLAGS_MEMBER(wxLC_SORT_DESCENDING
)
292 wxFLAGS_MEMBER(wxLC_VIRTUAL
)
294 wxEND_FLAGS( wxListCtrlStyle
)
296 IMPLEMENT_DYNAMIC_CLASS_XTI(wxListCtrl
, wxControl
,"wx/listctrl.h")
298 wxBEGIN_PROPERTIES_TABLE(wxListCtrl
)
299 wxEVENT_PROPERTY( TextUpdated
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
)
301 wxPROPERTY_FLAGS( WindowStyle
, wxListCtrlStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
302 wxEND_PROPERTIES_TABLE()
304 wxBEGIN_HANDLERS_TABLE(wxListCtrl
)
305 wxEND_HANDLERS_TABLE()
307 wxCONSTRUCTOR_5( wxListCtrl
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
310 TODO : Expose more information of a list's layout etc. via appropriate objects (Ã la NotebookPageInfo)
313 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl
, wxControl
)
316 IMPLEMENT_DYNAMIC_CLASS(wxListView
, wxListCtrl
)
317 IMPLEMENT_DYNAMIC_CLASS(wxListItem
, wxObject
)
319 IMPLEMENT_DYNAMIC_CLASS(wxListEvent
, wxNotifyEvent
)
321 BEGIN_EVENT_TABLE(wxListCtrl
, wxControl
)
322 EVT_PAINT(wxListCtrl::OnPaint
)
325 // ============================================================================
327 // ============================================================================
329 // ----------------------------------------------------------------------------
330 // wxListCtrl construction
331 // ----------------------------------------------------------------------------
333 void wxListCtrl::Init()
335 m_imageListNormal
= NULL
;
336 m_imageListSmall
= NULL
;
337 m_imageListState
= NULL
;
338 m_ownsImageListNormal
= m_ownsImageListSmall
= m_ownsImageListState
= false;
341 m_ignoreChangeMessages
= false;
343 m_AnyInternalData
= false;
344 m_hasAnyAttr
= false;
347 bool wxListCtrl::Create(wxWindow
*parent
,
352 const wxValidator
& validator
,
353 const wxString
& name
)
355 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
358 if ( !MSWCreateControl(WC_LISTVIEW
, wxEmptyString
, pos
, size
) )
361 // explicitly say that we want to use Unicode because otherwise we get ANSI
362 // versions of _some_ messages (notably LVN_GETDISPINFOA) in MSLU build
363 wxSetCCUnicodeFormat(GetHwnd());
365 // We must set the default text colour to the system/theme color, otherwise
366 // GetTextColour will always return black
367 SetTextColour(GetDefaultAttributes().colFg
);
369 // for comctl32.dll v 4.70+ we want to have some non default extended
370 // styles because it's prettier (and also because wxGTK does it like this)
371 if ( InReportView() && wxApp::GetComCtl32Version() >= 470 )
373 ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE
,
374 0, LVS_EX_LABELTIP
| LVS_EX_FULLROWSELECT
);
380 WXDWORD
wxListCtrl::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
382 WXDWORD wstyle
= wxControl::MSWGetStyle(style
, exstyle
);
384 wstyle
|= LVS_SHAREIMAGELISTS
| LVS_SHOWSELALWAYS
;
389 #define MAP_MODE_STYLE(wx, ms) \
390 if ( style & (wx) ) { wstyle |= (ms); nModes++; }
391 #else // !__WXDEBUG__
392 #define MAP_MODE_STYLE(wx, ms) \
393 if ( style & (wx) ) wstyle |= (ms);
394 #endif // __WXDEBUG__
396 MAP_MODE_STYLE(wxLC_ICON
, LVS_ICON
)
397 MAP_MODE_STYLE(wxLC_SMALL_ICON
, LVS_SMALLICON
)
398 MAP_MODE_STYLE(wxLC_LIST
, LVS_LIST
)
399 MAP_MODE_STYLE(wxLC_REPORT
, LVS_REPORT
)
401 wxASSERT_MSG( nModes
== 1,
402 _T("wxListCtrl style should have exactly one mode bit set") );
404 #undef MAP_MODE_STYLE
406 if ( style
& wxLC_ALIGN_LEFT
)
407 wstyle
|= LVS_ALIGNLEFT
;
409 if ( style
& wxLC_ALIGN_TOP
)
410 wstyle
|= LVS_ALIGNTOP
;
412 if ( style
& wxLC_AUTOARRANGE
)
413 wstyle
|= LVS_AUTOARRANGE
;
415 if ( style
& wxLC_NO_SORT_HEADER
)
416 wstyle
|= LVS_NOSORTHEADER
;
418 if ( style
& wxLC_NO_HEADER
)
419 wstyle
|= LVS_NOCOLUMNHEADER
;
421 if ( style
& wxLC_EDIT_LABELS
)
422 wstyle
|= LVS_EDITLABELS
;
424 if ( style
& wxLC_SINGLE_SEL
)
425 wstyle
|= LVS_SINGLESEL
;
427 if ( style
& wxLC_SORT_ASCENDING
)
429 wstyle
|= LVS_SORTASCENDING
;
431 wxASSERT_MSG( !(style
& wxLC_SORT_DESCENDING
),
432 _T("can't sort in ascending and descending orders at once") );
434 else if ( style
& wxLC_SORT_DESCENDING
)
435 wstyle
|= LVS_SORTDESCENDING
;
437 #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
438 if ( style
& wxLC_VIRTUAL
)
440 int ver
= wxApp::GetComCtl32Version();
443 wxLogWarning(_("Please install a newer version of comctl32.dll\n(at least version 4.70 is required but you have %d.%02d)\nor this program won't operate correctly."),
444 ver
/ 100, ver
% 100);
447 wstyle
|= LVS_OWNERDATA
;
449 #endif // ancient cygwin
454 void wxListCtrl::UpdateStyle()
458 // The new window view style
459 DWORD dwStyleNew
= MSWGetStyle(m_windowStyle
, NULL
);
461 // some styles are not returned by MSWGetStyle()
463 dwStyleNew
|= WS_VISIBLE
;
465 // Get the current window style.
466 DWORD dwStyleOld
= ::GetWindowLong(GetHwnd(), GWL_STYLE
);
468 // we don't have wxVSCROLL style, but the list control may have it,
469 // don't change it then
470 dwStyleNew
|= dwStyleOld
& (WS_HSCROLL
| WS_VSCROLL
);
472 // Only set the window style if the view bits have changed.
473 if ( dwStyleOld
!= dwStyleNew
)
475 ::SetWindowLong(GetHwnd(), GWL_STYLE
, dwStyleNew
);
480 void wxListCtrl::FreeAllInternalData()
482 if (m_AnyInternalData
)
484 int n
= GetItemCount();
486 m_ignoreChangeMessages
= true;
487 for (int i
= 0; i
< n
; i
++)
488 wxDeleteInternalData(this, i
);
489 m_ignoreChangeMessages
= false;
491 m_AnyInternalData
= false;
495 wxListCtrl::~wxListCtrl()
497 FreeAllInternalData();
501 m_textCtrl
->UnsubclassWin();
502 m_textCtrl
->SetHWND(0);
507 if (m_ownsImageListNormal
)
508 delete m_imageListNormal
;
509 if (m_ownsImageListSmall
)
510 delete m_imageListSmall
;
511 if (m_ownsImageListState
)
512 delete m_imageListState
;
515 // ----------------------------------------------------------------------------
516 // set/get/change style
517 // ----------------------------------------------------------------------------
519 // Add or remove a single window style
520 void wxListCtrl::SetSingleStyle(long style
, bool add
)
522 long flag
= GetWindowStyleFlag();
524 // Get rid of conflicting styles
527 if ( style
& wxLC_MASK_TYPE
)
528 flag
= flag
& ~wxLC_MASK_TYPE
;
529 if ( style
& wxLC_MASK_ALIGN
)
530 flag
= flag
& ~wxLC_MASK_ALIGN
;
531 if ( style
& wxLC_MASK_SORT
)
532 flag
= flag
& ~wxLC_MASK_SORT
;
540 SetWindowStyleFlag(flag
);
543 // Set the whole window style
544 void wxListCtrl::SetWindowStyleFlag(long flag
)
546 if ( flag
!= m_windowStyle
)
548 m_windowStyle
= flag
;
556 // ----------------------------------------------------------------------------
558 // ----------------------------------------------------------------------------
560 /* static */ wxVisualAttributes
561 wxListCtrl::GetClassDefaultAttributes(wxWindowVariant variant
)
563 wxVisualAttributes attrs
= GetCompositeControlsDefaultAttributes(variant
);
565 // common controls have their own default font
566 attrs
.font
= wxGetCCDefaultFont();
571 // Sets the foreground, i.e. text, colour
572 bool wxListCtrl::SetForegroundColour(const wxColour
& col
)
574 if ( !wxWindow::SetForegroundColour(col
) )
577 ListView_SetTextColor(GetHwnd(), wxColourToRGB(col
));
582 // Sets the background colour
583 bool wxListCtrl::SetBackgroundColour(const wxColour
& col
)
585 if ( !wxWindow::SetBackgroundColour(col
) )
588 // we set the same colour for both the "empty" background and the items
590 COLORREF color
= wxColourToRGB(col
);
591 ListView_SetBkColor(GetHwnd(), color
);
592 ListView_SetTextBkColor(GetHwnd(), color
);
597 // Gets information about this column
598 bool wxListCtrl::GetColumn(int col
, wxListItem
& item
) const
603 lvCol
.mask
= LVCF_WIDTH
;
605 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
607 lvCol
.mask
|= LVCF_TEXT
;
608 lvCol
.pszText
= new wxChar
[513];
609 lvCol
.cchTextMax
= 512;
612 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
614 lvCol
.mask
|= LVCF_FMT
;
617 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
619 lvCol
.mask
|= LVCF_IMAGE
;
622 bool success
= ListView_GetColumn(GetHwnd(), col
, &lvCol
) != 0;
624 // item.m_subItem = lvCol.iSubItem;
625 item
.m_width
= lvCol
.cx
;
627 if ( (item
.m_mask
& wxLIST_MASK_TEXT
) && lvCol
.pszText
)
629 item
.m_text
= lvCol
.pszText
;
630 delete[] lvCol
.pszText
;
633 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
635 switch (lvCol
.fmt
& LVCFMT_JUSTIFYMASK
) {
637 item
.m_format
= wxLIST_FORMAT_LEFT
;
640 item
.m_format
= wxLIST_FORMAT_RIGHT
;
643 item
.m_format
= wxLIST_FORMAT_CENTRE
;
646 item
.m_format
= -1; // Unknown?
651 // the column images were not supported in older versions but how to check
652 // for this? we can't use _WIN32_IE because we always define it to a very
653 // high value, so see if another symbol which is only defined starting from
654 // comctl32.dll 4.70 is available
655 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
656 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
658 item
.m_image
= lvCol
.iImage
;
660 #endif // LVCOLUMN::iImage exists
665 // Sets information about this column
666 bool wxListCtrl::SetColumn(int col
, const wxListItem
& item
)
669 wxConvertToMSWListCol(col
, item
, lvCol
);
671 return ListView_SetColumn(GetHwnd(), col
, &lvCol
) != 0;
674 // Gets the column width
675 int wxListCtrl::GetColumnWidth(int col
) const
677 return ListView_GetColumnWidth(GetHwnd(), col
);
680 // Sets the column width
681 bool wxListCtrl::SetColumnWidth(int col
, int width
)
683 if ( m_windowStyle
& wxLC_LIST
)
686 if ( width
== wxLIST_AUTOSIZE
)
687 width
= LVSCW_AUTOSIZE
;
688 else if ( width
== wxLIST_AUTOSIZE_USEHEADER
)
689 width
= LVSCW_AUTOSIZE_USEHEADER
;
691 return ListView_SetColumnWidth(GetHwnd(), col
, width
) != 0;
694 // Gets the number of items that can fit vertically in the
695 // visible area of the list control (list or report view)
696 // or the total number of items in the list control (icon
697 // or small icon view)
698 int wxListCtrl::GetCountPerPage() const
700 return ListView_GetCountPerPage(GetHwnd());
703 // Gets the edit control for editing labels.
704 wxTextCtrl
* wxListCtrl::GetEditControl() const
709 // Gets information about the item
710 bool wxListCtrl::GetItem(wxListItem
& info
) const
713 wxZeroMemory(lvItem
);
715 lvItem
.iItem
= info
.m_itemId
;
716 lvItem
.iSubItem
= info
.m_col
;
718 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
720 lvItem
.mask
|= LVIF_TEXT
;
721 lvItem
.pszText
= new wxChar
[513];
722 lvItem
.cchTextMax
= 512;
726 lvItem
.pszText
= NULL
;
729 if (info
.m_mask
& wxLIST_MASK_DATA
)
730 lvItem
.mask
|= LVIF_PARAM
;
732 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
733 lvItem
.mask
|= LVIF_IMAGE
;
735 if ( info
.m_mask
& wxLIST_MASK_STATE
)
737 lvItem
.mask
|= LVIF_STATE
;
738 wxConvertToMSWFlags(0, info
.m_stateMask
, lvItem
);
741 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
744 wxLogError(_("Couldn't retrieve information about list control item %d."),
749 // give NULL as hwnd as we already have everything we need
750 wxConvertFromMSWListItem(NULL
, info
, lvItem
);
754 delete[] lvItem
.pszText
;
759 // Sets information about the item
760 bool wxListCtrl::SetItem(wxListItem
& info
)
763 wxConvertToMSWListItem(this, info
, item
);
765 // we never update the lParam if it contains our pointer
766 // to the wxListItemInternalData structure
767 item
.mask
&= ~LVIF_PARAM
;
769 // check if setting attributes or lParam
770 if (info
.HasAttributes() || (info
.m_mask
& wxLIST_MASK_DATA
))
772 // get internal item data
773 // perhaps a cache here ?
774 wxListItemInternalData
*data
= wxGetInternalData(this, info
.m_itemId
);
779 m_AnyInternalData
= true;
780 data
= new wxListItemInternalData();
781 item
.lParam
= (LPARAM
) data
;
782 item
.mask
|= LVIF_PARAM
;
787 if (info
.m_mask
& wxLIST_MASK_DATA
)
788 data
->lParam
= info
.m_data
;
791 if (info
.HasAttributes())
794 *data
->attr
= *info
.GetAttributes();
796 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
801 // we could be changing only the attribute in which case we don't need to
802 // call ListView_SetItem() at all
806 if ( !ListView_SetItem(GetHwnd(), &item
) )
808 wxLogDebug(_T("ListView_SetItem() failed"));
814 // we need to update the item immediately to show the new image
815 bool updateNow
= (info
.m_mask
& wxLIST_MASK_IMAGE
) != 0;
817 // check whether it has any custom attributes
818 if ( info
.HasAttributes() )
822 // if the colour has changed, we must redraw the item
828 // we need this to make the change visible right now
829 RefreshItem(item
.iItem
);
835 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
839 info
.m_mask
= wxLIST_MASK_TEXT
;
840 info
.m_itemId
= index
;
844 info
.m_image
= imageId
;
845 info
.m_mask
|= wxLIST_MASK_IMAGE
;
847 return SetItem(info
);
851 // Gets the item state
852 int wxListCtrl::GetItemState(long item
, long stateMask
) const
856 info
.m_mask
= wxLIST_MASK_STATE
;
857 info
.m_stateMask
= stateMask
;
858 info
.m_itemId
= item
;
866 // Sets the item state
867 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
869 // NB: don't use SetItem() here as it doesn't work with the virtual list
872 wxZeroMemory(lvItem
);
874 wxConvertToMSWFlags(state
, stateMask
, lvItem
);
876 // for the virtual list controls we need to refresh the previously focused
877 // item manually when changing focus without changing selection
878 // programmatically because otherwise it keeps its focus rectangle until
879 // next repaint (yet another comctl32 bug)
882 (stateMask
& wxLIST_STATE_FOCUSED
) &&
883 (state
& wxLIST_STATE_FOCUSED
) )
885 focusOld
= GetNextItem(-1, wxLIST_NEXT_ALL
, wxLIST_STATE_FOCUSED
);
892 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE
,
893 (WPARAM
)item
, (LPARAM
)&lvItem
) )
895 wxLogLastError(_T("ListView_SetItemState"));
900 if ( focusOld
!= -1 )
902 // no need to refresh the item if it was previously selected, it would
903 // only result in annoying flicker
904 if ( !(GetItemState(focusOld
,
905 wxLIST_STATE_SELECTED
) & wxLIST_STATE_SELECTED
) )
907 RefreshItem(focusOld
);
914 // Sets the item image
915 bool wxListCtrl::SetItemImage(long item
, int image
, int WXUNUSED(selImage
))
919 info
.m_mask
= wxLIST_MASK_IMAGE
;
920 info
.m_image
= image
;
921 info
.m_itemId
= item
;
923 return SetItem(info
);
926 // Gets the item text
927 wxString
wxListCtrl::GetItemText(long item
) const
931 info
.m_mask
= wxLIST_MASK_TEXT
;
932 info
.m_itemId
= item
;
935 return wxEmptyString
;
939 // Sets the item text
940 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
944 info
.m_mask
= wxLIST_MASK_TEXT
;
945 info
.m_itemId
= item
;
951 // Gets the item data
952 wxUIntPtr
wxListCtrl::GetItemData(long item
) const
956 info
.m_mask
= wxLIST_MASK_DATA
;
957 info
.m_itemId
= item
;
964 // Sets the item data
965 bool wxListCtrl::SetItemData(long item
, long data
)
969 info
.m_mask
= wxLIST_MASK_DATA
;
970 info
.m_itemId
= item
;
973 return SetItem(info
);
976 wxRect
wxListCtrl::GetViewRect() const
978 wxASSERT_MSG( !HasFlag(wxLC_REPORT
| wxLC_LIST
),
979 _T("wxListCtrl::GetViewRect() only works in icon mode") );
982 if ( !ListView_GetViewRect(GetHwnd(), &rc
) )
984 wxLogDebug(_T("ListView_GetViewRect() failed."));
990 wxCopyRECTToRect(rc
, rect
);
995 // Gets the item rectangle
996 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
1001 if ( code
== wxLIST_RECT_BOUNDS
)
1002 codeWin
= LVIR_BOUNDS
;
1003 else if ( code
== wxLIST_RECT_ICON
)
1004 codeWin
= LVIR_ICON
;
1005 else if ( code
== wxLIST_RECT_LABEL
)
1006 codeWin
= LVIR_LABEL
;
1009 wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
1011 codeWin
= LVIR_BOUNDS
;
1014 bool success
= ListView_GetItemRect(GetHwnd(), (int) item
, &rectWin
, codeWin
) != 0;
1016 rect
.x
= rectWin
.left
;
1017 rect
.y
= rectWin
.top
;
1018 rect
.width
= rectWin
.right
- rectWin
.left
;
1019 rect
.height
= rectWin
.bottom
- rectWin
.top
;
1024 // Gets the item position
1025 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
1029 bool success
= (ListView_GetItemPosition(GetHwnd(), (int) item
, &pt
) != 0);
1031 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
1035 // Sets the item position.
1036 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
1038 return (ListView_SetItemPosition(GetHwnd(), (int) item
, pos
.x
, pos
.y
) != 0);
1041 // Gets the number of items in the list control
1042 int wxListCtrl::GetItemCount() const
1047 wxSize
wxListCtrl::GetItemSpacing() const
1049 const int spacing
= ListView_GetItemSpacing(GetHwnd(), (BOOL
)HasFlag(wxLC_SMALL_ICON
));
1051 return wxSize(LOWORD(spacing
), HIWORD(spacing
));
1054 int wxListCtrl::GetItemSpacing(bool isSmall
) const
1056 return ListView_GetItemSpacing(GetHwnd(), (BOOL
) isSmall
);
1059 void wxListCtrl::SetItemTextColour( long item
, const wxColour
&col
)
1062 info
.m_itemId
= item
;
1063 info
.SetTextColour( col
);
1067 wxColour
wxListCtrl::GetItemTextColour( long item
) const
1070 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1071 if ( data
&& data
->attr
)
1072 col
= data
->attr
->GetTextColour();
1077 void wxListCtrl::SetItemBackgroundColour( long item
, const wxColour
&col
)
1080 info
.m_itemId
= item
;
1081 info
.SetBackgroundColour( col
);
1085 wxColour
wxListCtrl::GetItemBackgroundColour( long item
) const
1088 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1089 if ( data
&& data
->attr
)
1090 col
= data
->attr
->GetBackgroundColour();
1095 void wxListCtrl::SetItemFont( long item
, const wxFont
&f
)
1098 info
.m_itemId
= item
;
1103 wxFont
wxListCtrl::GetItemFont( long item
) const
1106 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1107 if ( data
&& data
->attr
)
1108 f
= data
->attr
->GetFont();
1113 // Gets the number of selected items in the list control
1114 int wxListCtrl::GetSelectedItemCount() const
1116 return ListView_GetSelectedCount(GetHwnd());
1119 // Gets the text colour of the listview
1120 wxColour
wxListCtrl::GetTextColour() const
1122 COLORREF ref
= ListView_GetTextColor(GetHwnd());
1123 wxColour
col(GetRValue(ref
), GetGValue(ref
), GetBValue(ref
));
1127 // Sets the text colour of the listview
1128 void wxListCtrl::SetTextColour(const wxColour
& col
)
1130 ListView_SetTextColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
1133 // Gets the index of the topmost visible item when in
1134 // list or report view
1135 long wxListCtrl::GetTopItem() const
1137 return (long) ListView_GetTopIndex(GetHwnd());
1140 // Searches for an item, starting from 'item'.
1141 // 'geometry' is one of
1142 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1143 // 'state' is a state bit flag, one or more of
1144 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1145 // item can be -1 to find the first item that matches the
1147 // Returns the item or -1 if unsuccessful.
1148 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
1152 if ( geom
== wxLIST_NEXT_ABOVE
)
1153 flags
|= LVNI_ABOVE
;
1154 if ( geom
== wxLIST_NEXT_ALL
)
1156 if ( geom
== wxLIST_NEXT_BELOW
)
1157 flags
|= LVNI_BELOW
;
1158 if ( geom
== wxLIST_NEXT_LEFT
)
1159 flags
|= LVNI_TOLEFT
;
1160 if ( geom
== wxLIST_NEXT_RIGHT
)
1161 flags
|= LVNI_TORIGHT
;
1163 if ( state
& wxLIST_STATE_CUT
)
1165 if ( state
& wxLIST_STATE_DROPHILITED
)
1166 flags
|= LVNI_DROPHILITED
;
1167 if ( state
& wxLIST_STATE_FOCUSED
)
1168 flags
|= LVNI_FOCUSED
;
1169 if ( state
& wxLIST_STATE_SELECTED
)
1170 flags
|= LVNI_SELECTED
;
1172 return (long) ListView_GetNextItem(GetHwnd(), item
, flags
);
1176 wxImageList
*wxListCtrl::GetImageList(int which
) const
1178 if ( which
== wxIMAGE_LIST_NORMAL
)
1180 return m_imageListNormal
;
1182 else if ( which
== wxIMAGE_LIST_SMALL
)
1184 return m_imageListSmall
;
1186 else if ( which
== wxIMAGE_LIST_STATE
)
1188 return m_imageListState
;
1193 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
1196 if ( which
== wxIMAGE_LIST_NORMAL
)
1198 flags
= LVSIL_NORMAL
;
1199 if (m_ownsImageListNormal
) delete m_imageListNormal
;
1200 m_imageListNormal
= imageList
;
1201 m_ownsImageListNormal
= false;
1203 else if ( which
== wxIMAGE_LIST_SMALL
)
1205 flags
= LVSIL_SMALL
;
1206 if (m_ownsImageListSmall
) delete m_imageListSmall
;
1207 m_imageListSmall
= imageList
;
1208 m_ownsImageListSmall
= false;
1210 else if ( which
== wxIMAGE_LIST_STATE
)
1212 flags
= LVSIL_STATE
;
1213 if (m_ownsImageListState
) delete m_imageListState
;
1214 m_imageListState
= imageList
;
1215 m_ownsImageListState
= false;
1217 (void) ListView_SetImageList(GetHwnd(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
1220 void wxListCtrl::AssignImageList(wxImageList
*imageList
, int which
)
1222 SetImageList(imageList
, which
);
1223 if ( which
== wxIMAGE_LIST_NORMAL
)
1224 m_ownsImageListNormal
= true;
1225 else if ( which
== wxIMAGE_LIST_SMALL
)
1226 m_ownsImageListSmall
= true;
1227 else if ( which
== wxIMAGE_LIST_STATE
)
1228 m_ownsImageListState
= true;
1231 // ----------------------------------------------------------------------------
1233 // ----------------------------------------------------------------------------
1235 // Arranges the items
1236 bool wxListCtrl::Arrange(int flag
)
1239 if ( flag
== wxLIST_ALIGN_LEFT
)
1240 code
= LVA_ALIGNLEFT
;
1241 else if ( flag
== wxLIST_ALIGN_TOP
)
1242 code
= LVA_ALIGNTOP
;
1243 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
1245 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
1246 code
= LVA_SNAPTOGRID
;
1248 return (ListView_Arrange(GetHwnd(), code
) != 0);
1252 bool wxListCtrl::DeleteItem(long item
)
1254 if ( !ListView_DeleteItem(GetHwnd(), (int) item
) )
1256 wxLogLastError(_T("ListView_DeleteItem"));
1261 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1262 wxT("m_count should match ListView_GetItemCount"));
1264 // the virtual list control doesn't refresh itself correctly, help it
1267 // we need to refresh all the lines below the one which was deleted
1269 if ( item
> 0 && GetItemCount() )
1271 GetItemRect(item
- 1, rectItem
);
1276 rectItem
.height
= 0;
1279 wxRect rectWin
= GetRect();
1280 rectWin
.height
= rectWin
.GetBottom() - rectItem
.GetBottom();
1281 rectWin
.y
= rectItem
.GetBottom();
1283 RefreshRect(rectWin
);
1289 // Deletes all items
1290 bool wxListCtrl::DeleteAllItems()
1292 return ListView_DeleteAllItems(GetHwnd()) != 0;
1295 // Deletes all items
1296 bool wxListCtrl::DeleteAllColumns()
1298 while ( m_colCount
> 0 )
1300 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1302 wxLogLastError(wxT("ListView_DeleteColumn"));
1310 wxASSERT_MSG( m_colCount
== 0, wxT("no columns should be left") );
1316 bool wxListCtrl::DeleteColumn(int col
)
1318 bool success
= (ListView_DeleteColumn(GetHwnd(), col
) != 0);
1320 if ( success
&& (m_colCount
> 0) )
1325 // Clears items, and columns if there are any.
1326 void wxListCtrl::ClearAll()
1329 if ( m_colCount
> 0 )
1333 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
1335 wxASSERT( (textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
))) );
1337 // ListView_EditLabel requires that the list has focus.
1340 WXHWND hWnd
= (WXHWND
) ListView_EditLabel(GetHwnd(), item
);
1343 // failed to start editing
1347 // [re]create the text control wrapping the HWND we got
1350 m_textCtrl
->UnsubclassWin();
1351 m_textCtrl
->SetHWND(0);
1355 m_textCtrl
= (wxTextCtrl
*)textControlClass
->CreateObject();
1356 m_textCtrl
->SetHWND(hWnd
);
1357 m_textCtrl
->SubclassWin(hWnd
);
1358 m_textCtrl
->SetParent(this);
1360 // we must disallow TABbing away from the control while the edit contol is
1361 // shown because this leaves it in some strange state (just try removing
1362 // this line and then pressing TAB while editing an item in listctrl
1364 m_textCtrl
->SetWindowStyle(m_textCtrl
->GetWindowStyle() | wxTE_PROCESS_TAB
);
1369 // End label editing, optionally cancelling the edit
1370 bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel
))
1372 wxFAIL_MSG( _T("not implemented") );
1377 // Ensures this item is visible
1378 bool wxListCtrl::EnsureVisible(long item
)
1380 return ListView_EnsureVisible(GetHwnd(), (int) item
, FALSE
) != FALSE
;
1383 // Find an item whose label matches this string, starting from the item after 'start'
1384 // or the beginning if 'start' is -1.
1385 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
1387 LV_FINDINFO findInfo
;
1389 findInfo
.flags
= LVFI_STRING
;
1391 findInfo
.flags
|= LVFI_PARTIAL
;
1394 // ListView_FindItem() excludes the first item from search and to look
1395 // through all the items you need to start from -1 which is unnatural and
1396 // inconsistent with the generic version - so we adjust the index
1399 return ListView_FindItem(GetHwnd(), (int) start
, &findInfo
);
1402 // Find an item whose data matches this data, starting from the item after 'start'
1403 // or the beginning if 'start' is -1.
1404 // NOTE : Lindsay Mathieson - 14-July-2002
1405 // No longer use ListView_FindItem as the data attribute is now stored
1406 // in a wxListItemInternalData structure refernced by the actual lParam
1407 long wxListCtrl::FindItem(long start
, wxUIntPtr data
)
1409 long idx
= start
+ 1;
1410 long count
= GetItemCount();
1414 if (GetItemData(idx
) == data
)
1422 // Find an item nearest this position in the specified direction, starting from
1423 // the item after 'start' or the beginning if 'start' is -1.
1424 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
1426 LV_FINDINFO findInfo
;
1428 findInfo
.flags
= LVFI_NEARESTXY
;
1429 findInfo
.pt
.x
= pt
.x
;
1430 findInfo
.pt
.y
= pt
.y
;
1431 findInfo
.vkDirection
= VK_RIGHT
;
1433 if ( direction
== wxLIST_FIND_UP
)
1434 findInfo
.vkDirection
= VK_UP
;
1435 else if ( direction
== wxLIST_FIND_DOWN
)
1436 findInfo
.vkDirection
= VK_DOWN
;
1437 else if ( direction
== wxLIST_FIND_LEFT
)
1438 findInfo
.vkDirection
= VK_LEFT
;
1439 else if ( direction
== wxLIST_FIND_RIGHT
)
1440 findInfo
.vkDirection
= VK_RIGHT
;
1442 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
1445 // Determines which item (if any) is at the specified point,
1446 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1447 long wxListCtrl::HitTest(const wxPoint
& point
, int& flags
)
1449 LV_HITTESTINFO hitTestInfo
;
1450 hitTestInfo
.pt
.x
= (int) point
.x
;
1451 hitTestInfo
.pt
.y
= (int) point
.y
;
1453 ListView_HitTest(GetHwnd(), & hitTestInfo
);
1457 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
1458 flags
|= wxLIST_HITTEST_ABOVE
;
1459 if ( hitTestInfo
.flags
& LVHT_BELOW
)
1460 flags
|= wxLIST_HITTEST_BELOW
;
1461 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
1462 flags
|= wxLIST_HITTEST_TOLEFT
;
1463 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
1464 flags
|= wxLIST_HITTEST_TORIGHT
;
1466 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
1467 flags
|= wxLIST_HITTEST_NOWHERE
;
1469 // note a bug or at least a very strange feature of comtl32.dll (tested
1470 // with version 4.0 under Win95 and 6.0 under Win 2003): if you click to
1471 // the right of the item label, ListView_HitTest() returns a combination of
1472 // LVHT_ONITEMICON, LVHT_ONITEMLABEL and LVHT_ONITEMSTATEICON -- filter out
1473 // the bits which don't make sense
1474 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
1476 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
1478 // do not translate LVHT_ONITEMICON here, as per above
1482 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
1483 flags
|= wxLIST_HITTEST_ONITEMICON
;
1484 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
1485 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
1488 return (long) hitTestInfo
.iItem
;
1491 // Inserts an item, returning the index of the new item if successful,
1493 long wxListCtrl::InsertItem(const wxListItem
& info
)
1495 wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
1498 wxConvertToMSWListItem(this, info
, item
);
1499 item
.mask
&= ~LVIF_PARAM
;
1501 // check wether we need to allocate our internal data
1502 bool needInternalData
= ((info
.m_mask
& wxLIST_MASK_DATA
) || info
.HasAttributes());
1503 if (needInternalData
)
1505 m_AnyInternalData
= true;
1506 item
.mask
|= LVIF_PARAM
;
1508 // internal stucture that manages data
1509 wxListItemInternalData
*data
= new wxListItemInternalData();
1510 item
.lParam
= (LPARAM
) data
;
1512 if (info
.m_mask
& wxLIST_MASK_DATA
)
1513 data
->lParam
= info
.m_data
;
1515 // check whether it has any custom attributes
1516 if ( info
.HasAttributes() )
1518 // take copy of attributes
1519 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
1521 // and remember that we have some now...
1522 m_hasAnyAttr
= true;
1526 long rv
= ListView_InsertItem(GetHwnd(), & item
);
1529 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1530 wxT("m_count should match ListView_GetItemCount"));
1535 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1538 info
.m_text
= label
;
1539 info
.m_mask
= wxLIST_MASK_TEXT
;
1540 info
.m_itemId
= index
;
1541 return InsertItem(info
);
1544 // Inserts an image item
1545 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1548 info
.m_image
= imageIndex
;
1549 info
.m_mask
= wxLIST_MASK_IMAGE
;
1550 info
.m_itemId
= index
;
1551 return InsertItem(info
);
1554 // Inserts an image/string item
1555 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1558 info
.m_image
= imageIndex
;
1559 info
.m_text
= label
;
1560 info
.m_mask
= wxLIST_MASK_IMAGE
| wxLIST_MASK_TEXT
;
1561 info
.m_itemId
= index
;
1562 return InsertItem(info
);
1565 // For list view mode (only), inserts a column.
1566 long wxListCtrl::InsertColumn(long col
, const wxListItem
& item
)
1569 wxConvertToMSWListCol(col
, item
, lvCol
);
1571 if ( !(lvCol
.mask
& LVCF_WIDTH
) )
1573 // always give some width to the new column: this one is compatible
1574 // with the generic version
1575 lvCol
.mask
|= LVCF_WIDTH
;
1579 long n
= ListView_InsertColumn(GetHwnd(), col
, &lvCol
);
1584 else // failed to insert?
1586 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1593 long wxListCtrl::InsertColumn(long col
,
1594 const wxString
& heading
,
1599 item
.m_mask
= wxLIST_MASK_TEXT
| wxLIST_MASK_FORMAT
;
1600 item
.m_text
= heading
;
1603 item
.m_mask
|= wxLIST_MASK_WIDTH
;
1604 item
.m_width
= width
;
1606 item
.m_format
= format
;
1608 return InsertColumn(col
, item
);
1611 // scroll the control by the given number of pixels (exception: in list view,
1612 // dx is interpreted as number of columns)
1613 bool wxListCtrl::ScrollList(int dx
, int dy
)
1615 if ( !ListView_Scroll(GetHwnd(), dx
, dy
) )
1617 wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx
, dy
);
1627 // fn is a function which takes 3 long arguments: item1, item2, data.
1628 // item1 is the long data associated with a first item (NOT the index).
1629 // item2 is the long data associated with a second item (NOT the index).
1630 // data is the same value as passed to SortItems.
1631 // The return value is a negative number if the first item should precede the second
1632 // item, a positive number of the second item should precede the first,
1633 // or zero if the two items are equivalent.
1635 // data is arbitrary data to be passed to the sort function.
1637 // Internal structures for proxying the user compare function
1638 // so that we can pass it the *real* user data
1640 // translate lParam data and call user func
1641 struct wxInternalDataSort
1643 wxListCtrlCompare user_fn
;
1647 int CALLBACK
wxInternalDataCompareFunc(LPARAM lParam1
, LPARAM lParam2
, LPARAM lParamSort
)
1649 struct wxInternalDataSort
*internalData
= (struct wxInternalDataSort
*) lParamSort
;
1651 wxListItemInternalData
*data1
= (wxListItemInternalData
*) lParam1
;
1652 wxListItemInternalData
*data2
= (wxListItemInternalData
*) lParam2
;
1654 long d1
= (data1
== NULL
? 0 : data1
->lParam
);
1655 long d2
= (data2
== NULL
? 0 : data2
->lParam
);
1657 return internalData
->user_fn(d1
, d2
, internalData
->data
);
1661 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, long data
)
1663 struct wxInternalDataSort internalData
;
1664 internalData
.user_fn
= fn
;
1665 internalData
.data
= data
;
1667 // WPARAM cast is needed for mingw/cygwin
1668 if ( !ListView_SortItems(GetHwnd(),
1669 wxInternalDataCompareFunc
,
1670 (WPARAM
) &internalData
) )
1672 wxLogDebug(_T("ListView_SortItems() failed"));
1682 // ----------------------------------------------------------------------------
1683 // message processing
1684 // ----------------------------------------------------------------------------
1686 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1688 if (cmd
== EN_UPDATE
)
1690 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1691 event
.SetEventObject( this );
1692 ProcessCommand(event
);
1695 else if (cmd
== EN_KILLFOCUS
)
1697 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1698 event
.SetEventObject( this );
1699 ProcessCommand(event
);
1706 bool wxListCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
1709 // prepare the event
1710 // -----------------
1712 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1713 event
.SetEventObject(this);
1715 wxEventType eventType
= wxEVT_NULL
;
1717 NMHDR
*nmhdr
= (NMHDR
*)lParam
;
1719 // if your compiler is as broken as this, you should really change it: this
1720 // code is needed for normal operation! #ifdef below is only useful for
1721 // automatic rebuilds which are done with a very old compiler version
1722 #ifdef HDN_BEGINTRACKA
1724 // check for messages from the header (in report view)
1725 HWND hwndHdr
= ListView_GetHeader(GetHwnd());
1727 // is it a message from the header?
1728 if ( nmhdr
->hwndFrom
== hwndHdr
)
1730 HD_NOTIFY
*nmHDR
= (HD_NOTIFY
*)nmhdr
;
1732 event
.m_itemIndex
= -1;
1734 switch ( nmhdr
->code
)
1736 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1737 // TRACK messages even to ANSI programs: on my system I get
1738 // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all!
1740 // work around is to simply catch both versions and hope that it
1741 // works (why should this message exist in ANSI and Unicode is
1742 // beyond me as it doesn't deal with strings at all...)
1744 // note that fr HDN_TRACK another possibility could be to use
1745 // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when
1746 // something other than the item width changes so we'd have to
1747 // filter out the unwanted events then
1748 case HDN_BEGINTRACKA
:
1749 case HDN_BEGINTRACKW
:
1750 eventType
= wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
;
1755 if ( eventType
== wxEVT_NULL
)
1756 eventType
= wxEVT_COMMAND_LIST_COL_DRAGGING
;
1761 if ( eventType
== wxEVT_NULL
)
1762 eventType
= wxEVT_COMMAND_LIST_COL_END_DRAG
;
1764 event
.m_item
.m_width
= nmHDR
->pitem
->cxy
;
1765 event
.m_col
= nmHDR
->iItem
;
1768 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1769 case GN_CONTEXTMENU
:
1770 #endif //__WXWINCE__
1773 eventType
= wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
;
1776 // find the column clicked: we have to search for it
1777 // ourselves as the notification message doesn't provide
1780 // where did the click occur?
1782 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1783 if(nmhdr
->code
== GN_CONTEXTMENU
) {
1784 ptClick
= ((NMRGINFO
*)nmhdr
)->ptAction
;
1786 #endif //__WXWINCE__
1787 if ( !::GetCursorPos(&ptClick
) )
1789 wxLogLastError(_T("GetCursorPos"));
1792 if ( !::ScreenToClient(GetHwnd(), &ptClick
) )
1794 wxLogLastError(_T("ScreenToClient(listctrl header)"));
1797 event
.m_pointDrag
.x
= ptClick
.x
;
1798 event
.m_pointDrag
.y
= ptClick
.y
;
1800 int colCount
= Header_GetItemCount(hwndHdr
);
1803 for ( int col
= 0; col
< colCount
; col
++ )
1805 if ( Header_GetItemRect(hwndHdr
, col
, &rect
) )
1807 if ( ::PtInRect(&rect
, ptClick
) )
1817 case HDN_GETDISPINFOW
:
1818 // letting Windows XP handle this message results in mysterious
1819 // crashes in comctl32.dll seemingly because of bad message
1822 // I have no idea what is the real cause of the bug (which is,
1823 // just to make things interesting, is impossible to reproduce
1824 // reliably) but ignoring all these messages does fix it and
1825 // doesn't seem to have any negative consequences
1829 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1833 #endif // defined(HDN_BEGINTRACKA)
1834 if ( nmhdr
->hwndFrom
== GetHwnd() )
1836 // almost all messages use NM_LISTVIEW
1837 NM_LISTVIEW
*nmLV
= (NM_LISTVIEW
*)nmhdr
;
1839 const int iItem
= nmLV
->iItem
;
1842 // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be
1843 // ignored for efficiency. It is done here because the internal data is in the
1844 // process of being deleted so we don't want to try and access it below.
1845 if ( m_ignoreChangeMessages
&&
1846 ( (nmLV
->hdr
.code
== LVN_ITEMCHANGED
) ||
1847 (nmLV
->hdr
.code
== LVN_ITEMCHANGING
)) )
1853 // If we have a valid item then check if there is a data value
1854 // associated with it and put it in the event.
1855 if ( iItem
>= 0 && iItem
< GetItemCount() )
1857 wxListItemInternalData
*internaldata
=
1858 wxGetInternalData(GetHwnd(), iItem
);
1861 event
.m_item
.m_data
= internaldata
->lParam
;
1864 bool processed
= true;
1865 switch ( nmhdr
->code
)
1867 case LVN_BEGINRDRAG
:
1868 eventType
= wxEVT_COMMAND_LIST_BEGIN_RDRAG
;
1872 if ( eventType
== wxEVT_NULL
)
1874 eventType
= wxEVT_COMMAND_LIST_BEGIN_DRAG
;
1877 event
.m_itemIndex
= iItem
;
1878 event
.m_pointDrag
.x
= nmLV
->ptAction
.x
;
1879 event
.m_pointDrag
.y
= nmLV
->ptAction
.y
;
1882 // NB: we have to handle both *A and *W versions here because some
1883 // versions of comctl32.dll send ANSI messages even to the
1885 case LVN_BEGINLABELEDITA
:
1886 case LVN_BEGINLABELEDITW
:
1889 if ( nmhdr
->code
== LVN_BEGINLABELEDITA
)
1891 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1893 else // LVN_BEGINLABELEDITW
1895 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1898 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1899 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, item
);
1900 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1904 case LVN_ENDLABELEDITA
:
1905 case LVN_ENDLABELEDITW
:
1908 if ( nmhdr
->code
== LVN_ENDLABELEDITA
)
1910 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1912 else // LVN_ENDLABELEDITW
1914 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1917 // was editing cancelled?
1918 const LV_ITEM
& lvi
= (LV_ITEM
)item
;
1919 if ( !lvi
.pszText
|| lvi
.iItem
== -1 )
1921 // don't keep a stale wxTextCtrl around
1924 // EDIT control will be deleted by the list control itself so
1925 // prevent us from deleting it as well
1926 m_textCtrl
->UnsubclassWin();
1927 m_textCtrl
->SetHWND(0);
1932 event
.SetEditCanceled(true);
1935 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1936 wxConvertFromMSWListItem(NULL
, event
.m_item
, item
);
1937 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1941 case LVN_COLUMNCLICK
:
1942 eventType
= wxEVT_COMMAND_LIST_COL_CLICK
;
1943 event
.m_itemIndex
= -1;
1944 event
.m_col
= nmLV
->iSubItem
;
1947 case LVN_DELETEALLITEMS
:
1948 eventType
= wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
;
1949 event
.m_itemIndex
= -1;
1952 case LVN_DELETEITEM
:
1955 // this should be prevented by the post-processing code
1956 // below, but "just in case"
1960 eventType
= wxEVT_COMMAND_LIST_DELETE_ITEM
;
1961 event
.m_itemIndex
= iItem
;
1962 // delete the assoicated internal data
1963 wxDeleteInternalData(this, iItem
);
1966 #if WXWIN_COMPATIBILITY_2_4
1967 case LVN_SETDISPINFO
:
1969 eventType
= wxEVT_COMMAND_LIST_SET_INFO
;
1970 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1971 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, info
->item
);
1976 case LVN_INSERTITEM
:
1977 eventType
= wxEVT_COMMAND_LIST_INSERT_ITEM
;
1978 event
.m_itemIndex
= iItem
;
1981 case LVN_ITEMCHANGED
:
1982 // we translate this catch all message into more interesting
1983 // (and more easy to process) wxWidgets events
1985 // first of all, we deal with the state change events only and
1986 // only for valid items (item == -1 for the virtual list
1988 if ( nmLV
->uChanged
& LVIF_STATE
&& iItem
!= -1 )
1990 // temp vars for readability
1991 const UINT stOld
= nmLV
->uOldState
;
1992 const UINT stNew
= nmLV
->uNewState
;
1994 event
.m_item
.SetId(iItem
);
1995 event
.m_item
.SetMask(wxLIST_MASK_TEXT
|
1998 GetItem(event
.m_item
);
2000 // has the focus changed?
2001 if ( !(stOld
& LVIS_FOCUSED
) && (stNew
& LVIS_FOCUSED
) )
2003 eventType
= wxEVT_COMMAND_LIST_ITEM_FOCUSED
;
2004 event
.m_itemIndex
= iItem
;
2007 if ( (stNew
& LVIS_SELECTED
) != (stOld
& LVIS_SELECTED
) )
2009 if ( eventType
!= wxEVT_NULL
)
2011 // focus and selection have both changed: send the
2012 // focus event from here and the selection one
2014 event
.SetEventType(eventType
);
2015 (void)GetEventHandler()->ProcessEvent(event
);
2017 else // no focus event to send
2019 // then need to set m_itemIndex as it wasn't done
2021 event
.m_itemIndex
= iItem
;
2024 eventType
= stNew
& LVIS_SELECTED
2025 ? wxEVT_COMMAND_LIST_ITEM_SELECTED
2026 : wxEVT_COMMAND_LIST_ITEM_DESELECTED
;
2030 if ( eventType
== wxEVT_NULL
)
2032 // not an interesting event for us
2040 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
2041 WORD wVKey
= info
->wVKey
;
2043 // get the current selection
2044 long lItem
= GetNextItem(-1,
2046 wxLIST_STATE_SELECTED
);
2048 // <Enter> or <Space> activate the selected item if any (but
2049 // not with Shift and/or Ctrl as then they have a predefined
2050 // meaning for the list view)
2052 (wVKey
== VK_RETURN
|| wVKey
== VK_SPACE
) &&
2053 !(wxIsShiftDown() || wxIsCtrlDown()) )
2055 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2059 eventType
= wxEVT_COMMAND_LIST_KEY_DOWN
;
2061 // wxCharCodeMSWToWX() returns 0 if the key is an ASCII
2062 // value which should be used as is
2063 int code
= wxCharCodeMSWToWX(wVKey
);
2064 event
.m_code
= code
? code
: wVKey
;
2068 event
.m_item
.m_itemId
= lItem
;
2072 // fill the other fields too
2073 event
.m_item
.m_text
= GetItemText(lItem
);
2074 event
.m_item
.m_data
= GetItemData(lItem
);
2080 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2082 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2087 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
2088 // if it happened on an item (and not on empty place)
2095 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2096 event
.m_itemIndex
= iItem
;
2097 event
.m_item
.m_text
= GetItemText(iItem
);
2098 event
.m_item
.m_data
= GetItemData(iItem
);
2101 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2102 case GN_CONTEXTMENU
:
2103 #endif //__WXWINCE__
2105 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2106 // don't do anything else
2107 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2112 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
2113 LV_HITTESTINFO lvhti
;
2114 wxZeroMemory(lvhti
);
2116 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2117 if(nmhdr
->code
== GN_CONTEXTMENU
) {
2118 lvhti
.pt
= ((NMRGINFO
*)nmhdr
)->ptAction
;
2120 #endif //__WXWINCE__
2121 ::GetCursorPos(&(lvhti
.pt
));
2122 ::ScreenToClient(GetHwnd(),&(lvhti
.pt
));
2123 if ( ListView_HitTest(GetHwnd(),&lvhti
) != -1 )
2125 if ( lvhti
.flags
& LVHT_ONITEM
)
2127 eventType
= wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
;
2128 event
.m_itemIndex
= lvhti
.iItem
;
2129 event
.m_pointDrag
.x
= lvhti
.pt
.x
;
2130 event
.m_pointDrag
.y
= lvhti
.pt
.y
;
2135 #ifdef NM_CUSTOMDRAW
2137 *result
= OnCustomDraw(lParam
);
2140 #endif // _WIN32_IE >= 0x300
2142 case LVN_ODCACHEHINT
:
2144 const NM_CACHEHINT
*cacheHint
= (NM_CACHEHINT
*)lParam
;
2146 eventType
= wxEVT_COMMAND_LIST_CACHE_HINT
;
2148 // we get some really stupid cache hints like ones for
2149 // items in range 0..0 for an empty control or, after
2150 // deleting an item, for items in invalid range -- filter
2152 if ( cacheHint
->iFrom
> cacheHint
->iTo
)
2155 event
.m_oldItemIndex
= cacheHint
->iFrom
;
2157 const long iMax
= GetItemCount();
2158 event
.m_itemIndex
= cacheHint
->iTo
< iMax
? cacheHint
->iTo
2163 #ifdef HAVE_NMLVFINDITEM
2164 case LVN_ODFINDITEM
:
2165 // this message is only used with the virtual list control but
2166 // even there we don't want to always use it: in a control with
2167 // sufficiently big number of items (defined as > 1000 here),
2168 // accidentally pressing a key could result in hanging an
2169 // application waiting while it performs linear search
2170 if ( IsVirtual() && GetItemCount() <= 1000 )
2172 NMLVFINDITEM
* pFindInfo
= (NMLVFINDITEM
*)lParam
;
2174 // no match by default
2177 // we only handle string-based searches here
2179 // TODO: what about LVFI_PARTIAL, should we handle this?
2180 if ( !(pFindInfo
->lvfi
.flags
& LVFI_STRING
) )
2185 const wxChar
* const searchstr
= pFindInfo
->lvfi
.psz
;
2186 const size_t len
= wxStrlen(searchstr
);
2188 // this is the first item we should examine, search from it
2189 // wrapping if necessary
2190 const int startPos
= pFindInfo
->iStart
;
2191 const int maxPos
= GetItemCount();
2192 wxCHECK_MSG( startPos
<= maxPos
, false,
2193 _T("bad starting position in LVN_ODFINDITEM") );
2195 int currentPos
= startPos
;
2198 // wrap to the beginning if necessary
2199 if ( currentPos
== maxPos
)
2201 // somewhat surprizingly, LVFI_WRAP isn't set in
2202 // flags but we still should wrap
2206 // does this item begin with searchstr?
2207 if ( wxStrnicmp(searchstr
,
2208 GetItemText(currentPos
), len
) == 0 )
2210 *result
= currentPos
;
2214 while ( ++currentPos
!= startPos
);
2216 if ( *result
== -1 )
2222 SetItemState(*result
,
2223 wxLIST_STATE_SELECTED
| wxLIST_STATE_FOCUSED
,
2224 wxLIST_STATE_SELECTED
| wxLIST_STATE_FOCUSED
);
2225 EnsureVisible(*result
);
2233 #endif // HAVE_NMLVFINDITEM
2235 case LVN_GETDISPINFO
:
2238 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
2240 LV_ITEM
& lvi
= info
->item
;
2241 long item
= lvi
.iItem
;
2243 if ( lvi
.mask
& LVIF_TEXT
)
2245 wxString text
= OnGetItemText(item
, lvi
.iSubItem
);
2246 wxStrncpy(lvi
.pszText
, text
, lvi
.cchTextMax
);
2249 // see comment at the end of wxListCtrl::GetColumn()
2250 #ifdef NM_CUSTOMDRAW
2251 if ( lvi
.mask
& LVIF_IMAGE
)
2253 lvi
.iImage
= OnGetItemImage(item
);
2255 #endif // NM_CUSTOMDRAW
2257 // a little dose of healthy paranoia: as we never use
2258 // LVM_SETCALLBACKMASK we're not supposed to get these ones
2259 wxASSERT_MSG( !(lvi
.mask
& LVIF_STATE
),
2260 _T("we don't support state callbacks yet!") );
2271 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
2275 // where did this one come from?
2279 // process the event
2280 // -----------------
2282 event
.SetEventType(eventType
);
2284 bool processed
= GetEventHandler()->ProcessEvent(event
);
2288 switch ( nmhdr
->code
)
2290 case LVN_DELETEALLITEMS
:
2291 // always return true to suppress all additional LVN_DELETEITEM
2292 // notifications - this makes deleting all items from a list ctrl
2296 // also, we may free all user data now (couldn't do it before as
2297 // the user should have access to it in OnDeleteAllItems() handler)
2298 FreeAllInternalData();
2300 // the control is empty now, synchronize the cached number of items
2301 // with the real one
2305 case LVN_ENDLABELEDITA
:
2306 case LVN_ENDLABELEDITW
:
2307 // logic here is inverted compared to all the other messages
2308 *result
= event
.IsAllowed();
2310 // don't keep a stale wxTextCtrl around
2313 // EDIT control will be deleted by the list control itself so
2314 // prevent us from deleting it as well
2315 m_textCtrl
->UnsubclassWin();
2316 m_textCtrl
->SetHWND(0);
2325 *result
= !event
.IsAllowed();
2330 // see comment at the end of wxListCtrl::GetColumn()
2331 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2333 WXLPARAM
wxListCtrl::OnCustomDraw(WXLPARAM lParam
)
2335 LPNMLVCUSTOMDRAW lplvcd
= (LPNMLVCUSTOMDRAW
)lParam
;
2336 NMCUSTOMDRAW
& nmcd
= lplvcd
->nmcd
;
2337 switch ( nmcd
.dwDrawStage
)
2340 // if we've got any items with non standard attributes,
2341 // notify us before painting each item
2343 // for virtual controls, always suppose that we have attributes as
2344 // there is no way to check for this
2345 return IsVirtual() || m_hasAnyAttr
? CDRF_NOTIFYITEMDRAW
2348 case CDDS_ITEMPREPAINT
:
2350 size_t item
= (size_t)nmcd
.dwItemSpec
;
2351 if ( item
>= (size_t)GetItemCount() )
2353 // we get this message with item == 0 for an empty control,
2354 // we must ignore it as calling OnGetItemAttr() would be
2356 return CDRF_DODEFAULT
;
2359 wxListItemAttr
*attr
=
2360 IsVirtual() ? OnGetItemAttr(item
)
2361 : wxGetInternalDataAttr(this, item
);
2365 // nothing to do for this item
2366 return CDRF_DODEFAULT
;
2370 wxColour colText
, colBack
;
2371 if ( attr
->HasFont() )
2373 wxFont font
= attr
->GetFont();
2374 hFont
= (HFONT
)font
.GetResourceHandle();
2381 if ( attr
->HasTextColour() )
2383 colText
= attr
->GetTextColour();
2387 colText
= GetTextColour();
2390 if ( attr
->HasBackgroundColour() )
2392 colBack
= attr
->GetBackgroundColour();
2396 colBack
= GetBackgroundColour();
2399 lplvcd
->clrText
= wxColourToRGB(colText
);
2400 lplvcd
->clrTextBk
= wxColourToRGB(colBack
);
2402 // note that if we wanted to set colours for
2403 // individual columns (subitems), we would have
2404 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2407 ::SelectObject(nmcd
.hdc
, hFont
);
2409 return CDRF_NEWFONT
;
2412 // fall through to return CDRF_DODEFAULT
2415 return CDRF_DODEFAULT
;
2419 #endif // NM_CUSTOMDRAW supported
2421 // Necessary for drawing hrules and vrules, if specified
2422 void wxListCtrl::OnPaint(wxPaintEvent
& event
)
2426 wxControl::OnPaint(event
);
2428 // Reset the device origin since it may have been set
2429 dc
.SetDeviceOrigin(0, 0);
2431 bool drawHRules
= HasFlag(wxLC_HRULES
);
2432 bool drawVRules
= HasFlag(wxLC_VRULES
);
2434 if (!InReportView() || !drawHRules
&& !drawVRules
)
2437 wxPen
pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT
), 1, wxSOLID
);
2439 dc
.SetBrush(* wxTRANSPARENT_BRUSH
);
2441 wxSize clientSize
= GetClientSize();
2444 int itemCount
= GetItemCount();
2448 long top
= GetTopItem();
2449 for (i
= top
; i
< top
+ GetCountPerPage() + 1; i
++)
2451 if (GetItemRect(i
, itemRect
))
2453 int cy
= itemRect
.GetTop();
2454 if (i
!= 0) // Don't draw the first one
2456 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2459 if (i
== itemCount
- 1)
2461 cy
= itemRect
.GetBottom();
2462 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2468 if (drawVRules
&& (i
> -1))
2470 wxRect firstItemRect
;
2471 GetItemRect(0, firstItemRect
);
2473 if (GetItemRect(i
, itemRect
))
2476 int x
= itemRect
.GetX();
2477 for (col
= 0; col
< GetColumnCount(); col
++)
2479 int colWidth
= GetColumnWidth(col
);
2481 dc
.DrawLine(x
-1, firstItemRect
.GetY() - 2, x
-1, itemRect
.GetBottom());
2488 wxListCtrl::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
2491 if ( nMsg
== WM_PRINT
)
2493 // we should bypass our own WM_PRINT handling as we don't handle
2494 // PRF_CHILDREN flag, so leave it to the native control itself
2495 return MSWDefWindowProc(nMsg
, wParam
, lParam
);
2499 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
2502 // ----------------------------------------------------------------------------
2503 // virtual list controls
2504 // ----------------------------------------------------------------------------
2506 wxString
wxListCtrl::OnGetItemText(long WXUNUSED(item
), long WXUNUSED(col
)) const
2508 // this is a pure virtual function, in fact - which is not really pure
2509 // because the controls which are not virtual don't need to implement it
2510 wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") );
2512 return wxEmptyString
;
2515 int wxListCtrl::OnGetItemImage(long WXUNUSED(item
)) const
2517 wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL
),
2519 wxT("List control has an image list, OnGetItemImage should be overridden."));
2523 wxListItemAttr
*wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item
)) const
2525 wxASSERT_MSG( item
>= 0 && item
< GetItemCount(),
2526 _T("invalid item index in OnGetItemAttr()") );
2528 // no attributes by default
2532 void wxListCtrl::SetItemCount(long count
)
2534 wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
2536 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT
, (WPARAM
)count
,
2537 LVSICF_NOSCROLL
| LVSICF_NOINVALIDATEALL
) )
2539 wxLogLastError(_T("ListView_SetItemCount"));
2542 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
2543 wxT("m_count should match ListView_GetItemCount"));
2546 void wxListCtrl::RefreshItem(long item
)
2548 // strangely enough, ListView_Update() results in much more flicker here
2549 // than a dumb Refresh() -- why?
2551 if ( !ListView_Update(GetHwnd(), item
) )
2553 wxLogLastError(_T("ListView_Update"));
2557 GetItemRect(item
, rect
);
2562 void wxListCtrl::RefreshItems(long itemFrom
, long itemTo
)
2564 wxRect rect1
, rect2
;
2565 GetItemRect(itemFrom
, rect1
);
2566 GetItemRect(itemTo
, rect2
);
2568 wxRect rect
= rect1
;
2569 rect
.height
= rect2
.GetBottom() - rect1
.GetTop();
2574 // ----------------------------------------------------------------------------
2575 // internal data stuff
2576 // ----------------------------------------------------------------------------
2578 static wxListItemInternalData
*wxGetInternalData(HWND hwnd
, long itemId
)
2581 it
.mask
= LVIF_PARAM
;
2584 if ( !ListView_GetItem(hwnd
, &it
) )
2587 return (wxListItemInternalData
*) it
.lParam
;
2591 wxListItemInternalData
*wxGetInternalData(const wxListCtrl
*ctl
, long itemId
)
2593 return wxGetInternalData(GetHwndOf(ctl
), itemId
);
2596 static wxListItemAttr
*wxGetInternalDataAttr(wxListCtrl
*ctl
, long itemId
)
2598 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2600 return data
? data
->attr
: NULL
;
2603 static void wxDeleteInternalData(wxListCtrl
* ctl
, long itemId
)
2605 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2609 memset(&item
, 0, sizeof(item
));
2610 item
.iItem
= itemId
;
2611 item
.mask
= LVIF_PARAM
;
2612 item
.lParam
= (LPARAM
) 0;
2613 ListView_SetItem((HWND
)ctl
->GetHWND(), &item
);
2618 // ----------------------------------------------------------------------------
2619 // wxWin <-> MSW items conversions
2620 // ----------------------------------------------------------------------------
2622 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
2626 wxListItemInternalData
*internaldata
=
2627 (wxListItemInternalData
*) lvItem
.lParam
;
2630 info
.m_data
= internaldata
->lParam
;
2634 info
.m_stateMask
= 0;
2635 info
.m_itemId
= lvItem
.iItem
;
2637 long oldMask
= lvItem
.mask
;
2639 bool needText
= false;
2640 if (hwndListCtrl
!= 0)
2642 if ( lvItem
.mask
& LVIF_TEXT
)
2649 lvItem
.pszText
= new wxChar
[513];
2650 lvItem
.cchTextMax
= 512;
2652 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
2653 ::SendMessage(hwndListCtrl
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
);
2656 if ( lvItem
.mask
& LVIF_STATE
)
2658 info
.m_mask
|= wxLIST_MASK_STATE
;
2660 if ( lvItem
.stateMask
& LVIS_CUT
)
2662 info
.m_stateMask
|= wxLIST_STATE_CUT
;
2663 if ( lvItem
.state
& LVIS_CUT
)
2664 info
.m_state
|= wxLIST_STATE_CUT
;
2666 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
2668 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
2669 if ( lvItem
.state
& LVIS_DROPHILITED
)
2670 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
2672 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
2674 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
2675 if ( lvItem
.state
& LVIS_FOCUSED
)
2676 info
.m_state
|= wxLIST_STATE_FOCUSED
;
2678 if ( lvItem
.stateMask
& LVIS_SELECTED
)
2680 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
2681 if ( lvItem
.state
& LVIS_SELECTED
)
2682 info
.m_state
|= wxLIST_STATE_SELECTED
;
2686 if ( lvItem
.mask
& LVIF_TEXT
)
2688 info
.m_mask
|= wxLIST_MASK_TEXT
;
2689 info
.m_text
= lvItem
.pszText
;
2691 if ( lvItem
.mask
& LVIF_IMAGE
)
2693 info
.m_mask
|= wxLIST_MASK_IMAGE
;
2694 info
.m_image
= lvItem
.iImage
;
2696 if ( lvItem
.mask
& LVIF_PARAM
)
2697 info
.m_mask
|= wxLIST_MASK_DATA
;
2698 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
2699 info
.m_mask
|= wxLIST_SET_ITEM
;
2700 info
.m_col
= lvItem
.iSubItem
;
2705 delete[] lvItem
.pszText
;
2707 lvItem
.mask
= oldMask
;
2710 static void wxConvertToMSWFlags(long state
, long stateMask
, LV_ITEM
& lvItem
)
2712 if (stateMask
& wxLIST_STATE_CUT
)
2714 lvItem
.stateMask
|= LVIS_CUT
;
2715 if (state
& wxLIST_STATE_CUT
)
2716 lvItem
.state
|= LVIS_CUT
;
2718 if (stateMask
& wxLIST_STATE_DROPHILITED
)
2720 lvItem
.stateMask
|= LVIS_DROPHILITED
;
2721 if (state
& wxLIST_STATE_DROPHILITED
)
2722 lvItem
.state
|= LVIS_DROPHILITED
;
2724 if (stateMask
& wxLIST_STATE_FOCUSED
)
2726 lvItem
.stateMask
|= LVIS_FOCUSED
;
2727 if (state
& wxLIST_STATE_FOCUSED
)
2728 lvItem
.state
|= LVIS_FOCUSED
;
2730 if (stateMask
& wxLIST_STATE_SELECTED
)
2732 lvItem
.stateMask
|= LVIS_SELECTED
;
2733 if (state
& wxLIST_STATE_SELECTED
)
2734 lvItem
.state
|= LVIS_SELECTED
;
2738 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
2739 const wxListItem
& info
,
2742 lvItem
.iItem
= (int) info
.m_itemId
;
2744 lvItem
.iImage
= info
.m_image
;
2745 lvItem
.stateMask
= 0;
2748 lvItem
.iSubItem
= info
.m_col
;
2750 if (info
.m_mask
& wxLIST_MASK_STATE
)
2752 lvItem
.mask
|= LVIF_STATE
;
2754 wxConvertToMSWFlags(info
.m_state
, info
.m_stateMask
, lvItem
);
2757 if (info
.m_mask
& wxLIST_MASK_TEXT
)
2759 lvItem
.mask
|= LVIF_TEXT
;
2760 if ( ctrl
->HasFlag(wxLC_USER_TEXT
) )
2762 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
2766 // pszText is not const, hence the cast
2767 lvItem
.pszText
= (wxChar
*)info
.m_text
.c_str();
2768 if ( lvItem
.pszText
)
2769 lvItem
.cchTextMax
= info
.m_text
.length();
2771 lvItem
.cchTextMax
= 0;
2774 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
2775 lvItem
.mask
|= LVIF_IMAGE
;
2778 static void wxConvertToMSWListCol(int WXUNUSED(col
), const wxListItem
& item
,
2781 wxZeroMemory(lvCol
);
2783 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
2785 lvCol
.mask
|= LVCF_TEXT
;
2786 lvCol
.pszText
= (wxChar
*)item
.m_text
.c_str(); // cast is safe
2789 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
2791 lvCol
.mask
|= LVCF_FMT
;
2793 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
2794 lvCol
.fmt
= LVCFMT_LEFT
;
2795 else if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
2796 lvCol
.fmt
= LVCFMT_RIGHT
;
2797 else if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
2798 lvCol
.fmt
= LVCFMT_CENTER
;
2801 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
2803 lvCol
.mask
|= LVCF_WIDTH
;
2804 if ( item
.m_width
== wxLIST_AUTOSIZE
)
2805 lvCol
.cx
= LVSCW_AUTOSIZE
;
2806 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
2807 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
2809 lvCol
.cx
= item
.m_width
;
2812 // see comment at the end of wxListCtrl::GetColumn()
2813 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2814 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
2816 if ( wxTheApp
->GetComCtl32Version() >= 470 )
2818 lvCol
.mask
|= LVCF_IMAGE
| LVCF_FMT
;
2820 // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right
2821 // seem to be generally nicer than on the left and the generic
2822 // version only draws them on the right (we don't have a flag to
2823 // specify the image location anyhow)
2825 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
2826 // make any difference in my tests -- but maybe we should?
2827 if ( item
.m_image
!= -1 )
2828 lvCol
.fmt
|= LVCFMT_BITMAP_ON_RIGHT
| LVCFMT_IMAGE
;
2830 lvCol
.iImage
= item
.m_image
;
2832 //else: it doesn't support item images anyhow
2834 #endif // _WIN32_IE >= 0x0300
2837 #endif // wxUSE_LISTCTRL