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"
27 #if wxUSE_LISTCTRL && defined(__WIN95__)
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 // for comctl32.dll v 4.70+ we want to have some non default extended
366 // styles because it's prettier (and also because wxGTK does it like this)
367 if ( InReportView() && wxApp::GetComCtl32Version() >= 470 )
369 ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE
,
370 0, LVS_EX_LABELTIP
| LVS_EX_FULLROWSELECT
);
376 WXDWORD
wxListCtrl::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
378 WXDWORD wstyle
= wxControl::MSWGetStyle(style
, exstyle
);
380 wstyle
|= LVS_SHAREIMAGELISTS
| LVS_SHOWSELALWAYS
;
385 #define MAP_MODE_STYLE(wx, ms) \
386 if ( style & (wx) ) { wstyle |= (ms); nModes++; }
387 #else // !__WXDEBUG__
388 #define MAP_MODE_STYLE(wx, ms) \
389 if ( style & (wx) ) wstyle |= (ms);
390 #endif // __WXDEBUG__
392 MAP_MODE_STYLE(wxLC_ICON
, LVS_ICON
)
393 MAP_MODE_STYLE(wxLC_SMALL_ICON
, LVS_SMALLICON
)
394 MAP_MODE_STYLE(wxLC_LIST
, LVS_LIST
)
395 MAP_MODE_STYLE(wxLC_REPORT
, LVS_REPORT
)
397 wxASSERT_MSG( nModes
== 1,
398 _T("wxListCtrl style should have exactly one mode bit set") );
400 #undef MAP_MODE_STYLE
402 if ( style
& wxLC_ALIGN_LEFT
)
403 wstyle
|= LVS_ALIGNLEFT
;
405 if ( style
& wxLC_ALIGN_TOP
)
406 wstyle
|= LVS_ALIGNTOP
;
408 if ( style
& wxLC_AUTOARRANGE
)
409 wstyle
|= LVS_AUTOARRANGE
;
411 if ( style
& wxLC_NO_SORT_HEADER
)
412 wstyle
|= LVS_NOSORTHEADER
;
414 if ( style
& wxLC_NO_HEADER
)
415 wstyle
|= LVS_NOCOLUMNHEADER
;
417 if ( style
& wxLC_EDIT_LABELS
)
418 wstyle
|= LVS_EDITLABELS
;
420 if ( style
& wxLC_SINGLE_SEL
)
421 wstyle
|= LVS_SINGLESEL
;
423 if ( style
& wxLC_SORT_ASCENDING
)
425 wstyle
|= LVS_SORTASCENDING
;
427 wxASSERT_MSG( !(style
& wxLC_SORT_DESCENDING
),
428 _T("can't sort in ascending and descending orders at once") );
430 else if ( style
& wxLC_SORT_DESCENDING
)
431 wstyle
|= LVS_SORTDESCENDING
;
433 #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
434 if ( style
& wxLC_VIRTUAL
)
436 int ver
= wxApp::GetComCtl32Version();
439 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."),
440 ver
/ 100, ver
% 100);
443 wstyle
|= LVS_OWNERDATA
;
445 #endif // ancient cygwin
450 void wxListCtrl::UpdateStyle()
454 // The new window view style
455 DWORD dwStyleNew
= MSWGetStyle(m_windowStyle
, NULL
);
457 // some styles are not returned by MSWGetStyle()
459 dwStyleNew
|= WS_VISIBLE
;
461 // Get the current window style.
462 DWORD dwStyleOld
= ::GetWindowLong(GetHwnd(), GWL_STYLE
);
464 // we don't have wxVSCROLL style, but the list control may have it,
465 // don't change it then
466 dwStyleNew
|= dwStyleOld
& (WS_HSCROLL
| WS_VSCROLL
);
468 // Only set the window style if the view bits have changed.
469 if ( dwStyleOld
!= dwStyleNew
)
471 ::SetWindowLong(GetHwnd(), GWL_STYLE
, dwStyleNew
);
476 void wxListCtrl::FreeAllInternalData()
478 if (m_AnyInternalData
)
480 int n
= GetItemCount();
482 m_ignoreChangeMessages
= true;
483 for (int i
= 0; i
< n
; i
++)
484 wxDeleteInternalData(this, i
);
485 m_ignoreChangeMessages
= false;
487 m_AnyInternalData
= false;
491 wxListCtrl::~wxListCtrl()
493 FreeAllInternalData();
497 m_textCtrl
->UnsubclassWin();
498 m_textCtrl
->SetHWND(0);
503 if (m_ownsImageListNormal
)
504 delete m_imageListNormal
;
505 if (m_ownsImageListSmall
)
506 delete m_imageListSmall
;
507 if (m_ownsImageListState
)
508 delete m_imageListState
;
511 // ----------------------------------------------------------------------------
512 // set/get/change style
513 // ----------------------------------------------------------------------------
515 // Add or remove a single window style
516 void wxListCtrl::SetSingleStyle(long style
, bool add
)
518 long flag
= GetWindowStyleFlag();
520 // Get rid of conflicting styles
523 if ( style
& wxLC_MASK_TYPE
)
524 flag
= flag
& ~wxLC_MASK_TYPE
;
525 if ( style
& wxLC_MASK_ALIGN
)
526 flag
= flag
& ~wxLC_MASK_ALIGN
;
527 if ( style
& wxLC_MASK_SORT
)
528 flag
= flag
& ~wxLC_MASK_SORT
;
536 SetWindowStyleFlag(flag
);
539 // Set the whole window style
540 void wxListCtrl::SetWindowStyleFlag(long flag
)
542 if ( flag
!= m_windowStyle
)
544 m_windowStyle
= flag
;
552 // ----------------------------------------------------------------------------
554 // ----------------------------------------------------------------------------
556 /* static */ wxVisualAttributes
557 wxListCtrl::GetClassDefaultAttributes(wxWindowVariant variant
)
559 wxVisualAttributes attrs
= GetCompositeControlsDefaultAttributes(variant
);
561 // common controls have their own default font
562 attrs
.font
= wxGetCCDefaultFont();
567 // Sets the foreground, i.e. text, colour
568 bool wxListCtrl::SetForegroundColour(const wxColour
& col
)
570 if ( !wxWindow::SetForegroundColour(col
) )
573 ListView_SetTextColor(GetHwnd(), wxColourToRGB(col
));
578 // Sets the background colour
579 bool wxListCtrl::SetBackgroundColour(const wxColour
& col
)
581 if ( !wxWindow::SetBackgroundColour(col
) )
584 // we set the same colour for both the "empty" background and the items
586 COLORREF color
= wxColourToRGB(col
);
587 ListView_SetBkColor(GetHwnd(), color
);
588 ListView_SetTextBkColor(GetHwnd(), color
);
593 // Gets information about this column
594 bool wxListCtrl::GetColumn(int col
, wxListItem
& item
) const
599 lvCol
.mask
= LVCF_WIDTH
;
601 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
603 lvCol
.mask
|= LVCF_TEXT
;
604 lvCol
.pszText
= new wxChar
[513];
605 lvCol
.cchTextMax
= 512;
608 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
610 lvCol
.mask
|= LVCF_FMT
;
613 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
615 lvCol
.mask
|= LVCF_IMAGE
;
618 bool success
= ListView_GetColumn(GetHwnd(), col
, &lvCol
) != 0;
620 // item.m_subItem = lvCol.iSubItem;
621 item
.m_width
= lvCol
.cx
;
623 if ( (item
.m_mask
& wxLIST_MASK_TEXT
) && lvCol
.pszText
)
625 item
.m_text
= lvCol
.pszText
;
626 delete[] lvCol
.pszText
;
629 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
631 switch (lvCol
.fmt
& LVCFMT_JUSTIFYMASK
) {
633 item
.m_format
= wxLIST_FORMAT_LEFT
;
636 item
.m_format
= wxLIST_FORMAT_RIGHT
;
639 item
.m_format
= wxLIST_FORMAT_CENTRE
;
642 item
.m_format
= -1; // Unknown?
647 // the column images were not supported in older versions but how to check
648 // for this? we can't use _WIN32_IE because we always define it to a very
649 // high value, so see if another symbol which is only defined starting from
650 // comctl32.dll 4.70 is available
651 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
652 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
654 item
.m_image
= lvCol
.iImage
;
656 #endif // LVCOLUMN::iImage exists
661 // Sets information about this column
662 bool wxListCtrl::SetColumn(int col
, const wxListItem
& item
)
665 wxConvertToMSWListCol(col
, item
, lvCol
);
667 return ListView_SetColumn(GetHwnd(), col
, &lvCol
) != 0;
670 // Gets the column width
671 int wxListCtrl::GetColumnWidth(int col
) const
673 return ListView_GetColumnWidth(GetHwnd(), col
);
676 // Sets the column width
677 bool wxListCtrl::SetColumnWidth(int col
, int width
)
679 if ( m_windowStyle
& wxLC_LIST
)
682 if ( width
== wxLIST_AUTOSIZE
)
683 width
= LVSCW_AUTOSIZE
;
684 else if ( width
== wxLIST_AUTOSIZE_USEHEADER
)
685 width
= LVSCW_AUTOSIZE_USEHEADER
;
687 return ListView_SetColumnWidth(GetHwnd(), col
, width
) != 0;
690 // Gets the number of items that can fit vertically in the
691 // visible area of the list control (list or report view)
692 // or the total number of items in the list control (icon
693 // or small icon view)
694 int wxListCtrl::GetCountPerPage() const
696 return ListView_GetCountPerPage(GetHwnd());
699 // Gets the edit control for editing labels.
700 wxTextCtrl
* wxListCtrl::GetEditControl() const
705 // Gets information about the item
706 bool wxListCtrl::GetItem(wxListItem
& info
) const
709 wxZeroMemory(lvItem
);
711 lvItem
.iItem
= info
.m_itemId
;
712 lvItem
.iSubItem
= info
.m_col
;
714 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
716 lvItem
.mask
|= LVIF_TEXT
;
717 lvItem
.pszText
= new wxChar
[513];
718 lvItem
.cchTextMax
= 512;
722 lvItem
.pszText
= NULL
;
725 if (info
.m_mask
& wxLIST_MASK_DATA
)
726 lvItem
.mask
|= LVIF_PARAM
;
728 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
729 lvItem
.mask
|= LVIF_IMAGE
;
731 if ( info
.m_mask
& wxLIST_MASK_STATE
)
733 lvItem
.mask
|= LVIF_STATE
;
734 wxConvertToMSWFlags(0, info
.m_stateMask
, lvItem
);
737 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
740 wxLogError(_("Couldn't retrieve information about list control item %d."),
745 // give NULL as hwnd as we already have everything we need
746 wxConvertFromMSWListItem(NULL
, info
, lvItem
);
750 delete[] lvItem
.pszText
;
755 // Sets information about the item
756 bool wxListCtrl::SetItem(wxListItem
& info
)
759 wxConvertToMSWListItem(this, info
, item
);
761 // we never update the lParam if it contains our pointer
762 // to the wxListItemInternalData structure
763 item
.mask
&= ~LVIF_PARAM
;
765 // check if setting attributes or lParam
766 if (info
.HasAttributes() || (info
.m_mask
& wxLIST_MASK_DATA
))
768 // get internal item data
769 // perhaps a cache here ?
770 wxListItemInternalData
*data
= wxGetInternalData(this, info
.m_itemId
);
775 m_AnyInternalData
= true;
776 data
= new wxListItemInternalData();
777 item
.lParam
= (LPARAM
) data
;
778 item
.mask
|= LVIF_PARAM
;
783 if (info
.m_mask
& wxLIST_MASK_DATA
)
784 data
->lParam
= info
.m_data
;
787 if (info
.HasAttributes())
790 *data
->attr
= *info
.GetAttributes();
792 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
797 // we could be changing only the attribute in which case we don't need to
798 // call ListView_SetItem() at all
802 if ( !ListView_SetItem(GetHwnd(), &item
) )
804 wxLogDebug(_T("ListView_SetItem() failed"));
810 // we need to update the item immediately to show the new image
811 bool updateNow
= (info
.m_mask
& wxLIST_MASK_IMAGE
) != 0;
813 // check whether it has any custom attributes
814 if ( info
.HasAttributes() )
818 // if the colour has changed, we must redraw the item
824 // we need this to make the change visible right now
825 RefreshItem(item
.iItem
);
831 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
835 info
.m_mask
= wxLIST_MASK_TEXT
;
836 info
.m_itemId
= index
;
840 info
.m_image
= imageId
;
841 info
.m_mask
|= wxLIST_MASK_IMAGE
;
843 return SetItem(info
);
847 // Gets the item state
848 int wxListCtrl::GetItemState(long item
, long stateMask
) const
852 info
.m_mask
= wxLIST_MASK_STATE
;
853 info
.m_stateMask
= stateMask
;
854 info
.m_itemId
= item
;
862 // Sets the item state
863 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
865 // NB: don't use SetItem() here as it doesn't work with the virtual list
868 wxZeroMemory(lvItem
);
870 wxConvertToMSWFlags(state
, stateMask
, lvItem
);
872 // for the virtual list controls we need to refresh the previously focused
873 // item manually when changing focus without changing selection
874 // programmatically because otherwise it keeps its focus rectangle until
875 // next repaint (yet another comctl32 bug)
878 (stateMask
& wxLIST_STATE_FOCUSED
) &&
879 (state
& wxLIST_STATE_FOCUSED
) )
881 focusOld
= GetNextItem(-1, wxLIST_NEXT_ALL
, wxLIST_STATE_FOCUSED
);
888 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE
,
889 (WPARAM
)item
, (LPARAM
)&lvItem
) )
891 wxLogLastError(_T("ListView_SetItemState"));
896 if ( focusOld
!= -1 )
898 // no need to refresh the item if it was previously selected, it would
899 // only result in annoying flicker
900 if ( !(GetItemState(focusOld
,
901 wxLIST_STATE_SELECTED
) & wxLIST_STATE_SELECTED
) )
903 RefreshItem(focusOld
);
910 // Sets the item image
911 bool wxListCtrl::SetItemImage(long item
, int image
, int WXUNUSED(selImage
))
915 info
.m_mask
= wxLIST_MASK_IMAGE
;
916 info
.m_image
= image
;
917 info
.m_itemId
= item
;
919 return SetItem(info
);
922 // Gets the item text
923 wxString
wxListCtrl::GetItemText(long item
) const
927 info
.m_mask
= wxLIST_MASK_TEXT
;
928 info
.m_itemId
= item
;
931 return wxEmptyString
;
935 // Sets the item text
936 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
940 info
.m_mask
= wxLIST_MASK_TEXT
;
941 info
.m_itemId
= item
;
947 // Gets the item data
948 wxUIntPtr
wxListCtrl::GetItemData(long item
) const
952 info
.m_mask
= wxLIST_MASK_DATA
;
953 info
.m_itemId
= item
;
960 // Sets the item data
961 bool wxListCtrl::SetItemData(long item
, long data
)
965 info
.m_mask
= wxLIST_MASK_DATA
;
966 info
.m_itemId
= item
;
969 return SetItem(info
);
972 wxRect
wxListCtrl::GetViewRect() const
974 wxASSERT_MSG( !HasFlag(wxLC_REPORT
| wxLC_LIST
),
975 _T("wxListCtrl::GetViewRect() only works in icon mode") );
978 if ( !ListView_GetViewRect(GetHwnd(), &rc
) )
980 wxLogDebug(_T("ListView_GetViewRect() failed."));
986 wxCopyRECTToRect(rc
, rect
);
991 // Gets the item rectangle
992 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
997 if ( code
== wxLIST_RECT_BOUNDS
)
998 codeWin
= LVIR_BOUNDS
;
999 else if ( code
== wxLIST_RECT_ICON
)
1000 codeWin
= LVIR_ICON
;
1001 else if ( code
== wxLIST_RECT_LABEL
)
1002 codeWin
= LVIR_LABEL
;
1005 wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
1007 codeWin
= LVIR_BOUNDS
;
1010 bool success
= ListView_GetItemRect(GetHwnd(), (int) item
, &rectWin
, codeWin
) != 0;
1012 rect
.x
= rectWin
.left
;
1013 rect
.y
= rectWin
.top
;
1014 rect
.width
= rectWin
.right
- rectWin
.left
;
1015 rect
.height
= rectWin
.bottom
- rectWin
.top
;
1020 // Gets the item position
1021 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
1025 bool success
= (ListView_GetItemPosition(GetHwnd(), (int) item
, &pt
) != 0);
1027 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
1031 // Sets the item position.
1032 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
1034 return (ListView_SetItemPosition(GetHwnd(), (int) item
, pos
.x
, pos
.y
) != 0);
1037 // Gets the number of items in the list control
1038 int wxListCtrl::GetItemCount() const
1043 wxSize
wxListCtrl::GetItemSpacing() const
1045 const int spacing
= ListView_GetItemSpacing(GetHwnd(), (BOOL
)HasFlag(wxLC_SMALL_ICON
));
1047 return wxSize(LOWORD(spacing
), HIWORD(spacing
));
1050 int wxListCtrl::GetItemSpacing(bool isSmall
) const
1052 return ListView_GetItemSpacing(GetHwnd(), (BOOL
) isSmall
);
1055 void wxListCtrl::SetItemTextColour( long item
, const wxColour
&col
)
1058 info
.m_itemId
= item
;
1059 info
.SetTextColour( col
);
1063 wxColour
wxListCtrl::GetItemTextColour( long item
) const
1066 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1067 if ( data
&& data
->attr
)
1068 col
= data
->attr
->GetTextColour();
1073 void wxListCtrl::SetItemBackgroundColour( long item
, const wxColour
&col
)
1076 info
.m_itemId
= item
;
1077 info
.SetBackgroundColour( col
);
1081 wxColour
wxListCtrl::GetItemBackgroundColour( long item
) const
1084 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1085 if ( data
&& data
->attr
)
1086 col
= data
->attr
->GetBackgroundColour();
1091 void wxListCtrl::SetItemFont( long item
, const wxFont
&f
)
1094 info
.m_itemId
= item
;
1099 wxFont
wxListCtrl::GetItemFont( long item
) const
1102 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1103 if ( data
&& data
->attr
)
1104 f
= data
->attr
->GetFont();
1109 // Gets the number of selected items in the list control
1110 int wxListCtrl::GetSelectedItemCount() const
1112 return ListView_GetSelectedCount(GetHwnd());
1115 // Gets the text colour of the listview
1116 wxColour
wxListCtrl::GetTextColour() const
1118 // Use GetDefaultAttributes instead of ListView_GetTextColor because
1119 // the latter seems to return black all the time (instead of the theme color)
1120 return GetDefaultAttributes().colFg
;
1123 // Sets the text colour of the listview
1124 void wxListCtrl::SetTextColour(const wxColour
& col
)
1126 ListView_SetTextColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
1129 // Gets the index of the topmost visible item when in
1130 // list or report view
1131 long wxListCtrl::GetTopItem() const
1133 return (long) ListView_GetTopIndex(GetHwnd());
1136 // Searches for an item, starting from 'item'.
1137 // 'geometry' is one of
1138 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1139 // 'state' is a state bit flag, one or more of
1140 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1141 // item can be -1 to find the first item that matches the
1143 // Returns the item or -1 if unsuccessful.
1144 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
1148 if ( geom
== wxLIST_NEXT_ABOVE
)
1149 flags
|= LVNI_ABOVE
;
1150 if ( geom
== wxLIST_NEXT_ALL
)
1152 if ( geom
== wxLIST_NEXT_BELOW
)
1153 flags
|= LVNI_BELOW
;
1154 if ( geom
== wxLIST_NEXT_LEFT
)
1155 flags
|= LVNI_TOLEFT
;
1156 if ( geom
== wxLIST_NEXT_RIGHT
)
1157 flags
|= LVNI_TORIGHT
;
1159 if ( state
& wxLIST_STATE_CUT
)
1161 if ( state
& wxLIST_STATE_DROPHILITED
)
1162 flags
|= LVNI_DROPHILITED
;
1163 if ( state
& wxLIST_STATE_FOCUSED
)
1164 flags
|= LVNI_FOCUSED
;
1165 if ( state
& wxLIST_STATE_SELECTED
)
1166 flags
|= LVNI_SELECTED
;
1168 return (long) ListView_GetNextItem(GetHwnd(), item
, flags
);
1172 wxImageList
*wxListCtrl::GetImageList(int which
) const
1174 if ( which
== wxIMAGE_LIST_NORMAL
)
1176 return m_imageListNormal
;
1178 else if ( which
== wxIMAGE_LIST_SMALL
)
1180 return m_imageListSmall
;
1182 else if ( which
== wxIMAGE_LIST_STATE
)
1184 return m_imageListState
;
1189 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
1192 if ( which
== wxIMAGE_LIST_NORMAL
)
1194 flags
= LVSIL_NORMAL
;
1195 if (m_ownsImageListNormal
) delete m_imageListNormal
;
1196 m_imageListNormal
= imageList
;
1197 m_ownsImageListNormal
= false;
1199 else if ( which
== wxIMAGE_LIST_SMALL
)
1201 flags
= LVSIL_SMALL
;
1202 if (m_ownsImageListSmall
) delete m_imageListSmall
;
1203 m_imageListSmall
= imageList
;
1204 m_ownsImageListSmall
= false;
1206 else if ( which
== wxIMAGE_LIST_STATE
)
1208 flags
= LVSIL_STATE
;
1209 if (m_ownsImageListState
) delete m_imageListState
;
1210 m_imageListState
= imageList
;
1211 m_ownsImageListState
= false;
1213 ListView_SetImageList(GetHwnd(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
1216 void wxListCtrl::AssignImageList(wxImageList
*imageList
, int which
)
1218 SetImageList(imageList
, which
);
1219 if ( which
== wxIMAGE_LIST_NORMAL
)
1220 m_ownsImageListNormal
= true;
1221 else if ( which
== wxIMAGE_LIST_SMALL
)
1222 m_ownsImageListSmall
= true;
1223 else if ( which
== wxIMAGE_LIST_STATE
)
1224 m_ownsImageListState
= true;
1227 // ----------------------------------------------------------------------------
1229 // ----------------------------------------------------------------------------
1231 // Arranges the items
1232 bool wxListCtrl::Arrange(int flag
)
1235 if ( flag
== wxLIST_ALIGN_LEFT
)
1236 code
= LVA_ALIGNLEFT
;
1237 else if ( flag
== wxLIST_ALIGN_TOP
)
1238 code
= LVA_ALIGNTOP
;
1239 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
1241 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
1242 code
= LVA_SNAPTOGRID
;
1244 return (ListView_Arrange(GetHwnd(), code
) != 0);
1248 bool wxListCtrl::DeleteItem(long item
)
1250 if ( !ListView_DeleteItem(GetHwnd(), (int) item
) )
1252 wxLogLastError(_T("ListView_DeleteItem"));
1257 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1258 wxT("m_count should match ListView_GetItemCount"));
1260 // the virtual list control doesn't refresh itself correctly, help it
1263 // we need to refresh all the lines below the one which was deleted
1265 if ( item
> 0 && GetItemCount() )
1267 GetItemRect(item
- 1, rectItem
);
1272 rectItem
.height
= 0;
1275 wxRect rectWin
= GetRect();
1276 rectWin
.height
= rectWin
.GetBottom() - rectItem
.GetBottom();
1277 rectWin
.y
= rectItem
.GetBottom();
1279 RefreshRect(rectWin
);
1285 // Deletes all items
1286 bool wxListCtrl::DeleteAllItems()
1288 return ListView_DeleteAllItems(GetHwnd()) != 0;
1291 // Deletes all items
1292 bool wxListCtrl::DeleteAllColumns()
1294 while ( m_colCount
> 0 )
1296 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1298 wxLogLastError(wxT("ListView_DeleteColumn"));
1306 wxASSERT_MSG( m_colCount
== 0, wxT("no columns should be left") );
1312 bool wxListCtrl::DeleteColumn(int col
)
1314 bool success
= (ListView_DeleteColumn(GetHwnd(), col
) != 0);
1316 if ( success
&& (m_colCount
> 0) )
1321 // Clears items, and columns if there are any.
1322 void wxListCtrl::ClearAll()
1325 if ( m_colCount
> 0 )
1329 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
1331 wxASSERT( (textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
))) );
1333 // ListView_EditLabel requires that the list has focus.
1336 WXHWND hWnd
= (WXHWND
) ListView_EditLabel(GetHwnd(), item
);
1339 // failed to start editing
1343 // [re]create the text control wrapping the HWND we got
1346 m_textCtrl
->UnsubclassWin();
1347 m_textCtrl
->SetHWND(0);
1351 m_textCtrl
= (wxTextCtrl
*)textControlClass
->CreateObject();
1352 m_textCtrl
->SetHWND(hWnd
);
1353 m_textCtrl
->SubclassWin(hWnd
);
1354 m_textCtrl
->SetParent(this);
1356 // we must disallow TABbing away from the control while the edit contol is
1357 // shown because this leaves it in some strange state (just try removing
1358 // this line and then pressing TAB while editing an item in listctrl
1360 m_textCtrl
->SetWindowStyle(m_textCtrl
->GetWindowStyle() | wxTE_PROCESS_TAB
);
1365 // End label editing, optionally cancelling the edit
1366 bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel
))
1368 wxFAIL_MSG( _T("not implemented") );
1373 // Ensures this item is visible
1374 bool wxListCtrl::EnsureVisible(long item
)
1376 return ListView_EnsureVisible(GetHwnd(), (int) item
, FALSE
) != FALSE
;
1379 // Find an item whose label matches this string, starting from the item after 'start'
1380 // or the beginning if 'start' is -1.
1381 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
1383 LV_FINDINFO findInfo
;
1385 findInfo
.flags
= LVFI_STRING
;
1387 findInfo
.flags
|= LVFI_PARTIAL
;
1390 // ListView_FindItem() excludes the first item from search and to look
1391 // through all the items you need to start from -1 which is unnatural and
1392 // inconsistent with the generic version - so we adjust the index
1395 return ListView_FindItem(GetHwnd(), (int) start
, &findInfo
);
1398 // Find an item whose data matches this data, starting from the item after 'start'
1399 // or the beginning if 'start' is -1.
1400 // NOTE : Lindsay Mathieson - 14-July-2002
1401 // No longer use ListView_FindItem as the data attribute is now stored
1402 // in a wxListItemInternalData structure refernced by the actual lParam
1403 long wxListCtrl::FindItem(long start
, wxUIntPtr data
)
1405 long idx
= start
+ 1;
1406 long count
= GetItemCount();
1410 if (GetItemData(idx
) == data
)
1418 // Find an item nearest this position in the specified direction, starting from
1419 // the item after 'start' or the beginning if 'start' is -1.
1420 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
1422 LV_FINDINFO findInfo
;
1424 findInfo
.flags
= LVFI_NEARESTXY
;
1425 findInfo
.pt
.x
= pt
.x
;
1426 findInfo
.pt
.y
= pt
.y
;
1427 findInfo
.vkDirection
= VK_RIGHT
;
1429 if ( direction
== wxLIST_FIND_UP
)
1430 findInfo
.vkDirection
= VK_UP
;
1431 else if ( direction
== wxLIST_FIND_DOWN
)
1432 findInfo
.vkDirection
= VK_DOWN
;
1433 else if ( direction
== wxLIST_FIND_LEFT
)
1434 findInfo
.vkDirection
= VK_LEFT
;
1435 else if ( direction
== wxLIST_FIND_RIGHT
)
1436 findInfo
.vkDirection
= VK_RIGHT
;
1438 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
1441 // Determines which item (if any) is at the specified point,
1442 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1443 long wxListCtrl::HitTest(const wxPoint
& point
, int& flags
)
1445 LV_HITTESTINFO hitTestInfo
;
1446 hitTestInfo
.pt
.x
= (int) point
.x
;
1447 hitTestInfo
.pt
.y
= (int) point
.y
;
1449 ListView_HitTest(GetHwnd(), & hitTestInfo
);
1453 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
1454 flags
|= wxLIST_HITTEST_ABOVE
;
1455 if ( hitTestInfo
.flags
& LVHT_BELOW
)
1456 flags
|= wxLIST_HITTEST_BELOW
;
1457 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
1458 flags
|= wxLIST_HITTEST_TOLEFT
;
1459 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
1460 flags
|= wxLIST_HITTEST_TORIGHT
;
1462 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
1463 flags
|= wxLIST_HITTEST_NOWHERE
;
1465 // note a bug or at least a very strange feature of comtl32.dll (tested
1466 // with version 4.0 under Win95 and 6.0 under Win 2003): if you click to
1467 // the right of the item label, ListView_HitTest() returns a combination of
1468 // LVHT_ONITEMICON, LVHT_ONITEMLABEL and LVHT_ONITEMSTATEICON -- filter out
1469 // the bits which don't make sense
1470 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
1472 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
1474 // do not translate LVHT_ONITEMICON here, as per above
1478 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
1479 flags
|= wxLIST_HITTEST_ONITEMICON
;
1480 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
1481 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
1484 return (long) hitTestInfo
.iItem
;
1487 // Inserts an item, returning the index of the new item if successful,
1489 long wxListCtrl::InsertItem(const wxListItem
& info
)
1491 wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
1494 wxConvertToMSWListItem(this, info
, item
);
1495 item
.mask
&= ~LVIF_PARAM
;
1497 // check wether we need to allocate our internal data
1498 bool needInternalData
= ((info
.m_mask
& wxLIST_MASK_DATA
) || info
.HasAttributes());
1499 if (needInternalData
)
1501 m_AnyInternalData
= true;
1502 item
.mask
|= LVIF_PARAM
;
1504 // internal stucture that manages data
1505 wxListItemInternalData
*data
= new wxListItemInternalData();
1506 item
.lParam
= (LPARAM
) data
;
1508 if (info
.m_mask
& wxLIST_MASK_DATA
)
1509 data
->lParam
= info
.m_data
;
1511 // check whether it has any custom attributes
1512 if ( info
.HasAttributes() )
1514 // take copy of attributes
1515 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
1517 // and remember that we have some now...
1518 m_hasAnyAttr
= true;
1522 long rv
= ListView_InsertItem(GetHwnd(), & item
);
1525 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1526 wxT("m_count should match ListView_GetItemCount"));
1531 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1534 info
.m_text
= label
;
1535 info
.m_mask
= wxLIST_MASK_TEXT
;
1536 info
.m_itemId
= index
;
1537 return InsertItem(info
);
1540 // Inserts an image item
1541 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1544 info
.m_image
= imageIndex
;
1545 info
.m_mask
= wxLIST_MASK_IMAGE
;
1546 info
.m_itemId
= index
;
1547 return InsertItem(info
);
1550 // Inserts an image/string item
1551 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1554 info
.m_image
= imageIndex
;
1555 info
.m_text
= label
;
1556 info
.m_mask
= wxLIST_MASK_IMAGE
| wxLIST_MASK_TEXT
;
1557 info
.m_itemId
= index
;
1558 return InsertItem(info
);
1561 // For list view mode (only), inserts a column.
1562 long wxListCtrl::InsertColumn(long col
, const wxListItem
& item
)
1565 wxConvertToMSWListCol(col
, item
, lvCol
);
1567 if ( !(lvCol
.mask
& LVCF_WIDTH
) )
1569 // always give some width to the new column: this one is compatible
1570 // with the generic version
1571 lvCol
.mask
|= LVCF_WIDTH
;
1575 long n
= ListView_InsertColumn(GetHwnd(), col
, &lvCol
);
1580 else // failed to insert?
1582 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1589 long wxListCtrl::InsertColumn(long col
,
1590 const wxString
& heading
,
1595 item
.m_mask
= wxLIST_MASK_TEXT
| wxLIST_MASK_FORMAT
;
1596 item
.m_text
= heading
;
1599 item
.m_mask
|= wxLIST_MASK_WIDTH
;
1600 item
.m_width
= width
;
1602 item
.m_format
= format
;
1604 return InsertColumn(col
, item
);
1607 // scroll the control by the given number of pixels (exception: in list view,
1608 // dx is interpreted as number of columns)
1609 bool wxListCtrl::ScrollList(int dx
, int dy
)
1611 if ( !ListView_Scroll(GetHwnd(), dx
, dy
) )
1613 wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx
, dy
);
1623 // fn is a function which takes 3 long arguments: item1, item2, data.
1624 // item1 is the long data associated with a first item (NOT the index).
1625 // item2 is the long data associated with a second item (NOT the index).
1626 // data is the same value as passed to SortItems.
1627 // The return value is a negative number if the first item should precede the second
1628 // item, a positive number of the second item should precede the first,
1629 // or zero if the two items are equivalent.
1631 // data is arbitrary data to be passed to the sort function.
1633 // Internal structures for proxying the user compare function
1634 // so that we can pass it the *real* user data
1636 // translate lParam data and call user func
1637 struct wxInternalDataSort
1639 wxListCtrlCompare user_fn
;
1643 int CALLBACK
wxInternalDataCompareFunc(LPARAM lParam1
, LPARAM lParam2
, LPARAM lParamSort
)
1645 struct wxInternalDataSort
*internalData
= (struct wxInternalDataSort
*) lParamSort
;
1647 wxListItemInternalData
*data1
= (wxListItemInternalData
*) lParam1
;
1648 wxListItemInternalData
*data2
= (wxListItemInternalData
*) lParam2
;
1650 long d1
= (data1
== NULL
? 0 : data1
->lParam
);
1651 long d2
= (data2
== NULL
? 0 : data2
->lParam
);
1653 return internalData
->user_fn(d1
, d2
, internalData
->data
);
1657 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, long data
)
1659 struct wxInternalDataSort internalData
;
1660 internalData
.user_fn
= fn
;
1661 internalData
.data
= data
;
1663 // WPARAM cast is needed for mingw/cygwin
1664 if ( !ListView_SortItems(GetHwnd(),
1665 wxInternalDataCompareFunc
,
1666 (WPARAM
) &internalData
) )
1668 wxLogDebug(_T("ListView_SortItems() failed"));
1678 // ----------------------------------------------------------------------------
1679 // message processing
1680 // ----------------------------------------------------------------------------
1682 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1684 if (cmd
== EN_UPDATE
)
1686 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1687 event
.SetEventObject( this );
1688 ProcessCommand(event
);
1691 else if (cmd
== EN_KILLFOCUS
)
1693 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1694 event
.SetEventObject( this );
1695 ProcessCommand(event
);
1702 bool wxListCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
1705 // prepare the event
1706 // -----------------
1708 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1709 event
.SetEventObject(this);
1711 wxEventType eventType
= wxEVT_NULL
;
1713 NMHDR
*nmhdr
= (NMHDR
*)lParam
;
1715 // if your compiler is as broken as this, you should really change it: this
1716 // code is needed for normal operation! #ifdef below is only useful for
1717 // automatic rebuilds which are done with a very old compiler version
1718 #ifdef HDN_BEGINTRACKA
1720 // check for messages from the header (in report view)
1721 HWND hwndHdr
= ListView_GetHeader(GetHwnd());
1723 // is it a message from the header?
1724 if ( nmhdr
->hwndFrom
== hwndHdr
)
1726 HD_NOTIFY
*nmHDR
= (HD_NOTIFY
*)nmhdr
;
1728 event
.m_itemIndex
= -1;
1730 switch ( nmhdr
->code
)
1732 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1733 // TRACK messages even to ANSI programs: on my system I get
1734 // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all!
1736 // work around is to simply catch both versions and hope that it
1737 // works (why should this message exist in ANSI and Unicode is
1738 // beyond me as it doesn't deal with strings at all...)
1740 // note that fr HDN_TRACK another possibility could be to use
1741 // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when
1742 // something other than the item width changes so we'd have to
1743 // filter out the unwanted events then
1744 case HDN_BEGINTRACKA
:
1745 case HDN_BEGINTRACKW
:
1746 eventType
= wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
;
1751 if ( eventType
== wxEVT_NULL
)
1752 eventType
= wxEVT_COMMAND_LIST_COL_DRAGGING
;
1757 if ( eventType
== wxEVT_NULL
)
1758 eventType
= wxEVT_COMMAND_LIST_COL_END_DRAG
;
1760 event
.m_item
.m_width
= nmHDR
->pitem
->cxy
;
1761 event
.m_col
= nmHDR
->iItem
;
1764 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1765 case GN_CONTEXTMENU
:
1766 #endif //__WXWINCE__
1769 eventType
= wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
;
1772 // find the column clicked: we have to search for it
1773 // ourselves as the notification message doesn't provide
1776 // where did the click occur?
1778 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1779 if(nmhdr
->code
== GN_CONTEXTMENU
) {
1780 ptClick
= ((NMRGINFO
*)nmhdr
)->ptAction
;
1782 #endif //__WXWINCE__
1783 if ( !::GetCursorPos(&ptClick
) )
1785 wxLogLastError(_T("GetCursorPos"));
1788 if ( !::ScreenToClient(GetHwnd(), &ptClick
) )
1790 wxLogLastError(_T("ScreenToClient(listctrl header)"));
1793 event
.m_pointDrag
.x
= ptClick
.x
;
1794 event
.m_pointDrag
.y
= ptClick
.y
;
1796 int colCount
= Header_GetItemCount(hwndHdr
);
1799 for ( int col
= 0; col
< colCount
; col
++ )
1801 if ( Header_GetItemRect(hwndHdr
, col
, &rect
) )
1803 if ( ::PtInRect(&rect
, ptClick
) )
1813 case HDN_GETDISPINFOW
:
1814 // letting Windows XP handle this message results in mysterious
1815 // crashes in comctl32.dll seemingly because of bad message
1818 // I have no idea what is the real cause of the bug (which is,
1819 // just to make things interesting, is impossible to reproduce
1820 // reliably) but ignoring all these messages does fix it and
1821 // doesn't seem to have any negative consequences
1825 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1829 #endif // defined(HDN_BEGINTRACKA)
1830 if ( nmhdr
->hwndFrom
== GetHwnd() )
1832 // almost all messages use NM_LISTVIEW
1833 NM_LISTVIEW
*nmLV
= (NM_LISTVIEW
*)nmhdr
;
1835 const int iItem
= nmLV
->iItem
;
1838 // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be
1839 // ignored for efficiency. It is done here because the internal data is in the
1840 // process of being deleted so we don't want to try and access it below.
1841 if ( m_ignoreChangeMessages
&&
1842 ( (nmLV
->hdr
.code
== LVN_ITEMCHANGED
) ||
1843 (nmLV
->hdr
.code
== LVN_ITEMCHANGING
)) )
1849 // If we have a valid item then check if there is a data value
1850 // associated with it and put it in the event.
1851 if ( iItem
>= 0 && iItem
< GetItemCount() )
1853 wxListItemInternalData
*internaldata
=
1854 wxGetInternalData(GetHwnd(), iItem
);
1857 event
.m_item
.m_data
= internaldata
->lParam
;
1860 bool processed
= true;
1861 switch ( nmhdr
->code
)
1863 case LVN_BEGINRDRAG
:
1864 eventType
= wxEVT_COMMAND_LIST_BEGIN_RDRAG
;
1868 if ( eventType
== wxEVT_NULL
)
1870 eventType
= wxEVT_COMMAND_LIST_BEGIN_DRAG
;
1873 event
.m_itemIndex
= iItem
;
1874 event
.m_pointDrag
.x
= nmLV
->ptAction
.x
;
1875 event
.m_pointDrag
.y
= nmLV
->ptAction
.y
;
1878 // NB: we have to handle both *A and *W versions here because some
1879 // versions of comctl32.dll send ANSI messages even to the
1881 case LVN_BEGINLABELEDITA
:
1882 case LVN_BEGINLABELEDITW
:
1885 if ( nmhdr
->code
== LVN_BEGINLABELEDITA
)
1887 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1889 else // LVN_BEGINLABELEDITW
1891 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1894 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1895 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, item
);
1896 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1900 case LVN_ENDLABELEDITA
:
1901 case LVN_ENDLABELEDITW
:
1904 if ( nmhdr
->code
== LVN_ENDLABELEDITA
)
1906 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1908 else // LVN_ENDLABELEDITW
1910 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1913 // was editing cancelled?
1914 const LV_ITEM
& lvi
= (LV_ITEM
)item
;
1915 if ( !lvi
.pszText
|| lvi
.iItem
== -1 )
1917 // don't keep a stale wxTextCtrl around
1920 // EDIT control will be deleted by the list control itself so
1921 // prevent us from deleting it as well
1922 m_textCtrl
->UnsubclassWin();
1923 m_textCtrl
->SetHWND(0);
1928 event
.SetEditCanceled(true);
1931 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1932 wxConvertFromMSWListItem(NULL
, event
.m_item
, item
);
1933 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1937 case LVN_COLUMNCLICK
:
1938 eventType
= wxEVT_COMMAND_LIST_COL_CLICK
;
1939 event
.m_itemIndex
= -1;
1940 event
.m_col
= nmLV
->iSubItem
;
1943 case LVN_DELETEALLITEMS
:
1944 eventType
= wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
;
1945 event
.m_itemIndex
= -1;
1948 case LVN_DELETEITEM
:
1951 // this should be prevented by the post-processing code
1952 // below, but "just in case"
1956 eventType
= wxEVT_COMMAND_LIST_DELETE_ITEM
;
1957 event
.m_itemIndex
= iItem
;
1958 // delete the assoicated internal data
1959 wxDeleteInternalData(this, iItem
);
1962 #if WXWIN_COMPATIBILITY_2_4
1963 case LVN_SETDISPINFO
:
1965 eventType
= wxEVT_COMMAND_LIST_SET_INFO
;
1966 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1967 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, info
->item
);
1972 case LVN_INSERTITEM
:
1973 eventType
= wxEVT_COMMAND_LIST_INSERT_ITEM
;
1974 event
.m_itemIndex
= iItem
;
1977 case LVN_ITEMCHANGED
:
1978 // we translate this catch all message into more interesting
1979 // (and more easy to process) wxWidgets events
1981 // first of all, we deal with the state change events only and
1982 // only for valid items (item == -1 for the virtual list
1984 if ( nmLV
->uChanged
& LVIF_STATE
&& iItem
!= -1 )
1986 // temp vars for readability
1987 const UINT stOld
= nmLV
->uOldState
;
1988 const UINT stNew
= nmLV
->uNewState
;
1990 event
.m_item
.SetId(iItem
);
1991 event
.m_item
.SetMask(wxLIST_MASK_TEXT
|
1994 GetItem(event
.m_item
);
1996 // has the focus changed?
1997 if ( !(stOld
& LVIS_FOCUSED
) && (stNew
& LVIS_FOCUSED
) )
1999 eventType
= wxEVT_COMMAND_LIST_ITEM_FOCUSED
;
2000 event
.m_itemIndex
= iItem
;
2003 if ( (stNew
& LVIS_SELECTED
) != (stOld
& LVIS_SELECTED
) )
2005 if ( eventType
!= wxEVT_NULL
)
2007 // focus and selection have both changed: send the
2008 // focus event from here and the selection one
2010 event
.SetEventType(eventType
);
2011 (void)GetEventHandler()->ProcessEvent(event
);
2013 else // no focus event to send
2015 // then need to set m_itemIndex as it wasn't done
2017 event
.m_itemIndex
= iItem
;
2020 eventType
= stNew
& LVIS_SELECTED
2021 ? wxEVT_COMMAND_LIST_ITEM_SELECTED
2022 : wxEVT_COMMAND_LIST_ITEM_DESELECTED
;
2026 if ( eventType
== wxEVT_NULL
)
2028 // not an interesting event for us
2036 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
2037 WORD wVKey
= info
->wVKey
;
2039 // get the current selection
2040 long lItem
= GetNextItem(-1,
2042 wxLIST_STATE_SELECTED
);
2044 // <Enter> or <Space> activate the selected item if any (but
2045 // not with Shift and/or Ctrl as then they have a predefined
2046 // meaning for the list view)
2048 (wVKey
== VK_RETURN
|| wVKey
== VK_SPACE
) &&
2049 !(wxIsShiftDown() || wxIsCtrlDown()) )
2051 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2055 eventType
= wxEVT_COMMAND_LIST_KEY_DOWN
;
2057 // wxCharCodeMSWToWX() returns 0 if the key is an ASCII
2058 // value which should be used as is
2059 int code
= wxCharCodeMSWToWX(wVKey
);
2060 event
.m_code
= code
? code
: wVKey
;
2064 event
.m_item
.m_itemId
= lItem
;
2068 // fill the other fields too
2069 event
.m_item
.m_text
= GetItemText(lItem
);
2070 event
.m_item
.m_data
= GetItemData(lItem
);
2076 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2078 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2083 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
2084 // if it happened on an item (and not on empty place)
2091 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2092 event
.m_itemIndex
= iItem
;
2093 event
.m_item
.m_text
= GetItemText(iItem
);
2094 event
.m_item
.m_data
= GetItemData(iItem
);
2097 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2098 case GN_CONTEXTMENU
:
2099 #endif //__WXWINCE__
2101 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2102 // don't do anything else
2103 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2108 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
2109 LV_HITTESTINFO lvhti
;
2110 wxZeroMemory(lvhti
);
2112 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2113 if(nmhdr
->code
== GN_CONTEXTMENU
) {
2114 lvhti
.pt
= ((NMRGINFO
*)nmhdr
)->ptAction
;
2116 #endif //__WXWINCE__
2117 ::GetCursorPos(&(lvhti
.pt
));
2118 ::ScreenToClient(GetHwnd(),&(lvhti
.pt
));
2119 if ( ListView_HitTest(GetHwnd(),&lvhti
) != -1 )
2121 if ( lvhti
.flags
& LVHT_ONITEM
)
2123 eventType
= wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
;
2124 event
.m_itemIndex
= lvhti
.iItem
;
2125 event
.m_pointDrag
.x
= lvhti
.pt
.x
;
2126 event
.m_pointDrag
.y
= lvhti
.pt
.y
;
2131 #ifdef NM_CUSTOMDRAW
2133 *result
= OnCustomDraw(lParam
);
2136 #endif // _WIN32_IE >= 0x300
2138 case LVN_ODCACHEHINT
:
2140 const NM_CACHEHINT
*cacheHint
= (NM_CACHEHINT
*)lParam
;
2142 eventType
= wxEVT_COMMAND_LIST_CACHE_HINT
;
2144 // we get some really stupid cache hints like ones for
2145 // items in range 0..0 for an empty control or, after
2146 // deleting an item, for items in invalid range -- filter
2148 if ( cacheHint
->iFrom
> cacheHint
->iTo
)
2151 event
.m_oldItemIndex
= cacheHint
->iFrom
;
2153 const long iMax
= GetItemCount();
2154 event
.m_itemIndex
= cacheHint
->iTo
< iMax
? cacheHint
->iTo
2159 #ifdef HAVE_NMLVFINDITEM
2160 case LVN_ODFINDITEM
:
2161 // this message is only used with the virtual list control but
2162 // even there we don't want to always use it: in a control with
2163 // sufficiently big number of items (defined as > 1000 here),
2164 // accidentally pressing a key could result in hanging an
2165 // application waiting while it performs linear search
2166 if ( IsVirtual() && GetItemCount() <= 1000 )
2168 NMLVFINDITEM
* pFindInfo
= (NMLVFINDITEM
*)lParam
;
2170 // no match by default
2173 // we only handle string-based searches here
2175 // TODO: what about LVFI_PARTIAL, should we handle this?
2176 if ( !(pFindInfo
->lvfi
.flags
& LVFI_STRING
) )
2181 const wxChar
* const searchstr
= pFindInfo
->lvfi
.psz
;
2182 const size_t len
= wxStrlen(searchstr
);
2184 // this is the first item we should examine, search from it
2185 // wrapping if necessary
2186 const int startPos
= pFindInfo
->iStart
;
2187 const int maxPos
= GetItemCount();
2188 wxCHECK_MSG( startPos
<= maxPos
, false,
2189 _T("bad starting position in LVN_ODFINDITEM") );
2191 int currentPos
= startPos
;
2194 // wrap to the beginning if necessary
2195 if ( currentPos
== maxPos
)
2197 // somewhat surprizingly, LVFI_WRAP isn't set in
2198 // flags but we still should wrap
2202 // does this item begin with searchstr?
2203 if ( wxStrnicmp(searchstr
,
2204 GetItemText(currentPos
), len
) == 0 )
2206 *result
= currentPos
;
2210 while ( ++currentPos
!= startPos
);
2212 if ( *result
== -1 )
2218 SetItemState(*result
,
2219 wxLIST_STATE_SELECTED
| wxLIST_STATE_FOCUSED
,
2220 wxLIST_STATE_SELECTED
| wxLIST_STATE_FOCUSED
);
2221 EnsureVisible(*result
);
2229 #endif // HAVE_NMLVFINDITEM
2231 case LVN_GETDISPINFO
:
2234 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
2236 LV_ITEM
& lvi
= info
->item
;
2237 long item
= lvi
.iItem
;
2239 if ( lvi
.mask
& LVIF_TEXT
)
2241 wxString text
= OnGetItemText(item
, lvi
.iSubItem
);
2242 wxStrncpy(lvi
.pszText
, text
, lvi
.cchTextMax
);
2245 // see comment at the end of wxListCtrl::GetColumn()
2246 #ifdef NM_CUSTOMDRAW
2247 if ( lvi
.mask
& LVIF_IMAGE
)
2249 lvi
.iImage
= OnGetItemImage(item
);
2251 #endif // NM_CUSTOMDRAW
2253 // a little dose of healthy paranoia: as we never use
2254 // LVM_SETCALLBACKMASK we're not supposed to get these ones
2255 wxASSERT_MSG( !(lvi
.mask
& LVIF_STATE
),
2256 _T("we don't support state callbacks yet!") );
2267 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
2271 // where did this one come from?
2275 // process the event
2276 // -----------------
2278 event
.SetEventType(eventType
);
2280 bool processed
= GetEventHandler()->ProcessEvent(event
);
2284 switch ( nmhdr
->code
)
2286 case LVN_DELETEALLITEMS
:
2287 // always return true to suppress all additional LVN_DELETEITEM
2288 // notifications - this makes deleting all items from a list ctrl
2292 // also, we may free all user data now (couldn't do it before as
2293 // the user should have access to it in OnDeleteAllItems() handler)
2294 FreeAllInternalData();
2296 // the control is empty now, synchronize the cached number of items
2297 // with the real one
2301 case LVN_ENDLABELEDITA
:
2302 case LVN_ENDLABELEDITW
:
2303 // logic here is inverted compared to all the other messages
2304 *result
= event
.IsAllowed();
2306 // don't keep a stale wxTextCtrl around
2309 // EDIT control will be deleted by the list control itself so
2310 // prevent us from deleting it as well
2311 m_textCtrl
->UnsubclassWin();
2312 m_textCtrl
->SetHWND(0);
2321 *result
= !event
.IsAllowed();
2326 // see comment at the end of wxListCtrl::GetColumn()
2327 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2329 WXLPARAM
wxListCtrl::OnCustomDraw(WXLPARAM lParam
)
2331 LPNMLVCUSTOMDRAW lplvcd
= (LPNMLVCUSTOMDRAW
)lParam
;
2332 NMCUSTOMDRAW
& nmcd
= lplvcd
->nmcd
;
2333 switch ( nmcd
.dwDrawStage
)
2336 // if we've got any items with non standard attributes,
2337 // notify us before painting each item
2339 // for virtual controls, always suppose that we have attributes as
2340 // there is no way to check for this
2341 return IsVirtual() || m_hasAnyAttr
? CDRF_NOTIFYITEMDRAW
2344 case CDDS_ITEMPREPAINT
:
2346 size_t item
= (size_t)nmcd
.dwItemSpec
;
2347 if ( item
>= (size_t)GetItemCount() )
2349 // we get this message with item == 0 for an empty control,
2350 // we must ignore it as calling OnGetItemAttr() would be
2352 return CDRF_DODEFAULT
;
2355 wxListItemAttr
*attr
=
2356 IsVirtual() ? OnGetItemAttr(item
)
2357 : wxGetInternalDataAttr(this, item
);
2361 // nothing to do for this item
2362 return CDRF_DODEFAULT
;
2366 wxColour colText
, colBack
;
2367 if ( attr
->HasFont() )
2369 wxFont font
= attr
->GetFont();
2370 hFont
= (HFONT
)font
.GetResourceHandle();
2377 if ( attr
->HasTextColour() )
2379 colText
= attr
->GetTextColour();
2383 colText
= GetTextColour();
2386 if ( attr
->HasBackgroundColour() )
2388 colBack
= attr
->GetBackgroundColour();
2392 colBack
= GetBackgroundColour();
2395 lplvcd
->clrText
= wxColourToRGB(colText
);
2396 lplvcd
->clrTextBk
= wxColourToRGB(colBack
);
2398 // note that if we wanted to set colours for
2399 // individual columns (subitems), we would have
2400 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2403 ::SelectObject(nmcd
.hdc
, hFont
);
2405 return CDRF_NEWFONT
;
2408 // fall through to return CDRF_DODEFAULT
2411 return CDRF_DODEFAULT
;
2415 #endif // NM_CUSTOMDRAW supported
2417 // Necessary for drawing hrules and vrules, if specified
2418 void wxListCtrl::OnPaint(wxPaintEvent
& event
)
2422 wxControl::OnPaint(event
);
2424 // Reset the device origin since it may have been set
2425 dc
.SetDeviceOrigin(0, 0);
2427 bool drawHRules
= HasFlag(wxLC_HRULES
);
2428 bool drawVRules
= HasFlag(wxLC_VRULES
);
2430 if (!InReportView() || !drawHRules
&& !drawVRules
)
2433 wxPen
pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT
), 1, wxSOLID
);
2435 dc
.SetBrush(* wxTRANSPARENT_BRUSH
);
2437 wxSize clientSize
= GetClientSize();
2440 int itemCount
= GetItemCount();
2444 long top
= GetTopItem();
2445 for (i
= top
; i
< top
+ GetCountPerPage() + 1; i
++)
2447 if (GetItemRect(i
, itemRect
))
2449 int cy
= itemRect
.GetTop();
2450 if (i
!= 0) // Don't draw the first one
2452 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2455 if (i
== itemCount
- 1)
2457 cy
= itemRect
.GetBottom();
2458 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2464 if (drawVRules
&& (i
> -1))
2466 wxRect firstItemRect
;
2467 GetItemRect(0, firstItemRect
);
2469 if (GetItemRect(i
, itemRect
))
2472 int x
= itemRect
.GetX();
2473 for (col
= 0; col
< GetColumnCount(); col
++)
2475 int colWidth
= GetColumnWidth(col
);
2477 dc
.DrawLine(x
-1, firstItemRect
.GetY() - 2, x
-1, itemRect
.GetBottom());
2484 wxListCtrl::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
2487 if ( nMsg
== WM_PRINT
)
2489 // we should bypass our own WM_PRINT handling as we don't handle
2490 // PRF_CHILDREN flag, so leave it to the native control itself
2491 return MSWDefWindowProc(nMsg
, wParam
, lParam
);
2495 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
2498 // ----------------------------------------------------------------------------
2499 // virtual list controls
2500 // ----------------------------------------------------------------------------
2502 wxString
wxListCtrl::OnGetItemText(long WXUNUSED(item
), long WXUNUSED(col
)) const
2504 // this is a pure virtual function, in fact - which is not really pure
2505 // because the controls which are not virtual don't need to implement it
2506 wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") );
2508 return wxEmptyString
;
2511 int wxListCtrl::OnGetItemImage(long WXUNUSED(item
)) const
2513 wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL
),
2515 wxT("List control has an image list, OnGetItemImage should be overridden."));
2519 wxListItemAttr
*wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item
)) const
2521 wxASSERT_MSG( item
>= 0 && item
< GetItemCount(),
2522 _T("invalid item index in OnGetItemAttr()") );
2524 // no attributes by default
2528 void wxListCtrl::SetItemCount(long count
)
2530 wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
2532 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT
, (WPARAM
)count
,
2533 LVSICF_NOSCROLL
| LVSICF_NOINVALIDATEALL
) )
2535 wxLogLastError(_T("ListView_SetItemCount"));
2538 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
2539 wxT("m_count should match ListView_GetItemCount"));
2542 void wxListCtrl::RefreshItem(long item
)
2544 // strangely enough, ListView_Update() results in much more flicker here
2545 // than a dumb Refresh() -- why?
2547 if ( !ListView_Update(GetHwnd(), item
) )
2549 wxLogLastError(_T("ListView_Update"));
2553 GetItemRect(item
, rect
);
2558 void wxListCtrl::RefreshItems(long itemFrom
, long itemTo
)
2560 wxRect rect1
, rect2
;
2561 GetItemRect(itemFrom
, rect1
);
2562 GetItemRect(itemTo
, rect2
);
2564 wxRect rect
= rect1
;
2565 rect
.height
= rect2
.GetBottom() - rect1
.GetTop();
2570 // ----------------------------------------------------------------------------
2571 // internal data stuff
2572 // ----------------------------------------------------------------------------
2574 static wxListItemInternalData
*wxGetInternalData(HWND hwnd
, long itemId
)
2577 it
.mask
= LVIF_PARAM
;
2580 if ( !ListView_GetItem(hwnd
, &it
) )
2583 return (wxListItemInternalData
*) it
.lParam
;
2587 wxListItemInternalData
*wxGetInternalData(const wxListCtrl
*ctl
, long itemId
)
2589 return wxGetInternalData(GetHwndOf(ctl
), itemId
);
2592 static wxListItemAttr
*wxGetInternalDataAttr(wxListCtrl
*ctl
, long itemId
)
2594 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2596 return data
? data
->attr
: NULL
;
2599 static void wxDeleteInternalData(wxListCtrl
* ctl
, long itemId
)
2601 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2605 memset(&item
, 0, sizeof(item
));
2606 item
.iItem
= itemId
;
2607 item
.mask
= LVIF_PARAM
;
2608 item
.lParam
= (LPARAM
) 0;
2609 ListView_SetItem((HWND
)ctl
->GetHWND(), &item
);
2614 // ----------------------------------------------------------------------------
2615 // wxWin <-> MSW items conversions
2616 // ----------------------------------------------------------------------------
2618 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
2622 wxListItemInternalData
*internaldata
=
2623 (wxListItemInternalData
*) lvItem
.lParam
;
2626 info
.m_data
= internaldata
->lParam
;
2630 info
.m_stateMask
= 0;
2631 info
.m_itemId
= lvItem
.iItem
;
2633 long oldMask
= lvItem
.mask
;
2635 bool needText
= false;
2636 if (hwndListCtrl
!= 0)
2638 if ( lvItem
.mask
& LVIF_TEXT
)
2645 lvItem
.pszText
= new wxChar
[513];
2646 lvItem
.cchTextMax
= 512;
2648 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
2649 ::SendMessage(hwndListCtrl
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
);
2652 if ( lvItem
.mask
& LVIF_STATE
)
2654 info
.m_mask
|= wxLIST_MASK_STATE
;
2656 if ( lvItem
.stateMask
& LVIS_CUT
)
2658 info
.m_stateMask
|= wxLIST_STATE_CUT
;
2659 if ( lvItem
.state
& LVIS_CUT
)
2660 info
.m_state
|= wxLIST_STATE_CUT
;
2662 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
2664 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
2665 if ( lvItem
.state
& LVIS_DROPHILITED
)
2666 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
2668 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
2670 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
2671 if ( lvItem
.state
& LVIS_FOCUSED
)
2672 info
.m_state
|= wxLIST_STATE_FOCUSED
;
2674 if ( lvItem
.stateMask
& LVIS_SELECTED
)
2676 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
2677 if ( lvItem
.state
& LVIS_SELECTED
)
2678 info
.m_state
|= wxLIST_STATE_SELECTED
;
2682 if ( lvItem
.mask
& LVIF_TEXT
)
2684 info
.m_mask
|= wxLIST_MASK_TEXT
;
2685 info
.m_text
= lvItem
.pszText
;
2687 if ( lvItem
.mask
& LVIF_IMAGE
)
2689 info
.m_mask
|= wxLIST_MASK_IMAGE
;
2690 info
.m_image
= lvItem
.iImage
;
2692 if ( lvItem
.mask
& LVIF_PARAM
)
2693 info
.m_mask
|= wxLIST_MASK_DATA
;
2694 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
2695 info
.m_mask
|= wxLIST_SET_ITEM
;
2696 info
.m_col
= lvItem
.iSubItem
;
2701 delete[] lvItem
.pszText
;
2703 lvItem
.mask
= oldMask
;
2706 static void wxConvertToMSWFlags(long state
, long stateMask
, LV_ITEM
& lvItem
)
2708 if (stateMask
& wxLIST_STATE_CUT
)
2710 lvItem
.stateMask
|= LVIS_CUT
;
2711 if (state
& wxLIST_STATE_CUT
)
2712 lvItem
.state
|= LVIS_CUT
;
2714 if (stateMask
& wxLIST_STATE_DROPHILITED
)
2716 lvItem
.stateMask
|= LVIS_DROPHILITED
;
2717 if (state
& wxLIST_STATE_DROPHILITED
)
2718 lvItem
.state
|= LVIS_DROPHILITED
;
2720 if (stateMask
& wxLIST_STATE_FOCUSED
)
2722 lvItem
.stateMask
|= LVIS_FOCUSED
;
2723 if (state
& wxLIST_STATE_FOCUSED
)
2724 lvItem
.state
|= LVIS_FOCUSED
;
2726 if (stateMask
& wxLIST_STATE_SELECTED
)
2728 lvItem
.stateMask
|= LVIS_SELECTED
;
2729 if (state
& wxLIST_STATE_SELECTED
)
2730 lvItem
.state
|= LVIS_SELECTED
;
2734 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
2735 const wxListItem
& info
,
2738 lvItem
.iItem
= (int) info
.m_itemId
;
2740 lvItem
.iImage
= info
.m_image
;
2741 lvItem
.stateMask
= 0;
2744 lvItem
.iSubItem
= info
.m_col
;
2746 if (info
.m_mask
& wxLIST_MASK_STATE
)
2748 lvItem
.mask
|= LVIF_STATE
;
2750 wxConvertToMSWFlags(info
.m_state
, info
.m_stateMask
, lvItem
);
2753 if (info
.m_mask
& wxLIST_MASK_TEXT
)
2755 lvItem
.mask
|= LVIF_TEXT
;
2756 if ( ctrl
->HasFlag(wxLC_USER_TEXT
) )
2758 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
2762 // pszText is not const, hence the cast
2763 lvItem
.pszText
= (wxChar
*)info
.m_text
.c_str();
2764 if ( lvItem
.pszText
)
2765 lvItem
.cchTextMax
= info
.m_text
.Length();
2767 lvItem
.cchTextMax
= 0;
2770 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
2771 lvItem
.mask
|= LVIF_IMAGE
;
2774 static void wxConvertToMSWListCol(int WXUNUSED(col
), const wxListItem
& item
,
2777 wxZeroMemory(lvCol
);
2779 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
2781 lvCol
.mask
|= LVCF_TEXT
;
2782 lvCol
.pszText
= (wxChar
*)item
.m_text
.c_str(); // cast is safe
2785 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
2787 lvCol
.mask
|= LVCF_FMT
;
2789 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
2790 lvCol
.fmt
= LVCFMT_LEFT
;
2791 else if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
2792 lvCol
.fmt
= LVCFMT_RIGHT
;
2793 else if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
2794 lvCol
.fmt
= LVCFMT_CENTER
;
2797 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
2799 lvCol
.mask
|= LVCF_WIDTH
;
2800 if ( item
.m_width
== wxLIST_AUTOSIZE
)
2801 lvCol
.cx
= LVSCW_AUTOSIZE
;
2802 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
2803 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
2805 lvCol
.cx
= item
.m_width
;
2808 // see comment at the end of wxListCtrl::GetColumn()
2809 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2810 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
2812 if ( wxTheApp
->GetComCtl32Version() >= 470 )
2814 lvCol
.mask
|= LVCF_IMAGE
| LVCF_FMT
;
2816 // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right
2817 // seem to be generally nicer than on the left and the generic
2818 // version only draws them on the right (we don't have a flag to
2819 // specify the image location anyhow)
2821 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
2822 // make any difference in my tests -- but maybe we should?
2823 if ( item
.m_image
!= -1 )
2824 lvCol
.fmt
|= LVCFMT_BITMAP_ON_RIGHT
| LVCFMT_IMAGE
;
2826 lvCol
.iImage
= item
.m_image
;
2828 //else: it doesn't support item images anyhow
2830 #endif // _WIN32_IE >= 0x0300
2833 #endif // wxUSE_LISTCTRL