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 wxConvertToMSWFlags(0, info
.m_stateMask
, lvItem
);
734 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
737 wxLogError(_("Couldn't retrieve information about list control item %d."),
742 // give NULL as hwnd as we already have everything we need
743 wxConvertFromMSWListItem(NULL
, info
, lvItem
);
747 delete[] lvItem
.pszText
;
752 // Sets information about the item
753 bool wxListCtrl::SetItem(wxListItem
& info
)
756 wxConvertToMSWListItem(this, info
, item
);
758 // we never update the lParam if it contains our pointer
759 // to the wxListItemInternalData structure
760 item
.mask
&= ~LVIF_PARAM
;
762 // check if setting attributes or lParam
763 if (info
.HasAttributes() || (info
.m_mask
& wxLIST_MASK_DATA
))
765 // get internal item data
766 // perhaps a cache here ?
767 wxListItemInternalData
*data
= wxGetInternalData(this, info
.m_itemId
);
772 m_AnyInternalData
= true;
773 data
= new wxListItemInternalData();
774 item
.lParam
= (LPARAM
) data
;
775 item
.mask
|= LVIF_PARAM
;
780 if (info
.m_mask
& wxLIST_MASK_DATA
)
781 data
->lParam
= info
.m_data
;
784 if (info
.HasAttributes())
787 *data
->attr
= *info
.GetAttributes();
789 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
794 // we could be changing only the attribute in which case we don't need to
795 // call ListView_SetItem() at all
799 if ( !ListView_SetItem(GetHwnd(), &item
) )
801 wxLogDebug(_T("ListView_SetItem() failed"));
807 // we need to update the item immediately to show the new image
808 bool updateNow
= (info
.m_mask
& wxLIST_MASK_IMAGE
) != 0;
810 // check whether it has any custom attributes
811 if ( info
.HasAttributes() )
815 // if the colour has changed, we must redraw the item
821 // we need this to make the change visible right now
822 RefreshItem(item
.iItem
);
828 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
832 info
.m_mask
= wxLIST_MASK_TEXT
;
833 info
.m_itemId
= index
;
837 info
.m_image
= imageId
;
838 info
.m_mask
|= wxLIST_MASK_IMAGE
;
840 return SetItem(info
);
844 // Gets the item state
845 int wxListCtrl::GetItemState(long item
, long stateMask
) const
849 info
.m_mask
= wxLIST_MASK_STATE
;
850 info
.m_stateMask
= stateMask
;
851 info
.m_itemId
= item
;
859 // Sets the item state
860 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
862 // NB: don't use SetItem() here as it doesn't work with the virtual list
865 wxZeroMemory(lvItem
);
867 wxConvertToMSWFlags(state
, stateMask
, lvItem
);
869 // for the virtual list controls we need to refresh the previously focused
870 // item manually when changing focus without changing selection
871 // programmatically because otherwise it keeps its focus rectangle until
872 // next repaint (yet another comctl32 bug)
875 (stateMask
& wxLIST_STATE_FOCUSED
) &&
876 (state
& wxLIST_STATE_FOCUSED
) )
878 focusOld
= GetNextItem(-1, wxLIST_NEXT_ALL
, wxLIST_STATE_FOCUSED
);
885 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE
,
886 (WPARAM
)item
, (LPARAM
)&lvItem
) )
888 wxLogLastError(_T("ListView_SetItemState"));
893 if ( focusOld
!= -1 )
895 // no need to refresh the item if it was previously selected, it would
896 // only result in annoying flicker
897 if ( !(GetItemState(focusOld
,
898 wxLIST_STATE_SELECTED
) & wxLIST_STATE_SELECTED
) )
900 RefreshItem(focusOld
);
907 // Sets the item image
908 bool wxListCtrl::SetItemImage(long item
, int image
, int WXUNUSED(selImage
))
912 info
.m_mask
= wxLIST_MASK_IMAGE
;
913 info
.m_image
= image
;
914 info
.m_itemId
= item
;
916 return SetItem(info
);
919 // Gets the item text
920 wxString
wxListCtrl::GetItemText(long item
) const
924 info
.m_mask
= wxLIST_MASK_TEXT
;
925 info
.m_itemId
= item
;
928 return wxEmptyString
;
932 // Sets the item text
933 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
937 info
.m_mask
= wxLIST_MASK_TEXT
;
938 info
.m_itemId
= item
;
944 // Gets the item data
945 wxUIntPtr
wxListCtrl::GetItemData(long item
) const
949 info
.m_mask
= wxLIST_MASK_DATA
;
950 info
.m_itemId
= item
;
957 // Sets the item data
958 bool wxListCtrl::SetItemData(long item
, long data
)
962 info
.m_mask
= wxLIST_MASK_DATA
;
963 info
.m_itemId
= item
;
966 return SetItem(info
);
969 wxRect
wxListCtrl::GetViewRect() const
971 wxASSERT_MSG( !HasFlag(wxLC_REPORT
| wxLC_LIST
),
972 _T("wxListCtrl::GetViewRect() only works in icon mode") );
975 if ( !ListView_GetViewRect(GetHwnd(), &rc
) )
977 wxLogDebug(_T("ListView_GetViewRect() failed."));
983 wxCopyRECTToRect(rc
, rect
);
988 // Gets the item rectangle
989 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
994 if ( code
== wxLIST_RECT_BOUNDS
)
995 codeWin
= LVIR_BOUNDS
;
996 else if ( code
== wxLIST_RECT_ICON
)
998 else if ( code
== wxLIST_RECT_LABEL
)
999 codeWin
= LVIR_LABEL
;
1002 wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
1004 codeWin
= LVIR_BOUNDS
;
1007 bool success
= ListView_GetItemRect(GetHwnd(), (int) item
, &rectWin
, codeWin
) != 0;
1009 rect
.x
= rectWin
.left
;
1010 rect
.y
= rectWin
.top
;
1011 rect
.width
= rectWin
.right
- rectWin
.left
;
1012 rect
.height
= rectWin
.bottom
- rectWin
.top
;
1017 // Gets the item position
1018 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
1022 bool success
= (ListView_GetItemPosition(GetHwnd(), (int) item
, &pt
) != 0);
1024 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
1028 // Sets the item position.
1029 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
1031 return (ListView_SetItemPosition(GetHwnd(), (int) item
, pos
.x
, pos
.y
) != 0);
1034 // Gets the number of items in the list control
1035 int wxListCtrl::GetItemCount() const
1040 wxSize
wxListCtrl::GetItemSpacing() const
1042 const int spacing
= ListView_GetItemSpacing(GetHwnd(), (BOOL
)HasFlag(wxLC_SMALL_ICON
));
1044 return wxSize(LOWORD(spacing
), HIWORD(spacing
));
1047 int wxListCtrl::GetItemSpacing(bool isSmall
) const
1049 return ListView_GetItemSpacing(GetHwnd(), (BOOL
) isSmall
);
1052 void wxListCtrl::SetItemTextColour( long item
, const wxColour
&col
)
1055 info
.m_itemId
= item
;
1056 info
.SetTextColour( col
);
1060 wxColour
wxListCtrl::GetItemTextColour( long item
) const
1063 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1064 if ( data
&& data
->attr
)
1065 col
= data
->attr
->GetTextColour();
1070 void wxListCtrl::SetItemBackgroundColour( long item
, const wxColour
&col
)
1073 info
.m_itemId
= item
;
1074 info
.SetBackgroundColour( col
);
1078 wxColour
wxListCtrl::GetItemBackgroundColour( long item
) const
1081 wxListItemInternalData
*data
= wxGetInternalData(this, item
);
1082 if ( data
&& data
->attr
)
1083 col
= data
->attr
->GetBackgroundColour();
1088 // Gets the number of selected items in the list control
1089 int wxListCtrl::GetSelectedItemCount() const
1091 return ListView_GetSelectedCount(GetHwnd());
1094 // Gets the text colour of the listview
1095 wxColour
wxListCtrl::GetTextColour() const
1097 COLORREF ref
= ListView_GetTextColor(GetHwnd());
1098 wxColour
col(GetRValue(ref
), GetGValue(ref
), GetBValue(ref
));
1102 // Sets the text colour of the listview
1103 void wxListCtrl::SetTextColour(const wxColour
& col
)
1105 ListView_SetTextColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
1108 // Gets the index of the topmost visible item when in
1109 // list or report view
1110 long wxListCtrl::GetTopItem() const
1112 return (long) ListView_GetTopIndex(GetHwnd());
1115 // Searches for an item, starting from 'item'.
1116 // 'geometry' is one of
1117 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1118 // 'state' is a state bit flag, one or more of
1119 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1120 // item can be -1 to find the first item that matches the
1122 // Returns the item or -1 if unsuccessful.
1123 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
1127 if ( geom
== wxLIST_NEXT_ABOVE
)
1128 flags
|= LVNI_ABOVE
;
1129 if ( geom
== wxLIST_NEXT_ALL
)
1131 if ( geom
== wxLIST_NEXT_BELOW
)
1132 flags
|= LVNI_BELOW
;
1133 if ( geom
== wxLIST_NEXT_LEFT
)
1134 flags
|= LVNI_TOLEFT
;
1135 if ( geom
== wxLIST_NEXT_RIGHT
)
1136 flags
|= LVNI_TORIGHT
;
1138 if ( state
& wxLIST_STATE_CUT
)
1140 if ( state
& wxLIST_STATE_DROPHILITED
)
1141 flags
|= LVNI_DROPHILITED
;
1142 if ( state
& wxLIST_STATE_FOCUSED
)
1143 flags
|= LVNI_FOCUSED
;
1144 if ( state
& wxLIST_STATE_SELECTED
)
1145 flags
|= LVNI_SELECTED
;
1147 return (long) ListView_GetNextItem(GetHwnd(), item
, flags
);
1151 wxImageList
*wxListCtrl::GetImageList(int which
) const
1153 if ( which
== wxIMAGE_LIST_NORMAL
)
1155 return m_imageListNormal
;
1157 else if ( which
== wxIMAGE_LIST_SMALL
)
1159 return m_imageListSmall
;
1161 else if ( which
== wxIMAGE_LIST_STATE
)
1163 return m_imageListState
;
1168 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
1171 if ( which
== wxIMAGE_LIST_NORMAL
)
1173 flags
= LVSIL_NORMAL
;
1174 if (m_ownsImageListNormal
) delete m_imageListNormal
;
1175 m_imageListNormal
= imageList
;
1176 m_ownsImageListNormal
= false;
1178 else if ( which
== wxIMAGE_LIST_SMALL
)
1180 flags
= LVSIL_SMALL
;
1181 if (m_ownsImageListSmall
) delete m_imageListSmall
;
1182 m_imageListSmall
= imageList
;
1183 m_ownsImageListSmall
= false;
1185 else if ( which
== wxIMAGE_LIST_STATE
)
1187 flags
= LVSIL_STATE
;
1188 if (m_ownsImageListState
) delete m_imageListState
;
1189 m_imageListState
= imageList
;
1190 m_ownsImageListState
= false;
1192 ListView_SetImageList(GetHwnd(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
1195 void wxListCtrl::AssignImageList(wxImageList
*imageList
, int which
)
1197 SetImageList(imageList
, which
);
1198 if ( which
== wxIMAGE_LIST_NORMAL
)
1199 m_ownsImageListNormal
= true;
1200 else if ( which
== wxIMAGE_LIST_SMALL
)
1201 m_ownsImageListSmall
= true;
1202 else if ( which
== wxIMAGE_LIST_STATE
)
1203 m_ownsImageListState
= true;
1206 // ----------------------------------------------------------------------------
1208 // ----------------------------------------------------------------------------
1210 // Arranges the items
1211 bool wxListCtrl::Arrange(int flag
)
1214 if ( flag
== wxLIST_ALIGN_LEFT
)
1215 code
= LVA_ALIGNLEFT
;
1216 else if ( flag
== wxLIST_ALIGN_TOP
)
1217 code
= LVA_ALIGNTOP
;
1218 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
1220 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
1221 code
= LVA_SNAPTOGRID
;
1223 return (ListView_Arrange(GetHwnd(), code
) != 0);
1227 bool wxListCtrl::DeleteItem(long item
)
1229 if ( !ListView_DeleteItem(GetHwnd(), (int) item
) )
1231 wxLogLastError(_T("ListView_DeleteItem"));
1236 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1237 wxT("m_count should match ListView_GetItemCount"));
1239 // the virtual list control doesn't refresh itself correctly, help it
1242 // we need to refresh all the lines below the one which was deleted
1244 if ( item
> 0 && GetItemCount() )
1246 GetItemRect(item
- 1, rectItem
);
1251 rectItem
.height
= 0;
1254 wxRect rectWin
= GetRect();
1255 rectWin
.height
= rectWin
.GetBottom() - rectItem
.GetBottom();
1256 rectWin
.y
= rectItem
.GetBottom();
1258 RefreshRect(rectWin
);
1264 // Deletes all items
1265 bool wxListCtrl::DeleteAllItems()
1267 return ListView_DeleteAllItems(GetHwnd()) != 0;
1270 // Deletes all items
1271 bool wxListCtrl::DeleteAllColumns()
1273 while ( m_colCount
> 0 )
1275 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1277 wxLogLastError(wxT("ListView_DeleteColumn"));
1285 wxASSERT_MSG( m_colCount
== 0, wxT("no columns should be left") );
1291 bool wxListCtrl::DeleteColumn(int col
)
1293 bool success
= (ListView_DeleteColumn(GetHwnd(), col
) != 0);
1295 if ( success
&& (m_colCount
> 0) )
1300 // Clears items, and columns if there are any.
1301 void wxListCtrl::ClearAll()
1304 if ( m_colCount
> 0 )
1308 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
1310 wxASSERT( (textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
))) );
1312 // ListView_EditLabel requires that the list has focus.
1315 WXHWND hWnd
= (WXHWND
) ListView_EditLabel(GetHwnd(), item
);
1318 // failed to start editing
1322 // [re]create the text control wrapping the HWND we got
1325 m_textCtrl
->UnsubclassWin();
1326 m_textCtrl
->SetHWND(0);
1330 m_textCtrl
= (wxTextCtrl
*)textControlClass
->CreateObject();
1331 m_textCtrl
->SetHWND(hWnd
);
1332 m_textCtrl
->SubclassWin(hWnd
);
1333 m_textCtrl
->SetParent(this);
1335 // we must disallow TABbing away from the control while the edit contol is
1336 // shown because this leaves it in some strange state (just try removing
1337 // this line and then pressing TAB while editing an item in listctrl
1339 m_textCtrl
->SetWindowStyle(m_textCtrl
->GetWindowStyle() | wxTE_PROCESS_TAB
);
1344 // End label editing, optionally cancelling the edit
1345 bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel
))
1347 wxFAIL_MSG( _T("not implemented") );
1352 // Ensures this item is visible
1353 bool wxListCtrl::EnsureVisible(long item
)
1355 return ListView_EnsureVisible(GetHwnd(), (int) item
, FALSE
) != FALSE
;
1358 // Find an item whose label matches this string, starting from the item after 'start'
1359 // or the beginning if 'start' is -1.
1360 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
1362 LV_FINDINFO findInfo
;
1364 findInfo
.flags
= LVFI_STRING
;
1366 findInfo
.flags
|= LVFI_PARTIAL
;
1369 // ListView_FindItem() excludes the first item from search and to look
1370 // through all the items you need to start from -1 which is unnatural and
1371 // inconsistent with the generic version - so we adjust the index
1374 return ListView_FindItem(GetHwnd(), (int) start
, &findInfo
);
1377 // Find an item whose data matches this data, starting from the item after 'start'
1378 // or the beginning if 'start' is -1.
1379 // NOTE : Lindsay Mathieson - 14-July-2002
1380 // No longer use ListView_FindItem as the data attribute is now stored
1381 // in a wxListItemInternalData structure refernced by the actual lParam
1382 long wxListCtrl::FindItem(long start
, wxUIntPtr data
)
1384 long idx
= start
+ 1;
1385 long count
= GetItemCount();
1389 if (GetItemData(idx
) == data
)
1397 // Find an item nearest this position in the specified direction, starting from
1398 // the item after 'start' or the beginning if 'start' is -1.
1399 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
1401 LV_FINDINFO findInfo
;
1403 findInfo
.flags
= LVFI_NEARESTXY
;
1404 findInfo
.pt
.x
= pt
.x
;
1405 findInfo
.pt
.y
= pt
.y
;
1406 findInfo
.vkDirection
= VK_RIGHT
;
1408 if ( direction
== wxLIST_FIND_UP
)
1409 findInfo
.vkDirection
= VK_UP
;
1410 else if ( direction
== wxLIST_FIND_DOWN
)
1411 findInfo
.vkDirection
= VK_DOWN
;
1412 else if ( direction
== wxLIST_FIND_LEFT
)
1413 findInfo
.vkDirection
= VK_LEFT
;
1414 else if ( direction
== wxLIST_FIND_RIGHT
)
1415 findInfo
.vkDirection
= VK_RIGHT
;
1417 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
1420 // Determines which item (if any) is at the specified point,
1421 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1422 long wxListCtrl::HitTest(const wxPoint
& point
, int& flags
)
1424 LV_HITTESTINFO hitTestInfo
;
1425 hitTestInfo
.pt
.x
= (int) point
.x
;
1426 hitTestInfo
.pt
.y
= (int) point
.y
;
1428 ListView_HitTest(GetHwnd(), & hitTestInfo
);
1432 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
1433 flags
|= wxLIST_HITTEST_ABOVE
;
1434 if ( hitTestInfo
.flags
& LVHT_BELOW
)
1435 flags
|= wxLIST_HITTEST_BELOW
;
1436 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
1437 flags
|= wxLIST_HITTEST_TOLEFT
;
1438 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
1439 flags
|= wxLIST_HITTEST_TORIGHT
;
1441 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
1442 flags
|= wxLIST_HITTEST_NOWHERE
;
1444 // note a bug or at least a very strange feature of comtl32.dll (tested
1445 // with version 4.0 under Win95 and 6.0 under Win 2003): if you click to
1446 // the right of the item label, ListView_HitTest() returns a combination of
1447 // LVHT_ONITEMICON, LVHT_ONITEMLABEL and LVHT_ONITEMSTATEICON -- filter out
1448 // the bits which don't make sense
1449 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
1451 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
1453 // do not translate LVHT_ONITEMICON here, as per above
1457 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
1458 flags
|= wxLIST_HITTEST_ONITEMICON
;
1459 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
1460 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
1463 return (long) hitTestInfo
.iItem
;
1466 // Inserts an item, returning the index of the new item if successful,
1468 long wxListCtrl::InsertItem(wxListItem
& info
)
1470 wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
1473 wxConvertToMSWListItem(this, info
, item
);
1474 item
.mask
&= ~LVIF_PARAM
;
1476 // check wether we need to allocate our internal data
1477 bool needInternalData
= ((info
.m_mask
& wxLIST_MASK_DATA
) || info
.HasAttributes());
1478 if (needInternalData
)
1480 m_AnyInternalData
= true;
1481 item
.mask
|= LVIF_PARAM
;
1483 // internal stucture that manages data
1484 wxListItemInternalData
*data
= new wxListItemInternalData();
1485 item
.lParam
= (LPARAM
) data
;
1487 if (info
.m_mask
& wxLIST_MASK_DATA
)
1488 data
->lParam
= info
.m_data
;
1490 // check whether it has any custom attributes
1491 if ( info
.HasAttributes() )
1493 // take copy of attributes
1494 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
1496 // and remember that we have some now...
1497 m_hasAnyAttr
= true;
1501 long rv
= ListView_InsertItem(GetHwnd(), & item
);
1504 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1505 wxT("m_count should match ListView_GetItemCount"));
1510 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1513 info
.m_text
= label
;
1514 info
.m_mask
= wxLIST_MASK_TEXT
;
1515 info
.m_itemId
= index
;
1516 return InsertItem(info
);
1519 // Inserts an image item
1520 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1523 info
.m_image
= imageIndex
;
1524 info
.m_mask
= wxLIST_MASK_IMAGE
;
1525 info
.m_itemId
= index
;
1526 return InsertItem(info
);
1529 // Inserts an image/string item
1530 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1533 info
.m_image
= imageIndex
;
1534 info
.m_text
= label
;
1535 info
.m_mask
= wxLIST_MASK_IMAGE
| wxLIST_MASK_TEXT
;
1536 info
.m_itemId
= index
;
1537 return InsertItem(info
);
1540 // For list view mode (only), inserts a column.
1541 long wxListCtrl::InsertColumn(long col
, wxListItem
& item
)
1544 wxConvertToMSWListCol(col
, item
, lvCol
);
1546 if ( !(lvCol
.mask
& LVCF_WIDTH
) )
1548 // always give some width to the new column: this one is compatible
1549 // with the generic version
1550 lvCol
.mask
|= LVCF_WIDTH
;
1554 long n
= ListView_InsertColumn(GetHwnd(), col
, &lvCol
);
1559 else // failed to insert?
1561 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1568 long wxListCtrl::InsertColumn(long col
,
1569 const wxString
& heading
,
1574 item
.m_mask
= wxLIST_MASK_TEXT
| wxLIST_MASK_FORMAT
;
1575 item
.m_text
= heading
;
1578 item
.m_mask
|= wxLIST_MASK_WIDTH
;
1579 item
.m_width
= width
;
1581 item
.m_format
= format
;
1583 return InsertColumn(col
, item
);
1586 // scroll the control by the given number of pixels (exception: in list view,
1587 // dx is interpreted as number of columns)
1588 bool wxListCtrl::ScrollList(int dx
, int dy
)
1590 if ( !ListView_Scroll(GetHwnd(), dx
, dy
) )
1592 wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx
, dy
);
1602 // fn is a function which takes 3 long arguments: item1, item2, data.
1603 // item1 is the long data associated with a first item (NOT the index).
1604 // item2 is the long data associated with a second item (NOT the index).
1605 // data is the same value as passed to SortItems.
1606 // The return value is a negative number if the first item should precede the second
1607 // item, a positive number of the second item should precede the first,
1608 // or zero if the two items are equivalent.
1610 // data is arbitrary data to be passed to the sort function.
1612 // Internal structures for proxying the user compare function
1613 // so that we can pass it the *real* user data
1615 // translate lParam data and call user func
1616 struct wxInternalDataSort
1618 wxListCtrlCompare user_fn
;
1622 int CALLBACK
wxInternalDataCompareFunc(LPARAM lParam1
, LPARAM lParam2
, LPARAM lParamSort
)
1624 struct wxInternalDataSort
*internalData
= (struct wxInternalDataSort
*) lParamSort
;
1626 wxListItemInternalData
*data1
= (wxListItemInternalData
*) lParam1
;
1627 wxListItemInternalData
*data2
= (wxListItemInternalData
*) lParam2
;
1629 long d1
= (data1
== NULL
? 0 : data1
->lParam
);
1630 long d2
= (data2
== NULL
? 0 : data2
->lParam
);
1632 return internalData
->user_fn(d1
, d2
, internalData
->data
);
1636 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, long data
)
1638 struct wxInternalDataSort internalData
;
1639 internalData
.user_fn
= fn
;
1640 internalData
.data
= data
;
1642 // WPARAM cast is needed for mingw/cygwin
1643 if ( !ListView_SortItems(GetHwnd(),
1644 wxInternalDataCompareFunc
,
1645 (WPARAM
) &internalData
) )
1647 wxLogDebug(_T("ListView_SortItems() failed"));
1657 // ----------------------------------------------------------------------------
1658 // message processing
1659 // ----------------------------------------------------------------------------
1661 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1663 if (cmd
== EN_UPDATE
)
1665 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1666 event
.SetEventObject( this );
1667 ProcessCommand(event
);
1670 else if (cmd
== EN_KILLFOCUS
)
1672 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1673 event
.SetEventObject( this );
1674 ProcessCommand(event
);
1681 bool wxListCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
1684 // prepare the event
1685 // -----------------
1687 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1688 event
.SetEventObject(this);
1690 wxEventType eventType
= wxEVT_NULL
;
1692 NMHDR
*nmhdr
= (NMHDR
*)lParam
;
1694 // if your compiler is as broken as this, you should really change it: this
1695 // code is needed for normal operation! #ifdef below is only useful for
1696 // automatic rebuilds which are done with a very old compiler version
1697 #ifdef HDN_BEGINTRACKA
1699 // check for messages from the header (in report view)
1700 HWND hwndHdr
= ListView_GetHeader(GetHwnd());
1702 // is it a message from the header?
1703 if ( nmhdr
->hwndFrom
== hwndHdr
)
1705 HD_NOTIFY
*nmHDR
= (HD_NOTIFY
*)nmhdr
;
1707 event
.m_itemIndex
= -1;
1709 switch ( nmhdr
->code
)
1711 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1712 // TRACK messages even to ANSI programs: on my system I get
1713 // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all!
1715 // work around is to simply catch both versions and hope that it
1716 // works (why should this message exist in ANSI and Unicode is
1717 // beyond me as it doesn't deal with strings at all...)
1719 // note that fr HDN_TRACK another possibility could be to use
1720 // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when
1721 // something other than the item width changes so we'd have to
1722 // filter out the unwanted events then
1723 case HDN_BEGINTRACKA
:
1724 case HDN_BEGINTRACKW
:
1725 eventType
= wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
;
1730 if ( eventType
== wxEVT_NULL
)
1731 eventType
= wxEVT_COMMAND_LIST_COL_DRAGGING
;
1736 if ( eventType
== wxEVT_NULL
)
1737 eventType
= wxEVT_COMMAND_LIST_COL_END_DRAG
;
1739 event
.m_item
.m_width
= nmHDR
->pitem
->cxy
;
1740 event
.m_col
= nmHDR
->iItem
;
1743 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1744 case GN_CONTEXTMENU
:
1745 #endif //__WXWINCE__
1748 eventType
= wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
;
1751 // find the column clicked: we have to search for it
1752 // ourselves as the notification message doesn't provide
1755 // where did the click occur?
1757 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
1758 if(nmhdr
->code
== GN_CONTEXTMENU
) {
1759 ptClick
= ((NMRGINFO
*)nmhdr
)->ptAction
;
1761 #endif //__WXWINCE__
1762 if ( !::GetCursorPos(&ptClick
) )
1764 wxLogLastError(_T("GetCursorPos"));
1767 if ( !::ScreenToClient(GetHwnd(), &ptClick
) )
1769 wxLogLastError(_T("ScreenToClient(listctrl header)"));
1772 event
.m_pointDrag
.x
= ptClick
.x
;
1773 event
.m_pointDrag
.y
= ptClick
.y
;
1775 int colCount
= Header_GetItemCount(hwndHdr
);
1778 for ( int col
= 0; col
< colCount
; col
++ )
1780 if ( Header_GetItemRect(hwndHdr
, col
, &rect
) )
1782 if ( ::PtInRect(&rect
, ptClick
) )
1792 case HDN_GETDISPINFOW
:
1793 // letting Windows XP handle this message results in mysterious
1794 // crashes in comctl32.dll seemingly because of bad message
1797 // I have no idea what is the real cause of the bug (which is,
1798 // just to make things interesting, is impossible to reproduce
1799 // reliably) but ignoring all these messages does fix it and
1800 // doesn't seem to have any negative consequences
1804 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1808 #endif // defined(HDN_BEGINTRACKA)
1809 if ( nmhdr
->hwndFrom
== GetHwnd() )
1811 // almost all messages use NM_LISTVIEW
1812 NM_LISTVIEW
*nmLV
= (NM_LISTVIEW
*)nmhdr
;
1814 const int iItem
= nmLV
->iItem
;
1817 // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be
1818 // ignored for efficiency. It is done here because the internal data is in the
1819 // process of being deleted so we don't want to try and access it below.
1820 if ( m_ignoreChangeMessages
&&
1821 ( (nmLV
->hdr
.code
== LVN_ITEMCHANGED
) ||
1822 (nmLV
->hdr
.code
== LVN_ITEMCHANGING
)) )
1828 // If we have a valid item then check if there is a data value
1829 // associated with it and put it in the event.
1830 if ( iItem
>= 0 && iItem
< GetItemCount() )
1832 wxListItemInternalData
*internaldata
=
1833 wxGetInternalData(GetHwnd(), iItem
);
1836 event
.m_item
.m_data
= internaldata
->lParam
;
1840 switch ( nmhdr
->code
)
1842 case LVN_BEGINRDRAG
:
1843 eventType
= wxEVT_COMMAND_LIST_BEGIN_RDRAG
;
1847 if ( eventType
== wxEVT_NULL
)
1849 eventType
= wxEVT_COMMAND_LIST_BEGIN_DRAG
;
1852 event
.m_itemIndex
= iItem
;
1853 event
.m_pointDrag
.x
= nmLV
->ptAction
.x
;
1854 event
.m_pointDrag
.y
= nmLV
->ptAction
.y
;
1857 // NB: we have to handle both *A and *W versions here because some
1858 // versions of comctl32.dll send ANSI messages even to the
1860 case LVN_BEGINLABELEDITA
:
1861 case LVN_BEGINLABELEDITW
:
1864 if ( nmhdr
->code
== LVN_BEGINLABELEDITA
)
1866 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1868 else // LVN_BEGINLABELEDITW
1870 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1873 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1874 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, item
);
1875 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1879 case LVN_ENDLABELEDITA
:
1880 case LVN_ENDLABELEDITW
:
1883 if ( nmhdr
->code
== LVN_ENDLABELEDITA
)
1885 item
.Init(((LV_DISPINFOA
*)lParam
)->item
);
1887 else // LVN_ENDLABELEDITW
1889 item
.Init(((LV_DISPINFOW
*)lParam
)->item
);
1892 // was editing cancelled?
1893 const LV_ITEM
& lvi
= (LV_ITEM
)item
;
1894 if ( !lvi
.pszText
|| lvi
.iItem
== -1 )
1896 // don't keep a stale wxTextCtrl around
1899 // EDIT control will be deleted by the list control itself so
1900 // prevent us from deleting it as well
1901 m_textCtrl
->UnsubclassWin();
1902 m_textCtrl
->SetHWND(0);
1907 event
.SetEditCanceled(true);
1910 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1911 wxConvertFromMSWListItem(NULL
, event
.m_item
, item
);
1912 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1916 case LVN_COLUMNCLICK
:
1917 eventType
= wxEVT_COMMAND_LIST_COL_CLICK
;
1918 event
.m_itemIndex
= -1;
1919 event
.m_col
= nmLV
->iSubItem
;
1922 case LVN_DELETEALLITEMS
:
1923 eventType
= wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
;
1924 event
.m_itemIndex
= -1;
1927 case LVN_DELETEITEM
:
1930 // this should be prevented by the post-processing code
1931 // below, but "just in case"
1935 eventType
= wxEVT_COMMAND_LIST_DELETE_ITEM
;
1936 event
.m_itemIndex
= iItem
;
1937 // delete the assoicated internal data
1938 wxDeleteInternalData(this, iItem
);
1941 #if WXWIN_COMPATIBILITY_2_4
1942 case LVN_SETDISPINFO
:
1944 eventType
= wxEVT_COMMAND_LIST_SET_INFO
;
1945 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1946 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, info
->item
);
1951 case LVN_INSERTITEM
:
1952 eventType
= wxEVT_COMMAND_LIST_INSERT_ITEM
;
1953 event
.m_itemIndex
= iItem
;
1956 case LVN_ITEMCHANGED
:
1957 // we translate this catch all message into more interesting
1958 // (and more easy to process) wxWidgets events
1960 // first of all, we deal with the state change events only and
1961 // only for valid items (item == -1 for the virtual list
1963 if ( nmLV
->uChanged
& LVIF_STATE
&& iItem
!= -1 )
1965 // temp vars for readability
1966 const UINT stOld
= nmLV
->uOldState
;
1967 const UINT stNew
= nmLV
->uNewState
;
1969 event
.m_item
.SetId(iItem
);
1970 event
.m_item
.SetMask(wxLIST_MASK_TEXT
|
1973 GetItem(event
.m_item
);
1975 // has the focus changed?
1976 if ( !(stOld
& LVIS_FOCUSED
) && (stNew
& LVIS_FOCUSED
) )
1978 eventType
= wxEVT_COMMAND_LIST_ITEM_FOCUSED
;
1979 event
.m_itemIndex
= iItem
;
1982 if ( (stNew
& LVIS_SELECTED
) != (stOld
& LVIS_SELECTED
) )
1984 if ( eventType
!= wxEVT_NULL
)
1986 // focus and selection have both changed: send the
1987 // focus event from here and the selection one
1989 event
.SetEventType(eventType
);
1990 (void)GetEventHandler()->ProcessEvent(event
);
1992 else // no focus event to send
1994 // then need to set m_itemIndex as it wasn't done
1996 event
.m_itemIndex
= iItem
;
1999 eventType
= stNew
& LVIS_SELECTED
2000 ? wxEVT_COMMAND_LIST_ITEM_SELECTED
2001 : wxEVT_COMMAND_LIST_ITEM_DESELECTED
;
2005 if ( eventType
== wxEVT_NULL
)
2007 // not an interesting event for us
2015 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
2016 WORD wVKey
= info
->wVKey
;
2018 // get the current selection
2019 long lItem
= GetNextItem(-1,
2021 wxLIST_STATE_SELECTED
);
2023 // <Enter> or <Space> activate the selected item if any (but
2024 // not with Shift and/or Ctrl as then they have a predefined
2025 // meaning for the list view)
2027 (wVKey
== VK_RETURN
|| wVKey
== VK_SPACE
) &&
2028 !(wxIsShiftDown() || wxIsCtrlDown()) )
2030 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2034 eventType
= wxEVT_COMMAND_LIST_KEY_DOWN
;
2036 // wxCharCodeMSWToWX() returns 0 if the key is an ASCII
2037 // value which should be used as is
2038 int code
= wxCharCodeMSWToWX(wVKey
);
2039 event
.m_code
= code
? code
: wVKey
;
2043 event
.m_item
.m_itemId
= lItem
;
2047 // fill the other fields too
2048 event
.m_item
.m_text
= GetItemText(lItem
);
2049 event
.m_item
.m_data
= GetItemData(lItem
);
2055 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2057 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2062 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
2063 // if it happened on an item (and not on empty place)
2070 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2071 event
.m_itemIndex
= iItem
;
2072 event
.m_item
.m_text
= GetItemText(iItem
);
2073 event
.m_item
.m_data
= GetItemData(iItem
);
2076 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2077 case GN_CONTEXTMENU
:
2078 #endif //__WXWINCE__
2080 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2081 // don't do anything else
2082 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2087 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
2088 LV_HITTESTINFO lvhti
;
2089 wxZeroMemory(lvhti
);
2091 #if defined(__WXWINCE__) && !defined(__HANDHELDPC__) && _WIN32_WCE < 400
2092 if(nmhdr
->code
== GN_CONTEXTMENU
) {
2093 lvhti
.pt
= ((NMRGINFO
*)nmhdr
)->ptAction
;
2095 #endif //__WXWINCE__
2096 ::GetCursorPos(&(lvhti
.pt
));
2097 ::ScreenToClient(GetHwnd(),&(lvhti
.pt
));
2098 if ( ListView_HitTest(GetHwnd(),&lvhti
) != -1 )
2100 if ( lvhti
.flags
& LVHT_ONITEM
)
2102 eventType
= wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
;
2103 event
.m_itemIndex
= lvhti
.iItem
;
2104 event
.m_pointDrag
.x
= lvhti
.pt
.x
;
2105 event
.m_pointDrag
.y
= lvhti
.pt
.y
;
2110 #ifdef NM_CUSTOMDRAW
2112 *result
= OnCustomDraw(lParam
);
2115 #endif // _WIN32_IE >= 0x300
2117 case LVN_ODCACHEHINT
:
2119 const NM_CACHEHINT
*cacheHint
= (NM_CACHEHINT
*)lParam
;
2121 eventType
= wxEVT_COMMAND_LIST_CACHE_HINT
;
2123 // we get some really stupid cache hints like ones for
2124 // items in range 0..0 for an empty control or, after
2125 // deleting an item, for items in invalid range -- filter
2127 if ( cacheHint
->iFrom
> cacheHint
->iTo
)
2130 event
.m_oldItemIndex
= cacheHint
->iFrom
;
2132 const long iMax
= GetItemCount();
2133 event
.m_itemIndex
= cacheHint
->iTo
< iMax
? cacheHint
->iTo
2138 case LVN_GETDISPINFO
:
2141 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
2143 LV_ITEM
& lvi
= info
->item
;
2144 long item
= lvi
.iItem
;
2146 if ( lvi
.mask
& LVIF_TEXT
)
2148 wxString text
= OnGetItemText(item
, lvi
.iSubItem
);
2149 wxStrncpy(lvi
.pszText
, text
, lvi
.cchTextMax
);
2152 // see comment at the end of wxListCtrl::GetColumn()
2153 #ifdef NM_CUSTOMDRAW
2154 if ( lvi
.mask
& LVIF_IMAGE
)
2156 lvi
.iImage
= OnGetItemImage(item
);
2158 #endif // NM_CUSTOMDRAW
2160 // a little dose of healthy paranoia: as we never use
2161 // LVM_SETCALLBACKMASK we're not supposed to get these ones
2162 wxASSERT_MSG( !(lvi
.mask
& LVIF_STATE
),
2163 _T("we don't support state callbacks yet!") );
2170 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
2175 // where did this one come from?
2179 // process the event
2180 // -----------------
2182 event
.SetEventType(eventType
);
2184 bool processed
= GetEventHandler()->ProcessEvent(event
);
2188 switch ( nmhdr
->code
)
2190 case LVN_DELETEALLITEMS
:
2191 // always return true to suppress all additional LVN_DELETEITEM
2192 // notifications - this makes deleting all items from a list ctrl
2196 // also, we may free all user data now (couldn't do it before as
2197 // the user should have access to it in OnDeleteAllItems() handler)
2198 FreeAllInternalData();
2200 // the control is empty now, synchronize the cached number of items
2201 // with the real one
2205 case LVN_ENDLABELEDITA
:
2206 case LVN_ENDLABELEDITW
:
2207 // logic here is inversed compared to all the other messages
2208 *result
= event
.IsAllowed();
2210 // don't keep a stale wxTextCtrl around
2213 // EDIT control will be deleted by the list control itself so
2214 // prevent us from deleting it as well
2215 m_textCtrl
->UnsubclassWin();
2216 m_textCtrl
->SetHWND(0);
2225 *result
= !event
.IsAllowed();
2230 // see comment at the end of wxListCtrl::GetColumn()
2231 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2233 WXLPARAM
wxListCtrl::OnCustomDraw(WXLPARAM lParam
)
2235 LPNMLVCUSTOMDRAW lplvcd
= (LPNMLVCUSTOMDRAW
)lParam
;
2236 NMCUSTOMDRAW
& nmcd
= lplvcd
->nmcd
;
2237 switch ( nmcd
.dwDrawStage
)
2240 // if we've got any items with non standard attributes,
2241 // notify us before painting each item
2243 // for virtual controls, always suppose that we have attributes as
2244 // there is no way to check for this
2245 return IsVirtual() || m_hasAnyAttr
? CDRF_NOTIFYITEMDRAW
2248 case CDDS_ITEMPREPAINT
:
2250 size_t item
= (size_t)nmcd
.dwItemSpec
;
2251 if ( item
>= (size_t)GetItemCount() )
2253 // we get this message with item == 0 for an empty control,
2254 // we must ignore it as calling OnGetItemAttr() would be
2256 return CDRF_DODEFAULT
;
2259 wxListItemAttr
*attr
=
2260 IsVirtual() ? OnGetItemAttr(item
)
2261 : wxGetInternalDataAttr(this, item
);
2265 // nothing to do for this item
2266 return CDRF_DODEFAULT
;
2270 wxColour colText
, colBack
;
2271 if ( attr
->HasFont() )
2273 wxFont font
= attr
->GetFont();
2274 hFont
= (HFONT
)font
.GetResourceHandle();
2281 if ( attr
->HasTextColour() )
2283 colText
= attr
->GetTextColour();
2287 colText
= GetTextColour();
2290 if ( attr
->HasBackgroundColour() )
2292 colBack
= attr
->GetBackgroundColour();
2296 colBack
= GetBackgroundColour();
2299 lplvcd
->clrText
= wxColourToRGB(colText
);
2300 lplvcd
->clrTextBk
= wxColourToRGB(colBack
);
2302 // note that if we wanted to set colours for
2303 // individual columns (subitems), we would have
2304 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2307 ::SelectObject(nmcd
.hdc
, hFont
);
2309 return CDRF_NEWFONT
;
2312 // fall through to return CDRF_DODEFAULT
2315 return CDRF_DODEFAULT
;
2319 #endif // NM_CUSTOMDRAW supported
2321 // Necessary for drawing hrules and vrules, if specified
2322 void wxListCtrl::OnPaint(wxPaintEvent
& event
)
2326 wxControl::OnPaint(event
);
2328 // Reset the device origin since it may have been set
2329 dc
.SetDeviceOrigin(0, 0);
2331 bool drawHRules
= HasFlag(wxLC_HRULES
);
2332 bool drawVRules
= HasFlag(wxLC_VRULES
);
2334 if (!InReportView() || !drawHRules
&& !drawVRules
)
2337 wxPen
pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT
), 1, wxSOLID
);
2339 dc
.SetBrush(* wxTRANSPARENT_BRUSH
);
2341 wxSize clientSize
= GetClientSize();
2344 int itemCount
= GetItemCount();
2348 long top
= GetTopItem();
2349 for (i
= top
; i
< top
+ GetCountPerPage() + 1; i
++)
2351 if (GetItemRect(i
, itemRect
))
2353 int cy
= itemRect
.GetTop();
2354 if (i
!= 0) // Don't draw the first one
2356 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2359 if (i
== itemCount
- 1)
2361 cy
= itemRect
.GetBottom();
2362 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2368 if (drawVRules
&& (i
> -1))
2370 wxRect firstItemRect
;
2371 GetItemRect(0, firstItemRect
);
2373 if (GetItemRect(i
, itemRect
))
2376 int x
= itemRect
.GetX();
2377 for (col
= 0; col
< GetColumnCount(); col
++)
2379 int colWidth
= GetColumnWidth(col
);
2381 dc
.DrawLine(x
-1, firstItemRect
.GetY() - 2, x
-1, itemRect
.GetBottom());
2388 wxListCtrl::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
2391 if ( nMsg
== WM_PRINT
)
2393 // we should bypass our own WM_PRINT handling as we don't handle
2394 // PRF_CHILDREN flag, so leave it to the native control itself
2395 return MSWDefWindowProc(nMsg
, wParam
, lParam
);
2399 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
2402 // ----------------------------------------------------------------------------
2403 // virtual list controls
2404 // ----------------------------------------------------------------------------
2406 wxString
wxListCtrl::OnGetItemText(long WXUNUSED(item
), long WXUNUSED(col
)) const
2408 // this is a pure virtual function, in fact - which is not really pure
2409 // because the controls which are not virtual don't need to implement it
2410 wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") );
2412 return wxEmptyString
;
2415 int wxListCtrl::OnGetItemImage(long WXUNUSED(item
)) const
2417 wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL
),
2419 wxT("List control has an image list, OnGetItemImage should be overridden."));
2423 wxListItemAttr
*wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item
)) const
2425 wxASSERT_MSG( item
>= 0 && item
< GetItemCount(),
2426 _T("invalid item index in OnGetItemAttr()") );
2428 // no attributes by default
2432 void wxListCtrl::SetItemCount(long count
)
2434 wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
2436 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT
, (WPARAM
)count
,
2437 LVSICF_NOSCROLL
| LVSICF_NOINVALIDATEALL
) )
2439 wxLogLastError(_T("ListView_SetItemCount"));
2442 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
2443 wxT("m_count should match ListView_GetItemCount"));
2446 void wxListCtrl::RefreshItem(long item
)
2448 // strangely enough, ListView_Update() results in much more flicker here
2449 // than a dumb Refresh() -- why?
2451 if ( !ListView_Update(GetHwnd(), item
) )
2453 wxLogLastError(_T("ListView_Update"));
2457 GetItemRect(item
, rect
);
2462 void wxListCtrl::RefreshItems(long itemFrom
, long itemTo
)
2464 wxRect rect1
, rect2
;
2465 GetItemRect(itemFrom
, rect1
);
2466 GetItemRect(itemTo
, rect2
);
2468 wxRect rect
= rect1
;
2469 rect
.height
= rect2
.GetBottom() - rect1
.GetTop();
2474 // ----------------------------------------------------------------------------
2475 // internal data stuff
2476 // ----------------------------------------------------------------------------
2478 static wxListItemInternalData
*wxGetInternalData(HWND hwnd
, long itemId
)
2481 it
.mask
= LVIF_PARAM
;
2484 if ( !ListView_GetItem(hwnd
, &it
) )
2487 return (wxListItemInternalData
*) it
.lParam
;
2491 wxListItemInternalData
*wxGetInternalData(const wxListCtrl
*ctl
, long itemId
)
2493 return wxGetInternalData(GetHwndOf(ctl
), itemId
);
2496 static wxListItemAttr
*wxGetInternalDataAttr(wxListCtrl
*ctl
, long itemId
)
2498 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2500 return data
? data
->attr
: NULL
;
2503 static void wxDeleteInternalData(wxListCtrl
* ctl
, long itemId
)
2505 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2509 memset(&item
, 0, sizeof(item
));
2510 item
.iItem
= itemId
;
2511 item
.mask
= LVIF_PARAM
;
2512 item
.lParam
= (LPARAM
) 0;
2513 ListView_SetItem((HWND
)ctl
->GetHWND(), &item
);
2518 // ----------------------------------------------------------------------------
2519 // wxWin <-> MSW items conversions
2520 // ----------------------------------------------------------------------------
2522 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
2526 wxListItemInternalData
*internaldata
=
2527 (wxListItemInternalData
*) lvItem
.lParam
;
2530 info
.m_data
= internaldata
->lParam
;
2534 info
.m_stateMask
= 0;
2535 info
.m_itemId
= lvItem
.iItem
;
2537 long oldMask
= lvItem
.mask
;
2539 bool needText
= false;
2540 if (hwndListCtrl
!= 0)
2542 if ( lvItem
.mask
& LVIF_TEXT
)
2549 lvItem
.pszText
= new wxChar
[513];
2550 lvItem
.cchTextMax
= 512;
2552 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
2553 ::SendMessage(hwndListCtrl
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
);
2556 if ( lvItem
.mask
& LVIF_STATE
)
2558 info
.m_mask
|= wxLIST_MASK_STATE
;
2560 if ( lvItem
.stateMask
& LVIS_CUT
)
2562 info
.m_stateMask
|= wxLIST_STATE_CUT
;
2563 if ( lvItem
.state
& LVIS_CUT
)
2564 info
.m_state
|= wxLIST_STATE_CUT
;
2566 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
2568 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
2569 if ( lvItem
.state
& LVIS_DROPHILITED
)
2570 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
2572 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
2574 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
2575 if ( lvItem
.state
& LVIS_FOCUSED
)
2576 info
.m_state
|= wxLIST_STATE_FOCUSED
;
2578 if ( lvItem
.stateMask
& LVIS_SELECTED
)
2580 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
2581 if ( lvItem
.state
& LVIS_SELECTED
)
2582 info
.m_state
|= wxLIST_STATE_SELECTED
;
2586 if ( lvItem
.mask
& LVIF_TEXT
)
2588 info
.m_mask
|= wxLIST_MASK_TEXT
;
2589 info
.m_text
= lvItem
.pszText
;
2591 if ( lvItem
.mask
& LVIF_IMAGE
)
2593 info
.m_mask
|= wxLIST_MASK_IMAGE
;
2594 info
.m_image
= lvItem
.iImage
;
2596 if ( lvItem
.mask
& LVIF_PARAM
)
2597 info
.m_mask
|= wxLIST_MASK_DATA
;
2598 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
2599 info
.m_mask
|= wxLIST_SET_ITEM
;
2600 info
.m_col
= lvItem
.iSubItem
;
2605 delete[] lvItem
.pszText
;
2607 lvItem
.mask
= oldMask
;
2610 static void wxConvertToMSWFlags(long state
, long stateMask
, LV_ITEM
& lvItem
)
2612 if (stateMask
& wxLIST_STATE_CUT
)
2614 lvItem
.stateMask
|= LVIS_CUT
;
2615 if (state
& wxLIST_STATE_CUT
)
2616 lvItem
.state
|= LVIS_CUT
;
2618 if (stateMask
& wxLIST_STATE_DROPHILITED
)
2620 lvItem
.stateMask
|= LVIS_DROPHILITED
;
2621 if (state
& wxLIST_STATE_DROPHILITED
)
2622 lvItem
.state
|= LVIS_DROPHILITED
;
2624 if (stateMask
& wxLIST_STATE_FOCUSED
)
2626 lvItem
.stateMask
|= LVIS_FOCUSED
;
2627 if (state
& wxLIST_STATE_FOCUSED
)
2628 lvItem
.state
|= LVIS_FOCUSED
;
2630 if (stateMask
& wxLIST_STATE_SELECTED
)
2632 lvItem
.stateMask
|= LVIS_SELECTED
;
2633 if (state
& wxLIST_STATE_SELECTED
)
2634 lvItem
.state
|= LVIS_SELECTED
;
2638 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
2639 const wxListItem
& info
,
2642 lvItem
.iItem
= (int) info
.m_itemId
;
2644 lvItem
.iImage
= info
.m_image
;
2645 lvItem
.stateMask
= 0;
2648 lvItem
.iSubItem
= info
.m_col
;
2650 if (info
.m_mask
& wxLIST_MASK_STATE
)
2652 lvItem
.mask
|= LVIF_STATE
;
2654 wxConvertToMSWFlags(info
.m_state
, info
.m_stateMask
, lvItem
);
2657 if (info
.m_mask
& wxLIST_MASK_TEXT
)
2659 lvItem
.mask
|= LVIF_TEXT
;
2660 if ( ctrl
->HasFlag(wxLC_USER_TEXT
) )
2662 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
2666 // pszText is not const, hence the cast
2667 lvItem
.pszText
= (wxChar
*)info
.m_text
.c_str();
2668 if ( lvItem
.pszText
)
2669 lvItem
.cchTextMax
= info
.m_text
.Length();
2671 lvItem
.cchTextMax
= 0;
2674 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
2675 lvItem
.mask
|= LVIF_IMAGE
;
2678 static void wxConvertToMSWListCol(int WXUNUSED(col
), const wxListItem
& item
,
2681 wxZeroMemory(lvCol
);
2683 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
2685 lvCol
.mask
|= LVCF_TEXT
;
2686 lvCol
.pszText
= (wxChar
*)item
.m_text
.c_str(); // cast is safe
2689 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
2691 lvCol
.mask
|= LVCF_FMT
;
2693 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
2694 lvCol
.fmt
= LVCFMT_LEFT
;
2695 else if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
2696 lvCol
.fmt
= LVCFMT_RIGHT
;
2697 else if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
2698 lvCol
.fmt
= LVCFMT_CENTER
;
2701 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
2703 lvCol
.mask
|= LVCF_WIDTH
;
2704 if ( item
.m_width
== wxLIST_AUTOSIZE
)
2705 lvCol
.cx
= LVSCW_AUTOSIZE
;
2706 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
2707 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
2709 lvCol
.cx
= item
.m_width
;
2712 // see comment at the end of wxListCtrl::GetColumn()
2713 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2714 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
2716 if ( wxTheApp
->GetComCtl32Version() >= 470 )
2718 lvCol
.mask
|= LVCF_IMAGE
| LVCF_FMT
;
2720 // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right
2721 // seem to be generally nicer than on the left and the generic
2722 // version only draws them on the right (we don't have a flag to
2723 // specify the image location anyhow)
2725 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
2726 // make any difference in my tests -- but maybe we should?
2727 lvCol
.fmt
|= LVCFMT_BITMAP_ON_RIGHT
| LVCFMT_IMAGE
;
2729 lvCol
.iImage
= item
.m_image
;
2731 //else: it doesn't support item images anyhow
2733 #endif // _WIN32_IE >= 0x0300
2736 #endif // wxUSE_LISTCTRL