1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/listctrl.cpp
4 // Author: Julian Smart
5 // Modified by: Agron Selimaj
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"
29 #include "wx/listctrl.h"
32 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
36 #include "wx/settings.h"
37 #include "wx/stopwatch.h"
38 #include "wx/dcclient.h"
39 #include "wx/textctrl.h"
42 #include "wx/imaglist.h"
43 #include "wx/vector.h"
45 #include "wx/msw/private.h"
46 #include "wx/msw/private/keyboard.h"
48 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__)
56 // Currently gcc and watcom don't define NMLVFINDITEM, and DMC only defines
57 // it by its old name NM_FINDTIEM.
59 #if defined(__VISUALC__) || defined(__BORLANDC__) || defined(NMLVFINDITEM)
60 #define HAVE_NMLVFINDITEM 1
61 #elif defined(__DMC__) || defined(NM_FINDITEM)
62 #define HAVE_NMLVFINDITEM 1
63 #define NMLVFINDITEM NM_FINDITEM
66 // ----------------------------------------------------------------------------
68 // ----------------------------------------------------------------------------
70 // convert our state and mask flags to LV_ITEM constants
71 static void wxConvertToMSWFlags(long state
, long mask
, LV_ITEM
& lvItem
);
73 // convert wxListItem to LV_ITEM
74 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
75 const wxListItem
& info
, LV_ITEM
& lvItem
);
77 // convert LV_ITEM to wxListItem
78 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
80 /* const */ LV_ITEM
& lvItem
);
82 // convert our wxListItem to LV_COLUMN
83 static void wxConvertToMSWListCol(HWND hwndList
,
85 const wxListItem
& item
,
91 // replacement for ListView_GetSubItemRect() which provokes warnings like
92 // "the address of 'rc' will always evaluate as 'true'" when used with mingw32
95 // this function does no error checking on item and subitem parameters, notice
96 // that subitem 0 means the whole item so there is no way to retrieve the
97 // rectangle of the first subitem using this function, in particular notice
98 // that the index is *not* 1-based, in spite of what MSDN says
100 wxGetListCtrlSubItemRect(HWND hwnd
, int item
, int subitem
, int flags
, RECT
& rect
)
104 return ::SendMessage(hwnd
, LVM_GETSUBITEMRECT
, item
, (LPARAM
)&rect
) != 0;
108 wxGetListCtrlItemRect(HWND hwnd
, int item
, int flags
, RECT
& rect
)
110 return wxGetListCtrlSubItemRect(hwnd
, item
, 0, flags
, rect
);
113 } // anonymous namespace
115 // ----------------------------------------------------------------------------
116 // private helper classes
117 // ----------------------------------------------------------------------------
119 // We have to handle both fooW and fooA notifications in several cases
120 // because of broken comctl32.dll and/or unicows.dll. This class is used to
121 // convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or
122 // LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed
123 // by wxConvertToMSWListItem().
125 #define LV_ITEM_NATIVE LV_ITEMW
126 #define LV_ITEM_OTHER LV_ITEMA
128 #define LV_CONV_TO_WX cMB2WX
129 #define LV_CONV_BUF wxMB2WXbuf
131 #define LV_ITEM_NATIVE LV_ITEMA
132 #define LV_ITEM_OTHER LV_ITEMW
134 #define LV_CONV_TO_WX cWC2WX
135 #define LV_CONV_BUF wxWC2WXbuf
136 #endif // Unicode/ANSI
141 // default ctor, use Init() later
142 wxLV_ITEM() { m_buf
= NULL
; m_pItem
= NULL
; }
144 // init without conversion
145 void Init(LV_ITEM_NATIVE
& item
)
147 wxASSERT_MSG( !m_pItem
, wxT("Init() called twice?") );
152 // init with conversion
153 void Init(const LV_ITEM_OTHER
& item
)
155 // avoid unnecessary dynamic memory allocation, jjust make m_pItem
156 // point to our own m_item
158 // memcpy() can't work if the struct sizes are different
159 wxCOMPILE_TIME_ASSERT( sizeof(LV_ITEM_OTHER
) == sizeof(LV_ITEM_NATIVE
),
160 CodeCantWorkIfDiffSizes
);
162 memcpy(&m_item
, &item
, sizeof(LV_ITEM_NATIVE
));
164 // convert text from ANSI to Unicod if necessary
165 if ( (item
.mask
& LVIF_TEXT
) && item
.pszText
)
167 m_buf
= new LV_CONV_BUF(wxConvLocal
.LV_CONV_TO_WX(item
.pszText
));
168 m_item
.pszText
= (wxChar
*)m_buf
->data();
172 // ctor without conversion
173 wxLV_ITEM(LV_ITEM_NATIVE
& item
) : m_buf(NULL
), m_pItem(&item
) { }
175 // ctor with conversion
176 wxLV_ITEM(LV_ITEM_OTHER
& item
) : m_buf(NULL
)
181 ~wxLV_ITEM() { delete m_buf
; }
183 // conversion to the real LV_ITEM
184 operator LV_ITEM_NATIVE
&() const { return *m_pItem
; }
189 LV_ITEM_NATIVE
*m_pItem
;
190 LV_ITEM_NATIVE m_item
;
192 wxDECLARE_NO_COPY_CLASS(wxLV_ITEM
);
195 ///////////////////////////////////////////////////////
197 // The MSW version had problems with SetTextColour() et
198 // al as the wxListItemAttr's were stored keyed on the
199 // item index. If a item was inserted anywhere but the end
200 // of the list the text attributes (colour etc) for
201 // the following items were out of sync.
204 // Under MSW the only way to associate data with a List
205 // item independent of its position in the list is to
206 // store a pointer to it in its lParam attribute. However
207 // user programs are already using this (via the
208 // SetItemData() GetItemData() calls).
210 // However what we can do is store a pointer to a
211 // structure which contains the attributes we want *and*
212 // a lParam -- and this is what wxMSWListItemData does.
214 // To conserve memory, a wxMSWListItemData is
215 // only allocated for a LV_ITEM if text attributes or
216 // user data(lparam) are being set.
217 class wxMSWListItemData
220 wxMSWListItemData() : attr(NULL
), lParam(0) {}
221 ~wxMSWListItemData() { delete attr
; }
223 wxListItemAttr
*attr
;
224 LPARAM lParam
; // real user data
226 wxDECLARE_NO_COPY_CLASS(wxMSWListItemData
);
229 BEGIN_EVENT_TABLE(wxListCtrl
, wxListCtrlBase
)
230 EVT_PAINT(wxListCtrl::OnPaint
)
231 EVT_CHAR_HOOK(wxListCtrl::OnCharHook
)
234 // ============================================================================
236 // ============================================================================
238 // ----------------------------------------------------------------------------
239 // wxListCtrl construction
240 // ----------------------------------------------------------------------------
242 void wxListCtrl::Init()
246 m_imageListState
= NULL
;
247 m_ownsImageListNormal
=
248 m_ownsImageListSmall
=
249 m_ownsImageListState
= false;
255 m_hasAnyAttr
= false;
258 bool wxListCtrl::Create(wxWindow
*parent
,
263 const wxValidator
& validator
,
264 const wxString
& name
)
266 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
269 if ( !MSWCreateControl(WC_LISTVIEW
, wxEmptyString
, pos
, size
) )
272 // explicitly say that we want to use Unicode because otherwise we get ANSI
273 // versions of _some_ messages (notably LVN_GETDISPINFOA) in MSLU build
274 wxSetCCUnicodeFormat(GetHwnd());
276 // We must set the default text colour to the system/theme color, otherwise
277 // GetTextColour will always return black
278 SetTextColour(GetDefaultAttributes().colFg
);
280 if ( InReportView() )
281 MSWSetExListStyles();
286 void wxListCtrl::MSWSetExListStyles()
288 // for comctl32.dll v 4.70+ we want to have some non default extended
289 // styles because it's prettier (and also because wxGTK does it like this)
290 if ( wxApp::GetComCtl32Version() >= 470 )
294 GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE
, 0,
295 // LVS_EX_LABELTIP shouldn't be used under Windows CE where it's
296 // not defined in the SDK headers
297 #ifdef LVS_EX_LABELTIP
300 LVS_EX_FULLROWSELECT
|
301 LVS_EX_SUBITEMIMAGES
|
302 // normally this should be governed by a style as it's probably not
303 // always appropriate, but we don't have any free styles left and
304 // it seems better to enable it by default than disable
305 LVS_EX_HEADERDRAGDROP
310 WXDWORD
wxListCtrl::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
312 WXDWORD wstyle
= wxListCtrlBase::MSWGetStyle(style
, exstyle
);
314 wstyle
|= LVS_SHAREIMAGELISTS
| LVS_SHOWSELALWAYS
;
319 #define MAP_MODE_STYLE(wx, ms) \
320 if ( style & (wx) ) { wstyle |= (ms); nModes++; }
321 #else // !wxDEBUG_LEVEL
322 #define MAP_MODE_STYLE(wx, ms) \
323 if ( style & (wx) ) wstyle |= (ms);
324 #endif // wxDEBUG_LEVEL/!wxDEBUG_LEVEL
326 MAP_MODE_STYLE(wxLC_ICON
, LVS_ICON
)
327 MAP_MODE_STYLE(wxLC_SMALL_ICON
, LVS_SMALLICON
)
328 MAP_MODE_STYLE(wxLC_LIST
, LVS_LIST
)
329 MAP_MODE_STYLE(wxLC_REPORT
, LVS_REPORT
)
331 wxASSERT_MSG( nModes
== 1,
332 wxT("wxListCtrl style should have exactly one mode bit set") );
334 #undef MAP_MODE_STYLE
336 if ( style
& wxLC_ALIGN_LEFT
)
337 wstyle
|= LVS_ALIGNLEFT
;
339 if ( style
& wxLC_ALIGN_TOP
)
340 wstyle
|= LVS_ALIGNTOP
;
342 if ( style
& wxLC_AUTOARRANGE
)
343 wstyle
|= LVS_AUTOARRANGE
;
345 if ( style
& wxLC_NO_SORT_HEADER
)
346 wstyle
|= LVS_NOSORTHEADER
;
348 if ( style
& wxLC_NO_HEADER
)
349 wstyle
|= LVS_NOCOLUMNHEADER
;
351 if ( style
& wxLC_EDIT_LABELS
)
352 wstyle
|= LVS_EDITLABELS
;
354 if ( style
& wxLC_SINGLE_SEL
)
355 wstyle
|= LVS_SINGLESEL
;
357 if ( style
& wxLC_SORT_ASCENDING
)
359 wstyle
|= LVS_SORTASCENDING
;
361 wxASSERT_MSG( !(style
& wxLC_SORT_DESCENDING
),
362 wxT("can't sort in ascending and descending orders at once") );
364 else if ( style
& wxLC_SORT_DESCENDING
)
365 wstyle
|= LVS_SORTDESCENDING
;
367 #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
368 if ( style
& wxLC_VIRTUAL
)
370 int ver
= wxApp::GetComCtl32Version();
373 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."),
374 ver
/ 100, ver
% 100);
377 wstyle
|= LVS_OWNERDATA
;
379 #endif // ancient cygwin
384 void wxListCtrl::UpdateStyle()
388 // The new window view style
389 DWORD dwStyleNew
= MSWGetStyle(m_windowStyle
, NULL
);
391 // some styles are not returned by MSWGetStyle()
393 dwStyleNew
|= WS_VISIBLE
;
395 // Get the current window style.
396 DWORD dwStyleOld
= ::GetWindowLong(GetHwnd(), GWL_STYLE
);
398 // we don't have wxVSCROLL style, but the list control may have it,
399 // don't change it then
400 dwStyleNew
|= dwStyleOld
& (WS_HSCROLL
| WS_VSCROLL
);
402 // Only set the window style if the view bits have changed.
403 if ( dwStyleOld
!= dwStyleNew
)
405 ::SetWindowLong(GetHwnd(), GWL_STYLE
, dwStyleNew
);
407 // if we switched to the report view, set the extended styles for
409 if ( !(dwStyleOld
& LVS_REPORT
) && (dwStyleNew
& LVS_REPORT
) )
410 MSWSetExListStyles();
415 void wxListCtrl::FreeAllInternalData()
417 const unsigned count
= m_internalData
.size();
418 for ( unsigned n
= 0; n
< count
; n
++ )
419 delete m_internalData
[n
];
421 m_internalData
.clear();
424 void wxListCtrl::DeleteEditControl()
428 m_textCtrl
->UnsubclassWin();
429 m_textCtrl
->SetHWND(0);
430 wxDELETE(m_textCtrl
);
434 wxListCtrl::~wxListCtrl()
436 FreeAllInternalData();
440 if (m_ownsImageListNormal
)
441 delete m_imageListNormal
;
442 if (m_ownsImageListSmall
)
443 delete m_imageListSmall
;
444 if (m_ownsImageListState
)
445 delete m_imageListState
;
448 // ----------------------------------------------------------------------------
449 // set/get/change style
450 // ----------------------------------------------------------------------------
452 // Add or remove a single window style
453 void wxListCtrl::SetSingleStyle(long style
, bool add
)
455 long flag
= GetWindowStyleFlag();
457 // Get rid of conflicting styles
460 if ( style
& wxLC_MASK_TYPE
)
461 flag
= flag
& ~wxLC_MASK_TYPE
;
462 if ( style
& wxLC_MASK_ALIGN
)
463 flag
= flag
& ~wxLC_MASK_ALIGN
;
464 if ( style
& wxLC_MASK_SORT
)
465 flag
= flag
& ~wxLC_MASK_SORT
;
473 SetWindowStyleFlag(flag
);
476 // Set the whole window style
477 void wxListCtrl::SetWindowStyleFlag(long flag
)
479 if ( flag
!= m_windowStyle
)
481 wxListCtrlBase::SetWindowStyleFlag(flag
);
489 // ----------------------------------------------------------------------------
491 // ----------------------------------------------------------------------------
493 /* static */ wxVisualAttributes
494 wxListCtrl::GetClassDefaultAttributes(wxWindowVariant variant
)
496 wxVisualAttributes attrs
= GetCompositeControlsDefaultAttributes(variant
);
498 // common controls have their own default font
499 attrs
.font
= wxGetCCDefaultFont();
504 // Sets the foreground, i.e. text, colour
505 bool wxListCtrl::SetForegroundColour(const wxColour
& col
)
507 if ( !wxWindow::SetForegroundColour(col
) )
510 ListView_SetTextColor(GetHwnd(), wxColourToRGB(col
));
515 // Sets the background colour
516 bool wxListCtrl::SetBackgroundColour(const wxColour
& col
)
518 if ( !wxWindow::SetBackgroundColour(col
) )
521 // we set the same colour for both the "empty" background and the items
523 COLORREF color
= wxColourToRGB(col
);
524 ListView_SetBkColor(GetHwnd(), color
);
525 ListView_SetTextBkColor(GetHwnd(), color
);
530 // Gets information about this column
531 bool wxListCtrl::GetColumn(int col
, wxListItem
& item
) const
536 lvCol
.mask
= LVCF_WIDTH
;
538 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
540 lvCol
.mask
|= LVCF_TEXT
;
541 lvCol
.pszText
= new wxChar
[513];
542 lvCol
.cchTextMax
= 512;
545 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
547 lvCol
.mask
|= LVCF_FMT
;
550 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
552 lvCol
.mask
|= LVCF_IMAGE
;
555 bool success
= ListView_GetColumn(GetHwnd(), col
, &lvCol
) != 0;
557 // item.m_subItem = lvCol.iSubItem;
558 item
.m_width
= lvCol
.cx
;
560 if ( (item
.m_mask
& wxLIST_MASK_TEXT
) && lvCol
.pszText
)
562 item
.m_text
= lvCol
.pszText
;
563 delete[] lvCol
.pszText
;
566 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
568 switch (lvCol
.fmt
& LVCFMT_JUSTIFYMASK
) {
570 item
.m_format
= wxLIST_FORMAT_LEFT
;
573 item
.m_format
= wxLIST_FORMAT_RIGHT
;
576 item
.m_format
= wxLIST_FORMAT_CENTRE
;
579 item
.m_format
= -1; // Unknown?
584 // the column images were not supported in older versions but how to check
585 // for this? we can't use _WIN32_IE because we always define it to a very
586 // high value, so see if another symbol which is only defined starting from
587 // comctl32.dll 4.70 is available
588 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
589 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
591 item
.m_image
= lvCol
.iImage
;
593 #endif // LVCOLUMN::iImage exists
598 // Sets information about this column
599 bool wxListCtrl::SetColumn(int col
, const wxListItem
& item
)
602 wxConvertToMSWListCol(GetHwnd(), col
, item
, lvCol
);
604 return ListView_SetColumn(GetHwnd(), col
, &lvCol
) != 0;
607 // Gets the column width
608 int wxListCtrl::GetColumnWidth(int col
) const
610 return ListView_GetColumnWidth(GetHwnd(), col
);
613 // Sets the column width
614 bool wxListCtrl::SetColumnWidth(int col
, int width
)
616 if ( m_windowStyle
& wxLC_LIST
)
619 if ( width
== wxLIST_AUTOSIZE
)
620 width
= LVSCW_AUTOSIZE
;
621 else if ( width
== wxLIST_AUTOSIZE_USEHEADER
)
622 width
= LVSCW_AUTOSIZE_USEHEADER
;
624 return ListView_SetColumnWidth(GetHwnd(), col
, width
) != 0;
627 // ----------------------------------------------------------------------------
629 // ----------------------------------------------------------------------------
631 int wxListCtrl::GetColumnIndexFromOrder(int order
) const
633 const int numCols
= GetColumnCount();
634 wxCHECK_MSG( order
>= 0 && order
< numCols
, -1,
635 wxT("Column position out of bounds") );
637 wxArrayInt
indexArray(numCols
);
638 if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols
, &indexArray
[0]) )
641 return indexArray
[order
];
644 int wxListCtrl::GetColumnOrder(int col
) const
646 const int numCols
= GetColumnCount();
647 wxASSERT_MSG( col
>= 0 && col
< numCols
, wxT("Column index out of bounds") );
649 wxArrayInt
indexArray(numCols
);
650 if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols
, &indexArray
[0]) )
653 for ( int pos
= 0; pos
< numCols
; pos
++ )
655 if ( indexArray
[pos
] == col
)
659 wxFAIL_MSG( wxT("no column with with given order?") );
664 // Gets the column order for all columns
665 wxArrayInt
wxListCtrl::GetColumnsOrder() const
667 const int numCols
= GetColumnCount();
669 wxArrayInt
orders(numCols
);
670 if ( !ListView_GetColumnOrderArray(GetHwnd(), numCols
, &orders
[0]) )
676 // Sets the column order for all columns
677 bool wxListCtrl::SetColumnsOrder(const wxArrayInt
& orders
)
679 const int numCols
= GetColumnCount();
681 wxCHECK_MSG( orders
.size() == (size_t)numCols
, false,
682 wxT("wrong number of elements in column orders array") );
684 return ListView_SetColumnOrderArray(GetHwnd(), numCols
, &orders
[0]) != 0;
688 // Gets the number of items that can fit vertically in the
689 // visible area of the list control (list or report view)
690 // or the total number of items in the list control (icon
691 // or small icon view)
692 int wxListCtrl::GetCountPerPage() const
694 return ListView_GetCountPerPage(GetHwnd());
697 // Gets the edit control for editing labels.
698 wxTextCtrl
* wxListCtrl::GetEditControl() const
700 // first check corresponds to the case when the label editing was started
701 // by user and hence m_textCtrl wasn't created by EditLabel() at all, while
702 // the second case corresponds to us being called from inside EditLabel()
703 // (e.g. from a user wxEVT_LIST_BEGIN_LABEL_EDIT handler): in this
704 // case EditLabel() did create the control but it didn't have an HWND to
705 // initialize it with yet
706 if ( !m_textCtrl
|| !m_textCtrl
->GetHWND() )
708 HWND hwndEdit
= ListView_GetEditControl(GetHwnd());
711 wxListCtrl
* const self
= const_cast<wxListCtrl
*>(this);
714 self
->m_textCtrl
= new wxTextCtrl
;
715 self
->InitEditControl((WXHWND
)hwndEdit
);
722 // Gets information about the item
723 bool wxListCtrl::GetItem(wxListItem
& info
) const
726 wxZeroMemory(lvItem
);
728 lvItem
.iItem
= info
.m_itemId
;
729 lvItem
.iSubItem
= info
.m_col
;
731 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
733 lvItem
.mask
|= LVIF_TEXT
;
734 lvItem
.pszText
= new wxChar
[513];
735 lvItem
.cchTextMax
= 512;
739 lvItem
.pszText
= NULL
;
742 if (info
.m_mask
& wxLIST_MASK_DATA
)
743 lvItem
.mask
|= LVIF_PARAM
;
745 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
746 lvItem
.mask
|= LVIF_IMAGE
;
748 if ( info
.m_mask
& wxLIST_MASK_STATE
)
750 lvItem
.mask
|= LVIF_STATE
;
751 wxConvertToMSWFlags(0, info
.m_stateMask
, lvItem
);
754 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
757 wxLogError(_("Couldn't retrieve information about list control item %d."),
762 // give NULL as hwnd as we already have everything we need
763 wxConvertFromMSWListItem(NULL
, info
, lvItem
);
767 delete[] lvItem
.pszText
;
772 // Sets information about the item
773 bool wxListCtrl::SetItem(wxListItem
& info
)
775 const long id
= info
.GetId();
776 wxCHECK_MSG( id
>= 0 && id
< GetItemCount(), false,
777 wxT("invalid item index in SetItem") );
780 wxConvertToMSWListItem(this, info
, item
);
782 // we never update the lParam if it contains our pointer
783 // to the wxMSWListItemData structure
784 item
.mask
&= ~LVIF_PARAM
;
786 // check if setting attributes or lParam
787 if ( info
.HasAttributes() || (info
.m_mask
& wxLIST_MASK_DATA
) )
789 // get internal item data
790 wxMSWListItemData
*data
= MSWGetItemData(id
);
794 // need to allocate the internal data object
795 data
= new wxMSWListItemData
;
796 m_internalData
.push_back(data
);
797 item
.lParam
= (LPARAM
) data
;
798 item
.mask
|= LVIF_PARAM
;
803 if ( info
.m_mask
& wxLIST_MASK_DATA
)
804 data
->lParam
= info
.m_data
;
807 if ( info
.HasAttributes() )
809 const wxListItemAttr
& attrNew
= *info
.GetAttributes();
811 // don't overwrite the already set attributes if we have them
813 data
->attr
->AssignFrom(attrNew
);
815 data
->attr
= new wxListItemAttr(attrNew
);
820 // we could be changing only the attribute in which case we don't need to
821 // call ListView_SetItem() at all
824 if ( !ListView_SetItem(GetHwnd(), &item
) )
826 wxLogDebug(wxT("ListView_SetItem() failed"));
832 // we need to update the item immediately to show the new image
833 bool updateNow
= (info
.m_mask
& wxLIST_MASK_IMAGE
) != 0;
835 // check whether it has any custom attributes
836 if ( info
.HasAttributes() )
840 // if the colour has changed, we must redraw the item
846 // we need this to make the change visible right now
847 RefreshItem(item
.iItem
);
853 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
857 info
.m_mask
= wxLIST_MASK_TEXT
;
858 info
.m_itemId
= index
;
862 info
.m_image
= imageId
;
863 info
.m_mask
|= wxLIST_MASK_IMAGE
;
865 return SetItem(info
);
869 // Gets the item state
870 int wxListCtrl::GetItemState(long item
, long stateMask
) const
874 info
.m_mask
= wxLIST_MASK_STATE
;
875 info
.m_stateMask
= stateMask
;
876 info
.m_itemId
= item
;
884 // Sets the item state
885 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
887 // NB: don't use SetItem() here as it doesn't work with the virtual list
890 wxZeroMemory(lvItem
);
892 wxConvertToMSWFlags(state
, stateMask
, lvItem
);
894 const bool changingFocus
= (stateMask
& wxLIST_STATE_FOCUSED
) &&
895 (state
& wxLIST_STATE_FOCUSED
);
897 // for the virtual list controls we need to refresh the previously focused
898 // item manually when changing focus without changing selection
899 // programmatically because otherwise it keeps its focus rectangle until
900 // next repaint (yet another comctl32 bug)
902 if ( IsVirtual() && changingFocus
)
904 focusOld
= GetNextItem(-1, wxLIST_NEXT_ALL
, wxLIST_STATE_FOCUSED
);
911 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE
,
912 (WPARAM
)item
, (LPARAM
)&lvItem
) )
914 wxLogLastError(wxT("ListView_SetItemState"));
919 if ( focusOld
!= -1 )
921 // no need to refresh the item if it was previously selected, it would
922 // only result in annoying flicker
923 if ( !(GetItemState(focusOld
,
924 wxLIST_STATE_SELECTED
) & wxLIST_STATE_SELECTED
) )
926 RefreshItem(focusOld
);
930 // we expect the selection anchor, i.e. the item from which multiple
931 // selection (such as performed with e.g. Shift-arrows) starts, to be the
932 // same as the currently focused item but the native control doesn't update
933 // it when we change focus and leaves at the last item it set itself focus
934 // to, so do it explicitly
935 if ( changingFocus
&& !HasFlag(wxLC_SINGLE_SEL
) )
937 ListView_SetSelectionMark(GetHwnd(), item
);
943 // Sets the item image
944 bool wxListCtrl::SetItemImage(long item
, int image
, int WXUNUSED(selImage
))
946 return SetItemColumnImage(item
, 0, image
);
949 // Sets the item image
950 bool wxListCtrl::SetItemColumnImage(long item
, long column
, int image
)
954 info
.m_mask
= wxLIST_MASK_IMAGE
;
955 info
.m_image
= image
;
956 info
.m_itemId
= item
;
959 return SetItem(info
);
962 // Gets the item text
963 wxString
wxListCtrl::GetItemText(long item
, int col
) const
967 info
.m_mask
= wxLIST_MASK_TEXT
;
968 info
.m_itemId
= item
;
972 return wxEmptyString
;
976 // Sets the item text
977 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
981 info
.m_mask
= wxLIST_MASK_TEXT
;
982 info
.m_itemId
= item
;
988 // Gets the internal item data
989 wxMSWListItemData
*wxListCtrl::MSWGetItemData(long itemId
) const
992 it
.mask
= LVIF_PARAM
;
995 if ( !ListView_GetItem(GetHwnd(), &it
) )
998 return (wxMSWListItemData
*) it
.lParam
;
1001 // Gets the item data
1002 wxUIntPtr
wxListCtrl::GetItemData(long item
) const
1006 info
.m_mask
= wxLIST_MASK_DATA
;
1007 info
.m_itemId
= item
;
1014 // Sets the item data
1015 bool wxListCtrl::SetItemPtrData(long item
, wxUIntPtr data
)
1019 info
.m_mask
= wxLIST_MASK_DATA
;
1020 info
.m_itemId
= item
;
1023 return SetItem(info
);
1026 wxRect
wxListCtrl::GetViewRect() const
1030 // ListView_GetViewRect() can only be used in icon and small icon views
1031 // (this is documented in MSDN and, indeed, it returns bogus results in
1032 // report view, at least with comctl32.dll v6 under Windows 2003)
1033 if ( HasFlag(wxLC_ICON
| wxLC_SMALL_ICON
) )
1036 if ( !ListView_GetViewRect(GetHwnd(), &rc
) )
1038 wxLogDebug(wxT("ListView_GetViewRect() failed."));
1043 wxCopyRECTToRect(rc
, rect
);
1045 else if ( HasFlag(wxLC_REPORT
) )
1047 const long count
= GetItemCount();
1050 GetItemRect(wxMin(GetTopItem() + GetCountPerPage(), count
- 1), rect
);
1052 // extend the rectangle to start at the top (we include the column
1053 // headers, if any, for compatibility with the generic version)
1054 rect
.height
+= rect
.y
;
1060 wxFAIL_MSG( wxT("not implemented in this mode") );
1066 // Gets the item rectangle
1067 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
1069 return GetSubItemRect( item
, wxLIST_GETSUBITEMRECT_WHOLEITEM
, rect
, code
) ;
1072 bool wxListCtrl::GetSubItemRect(long item
, long subItem
, wxRect
& rect
, int code
) const
1074 // ListView_GetSubItemRect() doesn't do subItem error checking and returns
1075 // true even for the out of range values of it (even if the results are
1076 // completely bogus in this case), so we check item validity ourselves
1077 wxCHECK_MSG( subItem
== wxLIST_GETSUBITEMRECT_WHOLEITEM
||
1078 (subItem
>= 0 && subItem
< GetColumnCount()),
1079 false, wxT("invalid sub item index") );
1081 // use wxCHECK_MSG against "item" too, for coherency with the generic implementation:
1082 wxCHECK_MSG( item
>= 0 && item
< GetItemCount(), false,
1083 wxT("invalid item in GetSubItemRect") );
1086 if ( code
== wxLIST_RECT_BOUNDS
)
1087 codeWin
= LVIR_BOUNDS
;
1088 else if ( code
== wxLIST_RECT_ICON
)
1089 codeWin
= LVIR_ICON
;
1090 else if ( code
== wxLIST_RECT_LABEL
)
1091 codeWin
= LVIR_LABEL
;
1094 wxFAIL_MSG( wxT("incorrect code in GetItemRect() / GetSubItemRect()") );
1095 codeWin
= LVIR_BOUNDS
;
1099 if ( !wxGetListCtrlSubItemRect
1103 subItem
== wxLIST_GETSUBITEMRECT_WHOLEITEM
? 0 : subItem
,
1111 wxCopyRECTToRect(rectWin
, rect
);
1113 // there is no way to retrieve the first sub item bounding rectangle using
1114 // wxGetListCtrlSubItemRect() as 0 means the whole item, so we need to
1115 // truncate it at first column ourselves
1116 if ( subItem
== 0 && code
== wxLIST_RECT_BOUNDS
)
1117 rect
.width
= GetColumnWidth(0);
1125 // Gets the item position
1126 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
1130 bool success
= (ListView_GetItemPosition(GetHwnd(), (int) item
, &pt
) != 0);
1132 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
1136 // Sets the item position.
1137 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
1139 return (ListView_SetItemPosition(GetHwnd(), (int) item
, pos
.x
, pos
.y
) != 0);
1142 // Gets the number of items in the list control
1143 int wxListCtrl::GetItemCount() const
1148 wxSize
wxListCtrl::GetItemSpacing() const
1150 const int spacing
= ListView_GetItemSpacing(GetHwnd(), (BOOL
)HasFlag(wxLC_SMALL_ICON
));
1152 return wxSize(LOWORD(spacing
), HIWORD(spacing
));
1155 #if WXWIN_COMPATIBILITY_2_6
1157 int wxListCtrl::GetItemSpacing(bool isSmall
) const
1159 return ListView_GetItemSpacing(GetHwnd(), (BOOL
) isSmall
);
1162 #endif // WXWIN_COMPATIBILITY_2_6
1164 void wxListCtrl::SetItemTextColour( long item
, const wxColour
&col
)
1167 info
.m_itemId
= item
;
1168 info
.SetTextColour( col
);
1172 wxColour
wxListCtrl::GetItemTextColour( long item
) const
1175 wxMSWListItemData
*data
= MSWGetItemData(item
);
1176 if ( data
&& data
->attr
)
1177 col
= data
->attr
->GetTextColour();
1182 void wxListCtrl::SetItemBackgroundColour( long item
, const wxColour
&col
)
1185 info
.m_itemId
= item
;
1186 info
.SetBackgroundColour( col
);
1190 wxColour
wxListCtrl::GetItemBackgroundColour( long item
) const
1193 wxMSWListItemData
*data
= MSWGetItemData(item
);
1194 if ( data
&& data
->attr
)
1195 col
= data
->attr
->GetBackgroundColour();
1200 void wxListCtrl::SetItemFont( long item
, const wxFont
&f
)
1203 info
.m_itemId
= item
;
1208 wxFont
wxListCtrl::GetItemFont( long item
) const
1211 wxMSWListItemData
*data
= MSWGetItemData(item
);
1212 if ( data
&& data
->attr
)
1213 f
= data
->attr
->GetFont();
1218 // Gets the number of selected items in the list control
1219 int wxListCtrl::GetSelectedItemCount() const
1221 return ListView_GetSelectedCount(GetHwnd());
1224 // Gets the text colour of the listview
1225 wxColour
wxListCtrl::GetTextColour() const
1227 COLORREF ref
= ListView_GetTextColor(GetHwnd());
1228 wxColour
col(GetRValue(ref
), GetGValue(ref
), GetBValue(ref
));
1232 // Sets the text colour of the listview
1233 void wxListCtrl::SetTextColour(const wxColour
& col
)
1235 ListView_SetTextColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
1238 // Gets the index of the topmost visible item when in
1239 // list or report view
1240 long wxListCtrl::GetTopItem() const
1242 return (long) ListView_GetTopIndex(GetHwnd());
1245 // Searches for an item, starting from 'item'.
1246 // 'geometry' is one of
1247 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1248 // 'state' is a state bit flag, one or more of
1249 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1250 // item can be -1 to find the first item that matches the
1252 // Returns the item or -1 if unsuccessful.
1253 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
1257 if ( geom
== wxLIST_NEXT_ABOVE
)
1258 flags
|= LVNI_ABOVE
;
1259 if ( geom
== wxLIST_NEXT_ALL
)
1261 if ( geom
== wxLIST_NEXT_BELOW
)
1262 flags
|= LVNI_BELOW
;
1263 if ( geom
== wxLIST_NEXT_LEFT
)
1264 flags
|= LVNI_TOLEFT
;
1265 if ( geom
== wxLIST_NEXT_RIGHT
)
1266 flags
|= LVNI_TORIGHT
;
1268 if ( state
& wxLIST_STATE_CUT
)
1270 if ( state
& wxLIST_STATE_DROPHILITED
)
1271 flags
|= LVNI_DROPHILITED
;
1272 if ( state
& wxLIST_STATE_FOCUSED
)
1273 flags
|= LVNI_FOCUSED
;
1274 if ( state
& wxLIST_STATE_SELECTED
)
1275 flags
|= LVNI_SELECTED
;
1277 return (long) ListView_GetNextItem(GetHwnd(), item
, flags
);
1281 wxImageList
*wxListCtrl::GetImageList(int which
) const
1283 if ( which
== wxIMAGE_LIST_NORMAL
)
1285 return m_imageListNormal
;
1287 else if ( which
== wxIMAGE_LIST_SMALL
)
1289 return m_imageListSmall
;
1291 else if ( which
== wxIMAGE_LIST_STATE
)
1293 return m_imageListState
;
1298 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
1301 if ( which
== wxIMAGE_LIST_NORMAL
)
1303 flags
= LVSIL_NORMAL
;
1304 if (m_ownsImageListNormal
) delete m_imageListNormal
;
1305 m_imageListNormal
= imageList
;
1306 m_ownsImageListNormal
= false;
1308 else if ( which
== wxIMAGE_LIST_SMALL
)
1310 flags
= LVSIL_SMALL
;
1311 if (m_ownsImageListSmall
) delete m_imageListSmall
;
1312 m_imageListSmall
= imageList
;
1313 m_ownsImageListSmall
= false;
1315 else if ( which
== wxIMAGE_LIST_STATE
)
1317 flags
= LVSIL_STATE
;
1318 if (m_ownsImageListState
) delete m_imageListState
;
1319 m_imageListState
= imageList
;
1320 m_ownsImageListState
= false;
1322 (void) ListView_SetImageList(GetHwnd(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
1325 void wxListCtrl::AssignImageList(wxImageList
*imageList
, int which
)
1327 SetImageList(imageList
, which
);
1328 if ( which
== wxIMAGE_LIST_NORMAL
)
1329 m_ownsImageListNormal
= true;
1330 else if ( which
== wxIMAGE_LIST_SMALL
)
1331 m_ownsImageListSmall
= true;
1332 else if ( which
== wxIMAGE_LIST_STATE
)
1333 m_ownsImageListState
= true;
1336 // ----------------------------------------------------------------------------
1338 // ----------------------------------------------------------------------------
1340 wxSize
wxListCtrl::MSWGetBestViewRect(int x
, int y
) const
1342 // The cast is necessary to suppress a MinGW warning due to a missing cast
1343 // to WPARAM in the definition of ListView_ApproximateViewRect() in its
1344 // own headers (this was the case up to at least MinGW 4.8).
1345 const DWORD rc
= ListView_ApproximateViewRect(GetHwnd(), x
, y
, (WPARAM
)-1);
1347 wxSize
size(LOWORD(rc
), HIWORD(rc
));
1349 // We have to add space for the scrollbars ourselves, they're not taken
1350 // into account by ListView_ApproximateViewRect(), at least not with
1351 // commctrl32.dll v6.
1352 const DWORD mswStyle
= ::GetWindowLong(GetHwnd(), GWL_STYLE
);
1354 if ( mswStyle
& WS_HSCROLL
)
1355 size
.y
+= wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y
);
1356 if ( mswStyle
& WS_VSCROLL
)
1357 size
.x
+= wxSystemSettings::GetMetric(wxSYS_VSCROLL_X
);
1362 // ----------------------------------------------------------------------------
1364 // ----------------------------------------------------------------------------
1366 // Arranges the items
1367 bool wxListCtrl::Arrange(int flag
)
1370 if ( flag
== wxLIST_ALIGN_LEFT
)
1371 code
= LVA_ALIGNLEFT
;
1372 else if ( flag
== wxLIST_ALIGN_TOP
)
1373 code
= LVA_ALIGNTOP
;
1374 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
1376 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
1377 code
= LVA_SNAPTOGRID
;
1379 return (ListView_Arrange(GetHwnd(), code
) != 0);
1383 bool wxListCtrl::DeleteItem(long item
)
1385 if ( !ListView_DeleteItem(GetHwnd(), (int) item
) )
1387 wxLogLastError(wxT("ListView_DeleteItem"));
1392 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1393 wxT("m_count should match ListView_GetItemCount"));
1395 // the virtual list control doesn't refresh itself correctly, help it
1398 // we need to refresh all the lines below the one which was deleted
1400 if ( item
> 0 && GetItemCount() )
1402 GetItemRect(item
- 1, rectItem
);
1407 rectItem
.height
= 0;
1410 wxRect rectWin
= GetRect();
1411 rectWin
.height
= rectWin
.GetBottom() - rectItem
.GetBottom();
1412 rectWin
.y
= rectItem
.GetBottom();
1414 RefreshRect(rectWin
);
1420 // Deletes all items
1421 bool wxListCtrl::DeleteAllItems()
1423 // Calling ListView_DeleteAllItems() will always generate an event but we
1424 // shouldn't do it if the control is empty
1425 return !GetItemCount() || ListView_DeleteAllItems(GetHwnd()) != 0;
1428 // Deletes all items
1429 bool wxListCtrl::DeleteAllColumns()
1431 while ( m_colCount
> 0 )
1433 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1435 wxLogLastError(wxT("ListView_DeleteColumn"));
1443 wxASSERT_MSG( m_colCount
== 0, wxT("no columns should be left") );
1449 bool wxListCtrl::DeleteColumn(int col
)
1451 bool success
= (ListView_DeleteColumn(GetHwnd(), col
) != 0);
1453 if ( success
&& (m_colCount
> 0) )
1458 // Clears items, and columns if there are any.
1459 void wxListCtrl::ClearAll()
1462 if ( m_colCount
> 0 )
1466 void wxListCtrl::InitEditControl(WXHWND hWnd
)
1468 m_textCtrl
->SetHWND(hWnd
);
1469 m_textCtrl
->SubclassWin(hWnd
);
1470 m_textCtrl
->SetParent(this);
1472 // we must disallow TABbing away from the control while the edit control is
1473 // shown because this leaves it in some strange state (just try removing
1474 // this line and then pressing TAB while editing an item in listctrl
1476 m_textCtrl
->SetWindowStyle(m_textCtrl
->GetWindowStyle() | wxTE_PROCESS_TAB
);
1479 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
1481 wxCHECK_MSG( textControlClass
->IsKindOf(wxCLASSINFO(wxTextCtrl
)), NULL
,
1482 "control used for label editing must be a wxTextCtrl" );
1484 // ListView_EditLabel requires that the list has focus.
1487 // create m_textCtrl here before calling ListView_EditLabel() because it
1488 // generates wxEVT_LIST_BEGIN_LABEL_EDIT event from inside it and
1489 // the user handler for it can call GetEditControl() resulting in an on
1490 // demand creation of a stock wxTextCtrl instead of the control of a
1491 // (possibly) custom wxClassInfo
1492 DeleteEditControl();
1493 m_textCtrl
= (wxTextCtrl
*)textControlClass
->CreateObject();
1495 WXHWND hWnd
= (WXHWND
) ListView_EditLabel(GetHwnd(), item
);
1498 // failed to start editing
1499 wxDELETE(m_textCtrl
);
1504 // if GetEditControl() hasn't been called, we need to initialize the edit
1505 // control ourselves
1506 if ( !m_textCtrl
->GetHWND() )
1507 InitEditControl(hWnd
);
1512 // End label editing, optionally cancelling the edit
1513 bool wxListCtrl::EndEditLabel(bool cancel
)
1515 // m_textCtrl is not always ready, ie. in EVT_LIST_BEGIN_LABEL_EDIT
1516 HWND hwnd
= ListView_GetEditControl(GetHwnd());
1520 // Newer versions of Windows have a special ListView_CancelEditLabel()
1521 // message for cancelling editing but it, rather counter-intuitively, keeps
1522 // the last text entered in the dialog while cancelling as we do it below
1523 // restores the original text which is the more expected behaviour.
1525 // We shouldn't destroy the control ourselves according to MSDN, which
1526 // proposes WM_CANCELMODE to do this, but it doesn't seem to work so
1527 // emulate the corresponding user action instead.
1528 ::SendMessage(hwnd
, WM_KEYDOWN
, cancel
? VK_ESCAPE
: VK_RETURN
, 0);
1533 // Ensures this item is visible
1534 bool wxListCtrl::EnsureVisible(long item
)
1536 return ListView_EnsureVisible(GetHwnd(), (int) item
, FALSE
) != FALSE
;
1539 // Find an item whose label matches this string, starting from the item after 'start'
1540 // or the beginning if 'start' is -1.
1541 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
1543 LV_FINDINFO findInfo
;
1545 findInfo
.flags
= LVFI_STRING
;
1547 findInfo
.flags
|= LVFI_PARTIAL
;
1548 findInfo
.psz
= str
.t_str();
1550 // ListView_FindItem() excludes the first item from search and to look
1551 // through all the items you need to start from -1 which is unnatural and
1552 // inconsistent with the generic version - so we adjust the index
1555 return ListView_FindItem(GetHwnd(), start
, &findInfo
);
1558 // Find an item whose data matches this data, starting from the item after
1559 // 'start' or the beginning if 'start' is -1.
1560 long wxListCtrl::FindItem(long start
, wxUIntPtr data
)
1562 // we can't use ListView_FindItem() directly as we don't store the data
1563 // pointer itself in the control but rather our own internal data, so first
1564 // we need to find the right value to search for (and there can be several
1566 int idx
= wxNOT_FOUND
;
1567 const unsigned count
= m_internalData
.size();
1568 for ( unsigned n
= 0; n
< count
; n
++ )
1570 if ( m_internalData
[n
]->lParam
== (LPARAM
)data
)
1572 LV_FINDINFO findInfo
;
1573 findInfo
.flags
= LVFI_PARAM
;
1574 findInfo
.lParam
= (LPARAM
)wxPtrToUInt(m_internalData
[n
]);
1576 int rc
= ListView_FindItem(GetHwnd(), start
, &findInfo
);
1579 if ( idx
== wxNOT_FOUND
|| rc
< idx
)
1582 if ( idx
== start
+ 1 )
1584 // we can stop here, we don't risk finding a closer
1589 //else: this item is after the previously found one
1597 // Find an item nearest this position in the specified direction, starting from
1598 // the item after 'start' or the beginning if 'start' is -1.
1599 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
1601 LV_FINDINFO findInfo
;
1603 findInfo
.flags
= LVFI_NEARESTXY
;
1604 findInfo
.pt
.x
= pt
.x
;
1605 findInfo
.pt
.y
= pt
.y
;
1606 findInfo
.vkDirection
= VK_RIGHT
;
1608 if ( direction
== wxLIST_FIND_UP
)
1609 findInfo
.vkDirection
= VK_UP
;
1610 else if ( direction
== wxLIST_FIND_DOWN
)
1611 findInfo
.vkDirection
= VK_DOWN
;
1612 else if ( direction
== wxLIST_FIND_LEFT
)
1613 findInfo
.vkDirection
= VK_LEFT
;
1614 else if ( direction
== wxLIST_FIND_RIGHT
)
1615 findInfo
.vkDirection
= VK_RIGHT
;
1617 return ListView_FindItem(GetHwnd(), start
, &findInfo
);
1620 // Determines which item (if any) is at the specified point,
1621 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1623 wxListCtrl::HitTest(const wxPoint
& point
, int& flags
, long *ptrSubItem
) const
1625 LV_HITTESTINFO hitTestInfo
;
1626 hitTestInfo
.pt
.x
= (int) point
.x
;
1627 hitTestInfo
.pt
.y
= (int) point
.y
;
1630 #ifdef LVM_SUBITEMHITTEST
1631 if ( ptrSubItem
&& wxApp::GetComCtl32Version() >= 470 )
1633 item
= ListView_SubItemHitTest(GetHwnd(), &hitTestInfo
);
1634 *ptrSubItem
= hitTestInfo
.iSubItem
;
1637 #endif // LVM_SUBITEMHITTEST
1639 item
= ListView_HitTest(GetHwnd(), &hitTestInfo
);
1644 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
1645 flags
|= wxLIST_HITTEST_ABOVE
;
1646 if ( hitTestInfo
.flags
& LVHT_BELOW
)
1647 flags
|= wxLIST_HITTEST_BELOW
;
1648 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
1649 flags
|= wxLIST_HITTEST_TOLEFT
;
1650 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
1651 flags
|= wxLIST_HITTEST_TORIGHT
;
1653 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
1654 flags
|= wxLIST_HITTEST_NOWHERE
;
1656 // note a bug or at least a very strange feature of comtl32.dll (tested
1657 // with version 4.0 under Win95 and 6.0 under Win 2003): if you click to
1658 // the right of the item label, ListView_HitTest() returns a combination of
1659 // LVHT_ONITEMICON, LVHT_ONITEMLABEL and LVHT_ONITEMSTATEICON -- filter out
1660 // the bits which don't make sense
1661 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
1663 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
1665 // do not translate LVHT_ONITEMICON here, as per above
1669 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
1670 flags
|= wxLIST_HITTEST_ONITEMICON
;
1671 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
1672 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
1679 // Inserts an item, returning the index of the new item if successful,
1681 long wxListCtrl::InsertItem(const wxListItem
& info
)
1683 wxASSERT_MSG( !IsVirtual(), wxT("can't be used with virtual controls") );
1685 // In 2.8 it was possible to succeed inserting an item without initializing
1686 // its ID as it defaulted to 0. This was however never supported and in 2.9
1687 // the ID is -1 by default and inserting it simply fails, but it might be
1688 // not obvious why does it happen, so check it proactively.
1689 wxASSERT_MSG( info
.m_itemId
!= -1, wxS("Item ID must be set.") );
1692 wxConvertToMSWListItem(this, info
, item
);
1693 item
.mask
&= ~LVIF_PARAM
;
1695 // check whether we need to allocate our internal data
1696 bool needInternalData
= (info
.m_mask
& wxLIST_MASK_DATA
) ||
1697 info
.HasAttributes();
1698 if ( needInternalData
)
1700 item
.mask
|= LVIF_PARAM
;
1702 wxMSWListItemData
* const data
= new wxMSWListItemData
;
1703 m_internalData
.push_back(data
);
1704 item
.lParam
= (LPARAM
)data
;
1706 if ( info
.m_mask
& wxLIST_MASK_DATA
)
1707 data
->lParam
= info
.m_data
;
1709 // check whether it has any custom attributes
1710 if ( info
.HasAttributes() )
1712 // take copy of attributes
1713 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
1715 // and remember that we have some now...
1716 m_hasAnyAttr
= true;
1720 const long rv
= ListView_InsertItem(GetHwnd(), & item
);
1722 // failing to insert the item is really unexpected
1723 wxCHECK_MSG( rv
!= -1, rv
, "failed to insert an item in wxListCtrl" );
1726 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1727 wxT("m_count should match ListView_GetItemCount"));
1732 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1735 info
.m_text
= label
;
1736 info
.m_mask
= wxLIST_MASK_TEXT
;
1737 info
.m_itemId
= index
;
1738 return InsertItem(info
);
1741 // Inserts an image item
1742 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1745 info
.m_image
= imageIndex
;
1746 info
.m_mask
= wxLIST_MASK_IMAGE
;
1747 info
.m_itemId
= index
;
1748 return InsertItem(info
);
1751 // Inserts an image/string item
1752 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1755 info
.m_image
= imageIndex
;
1756 info
.m_text
= label
;
1757 info
.m_mask
= wxLIST_MASK_TEXT
;
1758 if (imageIndex
> -1)
1759 info
.m_mask
|= wxLIST_MASK_IMAGE
;
1760 info
.m_itemId
= index
;
1761 return InsertItem(info
);
1764 // For list view mode (only), inserts a column.
1765 long wxListCtrl::DoInsertColumn(long col
, const wxListItem
& item
)
1768 wxConvertToMSWListCol(GetHwnd(), col
, item
, lvCol
);
1770 // LVSCW_AUTOSIZE_USEHEADER is not supported when inserting new column,
1771 // we'll deal with it below instead. Plain LVSCW_AUTOSIZE is not supported
1772 // neither but it doesn't need any special handling as we use fixed value
1773 // for it here, both because we can't do anything else (there are no items
1774 // with values in this column to compute the size from yet) and for
1775 // compatibility as wxLIST_AUTOSIZE == -1 and -1 as InsertColumn() width
1776 // parameter used to mean "arbitrary fixed width".
1777 if ( !(lvCol
.mask
& LVCF_WIDTH
) || lvCol
.cx
< 0 )
1779 // always give some width to the new column: this one is compatible
1780 // with the generic version
1781 lvCol
.mask
|= LVCF_WIDTH
;
1785 long n
= ListView_InsertColumn(GetHwnd(), col
, &lvCol
);
1788 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1795 // Now adjust the new column size.
1796 if ( (item
.GetMask() & wxLIST_MASK_WIDTH
) &&
1797 (item
.GetWidth() == wxLIST_AUTOSIZE_USEHEADER
) )
1799 SetColumnWidth(n
, wxLIST_AUTOSIZE_USEHEADER
);
1805 // scroll the control by the given number of pixels (exception: in list view,
1806 // dx is interpreted as number of columns)
1807 bool wxListCtrl::ScrollList(int dx
, int dy
)
1809 if ( !ListView_Scroll(GetHwnd(), dx
, dy
) )
1811 wxLogDebug(wxT("ListView_Scroll(%d, %d) failed"), dx
, dy
);
1821 // fn is a function which takes 3 long arguments: item1, item2, data.
1822 // item1 is the long data associated with a first item (NOT the index).
1823 // item2 is the long data associated with a second item (NOT the index).
1824 // data is the same value as passed to SortItems.
1825 // The return value is a negative number if the first item should precede the second
1826 // item, a positive number of the second item should precede the first,
1827 // or zero if the two items are equivalent.
1829 // data is arbitrary data to be passed to the sort function.
1831 // Internal structures for proxying the user compare function
1832 // so that we can pass it the *real* user data
1834 // translate lParam data and call user func
1835 struct wxInternalDataSort
1837 wxListCtrlCompare user_fn
;
1841 int CALLBACK
wxInternalDataCompareFunc(LPARAM lParam1
, LPARAM lParam2
, LPARAM lParamSort
)
1843 wxInternalDataSort
* const internalData
= (wxInternalDataSort
*) lParamSort
;
1845 wxMSWListItemData
*data1
= (wxMSWListItemData
*) lParam1
;
1846 wxMSWListItemData
*data2
= (wxMSWListItemData
*) lParam2
;
1848 wxIntPtr d1
= (data1
== NULL
? 0 : data1
->lParam
);
1849 wxIntPtr d2
= (data2
== NULL
? 0 : data2
->lParam
);
1851 return internalData
->user_fn(d1
, d2
, internalData
->data
);
1855 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, wxIntPtr data
)
1857 wxInternalDataSort internalData
;
1858 internalData
.user_fn
= fn
;
1859 internalData
.data
= data
;
1861 // WPARAM cast is needed for mingw/cygwin
1862 if ( !ListView_SortItems(GetHwnd(),
1863 wxInternalDataCompareFunc
,
1864 (WPARAM
) &internalData
) )
1866 wxLogDebug(wxT("ListView_SortItems() failed"));
1876 // ----------------------------------------------------------------------------
1877 // message processing
1878 // ----------------------------------------------------------------------------
1880 bool wxListCtrl::MSWShouldPreProcessMessage(WXMSG
* msg
)
1882 if ( msg
->message
== WM_KEYDOWN
)
1884 // Only eat VK_RETURN if not being used by the application in
1885 // conjunction with modifiers
1886 if ( msg
->wParam
== VK_RETURN
&& !wxIsAnyModifierDown() )
1888 // we need VK_RETURN to generate wxEVT_LIST_ITEM_ACTIVATED
1892 return wxListCtrlBase::MSWShouldPreProcessMessage(msg
);
1895 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id_
)
1897 const int id
= (signed short)id_
;
1898 if (cmd
== EN_UPDATE
)
1900 wxCommandEvent
event(wxEVT_TEXT
, id
);
1901 event
.SetEventObject( this );
1902 ProcessCommand(event
);
1905 else if (cmd
== EN_KILLFOCUS
)
1907 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1908 event
.SetEventObject( this );
1909 ProcessCommand(event
);
1916 // utility used by wxListCtrl::MSWOnNotify and by wxDataViewHeaderWindowMSW::MSWOnNotify
1917 int WXDLLIMPEXP_CORE
wxMSWGetColumnClicked(NMHDR
*nmhdr
, POINT
*ptClick
)
1919 // find the column clicked: we have to search for it ourselves as the
1920 // notification message doesn't provide this info
1922 // where did the click occur?
1923 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1924 if ( nmhdr
->code
== GN_CONTEXTMENU
)
1926 *ptClick
= ((NMRGINFO
*)nmhdr
)->ptAction
;
1929 #endif //__WXWINCE__
1931 wxGetCursorPosMSW(ptClick
);
1934 // we need to use listctrl coordinates for the event point so this is what
1935 // we return in ptClick, but for comparison with Header_GetItemRect()
1936 // result below we need to use header window coordinates
1937 POINT ptClickHeader
= *ptClick
;
1938 if ( !::ScreenToClient(nmhdr
->hwndFrom
, &ptClickHeader
) )
1940 wxLogLastError(wxT("ScreenToClient(listctrl header)"));
1943 if ( !::ScreenToClient(::GetParent(nmhdr
->hwndFrom
), ptClick
) )
1945 wxLogLastError(wxT("ScreenToClient(listctrl)"));
1948 const int colCount
= Header_GetItemCount(nmhdr
->hwndFrom
);
1949 for ( int col
= 0; col
< colCount
; col
++ )
1952 if ( Header_GetItemRect(nmhdr
->hwndFrom
, col
, &rect
) )
1954 if ( ::PtInRect(&rect
, ptClickHeader
) )
1964 bool wxListCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
1967 // prepare the event
1968 // -----------------
1970 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1971 event
.SetEventObject(this);
1973 wxEventType eventType
= wxEVT_NULL
;
1975 NMHDR
*nmhdr
= (NMHDR
*)lParam
;
1977 // if your compiler is as broken as this, you should really change it: this
1978 // code is needed for normal operation! #ifdef below is only useful for
1979 // automatic rebuilds which are done with a very old compiler version
1980 #ifdef HDN_BEGINTRACKA
1982 // check for messages from the header (in report view)
1983 HWND hwndHdr
= ListView_GetHeader(GetHwnd());
1985 // is it a message from the header?
1986 if ( nmhdr
->hwndFrom
== hwndHdr
)
1988 HD_NOTIFY
*nmHDR
= (HD_NOTIFY
*)nmhdr
;
1990 event
.m_itemIndex
= -1;
1992 bool ignore
= false;
1993 switch ( nmhdr
->code
)
1995 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1996 // TRACK messages even to ANSI programs: on my system I get
1997 // HDN_BEGINTRACKW and HDN_ENDTRACKA!
1999 // work around is to simply catch both versions and hope that it
2000 // works (why should this message exist in ANSI and Unicode is
2001 // beyond me as it doesn't deal with strings at all...)
2003 // another problem is that HDN_TRACK is not sent at all by header
2004 // with HDS_FULLDRAG style which is used by default by wxListCtrl
2005 // under recent Windows versions (starting from at least XP) so we
2006 // need to use HDN_ITEMCHANGING instead of it
2007 case HDN_BEGINTRACKA
:
2008 case HDN_BEGINTRACKW
:
2009 eventType
= wxEVT_LIST_COL_BEGIN_DRAG
;
2012 case HDN_ITEMCHANGING
:
2013 if ( eventType
== wxEVT_NULL
)
2015 if ( !nmHDR
->pitem
|| !(nmHDR
->pitem
->mask
& HDI_WIDTH
) )
2017 // something other than the width is being changed,
2023 // also ignore the events sent when the width didn't really
2024 // change: this is not just an optimization but also gets
2025 // rid of a useless and unexpected DRAGGING event which
2026 // would otherwise be sent after the END_DRAG one as we get
2027 // an HDN_ITEMCHANGING after HDN_ENDTRACK for some reason
2028 if ( nmHDR
->pitem
->cxy
== GetColumnWidth(nmHDR
->iItem
) )
2034 eventType
= wxEVT_LIST_COL_DRAGGING
;
2040 if ( eventType
== wxEVT_NULL
)
2041 eventType
= wxEVT_LIST_COL_END_DRAG
;
2043 event
.m_item
.m_width
= nmHDR
->pitem
->cxy
;
2044 event
.m_col
= nmHDR
->iItem
;
2047 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2048 case GN_CONTEXTMENU
:
2049 #endif //__WXWINCE__
2054 eventType
= wxEVT_LIST_COL_RIGHT_CLICK
;
2055 event
.m_col
= wxMSWGetColumnClicked(nmhdr
, &ptClick
);
2056 event
.m_pointDrag
.x
= ptClick
.x
;
2057 event
.m_pointDrag
.y
= ptClick
.y
;
2061 case HDN_GETDISPINFOW
:
2062 // letting Windows XP handle this message results in mysterious
2063 // crashes in comctl32.dll seemingly because of bad message
2066 // I have no idea what is the real cause of the bug (which is,
2067 // just to make things interesting, impossible to reproduce
2068 // reliably) but ignoring all these messages does fix it and
2069 // doesn't seem to have any negative consequences
2077 return wxListCtrlBase::MSWOnNotify(idCtrl
, lParam
, result
);
2080 #endif // defined(HDN_BEGINTRACKA)
2081 if ( nmhdr
->hwndFrom
== GetHwnd() )
2083 // almost all messages use NM_LISTVIEW
2084 NM_LISTVIEW
*nmLV
= (NM_LISTVIEW
*)nmhdr
;
2086 const int iItem
= nmLV
->iItem
;
2089 // If we have a valid item then check if there is a data value
2090 // associated with it and put it in the event.
2091 if ( iItem
>= 0 && iItem
< GetItemCount() )
2093 wxMSWListItemData
*internaldata
=
2094 MSWGetItemData(iItem
);
2097 event
.m_item
.m_data
= internaldata
->lParam
;
2100 bool processed
= true;
2101 switch ( nmhdr
->code
)
2103 case LVN_BEGINRDRAG
:
2104 eventType
= wxEVT_LIST_BEGIN_RDRAG
;
2108 if ( eventType
== wxEVT_NULL
)
2110 eventType
= wxEVT_LIST_BEGIN_DRAG
;
2113 event
.m_itemIndex
= iItem
;
2114 event
.m_pointDrag
.x
= nmLV
->ptAction
.x
;
2115 event
.m_pointDrag
.y
= nmLV
->ptAction
.y
;
2118 // NB: we have to handle both *A and *W versions here because some
2119 // versions of comctl32.dll send ANSI messages even to the
2121 case LVN_BEGINLABELEDITA
:
2122 case LVN_BEGINLABELEDITW
:
2125 if ( nmhdr
->code
== LVN_BEGINLABELEDITA
)
2127 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
2129 else // LVN_BEGINLABELEDITW
2131 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
2134 eventType
= wxEVT_LIST_BEGIN_LABEL_EDIT
;
2135 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, item
);
2136 event
.m_itemIndex
= event
.m_item
.m_itemId
;
2140 case LVN_ENDLABELEDITA
:
2141 case LVN_ENDLABELEDITW
:
2144 if ( nmhdr
->code
== LVN_ENDLABELEDITA
)
2146 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
2148 else // LVN_ENDLABELEDITW
2150 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
2153 // was editing cancelled?
2154 const LV_ITEM
& lvi
= (LV_ITEM
)item
;
2155 if ( !lvi
.pszText
|| lvi
.iItem
== -1 )
2157 // EDIT control will be deleted by the list control
2158 // itself so prevent us from deleting it as well
2159 DeleteEditControl();
2161 event
.SetEditCanceled(true);
2164 eventType
= wxEVT_LIST_END_LABEL_EDIT
;
2165 wxConvertFromMSWListItem(NULL
, event
.m_item
, item
);
2166 event
.m_itemIndex
= event
.m_item
.m_itemId
;
2170 case LVN_COLUMNCLICK
:
2171 eventType
= wxEVT_LIST_COL_CLICK
;
2172 event
.m_itemIndex
= -1;
2173 event
.m_col
= nmLV
->iSubItem
;
2176 case LVN_DELETEALLITEMS
:
2177 eventType
= wxEVT_LIST_DELETE_ALL_ITEMS
;
2178 event
.m_itemIndex
= -1;
2181 case LVN_DELETEITEM
:
2184 // this should be prevented by the post-processing code
2185 // below, but "just in case"
2189 eventType
= wxEVT_LIST_DELETE_ITEM
;
2190 event
.m_itemIndex
= iItem
;
2194 case LVN_INSERTITEM
:
2195 eventType
= wxEVT_LIST_INSERT_ITEM
;
2196 event
.m_itemIndex
= iItem
;
2199 case LVN_ITEMCHANGED
:
2200 // we translate this catch all message into more interesting
2201 // (and more easy to process) wxWidgets events
2203 // first of all, we deal with the state change events only and
2204 // only for valid items (item == -1 for the virtual list
2206 if ( nmLV
->uChanged
& LVIF_STATE
&& iItem
!= -1 )
2208 // temp vars for readability
2209 const UINT stOld
= nmLV
->uOldState
;
2210 const UINT stNew
= nmLV
->uNewState
;
2212 event
.m_item
.SetId(iItem
);
2213 event
.m_item
.SetMask(wxLIST_MASK_TEXT
|
2216 GetItem(event
.m_item
);
2218 // has the focus changed?
2219 if ( !(stOld
& LVIS_FOCUSED
) && (stNew
& LVIS_FOCUSED
) )
2221 eventType
= wxEVT_LIST_ITEM_FOCUSED
;
2222 event
.m_itemIndex
= iItem
;
2225 if ( (stNew
& LVIS_SELECTED
) != (stOld
& LVIS_SELECTED
) )
2227 if ( eventType
!= wxEVT_NULL
)
2229 // focus and selection have both changed: send the
2230 // focus event from here and the selection one
2232 event
.SetEventType(eventType
);
2233 (void)HandleWindowEvent(event
);
2235 else // no focus event to send
2237 // then need to set m_itemIndex as it wasn't done
2239 event
.m_itemIndex
= iItem
;
2242 eventType
= stNew
& LVIS_SELECTED
2243 ? wxEVT_LIST_ITEM_SELECTED
2244 : wxEVT_LIST_ITEM_DESELECTED
;
2248 if ( eventType
== wxEVT_NULL
)
2250 // not an interesting event for us
2258 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
2259 WORD wVKey
= info
->wVKey
;
2261 // get the current selection
2262 long lItem
= GetNextItem(-1,
2264 wxLIST_STATE_SELECTED
);
2266 // <Enter> or <Space> activate the selected item if any (but
2267 // not with any modifiers as they have a predefined meaning
2270 (wVKey
== VK_RETURN
|| wVKey
== VK_SPACE
) &&
2271 !wxIsAnyModifierDown() )
2273 eventType
= wxEVT_LIST_ITEM_ACTIVATED
;
2277 eventType
= wxEVT_LIST_KEY_DOWN
;
2279 event
.m_code
= wxMSWKeyboard::VKToWX(wVKey
);
2281 if ( event
.m_code
== WXK_NONE
)
2283 // We can't translate this to a standard key code,
2284 // until support for Unicode key codes is added to
2285 // wxListEvent we just ignore them.
2291 event
.m_item
.m_itemId
= lItem
;
2295 // fill the other fields too
2296 event
.m_item
.m_text
= GetItemText(lItem
);
2297 event
.m_item
.m_data
= GetItemData(lItem
);
2303 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2305 if ( wxListCtrlBase::MSWOnNotify(idCtrl
, lParam
, result
) )
2310 // else translate it into wxEVT_LIST_ITEM_ACTIVATED event
2311 // if it happened on an item (and not on empty place)
2318 eventType
= wxEVT_LIST_ITEM_ACTIVATED
;
2319 event
.m_itemIndex
= iItem
;
2320 event
.m_item
.m_text
= GetItemText(iItem
);
2321 event
.m_item
.m_data
= GetItemData(iItem
);
2324 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2325 case GN_CONTEXTMENU
:
2326 #endif //__WXWINCE__
2328 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2329 // don't do anything else
2330 if ( wxListCtrlBase::MSWOnNotify(idCtrl
, lParam
, result
) )
2335 // else translate it into wxEVT_LIST_ITEM_RIGHT_CLICK event
2336 LV_HITTESTINFO lvhti
;
2337 wxZeroMemory(lvhti
);
2339 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2340 if ( nmhdr
->code
== GN_CONTEXTMENU
)
2342 lvhti
.pt
= ((NMRGINFO
*)nmhdr
)->ptAction
;
2345 #endif //__WXWINCE__
2347 wxGetCursorPosMSW(&(lvhti
.pt
));
2350 ::ScreenToClient(GetHwnd(), &lvhti
.pt
);
2351 if ( ListView_HitTest(GetHwnd(), &lvhti
) != -1 )
2353 if ( lvhti
.flags
& LVHT_ONITEM
)
2355 eventType
= wxEVT_LIST_ITEM_RIGHT_CLICK
;
2356 event
.m_itemIndex
= lvhti
.iItem
;
2357 event
.m_pointDrag
.x
= lvhti
.pt
.x
;
2358 event
.m_pointDrag
.y
= lvhti
.pt
.y
;
2363 #ifdef NM_CUSTOMDRAW
2365 *result
= OnCustomDraw(lParam
);
2367 return *result
!= CDRF_DODEFAULT
;
2368 #endif // _WIN32_IE >= 0x300
2370 case LVN_ODCACHEHINT
:
2372 const NM_CACHEHINT
*cacheHint
= (NM_CACHEHINT
*)lParam
;
2374 eventType
= wxEVT_LIST_CACHE_HINT
;
2376 // we get some really stupid cache hints like ones for
2377 // items in range 0..0 for an empty control or, after
2378 // deleting an item, for items in invalid range -- filter
2380 if ( cacheHint
->iFrom
> cacheHint
->iTo
)
2383 event
.m_oldItemIndex
= cacheHint
->iFrom
;
2385 const long iMax
= GetItemCount();
2386 event
.m_itemIndex
= cacheHint
->iTo
< iMax
? cacheHint
->iTo
2391 #ifdef HAVE_NMLVFINDITEM
2392 case LVN_ODFINDITEM
:
2393 // Find an item in a (necessarily virtual) list control.
2396 NMLVFINDITEM
* pFindInfo
= (NMLVFINDITEM
*)lParam
;
2398 // no match by default
2401 // we only handle string-based searches here
2403 // TODO: what about LVFI_PARTIAL, should we handle this?
2404 if ( !(pFindInfo
->lvfi
.flags
& LVFI_STRING
) )
2409 const wxChar
* const searchstr
= pFindInfo
->lvfi
.psz
;
2410 const size_t len
= wxStrlen(searchstr
);
2412 // this is the first item we should examine, search from it
2413 // wrapping if necessary
2414 int startPos
= pFindInfo
->iStart
;
2415 const int maxPos
= GetItemCount();
2417 // Check that the index is valid to ensure that our loop
2418 // below always terminates.
2419 if ( startPos
< 0 || startPos
>= maxPos
)
2421 // When the last item in the control is selected,
2422 // iStart is really set to (invalid) maxPos index so
2423 // accept this silently.
2424 if ( startPos
!= maxPos
)
2426 wxLogDebug(wxT("Ignoring invalid search start ")
2427 wxT("position %d in list control with ")
2428 wxT("%d items."), startPos
, maxPos
);
2434 // Linear search in a control with a lot of items can take
2435 // a long time so we limit the total time of the search to
2436 // ensure that the program doesn't appear to hang.
2439 #endif // wxUSE_STOPWATCH
2440 for ( int currentPos
= startPos
; ; )
2442 // does this item begin with searchstr?
2443 if ( wxStrnicmp(searchstr
,
2444 GetItemText(currentPos
), len
) == 0 )
2446 *result
= currentPos
;
2450 // Go to next item with wrapping if necessary.
2451 if ( ++currentPos
== maxPos
)
2453 // Surprisingly, LVFI_WRAP seems to be never set in
2454 // the flags so wrap regardless of it.
2458 if ( currentPos
== startPos
)
2460 // We examined all items without finding anything.
2462 // Notice that we still return true as we did
2463 // perform the search, if we didn't do this the
2464 // message would have been considered unhandled and
2465 // the control seems to always select the first
2466 // item by default in this case.
2471 // Check the time elapsed only every thousand
2472 // iterations for performance reasons: if we did it
2473 // more often calling wxStopWatch::Time() could take
2474 // noticeable time on its own.
2475 if ( !((currentPos
- startPos
)%1000
) )
2477 // We use half a second to limit the search time
2478 // which is about as long as we can take without
2479 // annoying the user.
2480 if ( sw
.Time() > 500 )
2482 // As above, return true to prevent the control
2483 // from selecting the first item by default.
2487 #endif // wxUSE_STOPWATCH
2491 SetItemState(*result
,
2492 wxLIST_STATE_SELECTED
| wxLIST_STATE_FOCUSED
,
2493 wxLIST_STATE_SELECTED
| wxLIST_STATE_FOCUSED
);
2494 EnsureVisible(*result
);
2502 #endif // HAVE_NMLVFINDITEM
2504 case LVN_GETDISPINFO
:
2507 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
2509 LV_ITEM
& lvi
= info
->item
;
2510 long item
= lvi
.iItem
;
2512 if ( lvi
.mask
& LVIF_TEXT
)
2514 wxString text
= OnGetItemText(item
, lvi
.iSubItem
);
2515 wxStrlcpy(lvi
.pszText
, text
.c_str(), lvi
.cchTextMax
);
2518 // see comment at the end of wxListCtrl::GetColumn()
2519 #ifdef NM_CUSTOMDRAW
2520 if ( lvi
.mask
& LVIF_IMAGE
)
2522 lvi
.iImage
= OnGetItemColumnImage(item
, lvi
.iSubItem
);
2524 #endif // NM_CUSTOMDRAW
2526 // even though we never use LVM_SETCALLBACKMASK, we still
2527 // can get messages with LVIF_STATE in lvi.mask under Vista
2528 if ( lvi
.mask
& LVIF_STATE
)
2530 // we don't have anything to return from here...
2543 return wxListCtrlBase::MSWOnNotify(idCtrl
, lParam
, result
);
2547 // where did this one come from?
2551 // process the event
2552 // -----------------
2554 event
.SetEventType(eventType
);
2556 // fill in the item before passing it to the event handler if we do have a
2557 // valid item index and haven't filled it yet (e.g. for LVN_ITEMCHANGED)
2558 // and we're not using a virtual control as in this case the program
2559 // already has the data anyhow and we don't want to call GetItem() for
2560 // potentially many items
2561 if ( event
.m_itemIndex
!= -1 && !event
.m_item
.GetMask()
2564 wxListItem
& item
= event
.m_item
;
2566 item
.SetId(event
.m_itemIndex
);
2567 item
.SetMask(wxLIST_MASK_TEXT
| wxLIST_MASK_IMAGE
| wxLIST_MASK_DATA
);
2571 bool processed
= HandleWindowEvent(event
);
2575 switch ( nmhdr
->code
)
2577 case LVN_DELETEALLITEMS
:
2578 // always return true to suppress all additional LVN_DELETEITEM
2579 // notifications - this makes deleting all items from a list ctrl
2583 // also, we may free all user data now (couldn't do it before as
2584 // the user should have access to it in OnDeleteAllItems() handler)
2585 FreeAllInternalData();
2587 // the control is empty now, synchronize the cached number of items
2588 // with the real one
2592 case LVN_DELETEITEM
:
2593 // Delete the associated internal data. Notice that this can be
2594 // done only after the event has been handled as the data could be
2595 // accessed during the handling of the event.
2596 if ( wxMSWListItemData
*data
= MSWGetItemData(event
.m_itemIndex
) )
2598 const unsigned count
= m_internalData
.size();
2599 for ( unsigned n
= 0; n
< count
; n
++ )
2601 if ( m_internalData
[n
] == data
)
2603 m_internalData
.erase(m_internalData
.begin() + n
);
2609 wxASSERT_MSG( !data
, "invalid internal data pointer?" );
2613 case LVN_ENDLABELEDITA
:
2614 case LVN_ENDLABELEDITW
:
2615 // logic here is inverted compared to all the other messages
2616 *result
= event
.IsAllowed();
2618 // EDIT control will be deleted by the list control itself so
2619 // prevent us from deleting it as well
2620 DeleteEditControl();
2626 *result
= !event
.IsAllowed();
2631 // ----------------------------------------------------------------------------
2632 // custom draw stuff
2633 // ----------------------------------------------------------------------------
2635 // see comment at the end of wxListCtrl::GetColumn()
2636 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2638 static RECT
GetCustomDrawnItemRect(const NMCUSTOMDRAW
& nmcd
)
2641 wxGetListCtrlItemRect(nmcd
.hdr
.hwndFrom
, nmcd
.dwItemSpec
, LVIR_BOUNDS
, rc
);
2644 wxGetListCtrlItemRect(nmcd
.hdr
.hwndFrom
, nmcd
.dwItemSpec
, LVIR_ICON
, rcIcon
);
2646 // exclude the icon part, neither the selection background nor focus rect
2648 rc
.left
= rcIcon
.right
;
2654 bool HandleSubItemPrepaint(LPNMLVCUSTOMDRAW pLVCD
, HFONT hfont
, int colCount
)
2656 NMCUSTOMDRAW
& nmcd
= pLVCD
->nmcd
;
2659 HWND hwndList
= nmcd
.hdr
.hwndFrom
;
2660 const int col
= pLVCD
->iSubItem
;
2661 const DWORD item
= nmcd
.dwItemSpec
;
2663 // the font must be valid, otherwise we wouldn't be painting the item at all
2664 SelectInHDC
selFont(hdc
, hfont
);
2666 // get the rectangle to paint
2668 wxGetListCtrlSubItemRect(hwndList
, item
, col
, LVIR_BOUNDS
, rc
);
2669 if ( !col
&& colCount
> 1 )
2671 // ListView_GetSubItemRect() returns the entire item rect for 0th
2672 // subitem while we really need just the part for this column
2674 wxGetListCtrlSubItemRect(hwndList
, item
, 1, LVIR_BOUNDS
, rc2
);
2675 rc
.right
= rc2
.left
;
2678 else // not first subitem
2683 // get the image and text to draw
2687 it
.mask
= LVIF_TEXT
| LVIF_IMAGE
;
2691 it
.cchTextMax
= WXSIZEOF(text
);
2692 ListView_GetItem(hwndList
, &it
);
2694 HIMAGELIST himl
= ListView_GetImageList(hwndList
, LVSIL_SMALL
);
2695 if ( himl
&& ImageList_GetImageCount(himl
) )
2697 if ( it
.iImage
!= -1 )
2699 ImageList_Draw(himl
, it
.iImage
, hdc
, rc
.left
, rc
.top
,
2700 nmcd
.uItemState
& CDIS_SELECTED
? ILD_SELECTED
2704 // notice that even if this item doesn't have any image, the list
2705 // control still leaves space for the image in the first column if the
2706 // image list is not empty (presumably so that items with and without
2708 if ( it
.iImage
!= -1 || it
.iSubItem
== 0 )
2711 ImageList_GetIconSize(himl
, &wImage
, &hImage
);
2713 rc
.left
+= wImage
+ 2;
2717 ::SetBkMode(hdc
, TRANSPARENT
);
2719 UINT fmt
= DT_SINGLELINE
|
2722 #endif // __WXWINCE__
2727 wxZeroMemory(lvCol
);
2728 lvCol
.mask
= LVCF_FMT
;
2729 if ( ListView_GetColumn(hwndList
, col
, &lvCol
) )
2731 switch ( lvCol
.fmt
& LVCFMT_JUSTIFYMASK
)
2746 //else: failed to get alignment, assume it's DT_LEFT (default)
2748 DrawText(hdc
, text
, -1, &rc
, fmt
);
2753 static void HandleItemPostpaint(NMCUSTOMDRAW nmcd
)
2755 if ( nmcd
.uItemState
& CDIS_FOCUS
)
2757 RECT rc
= GetCustomDrawnItemRect(nmcd
);
2759 // don't use the provided HDC, it's in some strange state by now
2760 ::DrawFocusRect(WindowHDC(nmcd
.hdr
.hwndFrom
), &rc
);
2764 // pLVCD->clrText and clrTextBk should contain the colours to use
2765 static void HandleItemPaint(LPNMLVCUSTOMDRAW pLVCD
, HFONT hfont
)
2767 NMCUSTOMDRAW
& nmcd
= pLVCD
->nmcd
; // just a shortcut
2769 const HWND hwndList
= nmcd
.hdr
.hwndFrom
;
2770 const int item
= nmcd
.dwItemSpec
;
2772 // unfortunately we can't trust CDIS_SELECTED, it is often set even when
2773 // the item is not at all selected for some reason (comctl32 6), but we
2774 // also can't always trust ListView_GetItem() as it could return the old
2775 // item status if we're called just after the (de)selection, so remember
2776 // the last item to gain selection and also check for it here
2777 for ( int i
= -1;; )
2779 i
= ListView_GetNextItem(hwndList
, i
, LVNI_SELECTED
);
2782 nmcd
.uItemState
&= ~CDIS_SELECTED
;
2788 nmcd
.uItemState
|= CDIS_SELECTED
;
2793 // same thing for CDIS_FOCUS (except simpler as there is only one of them)
2795 // NB: cast is needed to work around the bug in mingw32 headers which don't
2796 // have it inside ListView_GetNextItem() itself (unlike SDK ones)
2797 if ( ::GetFocus() == hwndList
&&
2798 ListView_GetNextItem(
2799 hwndList
, static_cast<WPARAM
>(-1), LVNI_FOCUSED
) == item
)
2801 nmcd
.uItemState
|= CDIS_FOCUS
;
2805 nmcd
.uItemState
&= ~CDIS_FOCUS
;
2808 if ( nmcd
.uItemState
& CDIS_SELECTED
)
2810 int syscolFg
, syscolBg
;
2811 if ( ::GetFocus() == hwndList
)
2813 syscolFg
= COLOR_HIGHLIGHTTEXT
;
2814 syscolBg
= COLOR_HIGHLIGHT
;
2816 else // selected but unfocused
2818 syscolFg
= COLOR_WINDOWTEXT
;
2819 syscolBg
= COLOR_BTNFACE
;
2821 // don't grey out the icon in this case neither
2822 nmcd
.uItemState
&= ~CDIS_SELECTED
;
2825 pLVCD
->clrText
= ::GetSysColor(syscolFg
);
2826 pLVCD
->clrTextBk
= ::GetSysColor(syscolBg
);
2828 //else: not selected, use normal colours from pLVCD
2831 RECT rc
= GetCustomDrawnItemRect(nmcd
);
2833 ::SetTextColor(hdc
, pLVCD
->clrText
);
2834 ::FillRect(hdc
, &rc
, AutoHBRUSH(pLVCD
->clrTextBk
));
2836 // we could use CDRF_NOTIFYSUBITEMDRAW here but it results in weird repaint
2837 // problems so just draw everything except the focus rect from here instead
2838 const int colCount
= Header_GetItemCount(ListView_GetHeader(hwndList
));
2839 for ( int col
= 0; col
< colCount
; col
++ )
2841 pLVCD
->iSubItem
= col
;
2842 HandleSubItemPrepaint(pLVCD
, hfont
, colCount
);
2845 HandleItemPostpaint(nmcd
);
2848 static WXLPARAM
HandleItemPrepaint(wxListCtrl
*listctrl
,
2849 LPNMLVCUSTOMDRAW pLVCD
,
2850 wxListItemAttr
*attr
)
2854 // nothing to do for this item
2855 return CDRF_DODEFAULT
;
2859 // set the colours to use for text drawing
2860 pLVCD
->clrText
= attr
->HasTextColour()
2861 ? wxColourToRGB(attr
->GetTextColour())
2862 : wxColourToRGB(listctrl
->GetTextColour());
2863 pLVCD
->clrTextBk
= attr
->HasBackgroundColour()
2864 ? wxColourToRGB(attr
->GetBackgroundColour())
2865 : wxColourToRGB(listctrl
->GetBackgroundColour());
2867 // select the font if non default one is specified
2868 if ( attr
->HasFont() )
2870 wxFont font
= attr
->GetFont();
2871 if ( font
.GetEncoding() != wxFONTENCODING_SYSTEM
)
2873 // the standard control ignores the font encoding/charset, at least
2874 // with recent comctl32.dll versions (5 and 6, it uses to work with
2875 // 4.something) so we have to draw the item entirely ourselves in
2877 HandleItemPaint(pLVCD
, GetHfontOf(font
));
2878 return CDRF_SKIPDEFAULT
;
2881 ::SelectObject(pLVCD
->nmcd
.hdc
, GetHfontOf(font
));
2883 return CDRF_NEWFONT
;
2886 return CDRF_DODEFAULT
;
2889 WXLPARAM
wxListCtrl::OnCustomDraw(WXLPARAM lParam
)
2891 LPNMLVCUSTOMDRAW pLVCD
= (LPNMLVCUSTOMDRAW
)lParam
;
2892 NMCUSTOMDRAW
& nmcd
= pLVCD
->nmcd
;
2893 switch ( nmcd
.dwDrawStage
)
2896 // if we've got any items with non standard attributes,
2897 // notify us before painting each item
2899 // for virtual controls, always suppose that we have attributes as
2900 // there is no way to check for this
2901 if ( IsVirtual() || m_hasAnyAttr
)
2902 return CDRF_NOTIFYITEMDRAW
;
2905 case CDDS_ITEMPREPAINT
:
2906 // get a message for each subitem
2907 return CDRF_NOTIFYITEMDRAW
;
2909 case CDDS_SUBITEM
| CDDS_ITEMPREPAINT
:
2910 const int item
= nmcd
.dwItemSpec
;
2911 const int column
= pLVCD
->iSubItem
;
2913 // we get this message with item == 0 for an empty control, we
2914 // must ignore it as calling OnGetItemAttr() would be wrong
2915 if ( item
< 0 || item
>= GetItemCount() )
2918 if ( column
< 0 || column
>= GetColumnCount() )
2921 return HandleItemPrepaint(this, pLVCD
, DoGetItemColumnAttr(item
, column
));
2924 return CDRF_DODEFAULT
;
2927 #endif // NM_CUSTOMDRAW supported
2929 // Necessary for drawing hrules and vrules, if specified
2930 void wxListCtrl::OnPaint(wxPaintEvent
& event
)
2932 const int itemCount
= GetItemCount();
2933 const bool drawHRules
= HasFlag(wxLC_HRULES
);
2934 const bool drawVRules
= HasFlag(wxLC_VRULES
);
2936 if (!InReportView() || !(drawHRules
|| drawVRules
) || !itemCount
)
2944 wxListCtrlBase::OnPaint(event
);
2946 // Reset the device origin since it may have been set
2947 dc
.SetDeviceOrigin(0, 0);
2949 wxPen
pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT
));
2951 dc
.SetBrush(* wxTRANSPARENT_BRUSH
);
2953 wxSize clientSize
= GetClientSize();
2958 const long top
= GetTopItem();
2959 for ( int i
= top
; i
< top
+ GetCountPerPage() + 1; i
++ )
2961 if (GetItemRect(i
, itemRect
))
2963 int cy
= itemRect
.GetTop();
2964 if (i
!= 0) // Don't draw the first one
2966 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2969 if (i
== itemCount
- 1)
2971 cy
= itemRect
.GetBottom();
2972 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2981 wxRect firstItemRect
;
2982 GetItemRect(0, firstItemRect
);
2984 if (GetItemRect(itemCount
- 1, itemRect
))
2986 // this is a fix for bug 673394: erase the pixels which we would
2987 // otherwise leave on the screen
2988 static const int gap
= 2;
2989 dc
.SetPen(*wxTRANSPARENT_PEN
);
2990 dc
.SetBrush(wxBrush(GetBackgroundColour()));
2991 dc
.DrawRectangle(0, firstItemRect
.GetY() - gap
,
2992 clientSize
.GetWidth(), gap
);
2995 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
2997 const int numCols
= GetColumnCount();
2998 wxVector
<int> indexArray(numCols
);
2999 if ( !ListView_GetColumnOrderArray(GetHwnd(),
3003 wxFAIL_MSG( wxT("invalid column index array in OnPaint()") );
3007 int x
= itemRect
.GetX();
3008 for (int col
= 0; col
< numCols
; col
++)
3010 int colWidth
= GetColumnWidth(indexArray
[col
]);
3012 dc
.DrawLine(x
-1, firstItemRect
.GetY() - gap
,
3013 x
-1, itemRect
.GetBottom());
3019 void wxListCtrl::OnCharHook(wxKeyEvent
& event
)
3021 if ( GetEditControl() )
3023 // We need to ensure that Escape is not stolen from the in-place editor
3024 // by the containing dialog.
3026 // Notice that we don't have to care about Enter key here as we return
3027 // false from MSWShouldPreProcessMessage() for it.
3028 if ( event
.GetKeyCode() == WXK_ESCAPE
)
3030 EndEditLabel(true /* cancel */);
3032 // Don't call Skip() below.
3041 wxListCtrl::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
3047 // we should bypass our own WM_PRINT handling as we don't handle
3048 // PRF_CHILDREN flag, so leave it to the native control itself
3049 return MSWDefWindowProc(nMsg
, wParam
, lParam
);
3052 case WM_CONTEXTMENU
:
3053 // because this message is propagated upwards the child-parent
3054 // chain, we get it for the right clicks on the header window but
3055 // this is confusing in wx as right clicking there already
3056 // generates a separate wxEVT_LIST_COL_RIGHT_CLICK event
3057 // so just ignore them
3058 if ( (HWND
)wParam
== ListView_GetHeader(GetHwnd()) )
3063 return wxListCtrlBase::MSWWindowProc(nMsg
, wParam
, lParam
);
3066 // ----------------------------------------------------------------------------
3067 // virtual list controls
3068 // ----------------------------------------------------------------------------
3070 wxString
wxListCtrl::OnGetItemText(long WXUNUSED(item
), long WXUNUSED(col
)) const
3072 // this is a pure virtual function, in fact - which is not really pure
3073 // because the controls which are not virtual don't need to implement it
3074 wxFAIL_MSG( wxT("wxListCtrl::OnGetItemText not supposed to be called") );
3076 return wxEmptyString
;
3079 int wxListCtrl::OnGetItemImage(long WXUNUSED(item
)) const
3081 wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL
),
3083 wxT("List control has an image list, OnGetItemImage or OnGetItemColumnImage should be overridden."));
3087 int wxListCtrl::OnGetItemColumnImage(long item
, long column
) const
3090 return OnGetItemImage(item
);
3095 wxListItemAttr
*wxListCtrl::DoGetItemColumnAttr(long item
, long column
) const
3098 return OnGetItemColumnAttr(item
, column
);
3100 wxMSWListItemData
* const data
= MSWGetItemData(item
);
3101 return data
? data
->attr
: NULL
;
3104 void wxListCtrl::SetItemCount(long count
)
3106 wxASSERT_MSG( IsVirtual(), wxT("this is for virtual controls only") );
3108 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT
, (WPARAM
)count
,
3109 LVSICF_NOSCROLL
| LVSICF_NOINVALIDATEALL
) )
3111 wxLogLastError(wxT("ListView_SetItemCount"));
3114 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
3115 wxT("m_count should match ListView_GetItemCount"));
3118 void wxListCtrl::RefreshItem(long item
)
3120 RefreshItems(item
, item
);
3123 void wxListCtrl::RefreshItems(long itemFrom
, long itemTo
)
3125 ListView_RedrawItems(GetHwnd(), itemFrom
, itemTo
);
3128 // ----------------------------------------------------------------------------
3129 // wxWin <-> MSW items conversions
3130 // ----------------------------------------------------------------------------
3132 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
3136 wxMSWListItemData
*internaldata
=
3137 (wxMSWListItemData
*) lvItem
.lParam
;
3140 info
.m_data
= internaldata
->lParam
;
3144 info
.m_stateMask
= 0;
3145 info
.m_itemId
= lvItem
.iItem
;
3147 long oldMask
= lvItem
.mask
;
3149 bool needText
= false;
3150 if (hwndListCtrl
!= 0)
3152 if ( lvItem
.mask
& LVIF_TEXT
)
3159 lvItem
.pszText
= new wxChar
[513];
3160 lvItem
.cchTextMax
= 512;
3162 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
3163 ::SendMessage(hwndListCtrl
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
);
3166 if ( lvItem
.mask
& LVIF_STATE
)
3168 info
.m_mask
|= wxLIST_MASK_STATE
;
3170 if ( lvItem
.stateMask
& LVIS_CUT
)
3172 info
.m_stateMask
|= wxLIST_STATE_CUT
;
3173 if ( lvItem
.state
& LVIS_CUT
)
3174 info
.m_state
|= wxLIST_STATE_CUT
;
3176 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
3178 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
3179 if ( lvItem
.state
& LVIS_DROPHILITED
)
3180 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
3182 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
3184 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
3185 if ( lvItem
.state
& LVIS_FOCUSED
)
3186 info
.m_state
|= wxLIST_STATE_FOCUSED
;
3188 if ( lvItem
.stateMask
& LVIS_SELECTED
)
3190 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
3191 if ( lvItem
.state
& LVIS_SELECTED
)
3192 info
.m_state
|= wxLIST_STATE_SELECTED
;
3196 if ( lvItem
.mask
& LVIF_TEXT
)
3198 info
.m_mask
|= wxLIST_MASK_TEXT
;
3199 info
.m_text
= lvItem
.pszText
;
3201 if ( lvItem
.mask
& LVIF_IMAGE
)
3203 info
.m_mask
|= wxLIST_MASK_IMAGE
;
3204 info
.m_image
= lvItem
.iImage
;
3206 if ( lvItem
.mask
& LVIF_PARAM
)
3207 info
.m_mask
|= wxLIST_MASK_DATA
;
3208 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
3209 info
.m_mask
|= wxLIST_SET_ITEM
;
3210 info
.m_col
= lvItem
.iSubItem
;
3215 delete[] lvItem
.pszText
;
3217 lvItem
.mask
= oldMask
;
3220 static void wxConvertToMSWFlags(long state
, long stateMask
, LV_ITEM
& lvItem
)
3222 if (stateMask
& wxLIST_STATE_CUT
)
3224 lvItem
.stateMask
|= LVIS_CUT
;
3225 if (state
& wxLIST_STATE_CUT
)
3226 lvItem
.state
|= LVIS_CUT
;
3228 if (stateMask
& wxLIST_STATE_DROPHILITED
)
3230 lvItem
.stateMask
|= LVIS_DROPHILITED
;
3231 if (state
& wxLIST_STATE_DROPHILITED
)
3232 lvItem
.state
|= LVIS_DROPHILITED
;
3234 if (stateMask
& wxLIST_STATE_FOCUSED
)
3236 lvItem
.stateMask
|= LVIS_FOCUSED
;
3237 if (state
& wxLIST_STATE_FOCUSED
)
3238 lvItem
.state
|= LVIS_FOCUSED
;
3240 if (stateMask
& wxLIST_STATE_SELECTED
)
3242 lvItem
.stateMask
|= LVIS_SELECTED
;
3243 if (state
& wxLIST_STATE_SELECTED
)
3244 lvItem
.state
|= LVIS_SELECTED
;
3248 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
3249 const wxListItem
& info
,
3252 if ( ctrl
->InReportView() )
3254 wxASSERT_MSG( 0 <= info
.m_col
&& info
.m_col
< ctrl
->GetColumnCount(),
3255 "wxListCtrl column index out of bounds" );
3257 else // not in report view
3259 wxASSERT_MSG( info
.m_col
== 0, "columns only exist in report view" );
3262 lvItem
.iItem
= (int) info
.m_itemId
;
3264 lvItem
.iImage
= info
.m_image
;
3265 lvItem
.stateMask
= 0;
3268 lvItem
.iSubItem
= info
.m_col
;
3270 if (info
.m_mask
& wxLIST_MASK_STATE
)
3272 lvItem
.mask
|= LVIF_STATE
;
3274 wxConvertToMSWFlags(info
.m_state
, info
.m_stateMask
, lvItem
);
3277 if (info
.m_mask
& wxLIST_MASK_TEXT
)
3279 lvItem
.mask
|= LVIF_TEXT
;
3280 if ( ctrl
->HasFlag(wxLC_USER_TEXT
) )
3282 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
3286 // pszText is not const, hence the cast
3287 lvItem
.pszText
= wxMSW_CONV_LPTSTR(info
.m_text
);
3288 if ( lvItem
.pszText
)
3289 lvItem
.cchTextMax
= info
.m_text
.length();
3291 lvItem
.cchTextMax
= 0;
3294 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
3295 lvItem
.mask
|= LVIF_IMAGE
;
3298 static void wxConvertToMSWListCol(HWND hwndList
,
3300 const wxListItem
& item
,
3303 wxZeroMemory(lvCol
);
3305 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
3307 lvCol
.mask
|= LVCF_TEXT
;
3308 lvCol
.pszText
= wxMSW_CONV_LPTSTR(item
.m_text
);
3311 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
3313 lvCol
.mask
|= LVCF_FMT
;
3315 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
3316 lvCol
.fmt
= LVCFMT_LEFT
;
3317 else if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
3318 lvCol
.fmt
= LVCFMT_RIGHT
;
3319 else if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
3320 lvCol
.fmt
= LVCFMT_CENTER
;
3323 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
3325 lvCol
.mask
|= LVCF_WIDTH
;
3326 if ( item
.m_width
== wxLIST_AUTOSIZE
)
3327 lvCol
.cx
= LVSCW_AUTOSIZE
;
3328 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
3329 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
3331 lvCol
.cx
= item
.m_width
;
3334 // see comment at the end of wxListCtrl::GetColumn()
3335 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
3336 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
3338 if ( wxApp::GetComCtl32Version() >= 470 )
3340 lvCol
.mask
|= LVCF_IMAGE
;
3342 // we use LVCFMT_BITMAP_ON_RIGHT because the images on the right
3343 // seem to be generally nicer than on the left and the generic
3344 // version only draws them on the right (we don't have a flag to
3345 // specify the image location anyhow)
3347 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
3348 // make any difference in my tests -- but maybe we should?
3349 if ( item
.m_image
!= -1 )
3351 // as we're going to overwrite the format field, get its
3352 // current value first -- unless we want to overwrite it anyhow
3353 if ( !(lvCol
.mask
& LVCF_FMT
) )
3356 wxZeroMemory(lvColOld
);
3357 lvColOld
.mask
= LVCF_FMT
;
3358 if ( ListView_GetColumn(hwndList
, col
, &lvColOld
) )
3360 lvCol
.fmt
= lvColOld
.fmt
;
3363 lvCol
.mask
|= LVCF_FMT
;
3366 lvCol
.fmt
|= LVCFMT_BITMAP_ON_RIGHT
| LVCFMT_IMAGE
;
3369 lvCol
.iImage
= item
.m_image
;
3371 //else: it doesn't support item images anyhow
3373 #endif // _WIN32_IE >= 0x0300
3376 #endif // wxUSE_LISTCTRL