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__) && !defined(__HANDHELDPC__)
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 #if WXWIN_COMPATIBILITY_2_4
225 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO
)
226 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO
)
228 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED
)
229 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED
)
230 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN
)
231 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM
)
232 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK
)
233 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
)
234 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
)
235 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING
)
236 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG
)
237 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
)
238 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK
)
239 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED
)
240 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED
)
241 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT
)
243 #if wxUSE_EXTENDED_RTTI
244 WX_DEFINE_FLAGS( wxListCtrlStyle
)
246 wxBEGIN_FLAGS( wxListCtrlStyle
)
247 // new style border flags, we put them first to
248 // use them for streaming out
249 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
250 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
251 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
252 wxFLAGS_MEMBER(wxBORDER_RAISED
)
253 wxFLAGS_MEMBER(wxBORDER_STATIC
)
254 wxFLAGS_MEMBER(wxBORDER_NONE
)
256 // old style border flags
257 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
258 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
259 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
260 wxFLAGS_MEMBER(wxRAISED_BORDER
)
261 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
262 wxFLAGS_MEMBER(wxBORDER
)
264 // standard window styles
265 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
266 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
267 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
268 wxFLAGS_MEMBER(wxWANTS_CHARS
)
269 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
270 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
271 wxFLAGS_MEMBER(wxVSCROLL
)
272 wxFLAGS_MEMBER(wxHSCROLL
)
274 wxFLAGS_MEMBER(wxLC_LIST
)
275 wxFLAGS_MEMBER(wxLC_REPORT
)
276 wxFLAGS_MEMBER(wxLC_ICON
)
277 wxFLAGS_MEMBER(wxLC_SMALL_ICON
)
278 wxFLAGS_MEMBER(wxLC_ALIGN_TOP
)
279 wxFLAGS_MEMBER(wxLC_ALIGN_LEFT
)
280 wxFLAGS_MEMBER(wxLC_AUTOARRANGE
)
281 wxFLAGS_MEMBER(wxLC_USER_TEXT
)
282 wxFLAGS_MEMBER(wxLC_EDIT_LABELS
)
283 wxFLAGS_MEMBER(wxLC_NO_HEADER
)
284 wxFLAGS_MEMBER(wxLC_SINGLE_SEL
)
285 wxFLAGS_MEMBER(wxLC_SORT_ASCENDING
)
286 wxFLAGS_MEMBER(wxLC_SORT_DESCENDING
)
287 wxFLAGS_MEMBER(wxLC_VIRTUAL
)
289 wxEND_FLAGS( wxListCtrlStyle
)
291 IMPLEMENT_DYNAMIC_CLASS_XTI(wxListCtrl
, wxControl
,"wx/listctrl.h")
293 wxBEGIN_PROPERTIES_TABLE(wxListCtrl
)
294 wxEVENT_PROPERTY( TextUpdated
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
)
296 wxPROPERTY_FLAGS( WindowStyle
, wxListCtrlStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
297 wxEND_PROPERTIES_TABLE()
299 wxBEGIN_HANDLERS_TABLE(wxListCtrl
)
300 wxEND_HANDLERS_TABLE()
302 wxCONSTRUCTOR_5( wxListCtrl
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
305 TODO : Expose more information of a list's layout etc. via appropriate objects (Ã la NotebookPageInfo)
308 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl
, wxControl
)
311 IMPLEMENT_DYNAMIC_CLASS(wxListView
, wxListCtrl
)
312 IMPLEMENT_DYNAMIC_CLASS(wxListItem
, wxObject
)
314 IMPLEMENT_DYNAMIC_CLASS(wxListEvent
, wxNotifyEvent
)
316 BEGIN_EVENT_TABLE(wxListCtrl
, wxControl
)
317 EVT_PAINT(wxListCtrl::OnPaint
)
320 // ============================================================================
322 // ============================================================================
324 // ----------------------------------------------------------------------------
325 // wxListCtrl construction
326 // ----------------------------------------------------------------------------
328 void wxListCtrl::Init()
330 m_imageListNormal
= NULL
;
331 m_imageListSmall
= NULL
;
332 m_imageListState
= NULL
;
333 m_ownsImageListNormal
= m_ownsImageListSmall
= m_ownsImageListState
= false;
336 m_ignoreChangeMessages
= false;
338 m_AnyInternalData
= false;
339 m_hasAnyAttr
= false;
342 bool wxListCtrl::Create(wxWindow
*parent
,
347 const wxValidator
& validator
,
348 const wxString
& name
)
350 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
353 if ( !MSWCreateControl(WC_LISTVIEW
, wxEmptyString
, pos
, size
) )
356 // explicitly say that we want to use Unicode because otherwise we get ANSI
357 // versions of _some_ messages (notably LVN_GETDISPINFOA) in MSLU build
358 wxSetCCUnicodeFormat(GetHwnd());
360 // for comctl32.dll v 4.70+ we want to have this attribute because it's
361 // prettier (and also because wxGTK does it like this)
362 if ( InReportView() && wxTheApp
->GetComCtl32Version() >= 470 )
364 ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE
,
365 0, LVS_EX_FULLROWSELECT
);
371 WXDWORD
wxListCtrl::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
373 WXDWORD wstyle
= wxControl::MSWGetStyle(style
, exstyle
);
375 wstyle
|= LVS_SHAREIMAGELISTS
| LVS_SHOWSELALWAYS
;
380 #define MAP_MODE_STYLE(wx, ms) \
381 if ( style & (wx) ) { wstyle |= (ms); nModes++; }
382 #else // !__WXDEBUG__
383 #define MAP_MODE_STYLE(wx, ms) \
384 if ( style & (wx) ) wstyle |= (ms);
385 #endif // __WXDEBUG__
387 MAP_MODE_STYLE(wxLC_ICON
, LVS_ICON
)
388 MAP_MODE_STYLE(wxLC_SMALL_ICON
, LVS_SMALLICON
)
389 MAP_MODE_STYLE(wxLC_LIST
, LVS_LIST
)
390 MAP_MODE_STYLE(wxLC_REPORT
, LVS_REPORT
)
392 wxASSERT_MSG( nModes
== 1,
393 _T("wxListCtrl style should have exactly one mode bit set") );
395 #undef MAP_MODE_STYLE
397 if ( style
& wxLC_ALIGN_LEFT
)
398 wstyle
|= LVS_ALIGNLEFT
;
400 if ( style
& wxLC_ALIGN_TOP
)
401 wstyle
|= LVS_ALIGNTOP
;
403 if ( style
& wxLC_AUTOARRANGE
)
404 wstyle
|= LVS_AUTOARRANGE
;
406 if ( style
& wxLC_NO_SORT_HEADER
)
407 wstyle
|= LVS_NOSORTHEADER
;
409 if ( style
& wxLC_NO_HEADER
)
410 wstyle
|= LVS_NOCOLUMNHEADER
;
412 if ( style
& wxLC_EDIT_LABELS
)
413 wstyle
|= LVS_EDITLABELS
;
415 if ( style
& wxLC_SINGLE_SEL
)
416 wstyle
|= LVS_SINGLESEL
;
418 if ( style
& wxLC_SORT_ASCENDING
)
420 wstyle
|= LVS_SORTASCENDING
;
422 wxASSERT_MSG( !(style
& wxLC_SORT_DESCENDING
),
423 _T("can't sort in ascending and descending orders at once") );
425 else if ( style
& wxLC_SORT_DESCENDING
)
426 wstyle
|= LVS_SORTDESCENDING
;
428 #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
429 if ( style
& wxLC_VIRTUAL
)
431 int ver
= wxTheApp
->GetComCtl32Version();
434 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."),
435 ver
/ 100, ver
% 100);
438 wstyle
|= LVS_OWNERDATA
;
440 #endif // ancient cygwin
445 void wxListCtrl::UpdateStyle()
449 // The new window view style
450 DWORD dwStyleNew
= MSWGetStyle(m_windowStyle
, NULL
);
452 // some styles are not returned by MSWGetStyle()
454 dwStyleNew
|= WS_VISIBLE
;
456 // Get the current window style.
457 DWORD dwStyleOld
= ::GetWindowLong(GetHwnd(), GWL_STYLE
);
459 // we don't have wxVSCROLL style, but the list control may have it,
460 // don't change it then
461 dwStyleNew
|= dwStyleOld
& (WS_HSCROLL
| WS_VSCROLL
);
463 // Only set the window style if the view bits have changed.
464 if ( dwStyleOld
!= dwStyleNew
)
466 ::SetWindowLong(GetHwnd(), GWL_STYLE
, dwStyleNew
);
471 void wxListCtrl::FreeAllInternalData()
473 if (m_AnyInternalData
)
475 int n
= GetItemCount();
477 m_ignoreChangeMessages
= true;
478 for (int i
= 0; i
< n
; i
++)
479 wxDeleteInternalData(this, i
);
480 m_ignoreChangeMessages
= false;
482 m_AnyInternalData
= false;
486 wxListCtrl::~wxListCtrl()
488 FreeAllInternalData();
492 m_textCtrl
->UnsubclassWin();
493 m_textCtrl
->SetHWND(0);
498 if (m_ownsImageListNormal
)
499 delete m_imageListNormal
;
500 if (m_ownsImageListSmall
)
501 delete m_imageListSmall
;
502 if (m_ownsImageListState
)
503 delete m_imageListState
;
506 // ----------------------------------------------------------------------------
507 // set/get/change style
508 // ----------------------------------------------------------------------------
510 // Add or remove a single window style
511 void wxListCtrl::SetSingleStyle(long style
, bool add
)
513 long flag
= GetWindowStyleFlag();
515 // Get rid of conflicting styles
518 if ( style
& wxLC_MASK_TYPE
)
519 flag
= flag
& ~wxLC_MASK_TYPE
;
520 if ( style
& wxLC_MASK_ALIGN
)
521 flag
= flag
& ~wxLC_MASK_ALIGN
;
522 if ( style
& wxLC_MASK_SORT
)
523 flag
= flag
& ~wxLC_MASK_SORT
;
531 SetWindowStyleFlag(flag
);
534 // Set the whole window style
535 void wxListCtrl::SetWindowStyleFlag(long flag
)
537 if ( flag
!= m_windowStyle
)
539 m_windowStyle
= flag
;
547 // ----------------------------------------------------------------------------
549 // ----------------------------------------------------------------------------
551 /* static */ wxVisualAttributes
552 wxListCtrl::GetClassDefaultAttributes(wxWindowVariant variant
)
554 wxVisualAttributes attrs
= GetCompositeControlsDefaultAttributes(variant
);
556 // common controls have their own default font
557 attrs
.font
= wxGetCCDefaultFont();
562 // Sets the foreground, i.e. text, colour
563 bool wxListCtrl::SetForegroundColour(const wxColour
& col
)
565 if ( !wxWindow::SetForegroundColour(col
) )
568 ListView_SetTextColor(GetHwnd(), wxColourToRGB(col
));
573 // Sets the background colour
574 bool wxListCtrl::SetBackgroundColour(const wxColour
& col
)
576 if ( !wxWindow::SetBackgroundColour(col
) )
579 // we set the same colour for both the "empty" background and the items
581 COLORREF color
= wxColourToRGB(col
);
582 ListView_SetBkColor(GetHwnd(), color
);
583 ListView_SetTextBkColor(GetHwnd(), color
);
588 // Gets information about this column
589 bool wxListCtrl::GetColumn(int col
, wxListItem
& item
) const
594 lvCol
.mask
= LVCF_WIDTH
;
596 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
598 lvCol
.mask
|= LVCF_TEXT
;
599 lvCol
.pszText
= new wxChar
[513];
600 lvCol
.cchTextMax
= 512;
603 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
605 lvCol
.mask
|= LVCF_FMT
;
608 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
610 lvCol
.mask
|= LVCF_IMAGE
;
613 bool success
= ListView_GetColumn(GetHwnd(), col
, &lvCol
) != 0;
615 // item.m_subItem = lvCol.iSubItem;
616 item
.m_width
= lvCol
.cx
;
618 if ( (item
.m_mask
& wxLIST_MASK_TEXT
) && lvCol
.pszText
)
620 item
.m_text
= lvCol
.pszText
;
621 delete[] lvCol
.pszText
;
624 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
626 switch (lvCol
.fmt
& LVCFMT_JUSTIFYMASK
) {
628 item
.m_format
= wxLIST_FORMAT_LEFT
;
631 item
.m_format
= wxLIST_FORMAT_RIGHT
;
634 item
.m_format
= wxLIST_FORMAT_CENTRE
;
637 item
.m_format
= -1; // Unknown?
642 // the column images were not supported in older versions but how to check
643 // for this? we can't use _WIN32_IE because we always define it to a very
644 // high value, so see if another symbol which is only defined starting from
645 // comctl32.dll 4.70 is available
646 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
647 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
649 item
.m_image
= lvCol
.iImage
;
651 #endif // LVCOLUMN::iImage exists
656 // Sets information about this column
657 bool wxListCtrl::SetColumn(int col
, wxListItem
& item
)
660 wxConvertToMSWListCol(col
, item
, lvCol
);
662 return ListView_SetColumn(GetHwnd(), col
, &lvCol
) != 0;
665 // Gets the column width
666 int wxListCtrl::GetColumnWidth(int col
) const
668 return ListView_GetColumnWidth(GetHwnd(), col
);
671 // Sets the column width
672 bool wxListCtrl::SetColumnWidth(int col
, int width
)
675 if ( m_windowStyle
& wxLC_LIST
)
679 if ( width2
== wxLIST_AUTOSIZE
)
680 width2
= LVSCW_AUTOSIZE
;
681 else if ( width2
== wxLIST_AUTOSIZE_USEHEADER
)
682 width2
= LVSCW_AUTOSIZE_USEHEADER
;
684 return ListView_SetColumnWidth(GetHwnd(), col2
, width2
) != 0;
687 // Gets the number of items that can fit vertically in the
688 // visible area of the list control (list or report view)
689 // or the total number of items in the list control (icon
690 // or small icon view)
691 int wxListCtrl::GetCountPerPage() const
693 return ListView_GetCountPerPage(GetHwnd());
696 // Gets the edit control for editing labels.
697 wxTextCtrl
* wxListCtrl::GetEditControl() const
702 // Gets information about the item
703 bool wxListCtrl::GetItem(wxListItem
& info
) const
706 wxZeroMemory(lvItem
);
708 lvItem
.iItem
= info
.m_itemId
;
709 lvItem
.iSubItem
= info
.m_col
;
711 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
713 lvItem
.mask
|= LVIF_TEXT
;
714 lvItem
.pszText
= new wxChar
[513];
715 lvItem
.cchTextMax
= 512;
719 lvItem
.pszText
= NULL
;
722 if (info
.m_mask
& wxLIST_MASK_DATA
)
723 lvItem
.mask
|= LVIF_PARAM
;
725 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
726 lvItem
.mask
|= LVIF_IMAGE
;
728 if ( info
.m_mask
& wxLIST_MASK_STATE
)
730 lvItem
.mask
|= LVIF_STATE
;
731 // the other bits are hardly interesting anyhow
732 lvItem
.stateMask
= LVIS_SELECTED
| LVIS_FOCUSED
;
735 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
738 wxLogError(_("Couldn't retrieve information about list control item %d."),
743 // give NULL as hwnd as we already have everything we need
744 wxConvertFromMSWListItem(NULL
, info
, lvItem
);
748 delete[] lvItem
.pszText
;
753 // Sets information about the item
754 bool wxListCtrl::SetItem(wxListItem
& info
)
757 wxConvertToMSWListItem(this, info
, item
);
759 // we never update the lParam if it contains our pointer
760 // to the wxListItemInternalData structure
761 item
.mask
&= ~LVIF_PARAM
;
763 // check if setting attributes or lParam
764 if (info
.HasAttributes() || (info
.m_mask
& wxLIST_MASK_DATA
))
766 // get internal item data
767 // perhaps a cache here ?
768 wxListItemInternalData
*data
= wxGetInternalData(this, info
.m_itemId
);
773 m_AnyInternalData
= true;
774 data
= new wxListItemInternalData();
775 item
.lParam
= (LPARAM
) data
;
776 item
.mask
|= LVIF_PARAM
;
781 if (info
.m_mask
& wxLIST_MASK_DATA
)
782 data
->lParam
= info
.m_data
;
785 if (info
.HasAttributes())
788 *data
->attr
= *info
.GetAttributes();
790 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
795 // we could be changing only the attribute in which case we don't need to
796 // call ListView_SetItem() at all
800 if ( !ListView_SetItem(GetHwnd(), &item
) )
802 wxLogDebug(_T("ListView_SetItem() failed"));
808 // we need to update the item immediately to show the new image
809 bool updateNow
= (info
.m_mask
& wxLIST_MASK_IMAGE
) != 0;
811 // check whether it has any custom attributes
812 if ( info
.HasAttributes() )
816 // if the colour has changed, we must redraw the item
822 // we need this to make the change visible right now
823 RefreshItem(item
.iItem
);
829 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
833 info
.m_mask
= wxLIST_MASK_TEXT
;
834 info
.m_itemId
= index
;
838 info
.m_image
= imageId
;
839 info
.m_mask
|= wxLIST_MASK_IMAGE
;
841 return SetItem(info
);
845 // Gets the item state
846 int wxListCtrl::GetItemState(long item
, long stateMask
) const
850 info
.m_mask
= wxLIST_MASK_STATE
;
851 info
.m_stateMask
= stateMask
;
852 info
.m_itemId
= item
;
860 // Sets the item state
861 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
863 // NB: don't use SetItem() here as it doesn't work with the virtual list
866 wxZeroMemory(lvItem
);
868 wxConvertToMSWFlags(state
, stateMask
, lvItem
);
870 // for the virtual list controls we need to refresh the previously focused
871 // item manually when changing focus without changing selection
872 // programmatically because otherwise it keeps its focus rectangle until
873 // next repaint (yet another comctl32 bug)
876 (stateMask
& wxLIST_STATE_FOCUSED
) &&
877 (state
& wxLIST_STATE_FOCUSED
) )
879 focusOld
= GetNextItem(-1, wxLIST_NEXT_ALL
, wxLIST_STATE_FOCUSED
);
886 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE
,
887 (WPARAM
)item
, (LPARAM
)&lvItem
) )
889 wxLogLastError(_T("ListView_SetItemState"));
894 if ( focusOld
!= -1 )
896 // no need to refresh the item if it was previously selected, it would
897 // only result in annoying flicker
898 if ( !(GetItemState(focusOld
,
899 wxLIST_STATE_SELECTED
) & wxLIST_STATE_SELECTED
) )
901 RefreshItem(focusOld
);
908 // Sets the item image
909 bool wxListCtrl::SetItemImage(long item
, int image
, int WXUNUSED(selImage
))
913 info
.m_mask
= wxLIST_MASK_IMAGE
;
914 info
.m_image
= image
;
915 info
.m_itemId
= item
;
917 return SetItem(info
);
920 // Gets the item text
921 wxString
wxListCtrl::GetItemText(long item
) const
925 info
.m_mask
= wxLIST_MASK_TEXT
;
926 info
.m_itemId
= item
;
929 return wxEmptyString
;
933 // Sets the item text
934 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
938 info
.m_mask
= wxLIST_MASK_TEXT
;
939 info
.m_itemId
= item
;
945 // Gets the item data
946 wxUIntPtr
wxListCtrl::GetItemData(long item
) const
950 info
.m_mask
= wxLIST_MASK_DATA
;
951 info
.m_itemId
= item
;
958 // Sets the item data
959 bool wxListCtrl::SetItemData(long item
, long data
)
963 info
.m_mask
= wxLIST_MASK_DATA
;
964 info
.m_itemId
= item
;
967 return SetItem(info
);
970 wxRect
wxListCtrl::GetViewRect() const
972 wxASSERT_MSG( !HasFlag(wxLC_REPORT
| wxLC_LIST
),
973 _T("wxListCtrl::GetViewRect() only works in icon mode") );
976 if ( !ListView_GetViewRect(GetHwnd(), &rc
) )
978 wxLogDebug(_T("ListView_GetViewRect() failed."));
984 wxCopyRECTToRect(rc
, rect
);
989 // Gets the item rectangle
990 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
995 if ( code
== wxLIST_RECT_BOUNDS
)
996 codeWin
= LVIR_BOUNDS
;
997 else if ( code
== wxLIST_RECT_ICON
)
999 else if ( code
== wxLIST_RECT_LABEL
)
1000 codeWin
= LVIR_LABEL
;
1003 wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
1005 codeWin
= LVIR_BOUNDS
;
1008 bool success
= ListView_GetItemRect(GetHwnd(), (int) item
, &rectWin
, codeWin
) != 0;
1010 rect
.x
= rectWin
.left
;
1011 rect
.y
= rectWin
.top
;
1012 rect
.width
= rectWin
.right
- rectWin
.left
;
1013 rect
.height
= rectWin
.bottom
- rectWin
.top
;
1018 // Gets the item position
1019 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
1023 bool success
= (ListView_GetItemPosition(GetHwnd(), (int) item
, &pt
) != 0);
1025 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
1029 // Sets the item position.
1030 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
1032 return (ListView_SetItemPosition(GetHwnd(), (int) item
, pos
.x
, pos
.y
) != 0);
1035 // Gets the number of items in the list control
1036 int wxListCtrl::GetItemCount() const
1041 wxSize
wxListCtrl::GetItemSpacing() const
1043 const int spacing
= ListView_GetItemSpacing(GetHwnd(), (BOOL
)HasFlag(wxLC_SMALL_ICON
));
1045 return wxSize(LOWORD(spacing
), HIWORD(spacing
));
1048 int wxListCtrl::GetItemSpacing(bool isSmall
) const
1050 return ListView_GetItemSpacing(GetHwnd(), (BOOL
) isSmall
);
1053 void wxListCtrl::SetItemTextColour( long item
, const wxColour
&col
)
1056 info
.m_itemId
= item
;
1057 info
.SetTextColour( col
);
1061 wxColour
wxListCtrl::GetItemTextColour( long item
) const
1064 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1065 if ( data
&& data
->attr
)
1066 col
= data
->attr
->GetTextColour();
1071 void wxListCtrl::SetItemBackgroundColour( long item
, const wxColour
&col
)
1074 info
.m_itemId
= item
;
1075 info
.SetBackgroundColour( col
);
1079 wxColour
wxListCtrl::GetItemBackgroundColour( long item
) const
1082 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1083 if ( data
&& data
->attr
)
1084 col
= data
->attr
->GetBackgroundColour();
1089 // Gets the number of selected items in the list control
1090 int wxListCtrl::GetSelectedItemCount() const
1092 return ListView_GetSelectedCount(GetHwnd());
1095 // Gets the text colour of the listview
1096 wxColour
wxListCtrl::GetTextColour() const
1098 COLORREF ref
= ListView_GetTextColor(GetHwnd());
1099 wxColour
col(GetRValue(ref
), GetGValue(ref
), GetBValue(ref
));
1103 // Sets the text colour of the listview
1104 void wxListCtrl::SetTextColour(const wxColour
& col
)
1106 ListView_SetTextColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
1109 // Gets the index of the topmost visible item when in
1110 // list or report view
1111 long wxListCtrl::GetTopItem() const
1113 return (long) ListView_GetTopIndex(GetHwnd());
1116 // Searches for an item, starting from 'item'.
1117 // 'geometry' is one of
1118 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1119 // 'state' is a state bit flag, one or more of
1120 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1121 // item can be -1 to find the first item that matches the
1123 // Returns the item or -1 if unsuccessful.
1124 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
1128 if ( geom
== wxLIST_NEXT_ABOVE
)
1129 flags
|= LVNI_ABOVE
;
1130 if ( geom
== wxLIST_NEXT_ALL
)
1132 if ( geom
== wxLIST_NEXT_BELOW
)
1133 flags
|= LVNI_BELOW
;
1134 if ( geom
== wxLIST_NEXT_LEFT
)
1135 flags
|= LVNI_TOLEFT
;
1136 if ( geom
== wxLIST_NEXT_RIGHT
)
1137 flags
|= LVNI_TORIGHT
;
1139 if ( state
& wxLIST_STATE_CUT
)
1141 if ( state
& wxLIST_STATE_DROPHILITED
)
1142 flags
|= LVNI_DROPHILITED
;
1143 if ( state
& wxLIST_STATE_FOCUSED
)
1144 flags
|= LVNI_FOCUSED
;
1145 if ( state
& wxLIST_STATE_SELECTED
)
1146 flags
|= LVNI_SELECTED
;
1148 return (long) ListView_GetNextItem(GetHwnd(), item
, flags
);
1152 wxImageList
*wxListCtrl::GetImageList(int which
) const
1154 if ( which
== wxIMAGE_LIST_NORMAL
)
1156 return m_imageListNormal
;
1158 else if ( which
== wxIMAGE_LIST_SMALL
)
1160 return m_imageListSmall
;
1162 else if ( which
== wxIMAGE_LIST_STATE
)
1164 return m_imageListState
;
1169 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
1172 if ( which
== wxIMAGE_LIST_NORMAL
)
1174 flags
= LVSIL_NORMAL
;
1175 if (m_ownsImageListNormal
) delete m_imageListNormal
;
1176 m_imageListNormal
= imageList
;
1177 m_ownsImageListNormal
= false;
1179 else if ( which
== wxIMAGE_LIST_SMALL
)
1181 flags
= LVSIL_SMALL
;
1182 if (m_ownsImageListSmall
) delete m_imageListSmall
;
1183 m_imageListSmall
= imageList
;
1184 m_ownsImageListSmall
= false;
1186 else if ( which
== wxIMAGE_LIST_STATE
)
1188 flags
= LVSIL_STATE
;
1189 if (m_ownsImageListState
) delete m_imageListState
;
1190 m_imageListState
= imageList
;
1191 m_ownsImageListState
= false;
1193 ListView_SetImageList(GetHwnd(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
1196 void wxListCtrl::AssignImageList(wxImageList
*imageList
, int which
)
1198 SetImageList(imageList
, which
);
1199 if ( which
== wxIMAGE_LIST_NORMAL
)
1200 m_ownsImageListNormal
= true;
1201 else if ( which
== wxIMAGE_LIST_SMALL
)
1202 m_ownsImageListSmall
= true;
1203 else if ( which
== wxIMAGE_LIST_STATE
)
1204 m_ownsImageListState
= true;
1207 // ----------------------------------------------------------------------------
1209 // ----------------------------------------------------------------------------
1211 // Arranges the items
1212 bool wxListCtrl::Arrange(int flag
)
1215 if ( flag
== wxLIST_ALIGN_LEFT
)
1216 code
= LVA_ALIGNLEFT
;
1217 else if ( flag
== wxLIST_ALIGN_TOP
)
1218 code
= LVA_ALIGNTOP
;
1219 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
1221 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
1222 code
= LVA_SNAPTOGRID
;
1224 return (ListView_Arrange(GetHwnd(), code
) != 0);
1228 bool wxListCtrl::DeleteItem(long item
)
1230 if ( !ListView_DeleteItem(GetHwnd(), (int) item
) )
1232 wxLogLastError(_T("ListView_DeleteItem"));
1237 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1238 wxT("m_count should match ListView_GetItemCount"));
1240 // the virtual list control doesn't refresh itself correctly, help it
1243 // we need to refresh all the lines below the one which was deleted
1245 if ( item
> 0 && GetItemCount() )
1247 GetItemRect(item
- 1, rectItem
);
1252 rectItem
.height
= 0;
1255 wxRect rectWin
= GetRect();
1256 rectWin
.height
= rectWin
.GetBottom() - rectItem
.GetBottom();
1257 rectWin
.y
= rectItem
.GetBottom();
1259 RefreshRect(rectWin
);
1265 // Deletes all items
1266 bool wxListCtrl::DeleteAllItems()
1268 return ListView_DeleteAllItems(GetHwnd()) != 0;
1271 // Deletes all items
1272 bool wxListCtrl::DeleteAllColumns()
1274 while ( m_colCount
> 0 )
1276 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1278 wxLogLastError(wxT("ListView_DeleteColumn"));
1286 wxASSERT_MSG( m_colCount
== 0, wxT("no columns should be left") );
1292 bool wxListCtrl::DeleteColumn(int col
)
1294 bool success
= (ListView_DeleteColumn(GetHwnd(), col
) != 0);
1296 if ( success
&& (m_colCount
> 0) )
1301 // Clears items, and columns if there are any.
1302 void wxListCtrl::ClearAll()
1305 if ( m_colCount
> 0 )
1309 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
1311 wxASSERT( (textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
))) );
1313 // ListView_EditLabel requires that the list has focus.
1316 WXHWND hWnd
= (WXHWND
) ListView_EditLabel(GetHwnd(), item
);
1319 // failed to start editing
1323 // [re]create the text control wrapping the HWND we got
1326 m_textCtrl
->UnsubclassWin();
1327 m_textCtrl
->SetHWND(0);
1331 m_textCtrl
= (wxTextCtrl
*)textControlClass
->CreateObject();
1332 m_textCtrl
->SetHWND(hWnd
);
1333 m_textCtrl
->SubclassWin(hWnd
);
1334 m_textCtrl
->SetParent(this);
1336 // we must disallow TABbing away from the control while the edit contol is
1337 // shown because this leaves it in some strange state (just try removing
1338 // this line and then pressing TAB while editing an item in listctrl
1340 m_textCtrl
->SetWindowStyle(m_textCtrl
->GetWindowStyle() | wxTE_PROCESS_TAB
);
1345 // End label editing, optionally cancelling the edit
1346 bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel
))
1348 wxFAIL_MSG( _T("not implemented") );
1353 // Ensures this item is visible
1354 bool wxListCtrl::EnsureVisible(long item
)
1356 return ListView_EnsureVisible(GetHwnd(), (int) item
, FALSE
) != FALSE
;
1359 // Find an item whose label matches this string, starting from the item after 'start'
1360 // or the beginning if 'start' is -1.
1361 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
1363 LV_FINDINFO findInfo
;
1365 findInfo
.flags
= LVFI_STRING
;
1367 findInfo
.flags
|= LVFI_PARTIAL
;
1370 // ListView_FindItem() excludes the first item from search and to look
1371 // through all the items you need to start from -1 which is unnatural and
1372 // inconsistent with the generic version - so we adjust the index
1375 return ListView_FindItem(GetHwnd(), (int) start
, &findInfo
);
1378 // Find an item whose data matches this data, starting from the item after 'start'
1379 // or the beginning if 'start' is -1.
1380 // NOTE : Lindsay Mathieson - 14-July-2002
1381 // No longer use ListView_FindItem as the data attribute is now stored
1382 // in a wxListItemInternalData structure refernced by the actual lParam
1383 long wxListCtrl::FindItem(long start
, wxUIntPtr data
)
1385 long idx
= start
+ 1;
1386 long count
= GetItemCount();
1390 if (GetItemData(idx
) == data
)
1398 // Find an item nearest this position in the specified direction, starting from
1399 // the item after 'start' or the beginning if 'start' is -1.
1400 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
1402 LV_FINDINFO findInfo
;
1404 findInfo
.flags
= LVFI_NEARESTXY
;
1405 findInfo
.pt
.x
= pt
.x
;
1406 findInfo
.pt
.y
= pt
.y
;
1407 findInfo
.vkDirection
= VK_RIGHT
;
1409 if ( direction
== wxLIST_FIND_UP
)
1410 findInfo
.vkDirection
= VK_UP
;
1411 else if ( direction
== wxLIST_FIND_DOWN
)
1412 findInfo
.vkDirection
= VK_DOWN
;
1413 else if ( direction
== wxLIST_FIND_LEFT
)
1414 findInfo
.vkDirection
= VK_LEFT
;
1415 else if ( direction
== wxLIST_FIND_RIGHT
)
1416 findInfo
.vkDirection
= VK_RIGHT
;
1418 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
1421 // Determines which item (if any) is at the specified point,
1422 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1423 long wxListCtrl::HitTest(const wxPoint
& point
, int& flags
)
1425 LV_HITTESTINFO hitTestInfo
;
1426 hitTestInfo
.pt
.x
= (int) point
.x
;
1427 hitTestInfo
.pt
.y
= (int) point
.y
;
1429 ListView_HitTest(GetHwnd(), & hitTestInfo
);
1433 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
1434 flags
|= wxLIST_HITTEST_ABOVE
;
1435 if ( hitTestInfo
.flags
& LVHT_BELOW
)
1436 flags
|= wxLIST_HITTEST_BELOW
;
1437 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
1438 flags
|= wxLIST_HITTEST_TOLEFT
;
1439 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
1440 flags
|= wxLIST_HITTEST_TORIGHT
;
1442 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
1443 flags
|= wxLIST_HITTEST_NOWHERE
;
1445 // note a bug or at least a very strange feature of comtl32.dll (tested
1446 // with version 4.0 under Win95 and 6.0 under Win 2003): if you click to
1447 // the right of the item label, ListView_HitTest() returns a combination of
1448 // LVHT_ONITEMICON, LVHT_ONITEMLABEL and LVHT_ONITEMSTATEICON -- filter out
1449 // the bits which don't make sense
1450 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
1452 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
1454 // do not translate LVHT_ONITEMICON here, as per above
1458 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
1459 flags
|= wxLIST_HITTEST_ONITEMICON
;
1460 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
1461 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
1464 return (long) hitTestInfo
.iItem
;
1467 // Inserts an item, returning the index of the new item if successful,
1469 long wxListCtrl::InsertItem(wxListItem
& info
)
1471 wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
1474 wxConvertToMSWListItem(this, info
, item
);
1475 item
.mask
&= ~LVIF_PARAM
;
1477 // check wether we need to allocate our internal data
1478 bool needInternalData
= ((info
.m_mask
& wxLIST_MASK_DATA
) || info
.HasAttributes());
1479 if (needInternalData
)
1481 m_AnyInternalData
= true;
1482 item
.mask
|= LVIF_PARAM
;
1484 // internal stucture that manages data
1485 wxListItemInternalData
*data
= new wxListItemInternalData();
1486 item
.lParam
= (LPARAM
) data
;
1488 if (info
.m_mask
& wxLIST_MASK_DATA
)
1489 data
->lParam
= info
.m_data
;
1491 // check whether it has any custom attributes
1492 if ( info
.HasAttributes() )
1494 // take copy of attributes
1495 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
1497 // and remember that we have some now...
1498 m_hasAnyAttr
= true;
1502 long rv
= ListView_InsertItem(GetHwnd(), & item
);
1505 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1506 wxT("m_count should match ListView_GetItemCount"));
1511 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1514 info
.m_text
= label
;
1515 info
.m_mask
= wxLIST_MASK_TEXT
;
1516 info
.m_itemId
= index
;
1517 return InsertItem(info
);
1520 // Inserts an image item
1521 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1524 info
.m_image
= imageIndex
;
1525 info
.m_mask
= wxLIST_MASK_IMAGE
;
1526 info
.m_itemId
= index
;
1527 return InsertItem(info
);
1530 // Inserts an image/string item
1531 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1534 info
.m_image
= imageIndex
;
1535 info
.m_text
= label
;
1536 info
.m_mask
= wxLIST_MASK_IMAGE
| wxLIST_MASK_TEXT
;
1537 info
.m_itemId
= index
;
1538 return InsertItem(info
);
1541 // For list view mode (only), inserts a column.
1542 long wxListCtrl::InsertColumn(long col
, wxListItem
& item
)
1545 wxConvertToMSWListCol(col
, item
, lvCol
);
1547 if ( !(lvCol
.mask
& LVCF_WIDTH
) )
1549 // always give some width to the new column: this one is compatible
1550 // with the generic version
1551 lvCol
.mask
|= LVCF_WIDTH
;
1555 long n
= ListView_InsertColumn(GetHwnd(), col
, &lvCol
);
1560 else // failed to insert?
1562 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1569 long wxListCtrl::InsertColumn(long col
,
1570 const wxString
& heading
,
1575 item
.m_mask
= wxLIST_MASK_TEXT
| wxLIST_MASK_FORMAT
;
1576 item
.m_text
= heading
;
1579 item
.m_mask
|= wxLIST_MASK_WIDTH
;
1580 item
.m_width
= width
;
1582 item
.m_format
= format
;
1584 return InsertColumn(col
, item
);
1587 // scroll the control by the given number of pixels (exception: in list view,
1588 // dx is interpreted as number of columns)
1589 bool wxListCtrl::ScrollList(int dx
, int dy
)
1591 if ( !ListView_Scroll(GetHwnd(), dx
, dy
) )
1593 wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx
, dy
);
1603 // fn is a function which takes 3 long arguments: item1, item2, data.
1604 // item1 is the long data associated with a first item (NOT the index).
1605 // item2 is the long data associated with a second item (NOT the index).
1606 // data is the same value as passed to SortItems.
1607 // The return value is a negative number if the first item should precede the second
1608 // item, a positive number of the second item should precede the first,
1609 // or zero if the two items are equivalent.
1611 // data is arbitrary data to be passed to the sort function.
1613 // Internal structures for proxying the user compare function
1614 // so that we can pass it the *real* user data
1616 // translate lParam data and call user func
1617 struct wxInternalDataSort
1619 wxListCtrlCompare user_fn
;
1623 int CALLBACK
wxInternalDataCompareFunc(LPARAM lParam1
, LPARAM lParam2
, LPARAM lParamSort
)
1625 struct wxInternalDataSort
*internalData
= (struct wxInternalDataSort
*) lParamSort
;
1627 wxListItemInternalData
*data1
= (wxListItemInternalData
*) lParam1
;
1628 wxListItemInternalData
*data2
= (wxListItemInternalData
*) lParam2
;
1630 long d1
= (data1
== NULL
? 0 : data1
->lParam
);
1631 long d2
= (data2
== NULL
? 0 : data2
->lParam
);
1633 return internalData
->user_fn(d1
, d2
, internalData
->data
);
1637 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, long data
)
1639 struct wxInternalDataSort internalData
;
1640 internalData
.user_fn
= fn
;
1641 internalData
.data
= data
;
1643 // WPARAM cast is needed for mingw/cygwin
1644 if ( !ListView_SortItems(GetHwnd(),
1645 wxInternalDataCompareFunc
,
1646 (WPARAM
) &internalData
) )
1648 wxLogDebug(_T("ListView_SortItems() failed"));
1658 // ----------------------------------------------------------------------------
1659 // message processing
1660 // ----------------------------------------------------------------------------
1662 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1664 if (cmd
== EN_UPDATE
)
1666 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1667 event
.SetEventObject( this );
1668 ProcessCommand(event
);
1671 else if (cmd
== EN_KILLFOCUS
)
1673 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1674 event
.SetEventObject( this );
1675 ProcessCommand(event
);
1682 bool wxListCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
1685 // prepare the event
1686 // -----------------
1688 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1689 event
.SetEventObject(this);
1691 wxEventType eventType
= wxEVT_NULL
;
1693 NMHDR
*nmhdr
= (NMHDR
*)lParam
;
1695 // if your compiler is as broken as this, you should really change it: this
1696 // code is needed for normal operation! #ifdef below is only useful for
1697 // automatic rebuilds which are done with a very old compiler version
1698 #ifdef HDN_BEGINTRACKA
1700 // check for messages from the header (in report view)
1701 HWND hwndHdr
= ListView_GetHeader(GetHwnd());
1703 // is it a message from the header?
1704 if ( nmhdr
->hwndFrom
== hwndHdr
)
1706 HD_NOTIFY
*nmHDR
= (HD_NOTIFY
*)nmhdr
;
1708 event
.m_itemIndex
= -1;
1710 switch ( nmhdr
->code
)
1712 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1713 // TRACK messages even to ANSI programs: on my system I get
1714 // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all!
1716 // work around is to simply catch both versions and hope that it
1717 // works (why should this message exist in ANSI and Unicode is
1718 // beyond me as it doesn't deal with strings at all...)
1720 // note that fr HDN_TRACK another possibility could be to use
1721 // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when
1722 // something other than the item width changes so we'd have to
1723 // filter out the unwanted events then
1724 case HDN_BEGINTRACKA
:
1725 case HDN_BEGINTRACKW
:
1726 eventType
= wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
;
1731 if ( eventType
== wxEVT_NULL
)
1732 eventType
= wxEVT_COMMAND_LIST_COL_DRAGGING
;
1737 if ( eventType
== wxEVT_NULL
)
1738 eventType
= wxEVT_COMMAND_LIST_COL_END_DRAG
;
1740 event
.m_item
.m_width
= nmHDR
->pitem
->cxy
;
1741 event
.m_col
= nmHDR
->iItem
;
1744 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1745 case GN_CONTEXTMENU
:
1746 #endif //__WXWINCE__
1749 eventType
= wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
;
1752 // find the column clicked: we have to search for it
1753 // ourselves as the notification message doesn't provide
1756 // where did the click occur?
1758 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1759 if(nmhdr
->code
== GN_CONTEXTMENU
) {
1760 ptClick
= ((NMRGINFO
*)nmhdr
)->ptAction
;
1762 #endif //__WXWINCE__
1763 if ( !::GetCursorPos(&ptClick
) )
1765 wxLogLastError(_T("GetCursorPos"));
1768 if ( !::ScreenToClient(GetHwnd(), &ptClick
) )
1770 wxLogLastError(_T("ScreenToClient(listctrl header)"));
1773 event
.m_pointDrag
.x
= ptClick
.x
;
1774 event
.m_pointDrag
.y
= ptClick
.y
;
1776 int colCount
= Header_GetItemCount(hwndHdr
);
1779 for ( int col
= 0; col
< colCount
; col
++ )
1781 if ( Header_GetItemRect(hwndHdr
, col
, &rect
) )
1783 if ( ::PtInRect(&rect
, ptClick
) )
1793 case HDN_GETDISPINFOW
:
1794 // letting Windows XP handle this message results in mysterious
1795 // crashes in comctl32.dll seemingly because of bad message
1798 // I have no idea what is the real cause of the bug (which is,
1799 // just to make things interesting, is impossible to reproduce
1800 // reliably) but ignoring all these messages does fix it and
1801 // doesn't seem to have any negative consequences
1805 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1809 #endif // defined(HDN_BEGINTRACKA)
1810 if ( nmhdr
->hwndFrom
== GetHwnd() )
1812 // almost all messages use NM_LISTVIEW
1813 NM_LISTVIEW
*nmLV
= (NM_LISTVIEW
*)nmhdr
;
1815 const int iItem
= nmLV
->iItem
;
1818 // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be
1819 // ignored for efficiency. It is done here because the internal data is in the
1820 // process of being deleted so we don't want to try and access it below.
1821 if ( m_ignoreChangeMessages
&&
1822 ( (nmLV
->hdr
.code
== LVN_ITEMCHANGED
) ||
1823 (nmLV
->hdr
.code
== LVN_ITEMCHANGING
)) )
1829 // If we have a valid item then check if there is a data value
1830 // associated with it and put it in the event.
1831 if ( iItem
>= 0 && iItem
< GetItemCount() )
1833 wxListItemInternalData
*internaldata
=
1834 wxGetInternalData(GetHwnd(), iItem
);
1837 event
.m_item
.m_data
= internaldata
->lParam
;
1841 switch ( nmhdr
->code
)
1843 case LVN_BEGINRDRAG
:
1844 eventType
= wxEVT_COMMAND_LIST_BEGIN_RDRAG
;
1848 if ( eventType
== wxEVT_NULL
)
1850 eventType
= wxEVT_COMMAND_LIST_BEGIN_DRAG
;
1853 event
.m_itemIndex
= iItem
;
1854 event
.m_pointDrag
.x
= nmLV
->ptAction
.x
;
1855 event
.m_pointDrag
.y
= nmLV
->ptAction
.y
;
1858 // NB: we have to handle both *A and *W versions here because some
1859 // versions of comctl32.dll send ANSI messages even to the
1861 case LVN_BEGINLABELEDITA
:
1862 case LVN_BEGINLABELEDITW
:
1865 if ( nmhdr
->code
== LVN_BEGINLABELEDITA
)
1867 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1869 else // LVN_BEGINLABELEDITW
1871 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1874 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1875 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, item
);
1876 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1880 case LVN_ENDLABELEDITA
:
1881 case LVN_ENDLABELEDITW
:
1884 if ( nmhdr
->code
== LVN_ENDLABELEDITA
)
1886 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1888 else // LVN_ENDLABELEDITW
1890 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1893 // was editing cancelled?
1894 const LV_ITEM
& lvi
= (LV_ITEM
)item
;
1895 if ( !lvi
.pszText
|| lvi
.iItem
== -1 )
1897 // don't keep a stale wxTextCtrl around
1900 // EDIT control will be deleted by the list control itself so
1901 // prevent us from deleting it as well
1902 m_textCtrl
->UnsubclassWin();
1903 m_textCtrl
->SetHWND(0);
1908 event
.SetEditCanceled(true);
1911 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1912 wxConvertFromMSWListItem(NULL
, event
.m_item
, item
);
1913 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1917 case LVN_COLUMNCLICK
:
1918 eventType
= wxEVT_COMMAND_LIST_COL_CLICK
;
1919 event
.m_itemIndex
= -1;
1920 event
.m_col
= nmLV
->iSubItem
;
1923 case LVN_DELETEALLITEMS
:
1924 eventType
= wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
;
1925 event
.m_itemIndex
= -1;
1928 case LVN_DELETEITEM
:
1931 // this should be prevented by the post-processing code
1932 // below, but "just in case"
1936 eventType
= wxEVT_COMMAND_LIST_DELETE_ITEM
;
1937 event
.m_itemIndex
= iItem
;
1938 // delete the assoicated internal data
1939 wxDeleteInternalData(this, iItem
);
1942 #if WXWIN_COMPATIBILITY_2_4
1943 case LVN_SETDISPINFO
:
1945 eventType
= wxEVT_COMMAND_LIST_SET_INFO
;
1946 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1947 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, info
->item
);
1952 case LVN_INSERTITEM
:
1953 eventType
= wxEVT_COMMAND_LIST_INSERT_ITEM
;
1954 event
.m_itemIndex
= iItem
;
1957 case LVN_ITEMCHANGED
:
1958 // we translate this catch all message into more interesting
1959 // (and more easy to process) wxWidgets events
1961 // first of all, we deal with the state change events only and
1962 // only for valid items (item == -1 for the virtual list
1964 if ( nmLV
->uChanged
& LVIF_STATE
&& iItem
!= -1 )
1966 // temp vars for readability
1967 const UINT stOld
= nmLV
->uOldState
;
1968 const UINT stNew
= nmLV
->uNewState
;
1970 event
.m_item
.SetId(iItem
);
1971 event
.m_item
.SetMask(wxLIST_MASK_TEXT
|
1974 GetItem(event
.m_item
);
1976 // has the focus changed?
1977 if ( !(stOld
& LVIS_FOCUSED
) && (stNew
& LVIS_FOCUSED
) )
1979 eventType
= wxEVT_COMMAND_LIST_ITEM_FOCUSED
;
1980 event
.m_itemIndex
= iItem
;
1983 if ( (stNew
& LVIS_SELECTED
) != (stOld
& LVIS_SELECTED
) )
1985 if ( eventType
!= wxEVT_NULL
)
1987 // focus and selection have both changed: send the
1988 // focus event from here and the selection one
1990 event
.SetEventType(eventType
);
1991 (void)GetEventHandler()->ProcessEvent(event
);
1993 else // no focus event to send
1995 // then need to set m_itemIndex as it wasn't done
1997 event
.m_itemIndex
= iItem
;
2000 eventType
= stNew
& LVIS_SELECTED
2001 ? wxEVT_COMMAND_LIST_ITEM_SELECTED
2002 : wxEVT_COMMAND_LIST_ITEM_DESELECTED
;
2006 if ( eventType
== wxEVT_NULL
)
2008 // not an interesting event for us
2016 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
2017 WORD wVKey
= info
->wVKey
;
2019 // get the current selection
2020 long lItem
= GetNextItem(-1,
2022 wxLIST_STATE_SELECTED
);
2024 // <Enter> or <Space> activate the selected item if any (but
2025 // not with Shift and/or Ctrl as then they have a predefined
2026 // meaning for the list view)
2028 (wVKey
== VK_RETURN
|| wVKey
== VK_SPACE
) &&
2029 !(wxIsShiftDown() || wxIsCtrlDown()) )
2031 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2035 eventType
= wxEVT_COMMAND_LIST_KEY_DOWN
;
2037 // wxCharCodeMSWToWX() returns 0 if the key is an ASCII
2038 // value which should be used as is
2039 int code
= wxCharCodeMSWToWX(wVKey
);
2040 event
.m_code
= code
? code
: wVKey
;
2044 event
.m_item
.m_itemId
= lItem
;
2048 // fill the other fields too
2049 event
.m_item
.m_text
= GetItemText(lItem
);
2050 event
.m_item
.m_data
= GetItemData(lItem
);
2056 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2058 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2063 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
2064 // if it happened on an item (and not on empty place)
2071 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2072 event
.m_itemIndex
= iItem
;
2073 event
.m_item
.m_text
= GetItemText(iItem
);
2074 event
.m_item
.m_data
= GetItemData(iItem
);
2077 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2078 case GN_CONTEXTMENU
:
2079 #endif //__WXWINCE__
2081 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2082 // don't do anything else
2083 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2088 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
2089 LV_HITTESTINFO lvhti
;
2090 wxZeroMemory(lvhti
);
2092 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2093 if(nmhdr
->code
== GN_CONTEXTMENU
) {
2094 lvhti
.pt
= ((NMRGINFO
*)nmhdr
)->ptAction
;
2096 #endif //__WXWINCE__
2097 ::GetCursorPos(&(lvhti
.pt
));
2098 ::ScreenToClient(GetHwnd(),&(lvhti
.pt
));
2099 if ( ListView_HitTest(GetHwnd(),&lvhti
) != -1 )
2101 if ( lvhti
.flags
& LVHT_ONITEM
)
2103 eventType
= wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
;
2104 event
.m_itemIndex
= lvhti
.iItem
;
2105 event
.m_pointDrag
.x
= lvhti
.pt
.x
;
2106 event
.m_pointDrag
.y
= lvhti
.pt
.y
;
2111 #ifdef NM_CUSTOMDRAW
2113 *result
= OnCustomDraw(lParam
);
2116 #endif // _WIN32_IE >= 0x300
2118 case LVN_ODCACHEHINT
:
2120 const NM_CACHEHINT
*cacheHint
= (NM_CACHEHINT
*)lParam
;
2122 eventType
= wxEVT_COMMAND_LIST_CACHE_HINT
;
2124 // we get some really stupid cache hints like ones for
2125 // items in range 0..0 for an empty control or, after
2126 // deleting an item, for items in invalid range -- filter
2128 if ( cacheHint
->iFrom
> cacheHint
->iTo
)
2131 event
.m_oldItemIndex
= cacheHint
->iFrom
;
2133 const long iMax
= GetItemCount();
2134 event
.m_itemIndex
= cacheHint
->iTo
< iMax
? cacheHint
->iTo
2139 case LVN_GETDISPINFO
:
2142 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
2144 LV_ITEM
& lvi
= info
->item
;
2145 long item
= lvi
.iItem
;
2147 if ( lvi
.mask
& LVIF_TEXT
)
2149 wxString text
= OnGetItemText(item
, lvi
.iSubItem
);
2150 wxStrncpy(lvi
.pszText
, text
, lvi
.cchTextMax
);
2153 // see comment at the end of wxListCtrl::GetColumn()
2154 #ifdef NM_CUSTOMDRAW
2155 if ( lvi
.mask
& LVIF_IMAGE
)
2157 lvi
.iImage
= OnGetItemImage(item
);
2159 #endif // NM_CUSTOMDRAW
2161 // a little dose of healthy paranoia: as we never use
2162 // LVM_SETCALLBACKMASK we're not supposed to get these ones
2163 wxASSERT_MSG( !(lvi
.mask
& LVIF_STATE
),
2164 _T("we don't support state callbacks yet!") );
2171 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
2176 // where did this one come from?
2180 // process the event
2181 // -----------------
2183 event
.SetEventType(eventType
);
2185 bool processed
= GetEventHandler()->ProcessEvent(event
);
2189 switch ( nmhdr
->code
)
2191 case LVN_DELETEALLITEMS
:
2192 // always return true to suppress all additional LVN_DELETEITEM
2193 // notifications - this makes deleting all items from a list ctrl
2197 // also, we may free all user data now (couldn't do it before as
2198 // the user should have access to it in OnDeleteAllItems() handler)
2199 FreeAllInternalData();
2201 // the control is empty now, synchronize the cached number of items
2202 // with the real one
2206 case LVN_ENDLABELEDITA
:
2207 case LVN_ENDLABELEDITW
:
2208 // logic here is inversed compared to all the other messages
2209 *result
= event
.IsAllowed();
2211 // don't keep a stale wxTextCtrl around
2214 // EDIT control will be deleted by the list control itself so
2215 // prevent us from deleting it as well
2216 m_textCtrl
->UnsubclassWin();
2217 m_textCtrl
->SetHWND(0);
2226 *result
= !event
.IsAllowed();
2231 // see comment at the end of wxListCtrl::GetColumn()
2232 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2234 WXLPARAM
wxListCtrl::OnCustomDraw(WXLPARAM lParam
)
2236 LPNMLVCUSTOMDRAW lplvcd
= (LPNMLVCUSTOMDRAW
)lParam
;
2237 NMCUSTOMDRAW
& nmcd
= lplvcd
->nmcd
;
2238 switch ( nmcd
.dwDrawStage
)
2241 // if we've got any items with non standard attributes,
2242 // notify us before painting each item
2244 // for virtual controls, always suppose that we have attributes as
2245 // there is no way to check for this
2246 return IsVirtual() || m_hasAnyAttr
? CDRF_NOTIFYITEMDRAW
2249 case CDDS_ITEMPREPAINT
:
2251 size_t item
= (size_t)nmcd
.dwItemSpec
;
2252 if ( item
>= (size_t)GetItemCount() )
2254 // we get this message with item == 0 for an empty control,
2255 // we must ignore it as calling OnGetItemAttr() would be
2257 return CDRF_DODEFAULT
;
2260 wxListItemAttr
*attr
=
2261 IsVirtual() ? OnGetItemAttr(item
)
2262 : wxGetInternalDataAttr(this, item
);
2266 // nothing to do for this item
2267 return CDRF_DODEFAULT
;
2271 wxColour colText
, colBack
;
2272 if ( attr
->HasFont() )
2274 wxFont font
= attr
->GetFont();
2275 hFont
= (HFONT
)font
.GetResourceHandle();
2282 if ( attr
->HasTextColour() )
2284 colText
= attr
->GetTextColour();
2288 colText
= GetTextColour();
2291 if ( attr
->HasBackgroundColour() )
2293 colBack
= attr
->GetBackgroundColour();
2297 colBack
= GetBackgroundColour();
2300 lplvcd
->clrText
= wxColourToRGB(colText
);
2301 lplvcd
->clrTextBk
= wxColourToRGB(colBack
);
2303 // note that if we wanted to set colours for
2304 // individual columns (subitems), we would have
2305 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2308 ::SelectObject(nmcd
.hdc
, hFont
);
2310 return CDRF_NEWFONT
;
2313 // fall through to return CDRF_DODEFAULT
2316 return CDRF_DODEFAULT
;
2320 #endif // NM_CUSTOMDRAW supported
2322 // Necessary for drawing hrules and vrules, if specified
2323 void wxListCtrl::OnPaint(wxPaintEvent
& event
)
2327 wxControl::OnPaint(event
);
2329 // Reset the device origin since it may have been set
2330 dc
.SetDeviceOrigin(0, 0);
2332 bool drawHRules
= HasFlag(wxLC_HRULES
);
2333 bool drawVRules
= HasFlag(wxLC_VRULES
);
2335 if (!InReportView() || !drawHRules
&& !drawVRules
)
2338 wxPen
pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT
), 1, wxSOLID
);
2340 dc
.SetBrush(* wxTRANSPARENT_BRUSH
);
2342 wxSize clientSize
= GetClientSize();
2345 int itemCount
= GetItemCount();
2349 long top
= GetTopItem();
2350 for (i
= top
; i
< top
+ GetCountPerPage() + 1; i
++)
2352 if (GetItemRect(i
, itemRect
))
2354 int cy
= itemRect
.GetTop();
2355 if (i
!= 0) // Don't draw the first one
2357 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2360 if (i
== itemCount
- 1)
2362 cy
= itemRect
.GetBottom();
2363 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2369 if (drawVRules
&& (i
> -1))
2371 wxRect firstItemRect
;
2372 GetItemRect(0, firstItemRect
);
2374 if (GetItemRect(i
, itemRect
))
2377 int x
= itemRect
.GetX();
2378 for (col
= 0; col
< GetColumnCount(); col
++)
2380 int colWidth
= GetColumnWidth(col
);
2382 dc
.DrawLine(x
-1, firstItemRect
.GetY() - 2, x
-1, itemRect
.GetBottom());
2388 // ----------------------------------------------------------------------------
2389 // virtual list controls
2390 // ----------------------------------------------------------------------------
2392 wxString
wxListCtrl::OnGetItemText(long WXUNUSED(item
), long WXUNUSED(col
)) const
2394 // this is a pure virtual function, in fact - which is not really pure
2395 // because the controls which are not virtual don't need to implement it
2396 wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") );
2398 return wxEmptyString
;
2401 int wxListCtrl::OnGetItemImage(long WXUNUSED(item
)) const
2403 wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL
),
2405 wxT("List control has an image list, OnGetItemImage should be overridden."));
2409 wxListItemAttr
*wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item
)) const
2411 wxASSERT_MSG( item
>= 0 && item
< GetItemCount(),
2412 _T("invalid item index in OnGetItemAttr()") );
2414 // no attributes by default
2418 void wxListCtrl::SetItemCount(long count
)
2420 wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
2422 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT
, (WPARAM
)count
,
2423 LVSICF_NOSCROLL
| LVSICF_NOINVALIDATEALL
) )
2425 wxLogLastError(_T("ListView_SetItemCount"));
2428 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
2429 wxT("m_count should match ListView_GetItemCount"));
2432 void wxListCtrl::RefreshItem(long item
)
2434 // strangely enough, ListView_Update() results in much more flicker here
2435 // than a dumb Refresh() -- why?
2437 if ( !ListView_Update(GetHwnd(), item
) )
2439 wxLogLastError(_T("ListView_Update"));
2443 GetItemRect(item
, rect
);
2448 void wxListCtrl::RefreshItems(long itemFrom
, long itemTo
)
2450 wxRect rect1
, rect2
;
2451 GetItemRect(itemFrom
, rect1
);
2452 GetItemRect(itemTo
, rect2
);
2454 wxRect rect
= rect1
;
2455 rect
.height
= rect2
.GetBottom() - rect1
.GetTop();
2460 // ----------------------------------------------------------------------------
2461 // internal data stuff
2462 // ----------------------------------------------------------------------------
2464 static wxListItemInternalData
*wxGetInternalData(HWND hwnd
, long itemId
)
2467 it
.mask
= LVIF_PARAM
;
2470 if ( !ListView_GetItem(hwnd
, &it
) )
2473 return (wxListItemInternalData
*) it
.lParam
;
2477 wxListItemInternalData
*wxGetInternalData(const wxListCtrl
*ctl
, long itemId
)
2479 return wxGetInternalData(GetHwndOf(ctl
), itemId
);
2482 static wxListItemAttr
*wxGetInternalDataAttr(wxListCtrl
*ctl
, long itemId
)
2484 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2486 return data
? data
->attr
: NULL
;
2489 static void wxDeleteInternalData(wxListCtrl
* ctl
, long itemId
)
2491 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2495 memset(&item
, 0, sizeof(item
));
2496 item
.iItem
= itemId
;
2497 item
.mask
= LVIF_PARAM
;
2498 item
.lParam
= (LPARAM
) 0;
2499 ListView_SetItem((HWND
)ctl
->GetHWND(), &item
);
2504 // ----------------------------------------------------------------------------
2505 // wxWin <-> MSW items conversions
2506 // ----------------------------------------------------------------------------
2508 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
2512 wxListItemInternalData
*internaldata
=
2513 (wxListItemInternalData
*) lvItem
.lParam
;
2516 info
.m_data
= internaldata
->lParam
;
2520 info
.m_stateMask
= 0;
2521 info
.m_itemId
= lvItem
.iItem
;
2523 long oldMask
= lvItem
.mask
;
2525 bool needText
= false;
2526 if (hwndListCtrl
!= 0)
2528 if ( lvItem
.mask
& LVIF_TEXT
)
2535 lvItem
.pszText
= new wxChar
[513];
2536 lvItem
.cchTextMax
= 512;
2538 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
2539 ::SendMessage(hwndListCtrl
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
);
2542 if ( lvItem
.mask
& LVIF_STATE
)
2544 info
.m_mask
|= wxLIST_MASK_STATE
;
2546 if ( lvItem
.stateMask
& LVIS_CUT
)
2548 info
.m_stateMask
|= wxLIST_STATE_CUT
;
2549 if ( lvItem
.state
& LVIS_CUT
)
2550 info
.m_state
|= wxLIST_STATE_CUT
;
2552 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
2554 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
2555 if ( lvItem
.state
& LVIS_DROPHILITED
)
2556 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
2558 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
2560 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
2561 if ( lvItem
.state
& LVIS_FOCUSED
)
2562 info
.m_state
|= wxLIST_STATE_FOCUSED
;
2564 if ( lvItem
.stateMask
& LVIS_SELECTED
)
2566 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
2567 if ( lvItem
.state
& LVIS_SELECTED
)
2568 info
.m_state
|= wxLIST_STATE_SELECTED
;
2572 if ( lvItem
.mask
& LVIF_TEXT
)
2574 info
.m_mask
|= wxLIST_MASK_TEXT
;
2575 info
.m_text
= lvItem
.pszText
;
2577 if ( lvItem
.mask
& LVIF_IMAGE
)
2579 info
.m_mask
|= wxLIST_MASK_IMAGE
;
2580 info
.m_image
= lvItem
.iImage
;
2582 if ( lvItem
.mask
& LVIF_PARAM
)
2583 info
.m_mask
|= wxLIST_MASK_DATA
;
2584 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
2585 info
.m_mask
|= wxLIST_SET_ITEM
;
2586 info
.m_col
= lvItem
.iSubItem
;
2591 delete[] lvItem
.pszText
;
2593 lvItem
.mask
= oldMask
;
2596 static void wxConvertToMSWFlags(long state
, long stateMask
, LV_ITEM
& lvItem
)
2598 if (stateMask
& wxLIST_STATE_CUT
)
2600 lvItem
.stateMask
|= LVIS_CUT
;
2601 if (state
& wxLIST_STATE_CUT
)
2602 lvItem
.state
|= LVIS_CUT
;
2604 if (stateMask
& wxLIST_STATE_DROPHILITED
)
2606 lvItem
.stateMask
|= LVIS_DROPHILITED
;
2607 if (state
& wxLIST_STATE_DROPHILITED
)
2608 lvItem
.state
|= LVIS_DROPHILITED
;
2610 if (stateMask
& wxLIST_STATE_FOCUSED
)
2612 lvItem
.stateMask
|= LVIS_FOCUSED
;
2613 if (state
& wxLIST_STATE_FOCUSED
)
2614 lvItem
.state
|= LVIS_FOCUSED
;
2616 if (stateMask
& wxLIST_STATE_SELECTED
)
2618 lvItem
.stateMask
|= LVIS_SELECTED
;
2619 if (state
& wxLIST_STATE_SELECTED
)
2620 lvItem
.state
|= LVIS_SELECTED
;
2624 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
2625 const wxListItem
& info
,
2628 lvItem
.iItem
= (int) info
.m_itemId
;
2630 lvItem
.iImage
= info
.m_image
;
2631 lvItem
.stateMask
= 0;
2634 lvItem
.iSubItem
= info
.m_col
;
2636 if (info
.m_mask
& wxLIST_MASK_STATE
)
2638 lvItem
.mask
|= LVIF_STATE
;
2640 wxConvertToMSWFlags(info
.m_state
, info
.m_stateMask
, lvItem
);
2643 if (info
.m_mask
& wxLIST_MASK_TEXT
)
2645 lvItem
.mask
|= LVIF_TEXT
;
2646 if ( ctrl
->HasFlag(wxLC_USER_TEXT
) )
2648 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
2652 // pszText is not const, hence the cast
2653 lvItem
.pszText
= (wxChar
*)info
.m_text
.c_str();
2654 if ( lvItem
.pszText
)
2655 lvItem
.cchTextMax
= info
.m_text
.Length();
2657 lvItem
.cchTextMax
= 0;
2660 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
2661 lvItem
.mask
|= LVIF_IMAGE
;
2664 static void wxConvertToMSWListCol(int WXUNUSED(col
), const wxListItem
& item
,
2667 wxZeroMemory(lvCol
);
2669 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
2671 lvCol
.mask
|= LVCF_TEXT
;
2672 lvCol
.pszText
= (wxChar
*)item
.m_text
.c_str(); // cast is safe
2675 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
2677 lvCol
.mask
|= LVCF_FMT
;
2679 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
2680 lvCol
.fmt
= LVCFMT_LEFT
;
2681 else if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
2682 lvCol
.fmt
= LVCFMT_RIGHT
;
2683 else if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
2684 lvCol
.fmt
= LVCFMT_CENTER
;
2687 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
2689 lvCol
.mask
|= LVCF_WIDTH
;
2690 if ( item
.m_width
== wxLIST_AUTOSIZE
)
2691 lvCol
.cx
= LVSCW_AUTOSIZE
;
2692 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
2693 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
2695 lvCol
.cx
= item
.m_width
;
2698 // see comment at the end of wxListCtrl::GetColumn()
2699 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2700 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
2702 if ( wxTheApp
->GetComCtl32Version() >= 470 )
2704 lvCol
.mask
|= LVCF_IMAGE
| LVCF_FMT
;
2706 // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right
2707 // seem to be generally nicer than on the left and the generic
2708 // version only draws them on the right (we don't have a flag to
2709 // specify the image location anyhow)
2711 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
2712 // make any difference in my tests -- but maybe we should?
2713 lvCol
.fmt
|= LVCFMT_BITMAP_ON_RIGHT
| LVCFMT_IMAGE
;
2715 lvCol
.iImage
= item
.m_image
;
2717 //else: it doesn't support item images anyhow
2719 #endif // _WIN32_IE >= 0x0300
2722 #endif // wxUSE_LISTCTRL