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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "listctrl.h"
22 #pragma implementation "listctrlbase.h"
25 // For compilers that support precompilation, includes "wx.h".
26 #include "wx/wxprec.h"
32 #if wxUSE_LISTCTRL && defined(__WIN95__)
38 #include "wx/settings.h"
41 #include "wx/textctrl.h"
42 #include "wx/imaglist.h"
43 #include "wx/listctrl.h"
44 #include "wx/dcclient.h"
46 #include "wx/msw/private.h"
48 #if defined(__WXWINCE__)
56 // include <commctrl.h> "properly"
57 #include "wx/msw/wrapcctl.h"
59 // ----------------------------------------------------------------------------
61 // ----------------------------------------------------------------------------
63 // convert our state and mask flags to LV_ITEM constants
64 static void wxConvertToMSWFlags(long state
, long mask
, LV_ITEM
& lvItem
);
66 // convert wxListItem to LV_ITEM
67 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
68 const wxListItem
& info
, LV_ITEM
& lvItem
);
70 // convert LV_ITEM to wxListItem
71 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
73 /* const */ LV_ITEM
& lvItem
);
75 // convert our wxListItem to LV_COLUMN
76 static void wxConvertToMSWListCol(int col
, const wxListItem
& item
,
79 // ----------------------------------------------------------------------------
80 // private helper classes
81 // ----------------------------------------------------------------------------
83 // We have to handle both fooW and fooA notifications in several cases
84 // because of broken comctl32.dll and/or unicows.dll. This class is used to
85 // convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or
86 // LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed
87 // by wxConvertToMSWListItem().
89 #define LV_ITEM_NATIVE LV_ITEMW
90 #define LV_ITEM_OTHER LV_ITEMA
92 #define LV_CONV_TO_WX cMB2WX
93 #define LV_CONV_BUF wxMB2WXbuf
95 #define LV_ITEM_NATIVE LV_ITEMA
96 #define LV_ITEM_OTHER LV_ITEMW
98 #define LV_CONV_TO_WX cWC2WX
99 #define LV_CONV_BUF wxWC2WXbuf
100 #endif // Unicode/ANSI
105 // default ctor, use Init() later
106 wxLV_ITEM() { m_buf
= NULL
; m_pItem
= NULL
; }
108 // init without conversion
109 void Init(LV_ITEM_NATIVE
& item
)
111 wxASSERT_MSG( !m_pItem
, _T("Init() called twice?") );
116 // init with conversion
117 void Init(LV_ITEM_OTHER
& item
)
119 // avoid unnecessary dynamic memory allocation, jjust make m_pItem
120 // point to our own m_item
122 // memcpy() can't work if the struct sizes are different
123 wxCOMPILE_TIME_ASSERT( sizeof(LV_ITEM_OTHER
) == sizeof(LV_ITEM_NATIVE
),
124 CodeCantWorkIfDiffSizes
);
126 memcpy(&m_item
, &item
, sizeof(LV_ITEM_NATIVE
));
128 // convert text from ANSI to Unicod if necessary
129 if ( (item
.mask
& LVIF_TEXT
) && item
.pszText
)
131 m_buf
= new LV_CONV_BUF(wxConvLocal
.LV_CONV_TO_WX(item
.pszText
));
132 m_item
.pszText
= (wxChar
*)m_buf
->data();
136 // ctor without conversion
137 wxLV_ITEM(LV_ITEM_NATIVE
& item
) : m_buf(NULL
), m_pItem(&item
) { }
139 // ctor with conversion
140 wxLV_ITEM(LV_ITEM_OTHER
& item
) : m_buf(NULL
)
145 ~wxLV_ITEM() { delete m_buf
; }
147 // conversion to the real LV_ITEM
148 operator LV_ITEM_NATIVE
&() const { return *m_pItem
; }
153 LV_ITEM_NATIVE
*m_pItem
;
154 LV_ITEM_NATIVE m_item
;
156 DECLARE_NO_COPY_CLASS(wxLV_ITEM
)
159 ///////////////////////////////////////////////////////
161 // The MSW version had problems with SetTextColour() et
162 // al as the wxListItemAttr's were stored keyed on the
163 // item index. If a item was inserted anywhere but the end
164 // of the list the the text attributes (colour etc) for
165 // the following items were out of sync.
168 // Under MSW the only way to associate data with a List
169 // item independant of its position in the list is to
170 // store a pointer to it in its lParam attribute. However
171 // user programs are already using this (via the
172 // SetItemData() GetItemData() calls).
174 // However what we can do is store a pointer to a
175 // structure which contains the attributes we want *and*
176 // a lParam for the users data, e.g.
178 // class wxListItemInternalData
181 // wxListItemAttr *attr;
182 // long lParam; // user data
185 // To conserve memory, a wxListItemInternalData is
186 // only allocated for a LV_ITEM if text attributes or
187 // user data(lparam) are being set.
190 // class wxListItemInternalData
191 class wxListItemInternalData
194 wxListItemAttr
*attr
;
195 LPARAM lParam
; // user data
197 wxListItemInternalData() : attr(NULL
), lParam(0) {}
198 ~wxListItemInternalData()
204 DECLARE_NO_COPY_CLASS(wxListItemInternalData
)
207 // Get the internal data structure
208 static wxListItemInternalData
*wxGetInternalData(HWND hwnd
, long itemId
);
209 static wxListItemInternalData
*wxGetInternalData(const wxListCtrl
*ctl
, long itemId
);
210 static wxListItemAttr
*wxGetInternalDataAttr(wxListCtrl
*ctl
, long itemId
);
211 static void wxDeleteInternalData(wxListCtrl
* ctl
, long itemId
);
214 // ----------------------------------------------------------------------------
216 // ----------------------------------------------------------------------------
218 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG
)
219 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG
)
220 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
)
221 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT
)
222 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM
)
223 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
)
224 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO
)
225 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO
)
226 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED
)
227 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED
)
228 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN
)
229 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM
)
230 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK
)
231 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
)
232 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
)
233 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING
)
234 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG
)
235 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
)
236 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK
)
237 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED
)
238 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED
)
239 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT
)
241 #if wxUSE_EXTENDED_RTTI
242 WX_DEFINE_FLAGS( wxListCtrlStyle
)
244 wxBEGIN_FLAGS( wxListCtrlStyle
)
245 // new style border flags, we put them first to
246 // use them for streaming out
247 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
248 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
249 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
250 wxFLAGS_MEMBER(wxBORDER_RAISED
)
251 wxFLAGS_MEMBER(wxBORDER_STATIC
)
252 wxFLAGS_MEMBER(wxBORDER_NONE
)
254 // old style border flags
255 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
256 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
257 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
258 wxFLAGS_MEMBER(wxRAISED_BORDER
)
259 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
260 wxFLAGS_MEMBER(wxBORDER
)
262 // standard window styles
263 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
264 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
265 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
266 wxFLAGS_MEMBER(wxWANTS_CHARS
)
267 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
268 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
269 wxFLAGS_MEMBER(wxVSCROLL
)
270 wxFLAGS_MEMBER(wxHSCROLL
)
272 wxFLAGS_MEMBER(wxLC_LIST
)
273 wxFLAGS_MEMBER(wxLC_REPORT
)
274 wxFLAGS_MEMBER(wxLC_ICON
)
275 wxFLAGS_MEMBER(wxLC_SMALL_ICON
)
276 wxFLAGS_MEMBER(wxLC_ALIGN_TOP
)
277 wxFLAGS_MEMBER(wxLC_ALIGN_LEFT
)
278 wxFLAGS_MEMBER(wxLC_AUTOARRANGE
)
279 wxFLAGS_MEMBER(wxLC_USER_TEXT
)
280 wxFLAGS_MEMBER(wxLC_EDIT_LABELS
)
281 wxFLAGS_MEMBER(wxLC_NO_HEADER
)
282 wxFLAGS_MEMBER(wxLC_SINGLE_SEL
)
283 wxFLAGS_MEMBER(wxLC_SORT_ASCENDING
)
284 wxFLAGS_MEMBER(wxLC_SORT_DESCENDING
)
285 wxFLAGS_MEMBER(wxLC_VIRTUAL
)
287 wxEND_FLAGS( wxListCtrlStyle
)
289 IMPLEMENT_DYNAMIC_CLASS_XTI(wxListCtrl
, wxControl
,"wx/listctrl.h")
291 wxBEGIN_PROPERTIES_TABLE(wxListCtrl
)
292 wxEVENT_PROPERTY( TextUpdated
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
)
294 wxPROPERTY_FLAGS( WindowStyle
, wxListCtrlStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
295 wxEND_PROPERTIES_TABLE()
297 wxBEGIN_HANDLERS_TABLE(wxListCtrl
)
298 wxEND_HANDLERS_TABLE()
300 wxCONSTRUCTOR_5( wxListCtrl
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
303 TODO : Expose more information of a list's layout etc. via appropriate objects (Ã la NotebookPageInfo)
306 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl
, wxControl
)
309 IMPLEMENT_DYNAMIC_CLASS(wxListView
, wxListCtrl
)
310 IMPLEMENT_DYNAMIC_CLASS(wxListItem
, wxObject
)
312 IMPLEMENT_DYNAMIC_CLASS(wxListEvent
, wxNotifyEvent
)
314 BEGIN_EVENT_TABLE(wxListCtrl
, wxControl
)
315 EVT_PAINT(wxListCtrl::OnPaint
)
318 // ============================================================================
320 // ============================================================================
322 // ----------------------------------------------------------------------------
323 // wxListCtrl construction
324 // ----------------------------------------------------------------------------
326 void wxListCtrl::Init()
328 m_imageListNormal
= NULL
;
329 m_imageListSmall
= NULL
;
330 m_imageListState
= NULL
;
331 m_ownsImageListNormal
= m_ownsImageListSmall
= m_ownsImageListState
= FALSE
;
334 m_ignoreChangeMessages
= FALSE
;
336 m_AnyInternalData
= FALSE
;
337 m_hasAnyAttr
= FALSE
;
340 bool wxListCtrl::Create(wxWindow
*parent
,
345 const wxValidator
& validator
,
346 const wxString
& name
)
348 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
351 if ( !MSWCreateControl(WC_LISTVIEW
, _T(""), pos
, size
) )
354 // explicitly say that we want to use Unicode because otherwise we get ANSI
355 // versions of _some_ messages (notably LVN_GETDISPINFOA) in MSLU build
356 wxSetCCUnicodeFormat(GetHwnd());
358 // for comctl32.dll v 4.70+ we want to have this attribute because it's
359 // prettier (and also because wxGTK does it like this)
360 if ( InReportView() && wxTheApp
->GetComCtl32Version() >= 470 )
362 ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE
,
363 0, LVS_EX_FULLROWSELECT
);
366 // inherit foreground colour but our background should be the same as for
367 // listboxes and other such "container" windows and not inherited
368 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
));
369 SetForegroundColour(GetParent()->GetForegroundColour());
374 WXDWORD
wxListCtrl::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
376 WXDWORD wstyle
= wxControl::MSWGetStyle(style
, exstyle
);
378 wstyle
|= LVS_SHAREIMAGELISTS
| LVS_SHOWSELALWAYS
;
383 #define MAP_MODE_STYLE(wx, ms) \
384 if ( style & (wx) ) { wstyle |= (ms); nModes++; }
385 #else // !__WXDEBUG__
386 #define MAP_MODE_STYLE(wx, ms) \
387 if ( style & (wx) ) wstyle |= (ms);
388 #endif // __WXDEBUG__
390 MAP_MODE_STYLE(wxLC_ICON
, LVS_ICON
)
391 MAP_MODE_STYLE(wxLC_SMALL_ICON
, LVS_SMALLICON
)
392 MAP_MODE_STYLE(wxLC_LIST
, LVS_LIST
)
393 MAP_MODE_STYLE(wxLC_REPORT
, LVS_REPORT
)
395 wxASSERT_MSG( nModes
== 1,
396 _T("wxListCtrl style should have exactly one mode bit set") );
398 #undef MAP_MODE_STYLE
400 if ( style
& wxLC_ALIGN_LEFT
)
401 wstyle
|= LVS_ALIGNLEFT
;
403 if ( style
& wxLC_ALIGN_TOP
)
404 wstyle
|= LVS_ALIGNTOP
;
406 if ( style
& wxLC_AUTOARRANGE
)
407 wstyle
|= LVS_AUTOARRANGE
;
409 if ( style
& wxLC_NO_SORT_HEADER
)
410 wstyle
|= LVS_NOSORTHEADER
;
412 if ( style
& wxLC_NO_HEADER
)
413 wstyle
|= LVS_NOCOLUMNHEADER
;
415 if ( style
& wxLC_EDIT_LABELS
)
416 wstyle
|= LVS_EDITLABELS
;
418 if ( style
& wxLC_SINGLE_SEL
)
419 wstyle
|= LVS_SINGLESEL
;
421 if ( style
& wxLC_SORT_ASCENDING
)
423 wstyle
|= LVS_SORTASCENDING
;
425 wxASSERT_MSG( !(style
& wxLC_SORT_DESCENDING
),
426 _T("can't sort in ascending and descending orders at once") );
428 else if ( style
& wxLC_SORT_DESCENDING
)
429 wstyle
|= LVS_SORTDESCENDING
;
431 #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
432 if ( style
& wxLC_VIRTUAL
)
434 int ver
= wxTheApp
->GetComCtl32Version();
437 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."),
438 ver
/ 100, ver
% 100);
441 wstyle
|= LVS_OWNERDATA
;
443 #endif // ancient cygwin
448 void wxListCtrl::UpdateStyle()
452 // The new window view style
453 DWORD dwStyleNew
= MSWGetStyle(m_windowStyle
, NULL
);
455 // Get the current window style.
456 DWORD dwStyleOld
= ::GetWindowLong(GetHwnd(), GWL_STYLE
);
458 // Only set the window style if the view bits have changed.
459 if ( dwStyleOld
!= dwStyleNew
)
461 ::SetWindowLong(GetHwnd(), GWL_STYLE
, dwStyleNew
);
466 void wxListCtrl::FreeAllInternalData()
468 if (m_AnyInternalData
)
470 int n
= GetItemCount();
473 m_ignoreChangeMessages
= TRUE
;
474 for (i
= 0; i
< n
; i
++)
475 wxDeleteInternalData(this, i
);
476 m_ignoreChangeMessages
= FALSE
;
478 m_AnyInternalData
= FALSE
;
482 wxListCtrl::~wxListCtrl()
484 FreeAllInternalData();
488 m_textCtrl
->UnsubclassWin();
489 m_textCtrl
->SetHWND(0);
494 if (m_ownsImageListNormal
) delete m_imageListNormal
;
495 if (m_ownsImageListSmall
) delete m_imageListSmall
;
496 if (m_ownsImageListState
) delete m_imageListState
;
499 // ----------------------------------------------------------------------------
500 // set/get/change style
501 // ----------------------------------------------------------------------------
503 // Add or remove a single window style
504 void wxListCtrl::SetSingleStyle(long style
, bool add
)
506 long flag
= GetWindowStyleFlag();
508 // Get rid of conflicting styles
511 if ( style
& wxLC_MASK_TYPE
)
512 flag
= flag
& ~wxLC_MASK_TYPE
;
513 if ( style
& wxLC_MASK_ALIGN
)
514 flag
= flag
& ~wxLC_MASK_ALIGN
;
515 if ( style
& wxLC_MASK_SORT
)
516 flag
= flag
& ~wxLC_MASK_SORT
;
532 m_windowStyle
= flag
;
537 // Set the whole window style
538 void wxListCtrl::SetWindowStyleFlag(long flag
)
540 m_windowStyle
= flag
;
545 // ----------------------------------------------------------------------------
547 // ----------------------------------------------------------------------------
549 // Sets the foreground, i.e. text, colour
550 bool wxListCtrl::SetForegroundColour(const wxColour
& col
)
552 if ( !wxWindow::SetForegroundColour(col
) )
555 ListView_SetTextColor(GetHwnd(), wxColourToRGB(col
));
560 // Sets the background colour
561 bool wxListCtrl::SetBackgroundColour(const wxColour
& col
)
563 if ( !wxWindow::SetBackgroundColour(col
) )
566 // we set the same colour for both the "empty" background and the items
568 COLORREF color
= wxColourToRGB(col
);
569 ListView_SetBkColor(GetHwnd(), color
);
570 ListView_SetTextBkColor(GetHwnd(), color
);
575 // Gets information about this column
576 bool wxListCtrl::GetColumn(int col
, wxListItem
& item
) const
581 lvCol
.mask
= LVCF_WIDTH
;
583 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
585 lvCol
.mask
|= LVCF_TEXT
;
586 lvCol
.pszText
= new wxChar
[513];
587 lvCol
.cchTextMax
= 512;
590 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
592 lvCol
.mask
|= LVCF_FMT
;
595 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
597 lvCol
.mask
|= LVCF_IMAGE
;
600 bool success
= ListView_GetColumn(GetHwnd(), col
, &lvCol
) != 0;
602 // item.m_subItem = lvCol.iSubItem;
603 item
.m_width
= lvCol
.cx
;
605 if ( (item
.m_mask
& wxLIST_MASK_TEXT
) && lvCol
.pszText
)
607 item
.m_text
= lvCol
.pszText
;
608 delete[] lvCol
.pszText
;
611 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
613 switch (lvCol
.fmt
& LVCFMT_JUSTIFYMASK
) {
615 item
.m_format
= wxLIST_FORMAT_LEFT
;
618 item
.m_format
= wxLIST_FORMAT_RIGHT
;
621 item
.m_format
= wxLIST_FORMAT_CENTRE
;
624 item
.m_format
= -1; // Unknown?
629 // the column images were not supported in older versions but how to check
630 // for this? we can't use _WIN32_IE because we always define it to a very
631 // high value, so see if another symbol which is only defined starting from
632 // comctl32.dll 4.70 is available
633 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
634 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
636 item
.m_image
= lvCol
.iImage
;
638 #endif // LVCOLUMN::iImage exists
643 // Sets information about this column
644 bool wxListCtrl::SetColumn(int col
, wxListItem
& item
)
647 wxConvertToMSWListCol(col
, item
, lvCol
);
649 return ListView_SetColumn(GetHwnd(), col
, &lvCol
) != 0;
652 // Gets the column width
653 int wxListCtrl::GetColumnWidth(int col
) const
655 return ListView_GetColumnWidth(GetHwnd(), col
);
658 // Sets the column width
659 bool wxListCtrl::SetColumnWidth(int col
, int width
)
662 if ( m_windowStyle
& wxLC_LIST
)
666 if ( width2
== wxLIST_AUTOSIZE
)
667 width2
= LVSCW_AUTOSIZE
;
668 else if ( width2
== wxLIST_AUTOSIZE_USEHEADER
)
669 width2
= LVSCW_AUTOSIZE_USEHEADER
;
671 return ListView_SetColumnWidth(GetHwnd(), col2
, width2
) != 0;
674 // Gets the number of items that can fit vertically in the
675 // visible area of the list control (list or report view)
676 // or the total number of items in the list control (icon
677 // or small icon view)
678 int wxListCtrl::GetCountPerPage() const
680 return ListView_GetCountPerPage(GetHwnd());
683 // Gets the edit control for editing labels.
684 wxTextCtrl
* wxListCtrl::GetEditControl() const
689 // Gets information about the item
690 bool wxListCtrl::GetItem(wxListItem
& info
) const
693 wxZeroMemory(lvItem
);
695 lvItem
.iItem
= info
.m_itemId
;
696 lvItem
.iSubItem
= info
.m_col
;
698 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
700 lvItem
.mask
|= LVIF_TEXT
;
701 lvItem
.pszText
= new wxChar
[513];
702 lvItem
.cchTextMax
= 512;
706 lvItem
.pszText
= NULL
;
709 if (info
.m_mask
& wxLIST_MASK_DATA
)
710 lvItem
.mask
|= LVIF_PARAM
;
712 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
713 lvItem
.mask
|= LVIF_IMAGE
;
715 if ( info
.m_mask
& wxLIST_MASK_STATE
)
717 lvItem
.mask
|= LVIF_STATE
;
718 // the other bits are hardly interesting anyhow
719 lvItem
.stateMask
= LVIS_SELECTED
| LVIS_FOCUSED
;
722 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
725 wxLogError(_("Couldn't retrieve information about list control item %d."),
730 // give NULL as hwnd as we already have everything we need
731 wxConvertFromMSWListItem(NULL
, info
, lvItem
);
735 delete[] lvItem
.pszText
;
740 // Sets information about the item
741 bool wxListCtrl::SetItem(wxListItem
& info
)
744 wxConvertToMSWListItem(this, info
, item
);
746 // we never update the lParam if it contains our pointer
747 // to the wxListItemInternalData structure
748 item
.mask
&= ~LVIF_PARAM
;
750 // check if setting attributes or lParam
751 if (info
.HasAttributes() || (info
.m_mask
& wxLIST_MASK_DATA
))
753 // get internal item data
754 // perhaps a cache here ?
755 wxListItemInternalData
*data
= wxGetInternalData(this, info
.m_itemId
);
760 m_AnyInternalData
= TRUE
;
761 data
= new wxListItemInternalData();
762 item
.lParam
= (LPARAM
) data
;
763 item
.mask
|= LVIF_PARAM
;
768 if (info
.m_mask
& wxLIST_MASK_DATA
)
769 data
->lParam
= info
.m_data
;
772 if (info
.HasAttributes())
775 *data
->attr
= *info
.GetAttributes();
777 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
782 // we could be changing only the attribute in which case we don't need to
783 // call ListView_SetItem() at all
787 if ( !ListView_SetItem(GetHwnd(), &item
) )
789 wxLogDebug(_T("ListView_SetItem() failed"));
795 // we need to update the item immediately to show the new image
796 bool updateNow
= (info
.m_mask
& wxLIST_MASK_IMAGE
) != 0;
798 // check whether it has any custom attributes
799 if ( info
.HasAttributes() )
803 // if the colour has changed, we must redraw the item
809 // we need this to make the change visible right now
810 RefreshItem(item
.iItem
);
816 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
820 info
.m_mask
= wxLIST_MASK_TEXT
;
821 info
.m_itemId
= index
;
825 info
.m_image
= imageId
;
826 info
.m_mask
|= wxLIST_MASK_IMAGE
;
828 return SetItem(info
);
832 // Gets the item state
833 int wxListCtrl::GetItemState(long item
, long stateMask
) const
837 info
.m_mask
= wxLIST_MASK_STATE
;
838 info
.m_stateMask
= stateMask
;
839 info
.m_itemId
= item
;
847 // Sets the item state
848 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
850 // NB: don't use SetItem() here as it doesn't work with the virtual list
853 wxZeroMemory(lvItem
);
855 wxConvertToMSWFlags(state
, stateMask
, lvItem
);
857 // for the virtual list controls we need to refresh the previously focused
858 // item manually when changing focus without changing selection
859 // programmatically because otherwise it keeps its focus rectangle until
860 // next repaint (yet another comctl32 bug)
863 (stateMask
& wxLIST_STATE_FOCUSED
) &&
864 (state
& wxLIST_STATE_FOCUSED
) )
866 focusOld
= GetNextItem(-1, wxLIST_NEXT_ALL
, wxLIST_STATE_FOCUSED
);
873 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE
,
874 (WPARAM
)item
, (LPARAM
)&lvItem
) )
876 wxLogLastError(_T("ListView_SetItemState"));
881 if ( focusOld
!= -1 )
883 // no need to refresh the item if it was previously selected, it would
884 // only result in annoying flicker
885 if ( !(GetItemState(focusOld
,
886 wxLIST_STATE_SELECTED
) & wxLIST_STATE_SELECTED
) )
888 RefreshItem(focusOld
);
895 // Sets the item image
896 bool wxListCtrl::SetItemImage(long item
, int image
, int WXUNUSED(selImage
))
900 info
.m_mask
= wxLIST_MASK_IMAGE
;
901 info
.m_image
= image
;
902 info
.m_itemId
= item
;
904 return SetItem(info
);
907 // Gets the item text
908 wxString
wxListCtrl::GetItemText(long item
) const
912 info
.m_mask
= wxLIST_MASK_TEXT
;
913 info
.m_itemId
= item
;
916 return wxEmptyString
;
920 // Sets the item text
921 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
925 info
.m_mask
= wxLIST_MASK_TEXT
;
926 info
.m_itemId
= item
;
932 // Gets the item data
933 long wxListCtrl::GetItemData(long item
) const
937 info
.m_mask
= wxLIST_MASK_DATA
;
938 info
.m_itemId
= item
;
945 // Sets the item data
946 bool wxListCtrl::SetItemData(long item
, long data
)
950 info
.m_mask
= wxLIST_MASK_DATA
;
951 info
.m_itemId
= item
;
954 return SetItem(info
);
957 wxRect
wxListCtrl::GetViewRect() const
959 wxASSERT_MSG( !HasFlag(wxLC_REPORT
| wxLC_LIST
),
960 _T("wxListCtrl::GetViewRect() only works in icon mode") );
963 if ( !ListView_GetViewRect(GetHwnd(), &rc
) )
965 wxLogDebug(_T("ListView_GetViewRect() failed."));
971 wxCopyRECTToRect(rc
, rect
);
976 // Gets the item rectangle
977 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
982 if ( code
== wxLIST_RECT_BOUNDS
)
983 codeWin
= LVIR_BOUNDS
;
984 else if ( code
== wxLIST_RECT_ICON
)
986 else if ( code
== wxLIST_RECT_LABEL
)
987 codeWin
= LVIR_LABEL
;
990 wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
992 codeWin
= LVIR_BOUNDS
;
995 bool success
= ListView_GetItemRect(GetHwnd(), (int) item
, &rectWin
, codeWin
) != 0;
997 rect
.x
= rectWin
.left
;
998 rect
.y
= rectWin
.top
;
999 rect
.width
= rectWin
.right
- rectWin
.left
;
1000 rect
.height
= rectWin
.bottom
- rectWin
.top
;
1005 // Gets the item position
1006 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
1010 bool success
= (ListView_GetItemPosition(GetHwnd(), (int) item
, &pt
) != 0);
1012 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
1016 // Sets the item position.
1017 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
1019 return (ListView_SetItemPosition(GetHwnd(), (int) item
, pos
.x
, pos
.y
) != 0);
1022 // Gets the number of items in the list control
1023 int wxListCtrl::GetItemCount() const
1028 wxSize
wxListCtrl::GetItemSpacing() const
1030 const int spacing
= ListView_GetItemSpacing(GetHwnd(), (BOOL
)HasFlag(wxLC_SMALL_ICON
));
1032 return wxSize(LOWORD(spacing
), HIWORD(spacing
));
1035 int wxListCtrl::GetItemSpacing(bool isSmall
) const
1037 return ListView_GetItemSpacing(GetHwnd(), (BOOL
) isSmall
);
1040 void wxListCtrl::SetItemTextColour( long item
, const wxColour
&col
)
1043 info
.m_itemId
= item
;
1044 info
.SetTextColour( col
);
1048 wxColour
wxListCtrl::GetItemTextColour( long item
) const
1051 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1052 if ( data
&& data
->attr
)
1053 col
= data
->attr
->GetTextColour();
1058 void wxListCtrl::SetItemBackgroundColour( long item
, const wxColour
&col
)
1061 info
.m_itemId
= item
;
1062 info
.SetBackgroundColour( col
);
1066 wxColour
wxListCtrl::GetItemBackgroundColour( long item
) const
1069 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1070 if ( data
&& data
->attr
)
1071 col
= data
->attr
->GetBackgroundColour();
1076 // Gets the number of selected items in the list control
1077 int wxListCtrl::GetSelectedItemCount() const
1079 return ListView_GetSelectedCount(GetHwnd());
1082 // Gets the text colour of the listview
1083 wxColour
wxListCtrl::GetTextColour() const
1085 COLORREF ref
= ListView_GetTextColor(GetHwnd());
1086 wxColour
col(GetRValue(ref
), GetGValue(ref
), GetBValue(ref
));
1090 // Sets the text colour of the listview
1091 void wxListCtrl::SetTextColour(const wxColour
& col
)
1093 ListView_SetTextColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
1096 // Gets the index of the topmost visible item when in
1097 // list or report view
1098 long wxListCtrl::GetTopItem() const
1100 return (long) ListView_GetTopIndex(GetHwnd());
1103 // Searches for an item, starting from 'item'.
1104 // 'geometry' is one of
1105 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1106 // 'state' is a state bit flag, one or more of
1107 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1108 // item can be -1 to find the first item that matches the
1110 // Returns the item or -1 if unsuccessful.
1111 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
1115 if ( geom
== wxLIST_NEXT_ABOVE
)
1116 flags
|= LVNI_ABOVE
;
1117 if ( geom
== wxLIST_NEXT_ALL
)
1119 if ( geom
== wxLIST_NEXT_BELOW
)
1120 flags
|= LVNI_BELOW
;
1121 if ( geom
== wxLIST_NEXT_LEFT
)
1122 flags
|= LVNI_TOLEFT
;
1123 if ( geom
== wxLIST_NEXT_RIGHT
)
1124 flags
|= LVNI_TORIGHT
;
1126 if ( state
& wxLIST_STATE_CUT
)
1128 if ( state
& wxLIST_STATE_DROPHILITED
)
1129 flags
|= LVNI_DROPHILITED
;
1130 if ( state
& wxLIST_STATE_FOCUSED
)
1131 flags
|= LVNI_FOCUSED
;
1132 if ( state
& wxLIST_STATE_SELECTED
)
1133 flags
|= LVNI_SELECTED
;
1135 return (long) ListView_GetNextItem(GetHwnd(), item
, flags
);
1139 wxImageList
*wxListCtrl::GetImageList(int which
) const
1141 if ( which
== wxIMAGE_LIST_NORMAL
)
1143 return m_imageListNormal
;
1145 else if ( which
== wxIMAGE_LIST_SMALL
)
1147 return m_imageListSmall
;
1149 else if ( which
== wxIMAGE_LIST_STATE
)
1151 return m_imageListState
;
1156 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
1159 if ( which
== wxIMAGE_LIST_NORMAL
)
1161 flags
= LVSIL_NORMAL
;
1162 if (m_ownsImageListNormal
) delete m_imageListNormal
;
1163 m_imageListNormal
= imageList
;
1164 m_ownsImageListNormal
= FALSE
;
1166 else if ( which
== wxIMAGE_LIST_SMALL
)
1168 flags
= LVSIL_SMALL
;
1169 if (m_ownsImageListSmall
) delete m_imageListSmall
;
1170 m_imageListSmall
= imageList
;
1171 m_ownsImageListSmall
= FALSE
;
1173 else if ( which
== wxIMAGE_LIST_STATE
)
1175 flags
= LVSIL_STATE
;
1176 if (m_ownsImageListState
) delete m_imageListState
;
1177 m_imageListState
= imageList
;
1178 m_ownsImageListState
= FALSE
;
1180 ListView_SetImageList(GetHwnd(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
1183 void wxListCtrl::AssignImageList(wxImageList
*imageList
, int which
)
1185 SetImageList(imageList
, which
);
1186 if ( which
== wxIMAGE_LIST_NORMAL
)
1187 m_ownsImageListNormal
= TRUE
;
1188 else if ( which
== wxIMAGE_LIST_SMALL
)
1189 m_ownsImageListSmall
= TRUE
;
1190 else if ( which
== wxIMAGE_LIST_STATE
)
1191 m_ownsImageListState
= TRUE
;
1194 // ----------------------------------------------------------------------------
1196 // ----------------------------------------------------------------------------
1198 // Arranges the items
1199 bool wxListCtrl::Arrange(int flag
)
1202 if ( flag
== wxLIST_ALIGN_LEFT
)
1203 code
= LVA_ALIGNLEFT
;
1204 else if ( flag
== wxLIST_ALIGN_TOP
)
1205 code
= LVA_ALIGNTOP
;
1206 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
1208 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
1209 code
= LVA_SNAPTOGRID
;
1211 return (ListView_Arrange(GetHwnd(), code
) != 0);
1215 bool wxListCtrl::DeleteItem(long item
)
1217 if ( !ListView_DeleteItem(GetHwnd(), (int) item
) )
1219 wxLogLastError(_T("ListView_DeleteItem"));
1224 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1225 wxT("m_count should match ListView_GetItemCount"));
1227 // the virtual list control doesn't refresh itself correctly, help it
1230 // we need to refresh all the lines below the one which was deleted
1232 if ( item
> 0 && GetItemCount() )
1234 GetItemRect(item
- 1, rectItem
);
1239 rectItem
.height
= 0;
1242 wxRect rectWin
= GetRect();
1243 rectWin
.height
= rectWin
.GetBottom() - rectItem
.GetBottom();
1244 rectWin
.y
= rectItem
.GetBottom();
1246 RefreshRect(rectWin
);
1252 // Deletes all items
1253 bool wxListCtrl::DeleteAllItems()
1255 FreeAllInternalData();
1256 return ListView_DeleteAllItems(GetHwnd()) != 0;
1259 // Deletes all items
1260 bool wxListCtrl::DeleteAllColumns()
1262 while ( m_colCount
> 0 )
1264 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1266 wxLogLastError(wxT("ListView_DeleteColumn"));
1274 wxASSERT_MSG( m_colCount
== 0, wxT("no columns should be left") );
1280 bool wxListCtrl::DeleteColumn(int col
)
1282 bool success
= (ListView_DeleteColumn(GetHwnd(), col
) != 0);
1284 if ( success
&& (m_colCount
> 0) )
1289 // Clears items, and columns if there are any.
1290 void wxListCtrl::ClearAll()
1293 if ( m_colCount
> 0 )
1297 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
1299 wxASSERT( (textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
))) );
1301 // ListView_EditLabel requires that the list has focus.
1304 WXHWND hWnd
= (WXHWND
) ListView_EditLabel(GetHwnd(), item
);
1307 // failed to start editing
1311 // [re]create the text control wrapping the HWND we got
1314 m_textCtrl
->UnsubclassWin();
1315 m_textCtrl
->SetHWND(0);
1319 m_textCtrl
= (wxTextCtrl
*)textControlClass
->CreateObject();
1320 m_textCtrl
->SetHWND(hWnd
);
1321 m_textCtrl
->SubclassWin(hWnd
);
1322 m_textCtrl
->SetParent(this);
1324 // we must disallow TABbing away from the control while the edit contol is
1325 // shown because this leaves it in some strange state (just try removing
1326 // this line and then pressing TAB while editing an item in listctrl
1328 m_textCtrl
->SetWindowStyle(m_textCtrl
->GetWindowStyle() | wxTE_PROCESS_TAB
);
1333 // End label editing, optionally cancelling the edit
1334 bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel
))
1336 wxFAIL_MSG( _T("not implemented") );
1341 // Ensures this item is visible
1342 bool wxListCtrl::EnsureVisible(long item
)
1344 return ListView_EnsureVisible(GetHwnd(), (int) item
, FALSE
) != 0;
1347 // Find an item whose label matches this string, starting from the item after 'start'
1348 // or the beginning if 'start' is -1.
1349 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
1351 LV_FINDINFO findInfo
;
1353 findInfo
.flags
= LVFI_STRING
;
1355 findInfo
.flags
|= LVFI_PARTIAL
;
1358 // ListView_FindItem() excludes the first item from search and to look
1359 // through all the items you need to start from -1 which is unnatural and
1360 // inconsistent with the generic version - so we adjust the index
1363 return ListView_FindItem(GetHwnd(), (int) start
, &findInfo
);
1366 // Find an item whose data matches this data, starting from the item after 'start'
1367 // or the beginning if 'start' is -1.
1368 // NOTE : Lindsay Mathieson - 14-July-2002
1369 // No longer use ListView_FindItem as the data attribute is now stored
1370 // in a wxListItemInternalData structure refernced by the actual lParam
1371 long wxListCtrl::FindItem(long start
, long data
)
1373 long idx
= start
+ 1;
1374 long count
= GetItemCount();
1378 if (GetItemData(idx
) == data
)
1386 // Find an item nearest this position in the specified direction, starting from
1387 // the item after 'start' or the beginning if 'start' is -1.
1388 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
1390 LV_FINDINFO findInfo
;
1392 findInfo
.flags
= LVFI_NEARESTXY
;
1393 findInfo
.pt
.x
= pt
.x
;
1394 findInfo
.pt
.y
= pt
.y
;
1395 findInfo
.vkDirection
= VK_RIGHT
;
1397 if ( direction
== wxLIST_FIND_UP
)
1398 findInfo
.vkDirection
= VK_UP
;
1399 else if ( direction
== wxLIST_FIND_DOWN
)
1400 findInfo
.vkDirection
= VK_DOWN
;
1401 else if ( direction
== wxLIST_FIND_LEFT
)
1402 findInfo
.vkDirection
= VK_LEFT
;
1403 else if ( direction
== wxLIST_FIND_RIGHT
)
1404 findInfo
.vkDirection
= VK_RIGHT
;
1406 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
1409 // Determines which item (if any) is at the specified point,
1410 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1411 long wxListCtrl::HitTest(const wxPoint
& point
, int& flags
)
1413 LV_HITTESTINFO hitTestInfo
;
1414 hitTestInfo
.pt
.x
= (int) point
.x
;
1415 hitTestInfo
.pt
.y
= (int) point
.y
;
1417 ListView_HitTest(GetHwnd(), & hitTestInfo
);
1420 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
1421 flags
|= wxLIST_HITTEST_ABOVE
;
1422 if ( hitTestInfo
.flags
& LVHT_BELOW
)
1423 flags
|= wxLIST_HITTEST_BELOW
;
1424 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
1425 flags
|= wxLIST_HITTEST_NOWHERE
;
1426 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
1427 flags
|= wxLIST_HITTEST_ONITEMICON
;
1428 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
1429 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
1430 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
1431 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
1432 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
1433 flags
|= wxLIST_HITTEST_TOLEFT
;
1434 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
1435 flags
|= wxLIST_HITTEST_TORIGHT
;
1437 return (long) hitTestInfo
.iItem
;
1440 // Inserts an item, returning the index of the new item if successful,
1442 long wxListCtrl::InsertItem(wxListItem
& info
)
1444 wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
1447 wxConvertToMSWListItem(this, info
, item
);
1448 item
.mask
&= ~LVIF_PARAM
;
1450 // check wether we need to allocate our internal data
1451 bool needInternalData
= ((info
.m_mask
& wxLIST_MASK_DATA
) || info
.HasAttributes());
1452 if (needInternalData
)
1454 m_AnyInternalData
= TRUE
;
1455 item
.mask
|= LVIF_PARAM
;
1457 // internal stucture that manages data
1458 wxListItemInternalData
*data
= new wxListItemInternalData();
1459 item
.lParam
= (LPARAM
) data
;
1461 if (info
.m_mask
& wxLIST_MASK_DATA
)
1462 data
->lParam
= info
.m_data
;
1464 // check whether it has any custom attributes
1465 if ( info
.HasAttributes() )
1467 // take copy of attributes
1468 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
1470 // and remember that we have some now...
1471 m_hasAnyAttr
= TRUE
;
1475 long rv
= ListView_InsertItem(GetHwnd(), & item
);
1478 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1479 wxT("m_count should match ListView_GetItemCount"));
1484 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1487 info
.m_text
= label
;
1488 info
.m_mask
= wxLIST_MASK_TEXT
;
1489 info
.m_itemId
= index
;
1490 return InsertItem(info
);
1493 // Inserts an image item
1494 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1497 info
.m_image
= imageIndex
;
1498 info
.m_mask
= wxLIST_MASK_IMAGE
;
1499 info
.m_itemId
= index
;
1500 return InsertItem(info
);
1503 // Inserts an image/string item
1504 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1507 info
.m_image
= imageIndex
;
1508 info
.m_text
= label
;
1509 info
.m_mask
= wxLIST_MASK_IMAGE
| wxLIST_MASK_TEXT
;
1510 info
.m_itemId
= index
;
1511 return InsertItem(info
);
1514 // For list view mode (only), inserts a column.
1515 long wxListCtrl::InsertColumn(long col
, wxListItem
& item
)
1518 wxConvertToMSWListCol(col
, item
, lvCol
);
1520 if ( !(lvCol
.mask
& LVCF_WIDTH
) )
1522 // always give some width to the new column: this one is compatible
1523 // with the generic version
1524 lvCol
.mask
|= LVCF_WIDTH
;
1528 long n
= ListView_InsertColumn(GetHwnd(), col
, &lvCol
);
1533 else // failed to insert?
1535 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1542 long wxListCtrl::InsertColumn(long col
,
1543 const wxString
& heading
,
1548 item
.m_mask
= wxLIST_MASK_TEXT
| wxLIST_MASK_FORMAT
;
1549 item
.m_text
= heading
;
1552 item
.m_mask
|= wxLIST_MASK_WIDTH
;
1553 item
.m_width
= width
;
1555 item
.m_format
= format
;
1557 return InsertColumn(col
, item
);
1560 // scroll the control by the given number of pixels (exception: in list view,
1561 // dx is interpreted as number of columns)
1562 bool wxListCtrl::ScrollList(int dx
, int dy
)
1564 if ( !ListView_Scroll(GetHwnd(), dx
, dy
) )
1566 wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx
, dy
);
1576 // fn is a function which takes 3 long arguments: item1, item2, data.
1577 // item1 is the long data associated with a first item (NOT the index).
1578 // item2 is the long data associated with a second item (NOT the index).
1579 // data is the same value as passed to SortItems.
1580 // The return value is a negative number if the first item should precede the second
1581 // item, a positive number of the second item should precede the first,
1582 // or zero if the two items are equivalent.
1584 // data is arbitrary data to be passed to the sort function.
1586 // Internal structures for proxying the user compare function
1587 // so that we can pass it the *real* user data
1589 // translate lParam data and call user func
1590 struct wxInternalDataSort
1592 wxListCtrlCompare user_fn
;
1596 int CALLBACK
wxInternalDataCompareFunc(LPARAM lParam1
, LPARAM lParam2
, LPARAM lParamSort
)
1598 struct wxInternalDataSort
*internalData
= (struct wxInternalDataSort
*) lParamSort
;
1600 wxListItemInternalData
*data1
= (wxListItemInternalData
*) lParam1
;
1601 wxListItemInternalData
*data2
= (wxListItemInternalData
*) lParam2
;
1603 long d1
= (data1
== NULL
? 0 : data1
->lParam
);
1604 long d2
= (data2
== NULL
? 0 : data2
->lParam
);
1606 return internalData
->user_fn(d1
, d2
, internalData
->data
);
1610 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, long data
)
1612 struct wxInternalDataSort internalData
;
1613 internalData
.user_fn
= fn
;
1614 internalData
.data
= data
;
1616 // WPARAM cast is needed for mingw/cygwin
1617 if ( !ListView_SortItems(GetHwnd(),
1618 wxInternalDataCompareFunc
,
1619 (WPARAM
) &internalData
) )
1621 wxLogDebug(_T("ListView_SortItems() failed"));
1631 // ----------------------------------------------------------------------------
1632 // message processing
1633 // ----------------------------------------------------------------------------
1635 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1637 if (cmd
== EN_UPDATE
)
1639 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1640 event
.SetEventObject( this );
1641 ProcessCommand(event
);
1644 else if (cmd
== EN_KILLFOCUS
)
1646 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1647 event
.SetEventObject( this );
1648 ProcessCommand(event
);
1655 bool wxListCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
1658 // prepare the event
1659 // -----------------
1661 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1662 event
.SetEventObject(this);
1664 wxEventType eventType
= wxEVT_NULL
;
1666 NMHDR
*nmhdr
= (NMHDR
*)lParam
;
1668 // if your compiler is as broken as this, you should really change it: this
1669 // code is needed for normal operation! #ifdef below is only useful for
1670 // automatic rebuilds which are done with a very old compiler version
1671 #ifdef HDN_BEGINTRACKA
1673 // check for messages from the header (in report view)
1674 HWND hwndHdr
= ListView_GetHeader(GetHwnd());
1676 // is it a message from the header?
1677 if ( nmhdr
->hwndFrom
== hwndHdr
)
1679 HD_NOTIFY
*nmHDR
= (HD_NOTIFY
*)nmhdr
;
1681 event
.m_itemIndex
= -1;
1683 switch ( nmhdr
->code
)
1685 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1686 // TRACK messages even to ANSI programs: on my system I get
1687 // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all!
1689 // work around is to simply catch both versions and hope that it
1690 // works (why should this message exist in ANSI and Unicode is
1691 // beyond me as it doesn't deal with strings at all...)
1693 // note that fr HDN_TRACK another possibility could be to use
1694 // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when
1695 // something other than the item width changes so we'd have to
1696 // filter out the unwanted events then
1697 case HDN_BEGINTRACKA
:
1698 case HDN_BEGINTRACKW
:
1699 eventType
= wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
;
1704 if ( eventType
== wxEVT_NULL
)
1705 eventType
= wxEVT_COMMAND_LIST_COL_DRAGGING
;
1710 if ( eventType
== wxEVT_NULL
)
1711 eventType
= wxEVT_COMMAND_LIST_COL_END_DRAG
;
1713 event
.m_item
.m_width
= nmHDR
->pitem
->cxy
;
1714 event
.m_col
= nmHDR
->iItem
;
1717 #if defined(__WXWINCE__) && _WIN32_WCE < 400
1718 case GN_CONTEXTMENU
:
1719 #endif //__WXWINCE__
1722 eventType
= wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
;
1725 // find the column clicked: we have to search for it
1726 // ourselves as the notification message doesn't provide
1729 // where did the click occur?
1731 #if defined(__WXWINCE__) && _WIN32_WCE < 400
1732 if(nmhdr
->code
== GN_CONTEXTMENU
) {
1733 ptClick
= ((NMRGINFO
*)nmhdr
)->ptAction
;
1735 #endif //__WXWINCE__
1736 if ( !::GetCursorPos(&ptClick
) )
1738 wxLogLastError(_T("GetCursorPos"));
1741 if ( !::ScreenToClient(hwndHdr
, &ptClick
) )
1743 wxLogLastError(_T("ScreenToClient(listctrl header)"));
1746 event
.m_pointDrag
.x
= ptClick
.x
;
1747 event
.m_pointDrag
.y
= ptClick
.y
;
1749 int colCount
= Header_GetItemCount(hwndHdr
);
1752 for ( int col
= 0; col
< colCount
; col
++ )
1754 if ( Header_GetItemRect(hwndHdr
, col
, &rect
) )
1756 if ( ::PtInRect(&rect
, ptClick
) )
1766 case HDN_GETDISPINFOW
:
1768 LPNMHDDISPINFOW info
= (LPNMHDDISPINFOW
) lParam
;
1769 // This is a fix for a strange bug under XP.
1770 // Normally, info->iItem is a valid index, but
1771 // sometimes this is a silly (large) number
1772 // and when we return FALSE via wxControl::MSWOnNotify
1773 // to indicate that it hasn't yet been processed,
1774 // there's a GPF in Windows.
1775 // By returning TRUE here, we avoid further processing
1776 // of this strange message.
1777 if ( info
->iItem
>= GetColumnCount() )
1783 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1787 #endif // defined(HDN_BEGINTRACKA)
1788 if ( nmhdr
->hwndFrom
== GetHwnd() )
1790 // almost all messages use NM_LISTVIEW
1791 NM_LISTVIEW
*nmLV
= (NM_LISTVIEW
*)nmhdr
;
1793 const int iItem
= nmLV
->iItem
;
1796 // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be
1797 // ignored for efficiency. It is done here because the internal data is in the
1798 // process of being deleted so we don't want to try and access it below.
1799 if ( m_ignoreChangeMessages
&&
1800 ( (nmLV
->hdr
.code
== LVN_ITEMCHANGED
) || (nmLV
->hdr
.code
== LVN_ITEMCHANGING
)))
1806 // If we have a valid item then check if there is a data value
1807 // associated with it and put it in the event.
1808 if ( iItem
>= 0 && iItem
< GetItemCount() )
1810 wxListItemInternalData
*internaldata
=
1811 wxGetInternalData(GetHwnd(), iItem
);
1814 event
.m_item
.m_data
= internaldata
->lParam
;
1818 switch ( nmhdr
->code
)
1820 case LVN_BEGINRDRAG
:
1821 eventType
= wxEVT_COMMAND_LIST_BEGIN_RDRAG
;
1825 if ( eventType
== wxEVT_NULL
)
1827 eventType
= wxEVT_COMMAND_LIST_BEGIN_DRAG
;
1830 event
.m_itemIndex
= iItem
;
1831 event
.m_pointDrag
.x
= nmLV
->ptAction
.x
;
1832 event
.m_pointDrag
.y
= nmLV
->ptAction
.y
;
1835 // NB: we have to handle both *A and *W versions here because some
1836 // versions of comctl32.dll send ANSI messages even to the
1838 case LVN_BEGINLABELEDITA
:
1839 case LVN_BEGINLABELEDITW
:
1842 if ( nmhdr
->code
== LVN_BEGINLABELEDITA
)
1844 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1846 else // LVN_BEGINLABELEDITW
1848 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1851 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1852 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, item
);
1853 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1857 case LVN_ENDLABELEDITA
:
1858 case LVN_ENDLABELEDITW
:
1861 if ( nmhdr
->code
== LVN_ENDLABELEDITA
)
1863 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1865 else // LVN_ENDLABELEDITW
1867 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1870 // was editing cancelled?
1871 const LV_ITEM
& lvi
= (LV_ITEM
)item
;
1872 if ( !lvi
.pszText
|| lvi
.iItem
== -1 )
1874 // don't keep a stale wxTextCtrl around
1877 // EDIT control will be deleted by the list control itself so
1878 // prevent us from deleting it as well
1879 m_textCtrl
->UnsubclassWin();
1880 m_textCtrl
->SetHWND(0);
1885 event
.SetEditCanceled(true);
1888 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1889 wxConvertFromMSWListItem(NULL
, event
.m_item
, item
);
1890 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1894 case LVN_COLUMNCLICK
:
1895 eventType
= wxEVT_COMMAND_LIST_COL_CLICK
;
1896 event
.m_itemIndex
= -1;
1897 event
.m_col
= nmLV
->iSubItem
;
1900 case LVN_DELETEALLITEMS
:
1902 eventType
= wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
;
1903 event
.m_itemIndex
= -1;
1906 case LVN_DELETEITEM
:
1908 // this should be prevented by the post-processing code below,
1909 // but "just in case"
1912 eventType
= wxEVT_COMMAND_LIST_DELETE_ITEM
;
1913 event
.m_itemIndex
= iItem
;
1914 // delete the assoicated internal data
1915 wxDeleteInternalData(this, iItem
);
1918 case LVN_SETDISPINFO
:
1920 eventType
= wxEVT_COMMAND_LIST_SET_INFO
;
1921 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1922 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, info
->item
);
1926 case LVN_INSERTITEM
:
1927 eventType
= wxEVT_COMMAND_LIST_INSERT_ITEM
;
1928 event
.m_itemIndex
= iItem
;
1931 case LVN_ITEMCHANGED
:
1932 // we translate this catch all message into more interesting
1933 // (and more easy to process) wxWindows events
1935 // first of all, we deal with the state change events only and
1936 // only for valid items (item == -1 for the virtual list
1938 if ( nmLV
->uChanged
& LVIF_STATE
&& iItem
!= -1 )
1940 // temp vars for readability
1941 const UINT stOld
= nmLV
->uOldState
;
1942 const UINT stNew
= nmLV
->uNewState
;
1944 event
.m_item
.SetId(iItem
);
1945 event
.m_item
.SetMask(wxLIST_MASK_TEXT
|
1948 GetItem(event
.m_item
);
1950 // has the focus changed?
1951 if ( !(stOld
& LVIS_FOCUSED
) && (stNew
& LVIS_FOCUSED
) )
1953 eventType
= wxEVT_COMMAND_LIST_ITEM_FOCUSED
;
1954 event
.m_itemIndex
= iItem
;
1957 if ( (stNew
& LVIS_SELECTED
) != (stOld
& LVIS_SELECTED
) )
1959 if ( eventType
!= wxEVT_NULL
)
1961 // focus and selection have both changed: send the
1962 // focus event from here and the selection one
1964 event
.SetEventType(eventType
);
1965 (void)GetEventHandler()->ProcessEvent(event
);
1967 else // no focus event to send
1969 // then need to set m_itemIndex as it wasn't done
1971 event
.m_itemIndex
= iItem
;
1974 eventType
= stNew
& LVIS_SELECTED
1975 ? wxEVT_COMMAND_LIST_ITEM_SELECTED
1976 : wxEVT_COMMAND_LIST_ITEM_DESELECTED
;
1980 if ( eventType
== wxEVT_NULL
)
1982 // not an interesting event for us
1990 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
1991 WORD wVKey
= info
->wVKey
;
1993 // get the current selection
1994 long lItem
= GetNextItem(-1,
1996 wxLIST_STATE_SELECTED
);
1998 // <Enter> or <Space> activate the selected item if any (but
1999 // not with Shift and/or Ctrl as then they have a predefined
2000 // meaning for the list view)
2002 (wVKey
== VK_RETURN
|| wVKey
== VK_SPACE
) &&
2003 !(wxIsShiftDown() || wxIsCtrlDown()) )
2005 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2009 eventType
= wxEVT_COMMAND_LIST_KEY_DOWN
;
2011 // wxCharCodeMSWToWX() returns 0 if the key is an ASCII
2012 // value which should be used as is
2013 int code
= wxCharCodeMSWToWX(wVKey
);
2014 event
.m_code
= code
? code
: wVKey
;
2018 event
.m_item
.m_itemId
= lItem
;
2022 // fill the other fields too
2023 event
.m_item
.m_text
= GetItemText(lItem
);
2024 event
.m_item
.m_data
= GetItemData(lItem
);
2030 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2032 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2037 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
2038 // if it happened on an item (and not on empty place)
2045 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2046 event
.m_itemIndex
= iItem
;
2047 event
.m_item
.m_text
= GetItemText(iItem
);
2048 event
.m_item
.m_data
= GetItemData(iItem
);
2051 #if defined(__WXWINCE__) && _WIN32_WCE < 400
2052 case GN_CONTEXTMENU
:
2053 #endif //__WXWINCE__
2055 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2056 // don't do anything else
2057 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2062 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
2063 LV_HITTESTINFO lvhti
;
2064 wxZeroMemory(lvhti
);
2066 #if defined(__WXWINCE__) && _WIN32_WCE < 400
2067 if(nmhdr
->code
== GN_CONTEXTMENU
) {
2068 lvhti
.pt
= ((NMRGINFO
*)nmhdr
)->ptAction
;
2070 #endif //__WXWINCE__
2071 ::GetCursorPos(&(lvhti
.pt
));
2072 ::ScreenToClient(GetHwnd(),&(lvhti
.pt
));
2073 if ( ListView_HitTest(GetHwnd(),&lvhti
) != -1 )
2075 if ( lvhti
.flags
& LVHT_ONITEM
)
2077 eventType
= wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
;
2078 event
.m_itemIndex
= lvhti
.iItem
;
2079 event
.m_pointDrag
.x
= lvhti
.pt
.x
;
2080 event
.m_pointDrag
.y
= lvhti
.pt
.y
;
2085 #ifdef NM_CUSTOMDRAW
2087 *result
= OnCustomDraw(lParam
);
2090 #endif // _WIN32_IE >= 0x300
2092 case LVN_ODCACHEHINT
:
2094 const NM_CACHEHINT
*cacheHint
= (NM_CACHEHINT
*)lParam
;
2096 eventType
= wxEVT_COMMAND_LIST_CACHE_HINT
;
2098 // we get some really stupid cache hints like ones for
2099 // items in range 0..0 for an empty control or, after
2100 // deleting an item, for items in invalid range -- filter
2102 if ( cacheHint
->iFrom
> cacheHint
->iTo
)
2105 event
.m_oldItemIndex
= cacheHint
->iFrom
;
2107 const long iMax
= GetItemCount();
2108 event
.m_itemIndex
= cacheHint
->iTo
< iMax
? cacheHint
->iTo
2113 case LVN_GETDISPINFO
:
2116 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
2118 LV_ITEM
& lvi
= info
->item
;
2119 long item
= lvi
.iItem
;
2121 if ( lvi
.mask
& LVIF_TEXT
)
2123 wxString text
= OnGetItemText(item
, lvi
.iSubItem
);
2124 wxStrncpy(lvi
.pszText
, text
, lvi
.cchTextMax
);
2127 // see comment at the end of wxListCtrl::GetColumn()
2128 #ifdef NM_CUSTOMDRAW
2129 if ( lvi
.mask
& LVIF_IMAGE
)
2131 lvi
.iImage
= OnGetItemImage(item
);
2133 #endif // NM_CUSTOMDRAW
2135 // a little dose of healthy paranoia: as we never use
2136 // LVM_SETCALLBACKMASK we're not supposed to get these ones
2137 wxASSERT_MSG( !(lvi
.mask
& LVIF_STATE
),
2138 _T("we don't support state callbacks yet!") );
2145 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
2150 // where did this one come from?
2154 // process the event
2155 // -----------------
2157 event
.SetEventType(eventType
);
2159 bool processed
= GetEventHandler()->ProcessEvent(event
);
2163 switch ( nmhdr
->code
)
2165 case LVN_DELETEALLITEMS
:
2166 // always return TRUE to suppress all additional LVN_DELETEITEM
2167 // notifications - this makes deleting all items from a list ctrl
2172 case LVN_ENDLABELEDITA
:
2173 case LVN_ENDLABELEDITW
:
2174 // logic here is inversed compared to all the other messages
2175 *result
= event
.IsAllowed();
2177 // don't keep a stale wxTextCtrl around
2180 // EDIT control will be deleted by the list control itself so
2181 // prevent us from deleting it as well
2182 m_textCtrl
->UnsubclassWin();
2183 m_textCtrl
->SetHWND(0);
2192 *result
= !event
.IsAllowed();
2197 // see comment at the end of wxListCtrl::GetColumn()
2198 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2200 WXLPARAM
wxListCtrl::OnCustomDraw(WXLPARAM lParam
)
2202 LPNMLVCUSTOMDRAW lplvcd
= (LPNMLVCUSTOMDRAW
)lParam
;
2203 NMCUSTOMDRAW
& nmcd
= lplvcd
->nmcd
;
2204 switch ( nmcd
.dwDrawStage
)
2207 // if we've got any items with non standard attributes,
2208 // notify us before painting each item
2210 // for virtual controls, always suppose that we have attributes as
2211 // there is no way to check for this
2212 return IsVirtual() || m_hasAnyAttr
? CDRF_NOTIFYITEMDRAW
2215 case CDDS_ITEMPREPAINT
:
2217 size_t item
= (size_t)nmcd
.dwItemSpec
;
2218 if ( item
>= (size_t)GetItemCount() )
2220 // we get this message with item == 0 for an empty control,
2221 // we must ignore it as calling OnGetItemAttr() would be
2223 return CDRF_DODEFAULT
;
2226 wxListItemAttr
*attr
=
2227 IsVirtual() ? OnGetItemAttr(item
)
2228 : wxGetInternalDataAttr(this, item
);
2232 // nothing to do for this item
2233 return CDRF_DODEFAULT
;
2237 wxColour colText
, colBack
;
2238 if ( attr
->HasFont() )
2240 wxFont font
= attr
->GetFont();
2241 hFont
= (HFONT
)font
.GetResourceHandle();
2248 if ( attr
->HasTextColour() )
2250 colText
= attr
->GetTextColour();
2254 colText
= GetTextColour();
2257 if ( attr
->HasBackgroundColour() )
2259 colBack
= attr
->GetBackgroundColour();
2263 colBack
= GetBackgroundColour();
2266 lplvcd
->clrText
= wxColourToRGB(colText
);
2267 lplvcd
->clrTextBk
= wxColourToRGB(colBack
);
2269 // note that if we wanted to set colours for
2270 // individual columns (subitems), we would have
2271 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2274 ::SelectObject(nmcd
.hdc
, hFont
);
2276 return CDRF_NEWFONT
;
2279 // fall through to return CDRF_DODEFAULT
2282 return CDRF_DODEFAULT
;
2286 #endif // NM_CUSTOMDRAW supported
2288 // Necessary for drawing hrules and vrules, if specified
2289 void wxListCtrl::OnPaint(wxPaintEvent
& event
)
2293 wxControl::OnPaint(event
);
2295 // Reset the device origin since it may have been set
2296 dc
.SetDeviceOrigin(0, 0);
2298 bool drawHRules
= HasFlag(wxLC_HRULES
);
2299 bool drawVRules
= HasFlag(wxLC_VRULES
);
2301 if (!InReportView() || !drawHRules
&& !drawVRules
)
2304 wxPen
pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT
), 1, wxSOLID
);
2306 dc
.SetBrush(* wxTRANSPARENT_BRUSH
);
2308 wxSize clientSize
= GetClientSize();
2312 int itemCount
= GetItemCount();
2316 long top
= GetTopItem();
2317 for (i
= top
; i
< top
+ GetCountPerPage() + 1; i
++)
2319 if (GetItemRect(i
, itemRect
))
2321 cy
= itemRect
.GetTop();
2322 if (i
!= 0) // Don't draw the first one
2324 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2327 if (i
== itemCount
- 1)
2329 cy
= itemRect
.GetBottom();
2330 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2336 if (drawVRules
&& (i
> -1))
2338 wxRect firstItemRect
;
2339 GetItemRect(0, firstItemRect
);
2341 if (GetItemRect(i
, itemRect
))
2344 int x
= itemRect
.GetX();
2345 for (col
= 0; col
< GetColumnCount(); col
++)
2347 int colWidth
= GetColumnWidth(col
);
2349 dc
.DrawLine(x
-1, firstItemRect
.GetY() - 2, x
-1, itemRect
.GetBottom());
2355 // ----------------------------------------------------------------------------
2356 // virtual list controls
2357 // ----------------------------------------------------------------------------
2359 wxString
wxListCtrl::OnGetItemText(long WXUNUSED(item
), long WXUNUSED(col
)) const
2361 // this is a pure virtual function, in fact - which is not really pure
2362 // because the controls which are not virtual don't need to implement it
2363 wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") );
2365 return wxEmptyString
;
2368 int wxListCtrl::OnGetItemImage(long WXUNUSED(item
)) const
2371 wxFAIL_MSG( _T("wxListCtrl::OnGetItemImage not supposed to be called") );
2376 wxListItemAttr
*wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item
)) const
2378 wxASSERT_MSG( item
>= 0 && item
< GetItemCount(),
2379 _T("invalid item index in OnGetItemAttr()") );
2381 // no attributes by default
2385 void wxListCtrl::SetItemCount(long count
)
2387 wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
2389 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT
, (WPARAM
)count
,
2390 LVSICF_NOSCROLL
| LVSICF_NOINVALIDATEALL
) )
2392 wxLogLastError(_T("ListView_SetItemCount"));
2395 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
2396 wxT("m_count should match ListView_GetItemCount"));
2399 void wxListCtrl::RefreshItem(long item
)
2401 // strangely enough, ListView_Update() results in much more flicker here
2402 // than a dumb Refresh() -- why?
2404 if ( !ListView_Update(GetHwnd(), item
) )
2406 wxLogLastError(_T("ListView_Update"));
2410 GetItemRect(item
, rect
);
2415 void wxListCtrl::RefreshItems(long itemFrom
, long itemTo
)
2417 wxRect rect1
, rect2
;
2418 GetItemRect(itemFrom
, rect1
);
2419 GetItemRect(itemTo
, rect2
);
2421 wxRect rect
= rect1
;
2422 rect
.height
= rect2
.GetBottom() - rect1
.GetTop();
2427 // ----------------------------------------------------------------------------
2428 // internal data stuff
2429 // ----------------------------------------------------------------------------
2431 static wxListItemInternalData
*wxGetInternalData(HWND hwnd
, long itemId
)
2434 it
.mask
= LVIF_PARAM
;
2437 if ( !ListView_GetItem(hwnd
, &it
) )
2440 return (wxListItemInternalData
*) it
.lParam
;
2444 wxListItemInternalData
*wxGetInternalData(const wxListCtrl
*ctl
, long itemId
)
2446 return wxGetInternalData(GetHwndOf(ctl
), itemId
);
2449 static wxListItemAttr
*wxGetInternalDataAttr(wxListCtrl
*ctl
, long itemId
)
2451 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2453 return data
? data
->attr
: NULL
;
2456 static void wxDeleteInternalData(wxListCtrl
* ctl
, long itemId
)
2458 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2462 memset(&item
, 0, sizeof(item
));
2463 item
.iItem
= itemId
;
2464 item
.mask
= LVIF_PARAM
;
2465 item
.lParam
= (LPARAM
) 0;
2466 ListView_SetItem((HWND
)ctl
->GetHWND(), &item
);
2471 // ----------------------------------------------------------------------------
2472 // wxWin <-> MSW items conversions
2473 // ----------------------------------------------------------------------------
2475 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
2479 wxListItemInternalData
*internaldata
=
2480 (wxListItemInternalData
*) lvItem
.lParam
;
2483 info
.m_data
= internaldata
->lParam
;
2487 info
.m_stateMask
= 0;
2488 info
.m_itemId
= lvItem
.iItem
;
2490 long oldMask
= lvItem
.mask
;
2492 bool needText
= FALSE
;
2493 if (hwndListCtrl
!= 0)
2495 if ( lvItem
.mask
& LVIF_TEXT
)
2502 lvItem
.pszText
= new wxChar
[513];
2503 lvItem
.cchTextMax
= 512;
2505 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
2506 ::SendMessage(hwndListCtrl
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
);
2509 if ( lvItem
.mask
& LVIF_STATE
)
2511 info
.m_mask
|= wxLIST_MASK_STATE
;
2513 if ( lvItem
.stateMask
& LVIS_CUT
)
2515 info
.m_stateMask
|= wxLIST_STATE_CUT
;
2516 if ( lvItem
.state
& LVIS_CUT
)
2517 info
.m_state
|= wxLIST_STATE_CUT
;
2519 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
2521 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
2522 if ( lvItem
.state
& LVIS_DROPHILITED
)
2523 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
2525 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
2527 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
2528 if ( lvItem
.state
& LVIS_FOCUSED
)
2529 info
.m_state
|= wxLIST_STATE_FOCUSED
;
2531 if ( lvItem
.stateMask
& LVIS_SELECTED
)
2533 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
2534 if ( lvItem
.state
& LVIS_SELECTED
)
2535 info
.m_state
|= wxLIST_STATE_SELECTED
;
2539 if ( lvItem
.mask
& LVIF_TEXT
)
2541 info
.m_mask
|= wxLIST_MASK_TEXT
;
2542 info
.m_text
= lvItem
.pszText
;
2544 if ( lvItem
.mask
& LVIF_IMAGE
)
2546 info
.m_mask
|= wxLIST_MASK_IMAGE
;
2547 info
.m_image
= lvItem
.iImage
;
2549 if ( lvItem
.mask
& LVIF_PARAM
)
2550 info
.m_mask
|= wxLIST_MASK_DATA
;
2551 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
2552 info
.m_mask
|= wxLIST_SET_ITEM
;
2553 info
.m_col
= lvItem
.iSubItem
;
2558 delete[] lvItem
.pszText
;
2560 lvItem
.mask
= oldMask
;
2563 static void wxConvertToMSWFlags(long state
, long stateMask
, LV_ITEM
& lvItem
)
2565 if (stateMask
& wxLIST_STATE_CUT
)
2567 lvItem
.stateMask
|= LVIS_CUT
;
2568 if (state
& wxLIST_STATE_CUT
)
2569 lvItem
.state
|= LVIS_CUT
;
2571 if (stateMask
& wxLIST_STATE_DROPHILITED
)
2573 lvItem
.stateMask
|= LVIS_DROPHILITED
;
2574 if (state
& wxLIST_STATE_DROPHILITED
)
2575 lvItem
.state
|= LVIS_DROPHILITED
;
2577 if (stateMask
& wxLIST_STATE_FOCUSED
)
2579 lvItem
.stateMask
|= LVIS_FOCUSED
;
2580 if (state
& wxLIST_STATE_FOCUSED
)
2581 lvItem
.state
|= LVIS_FOCUSED
;
2583 if (stateMask
& wxLIST_STATE_SELECTED
)
2585 lvItem
.stateMask
|= LVIS_SELECTED
;
2586 if (state
& wxLIST_STATE_SELECTED
)
2587 lvItem
.state
|= LVIS_SELECTED
;
2591 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
2592 const wxListItem
& info
,
2595 lvItem
.iItem
= (int) info
.m_itemId
;
2597 lvItem
.iImage
= info
.m_image
;
2598 lvItem
.stateMask
= 0;
2601 lvItem
.iSubItem
= info
.m_col
;
2603 if (info
.m_mask
& wxLIST_MASK_STATE
)
2605 lvItem
.mask
|= LVIF_STATE
;
2607 wxConvertToMSWFlags(info
.m_state
, info
.m_stateMask
, lvItem
);
2610 if (info
.m_mask
& wxLIST_MASK_TEXT
)
2612 lvItem
.mask
|= LVIF_TEXT
;
2613 if ( ctrl
->HasFlag(wxLC_USER_TEXT
) )
2615 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
2619 // pszText is not const, hence the cast
2620 lvItem
.pszText
= (wxChar
*)info
.m_text
.c_str();
2621 if ( lvItem
.pszText
)
2622 lvItem
.cchTextMax
= info
.m_text
.Length();
2624 lvItem
.cchTextMax
= 0;
2627 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
2628 lvItem
.mask
|= LVIF_IMAGE
;
2631 static void wxConvertToMSWListCol(int WXUNUSED(col
), const wxListItem
& item
,
2634 wxZeroMemory(lvCol
);
2636 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
2638 lvCol
.mask
|= LVCF_TEXT
;
2639 lvCol
.pszText
= (wxChar
*)item
.m_text
.c_str(); // cast is safe
2642 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
2644 lvCol
.mask
|= LVCF_FMT
;
2646 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
2647 lvCol
.fmt
= LVCFMT_LEFT
;
2648 else if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
2649 lvCol
.fmt
= LVCFMT_RIGHT
;
2650 else if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
2651 lvCol
.fmt
= LVCFMT_CENTER
;
2654 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
2656 lvCol
.mask
|= LVCF_WIDTH
;
2657 if ( item
.m_width
== wxLIST_AUTOSIZE
)
2658 lvCol
.cx
= LVSCW_AUTOSIZE
;
2659 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
2660 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
2662 lvCol
.cx
= item
.m_width
;
2665 // see comment at the end of wxListCtrl::GetColumn()
2666 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2667 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
2669 if ( wxTheApp
->GetComCtl32Version() >= 470 )
2671 lvCol
.mask
|= LVCF_IMAGE
| LVCF_FMT
;
2673 // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right
2674 // seem to be generally nicer than on the left and the generic
2675 // version only draws them on the right (we don't have a flag to
2676 // specify the image location anyhow)
2678 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
2679 // make any difference in my tests -- but maybe we should?
2680 lvCol
.fmt
|= LVCFMT_BITMAP_ON_RIGHT
| LVCFMT_IMAGE
;
2682 lvCol
.iImage
= item
.m_image
;
2684 //else: it doesn't support item images anyhow
2686 #endif // _WIN32_IE >= 0x0300
2689 #endif // wxUSE_LISTCTRL