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 // include <commctrl.h> "properly"
49 #include "wx/msw/wrapcctl.h"
51 // ----------------------------------------------------------------------------
53 // ----------------------------------------------------------------------------
55 // convert our state and mask flags to LV_ITEM constants
56 static void wxConvertToMSWFlags(long state
, long mask
, LV_ITEM
& lvItem
);
58 // convert wxListItem to LV_ITEM
59 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
60 const wxListItem
& info
, LV_ITEM
& lvItem
);
62 // convert LV_ITEM to wxListItem
63 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
65 /* const */ LV_ITEM
& lvItem
);
67 // convert our wxListItem to LV_COLUMN
68 static void wxConvertToMSWListCol(int col
, const wxListItem
& item
,
71 // ----------------------------------------------------------------------------
72 // private helper classes
73 // ----------------------------------------------------------------------------
75 // We have to handle both fooW and fooA notifications in several cases
76 // because of broken commctl.dll and/or unicows.dll. This class is used to
77 // convert LV_ITEMA and LV_ITEMW to LV_ITEM (which is either LV_ITEMA or
78 // LV_ITEMW depending on wxUSE_UNICODE setting), so that it can be processed
79 // by wxConvertToMSWListItem().
83 ~wxLV_ITEM() { delete m_buf
; }
84 operator LV_ITEM
&() const { return *m_item
; }
87 wxLV_ITEM(LV_ITEMW
&item
) : m_buf(NULL
), m_item(&item
) {}
88 wxLV_ITEM(LV_ITEMA
&item
)
90 m_item
= new LV_ITEM((LV_ITEM
&)item
);
91 if ( (item
.mask
& LVIF_TEXT
) && item
.pszText
)
93 m_buf
= new wxMB2WXbuf(wxConvLocal
.cMB2WX(item
.pszText
));
94 m_item
->pszText
= (wxChar
*)m_buf
->data();
102 #else // !wxUSE_UNICODE
103 wxLV_ITEM(LV_ITEMW
&item
)
105 m_item
= new LV_ITEM((LV_ITEM
&)item
);
107 // the code below doesn't compile without wxUSE_WCHAR_T and as I don't
108 // know if it's useful to have it at all (do we ever get Unicode
109 // notifications in ANSI mode? I don't think so...) I'm not going to
110 // write alternative implementation right now
112 // but if it is indeed used, we should simply directly use
113 // ::WideCharToMultiByte() here
115 if ( (item
.mask
& LVIF_TEXT
) && item
.pszText
)
117 m_buf
= new wxWC2WXbuf(wxConvLocal
.cWC2WX(item
.pszText
));
118 m_item
->pszText
= (wxChar
*)m_buf
->data();
121 #endif // wxUSE_WCHAR_T
124 wxLV_ITEM(LV_ITEMA
&item
) : m_buf(NULL
), m_item(&item
) {}
127 #endif // wxUSE_UNICODE/!wxUSE_UNICODE
131 DECLARE_NO_COPY_CLASS(wxLV_ITEM
)
134 ///////////////////////////////////////////////////////
136 // The MSW version had problems with SetTextColour() et
137 // al as the wxListItemAttr's were stored keyed on the
138 // item index. If a item was inserted anywhere but the end
139 // of the list the the text attributes (colour etc) for
140 // the following items were out of sync.
143 // Under MSW the only way to associate data with a List
144 // item independant of its position in the list is to
145 // store a pointer to it in its lParam attribute. However
146 // user programs are already using this (via the
147 // SetItemData() GetItemData() calls).
149 // However what we can do is store a pointer to a
150 // structure which contains the attributes we want *and*
151 // a lParam for the users data, e.g.
153 // class wxListItemInternalData
156 // wxListItemAttr *attr;
157 // long lParam; // user data
160 // To conserve memory, a wxListItemInternalData is
161 // only allocated for a LV_ITEM if text attributes or
162 // user data(lparam) are being set.
165 // class wxListItemInternalData
166 class wxListItemInternalData
169 wxListItemAttr
*attr
;
170 LPARAM lParam
; // user data
172 wxListItemInternalData() : attr(NULL
), lParam(0) {}
173 ~wxListItemInternalData()
179 DECLARE_NO_COPY_CLASS(wxListItemInternalData
)
182 // Get the internal data structure
183 static wxListItemInternalData
*wxGetInternalData(HWND hwnd
, long itemId
);
184 static wxListItemInternalData
*wxGetInternalData(wxListCtrl
*ctl
, long itemId
);
185 static wxListItemAttr
*wxGetInternalDataAttr(wxListCtrl
*ctl
, long itemId
);
186 static void wxDeleteInternalData(wxListCtrl
* ctl
, long itemId
);
189 // ----------------------------------------------------------------------------
191 // ----------------------------------------------------------------------------
193 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG
)
194 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG
)
195 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
)
196 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT
)
197 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM
)
198 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
)
199 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO
)
200 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO
)
201 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED
)
202 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED
)
203 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN
)
204 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM
)
205 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK
)
206 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
)
207 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
)
208 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING
)
209 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG
)
210 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
)
211 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK
)
212 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED
)
213 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED
)
214 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT
)
216 #if wxUSE_EXTENDED_RTTI
217 WX_DEFINE_FLAGS( wxListCtrlStyle
)
219 wxBEGIN_FLAGS( wxListCtrlStyle
)
220 // new style border flags, we put them first to
221 // use them for streaming out
222 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
223 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
224 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
225 wxFLAGS_MEMBER(wxBORDER_RAISED
)
226 wxFLAGS_MEMBER(wxBORDER_STATIC
)
227 wxFLAGS_MEMBER(wxBORDER_NONE
)
229 // old style border flags
230 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
231 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
232 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
233 wxFLAGS_MEMBER(wxRAISED_BORDER
)
234 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
235 wxFLAGS_MEMBER(wxNO_BORDER
)
237 // standard window styles
238 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
239 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
240 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
241 wxFLAGS_MEMBER(wxWANTS_CHARS
)
242 wxFLAGS_MEMBER(wxNO_FULL_REPAINT_ON_RESIZE
)
243 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
244 wxFLAGS_MEMBER(wxVSCROLL
)
245 wxFLAGS_MEMBER(wxHSCROLL
)
247 wxFLAGS_MEMBER(wxLC_LIST
)
248 wxFLAGS_MEMBER(wxLC_REPORT
)
249 wxFLAGS_MEMBER(wxLC_ICON
)
250 wxFLAGS_MEMBER(wxLC_SMALL_ICON
)
251 wxFLAGS_MEMBER(wxLC_ALIGN_TOP
)
252 wxFLAGS_MEMBER(wxLC_ALIGN_LEFT
)
253 wxFLAGS_MEMBER(wxLC_AUTOARRANGE
)
254 wxFLAGS_MEMBER(wxLC_USER_TEXT
)
255 wxFLAGS_MEMBER(wxLC_EDIT_LABELS
)
256 wxFLAGS_MEMBER(wxLC_NO_HEADER
)
257 wxFLAGS_MEMBER(wxLC_SINGLE_SEL
)
258 wxFLAGS_MEMBER(wxLC_SORT_ASCENDING
)
259 wxFLAGS_MEMBER(wxLC_SORT_DESCENDING
)
260 wxFLAGS_MEMBER(wxLC_VIRTUAL
)
262 wxEND_FLAGS( wxListCtrlStyle
)
264 IMPLEMENT_DYNAMIC_CLASS_XTI(wxListCtrl
, wxControl
,"wx/listctrl.h")
266 wxBEGIN_PROPERTIES_TABLE(wxListCtrl
)
267 wxEVENT_PROPERTY( TextUpdated
, wxEVT_COMMAND_TEXT_UPDATED
, wxCommandEvent
)
269 wxPROPERTY_FLAGS( WindowStyle
, wxListCtrlStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
270 wxEND_PROPERTIES_TABLE()
272 wxBEGIN_HANDLERS_TABLE(wxListCtrl
)
273 wxEND_HANDLERS_TABLE()
275 wxCONSTRUCTOR_5( wxListCtrl
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
, long , WindowStyle
)
278 TODO : Expose more information of a list's layout etc. via appropriate objects (Ã la NotebookPageInfo)
281 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl
, wxControl
)
284 IMPLEMENT_DYNAMIC_CLASS(wxListView
, wxListCtrl
)
285 IMPLEMENT_DYNAMIC_CLASS(wxListItem
, wxObject
)
287 IMPLEMENT_DYNAMIC_CLASS(wxListEvent
, wxNotifyEvent
)
289 BEGIN_EVENT_TABLE(wxListCtrl
, wxControl
)
290 EVT_PAINT(wxListCtrl::OnPaint
)
293 // ============================================================================
295 // ============================================================================
297 // ----------------------------------------------------------------------------
298 // wxListCtrl construction
299 // ----------------------------------------------------------------------------
301 void wxListCtrl::Init()
303 m_imageListNormal
= NULL
;
304 m_imageListSmall
= NULL
;
305 m_imageListState
= NULL
;
306 m_ownsImageListNormal
= m_ownsImageListSmall
= m_ownsImageListState
= FALSE
;
310 m_ignoreChangeMessages
= FALSE
;
312 m_AnyInternalData
= FALSE
;
313 m_hasAnyAttr
= FALSE
;
316 bool wxListCtrl::Create(wxWindow
*parent
,
321 const wxValidator
& validator
,
322 const wxString
& name
)
325 SetValidator(validator
);
326 #endif // wxUSE_VALIDATORS
335 m_windowStyle
= style
;
348 m_windowId
= (id
== -1) ? NewControlId() : id
;
350 DWORD wstyle
= WS_VISIBLE
| WS_CHILD
| WS_TABSTOP
|
351 LVS_SHAREIMAGELISTS
| LVS_SHOWSELALWAYS
;
353 m_baseStyle
= wstyle
;
355 if ( !DoCreateControl(x
, y
, width
, height
) )
359 parent
->AddChild(this);
364 bool wxListCtrl::DoCreateControl(int x
, int y
, int w
, int h
)
366 DWORD wstyle
= m_baseStyle
;
369 WXDWORD standardStyle
= MSWGetStyle(GetWindowStyle(), & exStyle
) ;
371 long oldStyle
= 0; // Dummy
372 wstyle
|= ConvertToMSWStyle(oldStyle
, m_windowStyle
);
373 wstyle
|= standardStyle
;
375 // Create the ListView control.
376 m_hWnd
= (WXHWND
)CreateWindowEx(exStyle
,
381 GetWinHwnd(GetParent()),
388 wxLogError(_("Can't create list control window, check that comctl32.dll is installed."));
393 // explicitly say that we want to use Unicode because otherwise we get ANSI
394 // versions of _some_ messages (notably LVN_GETDISPINFOA) in MSLU build
396 ::SendMessage(GetHwnd(), LVM_SETUNICODEFORMAT
, TRUE
, 0);
399 // for comctl32.dll v 4.70+ we want to have this attribute because it's
400 // prettier (and also because wxGTK does it like this)
401 if ( (wstyle
& LVS_REPORT
) && wxTheApp
->GetComCtl32Version() >= 470 )
403 ::SendMessage(GetHwnd(), LVM_SETEXTENDEDLISTVIEWSTYLE
,
404 0, LVS_EX_FULLROWSELECT
);
407 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
));
408 SetForegroundColour(GetParent()->GetForegroundColour());
415 void wxListCtrl::UpdateStyle()
419 // The new window view style
421 DWORD dwStyleNew
= ConvertToMSWStyle(dummy
, m_windowStyle
);
422 dwStyleNew
|= m_baseStyle
;
424 // Get the current window style.
425 DWORD dwStyleOld
= ::GetWindowLong(GetHwnd(), GWL_STYLE
);
427 // Only set the window style if the view bits have changed.
428 if ( dwStyleOld
!= dwStyleNew
)
430 ::SetWindowLong(GetHwnd(), GWL_STYLE
, dwStyleNew
);
435 void wxListCtrl::FreeAllInternalData()
437 if (m_AnyInternalData
)
439 int n
= GetItemCount();
442 m_ignoreChangeMessages
= TRUE
;
443 for (i
= 0; i
< n
; i
++)
444 wxDeleteInternalData(this, i
);
445 m_ignoreChangeMessages
= FALSE
;
447 m_AnyInternalData
= FALSE
;
451 wxListCtrl::~wxListCtrl()
453 FreeAllInternalData();
457 m_textCtrl
->UnsubclassWin();
458 m_textCtrl
->SetHWND(0);
463 if (m_ownsImageListNormal
) delete m_imageListNormal
;
464 if (m_ownsImageListSmall
) delete m_imageListSmall
;
465 if (m_ownsImageListState
) delete m_imageListState
;
468 // ----------------------------------------------------------------------------
469 // set/get/change style
470 // ----------------------------------------------------------------------------
472 // Add or remove a single window style
473 void wxListCtrl::SetSingleStyle(long style
, bool add
)
475 long flag
= GetWindowStyleFlag();
477 // Get rid of conflicting styles
480 if ( style
& wxLC_MASK_TYPE
)
481 flag
= flag
& ~wxLC_MASK_TYPE
;
482 if ( style
& wxLC_MASK_ALIGN
)
483 flag
= flag
& ~wxLC_MASK_ALIGN
;
484 if ( style
& wxLC_MASK_SORT
)
485 flag
= flag
& ~wxLC_MASK_SORT
;
501 m_windowStyle
= flag
;
506 // Set the whole window style
507 void wxListCtrl::SetWindowStyleFlag(long flag
)
509 m_windowStyle
= flag
;
514 // Can be just a single style, or a bitlist
515 long wxListCtrl::ConvertToMSWStyle(long& oldStyle
, long style
) const
518 if ( style
& wxLC_ICON
)
520 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
521 oldStyle
-= LVS_SMALLICON
;
522 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
523 oldStyle
-= LVS_REPORT
;
524 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
525 oldStyle
-= LVS_LIST
;
529 if ( style
& wxLC_SMALL_ICON
)
531 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
532 oldStyle
-= LVS_ICON
;
533 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
534 oldStyle
-= LVS_REPORT
;
535 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
536 oldStyle
-= LVS_LIST
;
537 wstyle
|= LVS_SMALLICON
;
540 if ( style
& wxLC_LIST
)
542 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
543 oldStyle
-= LVS_ICON
;
544 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
545 oldStyle
-= LVS_REPORT
;
546 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
547 oldStyle
-= LVS_SMALLICON
;
551 if ( style
& wxLC_REPORT
)
553 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
554 oldStyle
-= LVS_ICON
;
555 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
556 oldStyle
-= LVS_LIST
;
557 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
558 oldStyle
-= LVS_SMALLICON
;
560 wstyle
|= LVS_REPORT
;
563 if ( style
& wxLC_ALIGN_LEFT
)
565 if ( oldStyle
& LVS_ALIGNTOP
)
566 oldStyle
-= LVS_ALIGNTOP
;
567 wstyle
|= LVS_ALIGNLEFT
;
570 if ( style
& wxLC_ALIGN_TOP
)
572 if ( oldStyle
& LVS_ALIGNLEFT
)
573 oldStyle
-= LVS_ALIGNLEFT
;
574 wstyle
|= LVS_ALIGNTOP
;
577 if ( style
& wxLC_AUTOARRANGE
)
578 wstyle
|= LVS_AUTOARRANGE
;
580 if ( style
& wxLC_NO_SORT_HEADER
)
581 wstyle
|= LVS_NOSORTHEADER
;
583 if ( style
& wxLC_NO_HEADER
)
584 wstyle
|= LVS_NOCOLUMNHEADER
;
586 if ( style
& wxLC_EDIT_LABELS
)
587 wstyle
|= LVS_EDITLABELS
;
589 if ( style
& wxLC_SINGLE_SEL
)
590 wstyle
|= LVS_SINGLESEL
;
592 if ( style
& wxLC_SORT_ASCENDING
)
594 if ( oldStyle
& LVS_SORTDESCENDING
)
595 oldStyle
-= LVS_SORTDESCENDING
;
596 wstyle
|= LVS_SORTASCENDING
;
599 if ( style
& wxLC_SORT_DESCENDING
)
601 if ( oldStyle
& LVS_SORTASCENDING
)
602 oldStyle
-= LVS_SORTASCENDING
;
603 wstyle
|= LVS_SORTDESCENDING
;
606 #if !( defined(__GNUWIN32__) && !wxCHECK_W32API_VERSION( 1, 0 ) )
607 if ( style
& wxLC_VIRTUAL
)
609 int ver
= wxTheApp
->GetComCtl32Version();
612 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."),
613 ver
/ 100, ver
% 100);
616 wstyle
|= LVS_OWNERDATA
;
623 // ----------------------------------------------------------------------------
625 // ----------------------------------------------------------------------------
627 // Sets the foreground, i.e. text, colour
628 bool wxListCtrl::SetForegroundColour(const wxColour
& col
)
630 if ( !wxWindow::SetForegroundColour(col
) )
633 ListView_SetTextColor(GetHwnd(), wxColourToRGB(col
));
638 // Sets the background colour
639 bool wxListCtrl::SetBackgroundColour(const wxColour
& col
)
641 if ( !wxWindow::SetBackgroundColour(col
) )
644 // we set the same colour for both the "empty" background and the items
646 COLORREF color
= wxColourToRGB(col
);
647 ListView_SetBkColor(GetHwnd(), color
);
648 ListView_SetTextBkColor(GetHwnd(), color
);
653 // Gets information about this column
654 bool wxListCtrl::GetColumn(int col
, wxListItem
& item
) const
659 lvCol
.mask
= LVCF_WIDTH
;
661 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
663 lvCol
.mask
|= LVCF_TEXT
;
664 lvCol
.pszText
= new wxChar
[513];
665 lvCol
.cchTextMax
= 512;
668 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
670 lvCol
.mask
|= LVCF_FMT
;
673 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
675 lvCol
.mask
|= LVCF_IMAGE
;
678 bool success
= ListView_GetColumn(GetHwnd(), col
, &lvCol
) != 0;
680 // item.m_subItem = lvCol.iSubItem;
681 item
.m_width
= lvCol
.cx
;
683 if ( (item
.m_mask
& wxLIST_MASK_TEXT
) && lvCol
.pszText
)
685 item
.m_text
= lvCol
.pszText
;
686 delete[] lvCol
.pszText
;
689 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
691 switch (lvCol
.fmt
& LVCFMT_JUSTIFYMASK
) {
693 item
.m_format
= wxLIST_FORMAT_LEFT
;
696 item
.m_format
= wxLIST_FORMAT_RIGHT
;
699 item
.m_format
= wxLIST_FORMAT_CENTRE
;
702 item
.m_format
= -1; // Unknown?
707 // the column images were not supported in older versions but how to check
708 // for this? we can't use _WIN32_IE because we always define it to a very
709 // high value, so see if another symbol which is only defined starting from
710 // comctl32.dll 4.70 is available
711 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
712 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
714 item
.m_image
= lvCol
.iImage
;
716 #endif // LVCOLUMN::iImage exists
721 // Sets information about this column
722 bool wxListCtrl::SetColumn(int col
, wxListItem
& item
)
725 wxConvertToMSWListCol(col
, item
, lvCol
);
727 return ListView_SetColumn(GetHwnd(), col
, &lvCol
) != 0;
730 // Gets the column width
731 int wxListCtrl::GetColumnWidth(int col
) const
733 return ListView_GetColumnWidth(GetHwnd(), col
);
736 // Sets the column width
737 bool wxListCtrl::SetColumnWidth(int col
, int width
)
740 if ( m_windowStyle
& wxLC_LIST
)
744 if ( width2
== wxLIST_AUTOSIZE
)
745 width2
= LVSCW_AUTOSIZE
;
746 else if ( width2
== wxLIST_AUTOSIZE_USEHEADER
)
747 width2
= LVSCW_AUTOSIZE_USEHEADER
;
749 return ListView_SetColumnWidth(GetHwnd(), col2
, width2
) != 0;
752 // Gets the number of items that can fit vertically in the
753 // visible area of the list control (list or report view)
754 // or the total number of items in the list control (icon
755 // or small icon view)
756 int wxListCtrl::GetCountPerPage() const
758 return ListView_GetCountPerPage(GetHwnd());
761 // Gets the edit control for editing labels.
762 wxTextCtrl
* wxListCtrl::GetEditControl() const
767 // Gets information about the item
768 bool wxListCtrl::GetItem(wxListItem
& info
) const
771 wxZeroMemory(lvItem
);
773 lvItem
.iItem
= info
.m_itemId
;
774 lvItem
.iSubItem
= info
.m_col
;
776 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
778 lvItem
.mask
|= LVIF_TEXT
;
779 lvItem
.pszText
= new wxChar
[513];
780 lvItem
.cchTextMax
= 512;
784 lvItem
.pszText
= NULL
;
787 if (info
.m_mask
& wxLIST_MASK_DATA
)
788 lvItem
.mask
|= LVIF_PARAM
;
790 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
791 lvItem
.mask
|= LVIF_IMAGE
;
793 if ( info
.m_mask
& wxLIST_MASK_STATE
)
795 lvItem
.mask
|= LVIF_STATE
;
796 // the other bits are hardly interesting anyhow
797 lvItem
.stateMask
= LVIS_SELECTED
| LVIS_FOCUSED
;
800 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
803 wxLogError(_("Couldn't retrieve information about list control item %d."),
808 // give NULL as hwnd as we already have everything we need
809 wxConvertFromMSWListItem(NULL
, info
, lvItem
);
813 delete[] lvItem
.pszText
;
818 // Sets information about the item
819 bool wxListCtrl::SetItem(wxListItem
& info
)
822 wxConvertToMSWListItem(this, info
, item
);
824 // we never update the lParam if it contains our pointer
825 // to the wxListItemInternalData structure
826 item
.mask
&= ~LVIF_PARAM
;
828 // check if setting attributes or lParam
829 if (info
.HasAttributes() || (info
.m_mask
& wxLIST_MASK_DATA
))
831 // get internal item data
832 // perhaps a cache here ?
833 wxListItemInternalData
*data
= wxGetInternalData(this, info
.m_itemId
);
838 m_AnyInternalData
= TRUE
;
839 data
= new wxListItemInternalData();
840 item
.lParam
= (LPARAM
) data
;
841 item
.mask
|= LVIF_PARAM
;
846 if (info
.m_mask
& wxLIST_MASK_DATA
)
847 data
->lParam
= info
.m_data
;
850 if (info
.HasAttributes())
853 *data
->attr
= *info
.GetAttributes();
855 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
860 // we could be changing only the attribute in which case we don't need to
861 // call ListView_SetItem() at all
865 if ( !ListView_SetItem(GetHwnd(), &item
) )
867 wxLogDebug(_T("ListView_SetItem() failed"));
873 // we need to update the item immediately to show the new image
874 bool updateNow
= (info
.m_mask
& wxLIST_MASK_IMAGE
) != 0;
876 // check whether it has any custom attributes
877 if ( info
.HasAttributes() )
881 // if the colour has changed, we must redraw the item
887 // we need this to make the change visible right now
888 RefreshItem(item
.iItem
);
894 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
898 info
.m_mask
= wxLIST_MASK_TEXT
;
899 info
.m_itemId
= index
;
903 info
.m_image
= imageId
;
904 info
.m_mask
|= wxLIST_MASK_IMAGE
;
906 return SetItem(info
);
910 // Gets the item state
911 int wxListCtrl::GetItemState(long item
, long stateMask
) const
915 info
.m_mask
= wxLIST_MASK_STATE
;
916 info
.m_stateMask
= stateMask
;
917 info
.m_itemId
= item
;
925 // Sets the item state
926 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
928 // NB: don't use SetItem() here as it doesn't work with the virtual list
931 wxZeroMemory(lvItem
);
933 wxConvertToMSWFlags(state
, stateMask
, lvItem
);
935 // for the virtual list controls we need to refresh the previously focused
936 // item manually when changing focus without changing selection
937 // programmatically because otherwise it keeps its focus rectangle until
938 // next repaint (yet another comctl32 bug)
941 (stateMask
& wxLIST_STATE_FOCUSED
) &&
942 (state
& wxLIST_STATE_FOCUSED
) )
944 focusOld
= GetNextItem(-1, wxLIST_NEXT_ALL
, wxLIST_STATE_FOCUSED
);
951 if ( !::SendMessage(GetHwnd(), LVM_SETITEMSTATE
,
952 (WPARAM
)item
, (LPARAM
)&lvItem
) )
954 wxLogLastError(_T("ListView_SetItemState"));
959 if ( focusOld
!= -1 )
961 // no need to refresh the item if it was previously selected, it would
962 // only result in annoying flicker
963 if ( !(GetItemState(focusOld
,
964 wxLIST_STATE_SELECTED
) & wxLIST_STATE_SELECTED
) )
966 RefreshItem(focusOld
);
973 // Sets the item image
974 bool wxListCtrl::SetItemImage(long item
, int image
, int WXUNUSED(selImage
))
978 info
.m_mask
= wxLIST_MASK_IMAGE
;
979 info
.m_image
= image
;
980 info
.m_itemId
= item
;
982 return SetItem(info
);
985 // Gets the item text
986 wxString
wxListCtrl::GetItemText(long item
) const
990 info
.m_mask
= wxLIST_MASK_TEXT
;
991 info
.m_itemId
= item
;
994 return wxEmptyString
;
998 // Sets the item text
999 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
1003 info
.m_mask
= wxLIST_MASK_TEXT
;
1004 info
.m_itemId
= item
;
1010 // Gets the item data
1011 long wxListCtrl::GetItemData(long item
) const
1015 info
.m_mask
= wxLIST_MASK_DATA
;
1016 info
.m_itemId
= item
;
1023 // Sets the item data
1024 bool wxListCtrl::SetItemData(long item
, long data
)
1028 info
.m_mask
= wxLIST_MASK_DATA
;
1029 info
.m_itemId
= item
;
1032 return SetItem(info
);
1035 // Gets the item rectangle
1036 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
1041 if ( code
== wxLIST_RECT_BOUNDS
)
1042 codeWin
= LVIR_BOUNDS
;
1043 else if ( code
== wxLIST_RECT_ICON
)
1044 codeWin
= LVIR_ICON
;
1045 else if ( code
== wxLIST_RECT_LABEL
)
1046 codeWin
= LVIR_LABEL
;
1049 wxFAIL_MSG( _T("incorrect code in GetItemRect()") );
1051 codeWin
= LVIR_BOUNDS
;
1054 bool success
= ListView_GetItemRect(GetHwnd(), (int) item
, &rectWin
, codeWin
) != 0;
1056 rect
.x
= rectWin
.left
;
1057 rect
.y
= rectWin
.top
;
1058 rect
.width
= rectWin
.right
- rectWin
.left
;
1059 rect
.height
= rectWin
.bottom
- rectWin
.top
;
1064 // Gets the item position
1065 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
1069 bool success
= (ListView_GetItemPosition(GetHwnd(), (int) item
, &pt
) != 0);
1071 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
1075 // Sets the item position.
1076 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
1078 return (ListView_SetItemPosition(GetHwnd(), (int) item
, pos
.x
, pos
.y
) != 0);
1081 // Gets the number of items in the list control
1082 int wxListCtrl::GetItemCount() const
1087 // Retrieves the spacing between icons in pixels.
1088 // If small is TRUE, gets the spacing for the small icon
1089 // view, otherwise the large icon view.
1090 int wxListCtrl::GetItemSpacing(bool isSmall
) const
1092 return ListView_GetItemSpacing(GetHwnd(), (BOOL
) isSmall
);
1095 void wxListCtrl::SetItemTextColour( long item
, const wxColour
&col
)
1098 info
.m_itemId
= item
;
1099 info
.SetTextColour( col
);
1103 wxColour
wxListCtrl::GetItemTextColour( long item
) const
1106 info
.m_itemId
= item
;
1108 return info
.GetTextColour();
1111 void wxListCtrl::SetItemBackgroundColour( long item
, const wxColour
&col
)
1114 info
.m_itemId
= item
;
1115 info
.SetBackgroundColour( col
);
1119 wxColour
wxListCtrl::GetItemBackgroundColour( long item
) const
1122 info
.m_itemId
= item
;
1124 return info
.GetBackgroundColour();
1127 // Gets the number of selected items in the list control
1128 int wxListCtrl::GetSelectedItemCount() const
1130 return ListView_GetSelectedCount(GetHwnd());
1133 // Gets the text colour of the listview
1134 wxColour
wxListCtrl::GetTextColour() const
1136 COLORREF ref
= ListView_GetTextColor(GetHwnd());
1137 wxColour
col(GetRValue(ref
), GetGValue(ref
), GetBValue(ref
));
1141 // Sets the text colour of the listview
1142 void wxListCtrl::SetTextColour(const wxColour
& col
)
1144 ListView_SetTextColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
1147 // Gets the index of the topmost visible item when in
1148 // list or report view
1149 long wxListCtrl::GetTopItem() const
1151 return (long) ListView_GetTopIndex(GetHwnd());
1154 // Searches for an item, starting from 'item'.
1155 // 'geometry' is one of
1156 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
1157 // 'state' is a state bit flag, one or more of
1158 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
1159 // item can be -1 to find the first item that matches the
1161 // Returns the item or -1 if unsuccessful.
1162 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
1166 if ( geom
== wxLIST_NEXT_ABOVE
)
1167 flags
|= LVNI_ABOVE
;
1168 if ( geom
== wxLIST_NEXT_ALL
)
1170 if ( geom
== wxLIST_NEXT_BELOW
)
1171 flags
|= LVNI_BELOW
;
1172 if ( geom
== wxLIST_NEXT_LEFT
)
1173 flags
|= LVNI_TOLEFT
;
1174 if ( geom
== wxLIST_NEXT_RIGHT
)
1175 flags
|= LVNI_TORIGHT
;
1177 if ( state
& wxLIST_STATE_CUT
)
1179 if ( state
& wxLIST_STATE_DROPHILITED
)
1180 flags
|= LVNI_DROPHILITED
;
1181 if ( state
& wxLIST_STATE_FOCUSED
)
1182 flags
|= LVNI_FOCUSED
;
1183 if ( state
& wxLIST_STATE_SELECTED
)
1184 flags
|= LVNI_SELECTED
;
1186 return (long) ListView_GetNextItem(GetHwnd(), item
, flags
);
1190 wxImageList
*wxListCtrl::GetImageList(int which
) const
1192 if ( which
== wxIMAGE_LIST_NORMAL
)
1194 return m_imageListNormal
;
1196 else if ( which
== wxIMAGE_LIST_SMALL
)
1198 return m_imageListSmall
;
1200 else if ( which
== wxIMAGE_LIST_STATE
)
1202 return m_imageListState
;
1207 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
1210 if ( which
== wxIMAGE_LIST_NORMAL
)
1212 flags
= LVSIL_NORMAL
;
1213 if (m_ownsImageListNormal
) delete m_imageListNormal
;
1214 m_imageListNormal
= imageList
;
1215 m_ownsImageListNormal
= FALSE
;
1217 else if ( which
== wxIMAGE_LIST_SMALL
)
1219 flags
= LVSIL_SMALL
;
1220 if (m_ownsImageListSmall
) delete m_imageListSmall
;
1221 m_imageListSmall
= imageList
;
1222 m_ownsImageListSmall
= FALSE
;
1224 else if ( which
== wxIMAGE_LIST_STATE
)
1226 flags
= LVSIL_STATE
;
1227 if (m_ownsImageListState
) delete m_imageListState
;
1228 m_imageListState
= imageList
;
1229 m_ownsImageListState
= FALSE
;
1231 ListView_SetImageList(GetHwnd(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
1234 void wxListCtrl::AssignImageList(wxImageList
*imageList
, int which
)
1236 SetImageList(imageList
, which
);
1237 if ( which
== wxIMAGE_LIST_NORMAL
)
1238 m_ownsImageListNormal
= TRUE
;
1239 else if ( which
== wxIMAGE_LIST_SMALL
)
1240 m_ownsImageListSmall
= TRUE
;
1241 else if ( which
== wxIMAGE_LIST_STATE
)
1242 m_ownsImageListState
= TRUE
;
1245 // ----------------------------------------------------------------------------
1247 // ----------------------------------------------------------------------------
1249 // Arranges the items
1250 bool wxListCtrl::Arrange(int flag
)
1253 if ( flag
== wxLIST_ALIGN_LEFT
)
1254 code
= LVA_ALIGNLEFT
;
1255 else if ( flag
== wxLIST_ALIGN_TOP
)
1256 code
= LVA_ALIGNTOP
;
1257 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
1259 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
1260 code
= LVA_SNAPTOGRID
;
1262 return (ListView_Arrange(GetHwnd(), code
) != 0);
1266 bool wxListCtrl::DeleteItem(long item
)
1268 if ( !ListView_DeleteItem(GetHwnd(), (int) item
) )
1270 wxLogLastError(_T("ListView_DeleteItem"));
1275 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1276 wxT("m_count should match ListView_GetItemCount"));
1278 // the virtual list control doesn't refresh itself correctly, help it
1281 // we need to refresh all the lines below the one which was deleted
1283 if ( item
> 0 && GetItemCount() )
1285 GetItemRect(item
- 1, rectItem
);
1290 rectItem
.height
= 0;
1293 wxRect rectWin
= GetRect();
1294 rectWin
.height
= rectWin
.GetBottom() - rectItem
.GetBottom();
1295 rectWin
.y
= rectItem
.GetBottom();
1297 RefreshRect(rectWin
);
1303 // Deletes all items
1304 bool wxListCtrl::DeleteAllItems()
1306 FreeAllInternalData();
1307 return ListView_DeleteAllItems(GetHwnd()) != 0;
1310 // Deletes all items
1311 bool wxListCtrl::DeleteAllColumns()
1313 while ( m_colCount
> 0 )
1315 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
1317 wxLogLastError(wxT("ListView_DeleteColumn"));
1325 wxASSERT_MSG( m_colCount
== 0, wxT("no columns should be left") );
1331 bool wxListCtrl::DeleteColumn(int col
)
1333 bool success
= (ListView_DeleteColumn(GetHwnd(), col
) != 0);
1335 if ( success
&& (m_colCount
> 0) )
1340 // Clears items, and columns if there are any.
1341 void wxListCtrl::ClearAll()
1344 if ( m_colCount
> 0 )
1348 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
1350 wxASSERT( (textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
))) );
1352 // ListView_EditLabel requires that the list has focus.
1355 WXHWND hWnd
= (WXHWND
) ListView_EditLabel(GetHwnd(), item
);
1358 // failed to start editing
1362 // [re]create the text control wrapping the HWND we got
1365 m_textCtrl
->UnsubclassWin();
1366 m_textCtrl
->SetHWND(0);
1370 m_textCtrl
= (wxTextCtrl
*)textControlClass
->CreateObject();
1371 m_textCtrl
->SetHWND(hWnd
);
1372 m_textCtrl
->SubclassWin(hWnd
);
1373 m_textCtrl
->SetParent(this);
1375 // we must disallow TABbing away from the control while the edit contol is
1376 // shown because this leaves it in some strange state (just try removing
1377 // this line and then pressing TAB while editing an item in listctrl
1379 m_textCtrl
->SetWindowStyle(m_textCtrl
->GetWindowStyle() | wxTE_PROCESS_TAB
);
1384 // End label editing, optionally cancelling the edit
1385 bool wxListCtrl::EndEditLabel(bool WXUNUSED(cancel
))
1387 wxFAIL_MSG( _T("not implemented") );
1392 // Ensures this item is visible
1393 bool wxListCtrl::EnsureVisible(long item
)
1395 return ListView_EnsureVisible(GetHwnd(), (int) item
, FALSE
) != 0;
1398 // Find an item whose label matches this string, starting from the item after 'start'
1399 // or the beginning if 'start' is -1.
1400 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
1402 LV_FINDINFO findInfo
;
1404 findInfo
.flags
= LVFI_STRING
;
1406 findInfo
.flags
|= LVFI_PARTIAL
;
1409 // ListView_FindItem() excludes the first item from search and to look
1410 // through all the items you need to start from -1 which is unnatural and
1411 // inconsistent with the generic version - so we adjust the index
1414 return ListView_FindItem(GetHwnd(), (int) start
, &findInfo
);
1417 // Find an item whose data matches this data, starting from the item after 'start'
1418 // or the beginning if 'start' is -1.
1419 // NOTE : Lindsay Mathieson - 14-July-2002
1420 // No longer use ListView_FindItem as the data attribute is now stored
1421 // in a wxListItemInternalData structure refernced by the actual lParam
1422 long wxListCtrl::FindItem(long start
, long data
)
1424 long idx
= start
+ 1;
1425 long count
= GetItemCount();
1429 if (GetItemData(idx
) == data
)
1437 // Find an item nearest this position in the specified direction, starting from
1438 // the item after 'start' or the beginning if 'start' is -1.
1439 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
1441 LV_FINDINFO findInfo
;
1443 findInfo
.flags
= LVFI_NEARESTXY
;
1444 findInfo
.pt
.x
= pt
.x
;
1445 findInfo
.pt
.y
= pt
.y
;
1446 findInfo
.vkDirection
= VK_RIGHT
;
1448 if ( direction
== wxLIST_FIND_UP
)
1449 findInfo
.vkDirection
= VK_UP
;
1450 else if ( direction
== wxLIST_FIND_DOWN
)
1451 findInfo
.vkDirection
= VK_DOWN
;
1452 else if ( direction
== wxLIST_FIND_LEFT
)
1453 findInfo
.vkDirection
= VK_LEFT
;
1454 else if ( direction
== wxLIST_FIND_RIGHT
)
1455 findInfo
.vkDirection
= VK_RIGHT
;
1457 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
1460 // Determines which item (if any) is at the specified point,
1461 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
1462 long wxListCtrl::HitTest(const wxPoint
& point
, int& flags
)
1464 LV_HITTESTINFO hitTestInfo
;
1465 hitTestInfo
.pt
.x
= (int) point
.x
;
1466 hitTestInfo
.pt
.y
= (int) point
.y
;
1468 ListView_HitTest(GetHwnd(), & hitTestInfo
);
1471 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
1472 flags
|= wxLIST_HITTEST_ABOVE
;
1473 if ( hitTestInfo
.flags
& LVHT_BELOW
)
1474 flags
|= wxLIST_HITTEST_BELOW
;
1475 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
1476 flags
|= wxLIST_HITTEST_NOWHERE
;
1477 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
1478 flags
|= wxLIST_HITTEST_ONITEMICON
;
1479 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
1480 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
1481 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
1482 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
1483 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
1484 flags
|= wxLIST_HITTEST_TOLEFT
;
1485 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
1486 flags
|= wxLIST_HITTEST_TORIGHT
;
1488 return (long) hitTestInfo
.iItem
;
1491 // Inserts an item, returning the index of the new item if successful,
1493 long wxListCtrl::InsertItem(wxListItem
& info
)
1495 wxASSERT_MSG( !IsVirtual(), _T("can't be used with virtual controls") );
1498 wxConvertToMSWListItem(this, info
, item
);
1499 item
.mask
&= ~LVIF_PARAM
;
1501 // check wether we need to allocate our internal data
1502 bool needInternalData
= ((info
.m_mask
& wxLIST_MASK_DATA
) || info
.HasAttributes());
1503 if (needInternalData
)
1505 m_AnyInternalData
= TRUE
;
1506 item
.mask
|= LVIF_PARAM
;
1508 // internal stucture that manages data
1509 wxListItemInternalData
*data
= new wxListItemInternalData();
1510 item
.lParam
= (LPARAM
) data
;
1512 if (info
.m_mask
& wxLIST_MASK_DATA
)
1513 data
->lParam
= info
.m_data
;
1515 // check whether it has any custom attributes
1516 if ( info
.HasAttributes() )
1518 // take copy of attributes
1519 data
->attr
= new wxListItemAttr(*info
.GetAttributes());
1523 long rv
= ListView_InsertItem(GetHwnd(), & item
);
1526 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
1527 wxT("m_count should match ListView_GetItemCount"));
1532 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1535 info
.m_text
= label
;
1536 info
.m_mask
= wxLIST_MASK_TEXT
;
1537 info
.m_itemId
= index
;
1538 return InsertItem(info
);
1541 // Inserts an image item
1542 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1545 info
.m_image
= imageIndex
;
1546 info
.m_mask
= wxLIST_MASK_IMAGE
;
1547 info
.m_itemId
= index
;
1548 return InsertItem(info
);
1551 // Inserts an image/string item
1552 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1555 info
.m_image
= imageIndex
;
1556 info
.m_text
= label
;
1557 info
.m_mask
= wxLIST_MASK_IMAGE
| wxLIST_MASK_TEXT
;
1558 info
.m_itemId
= index
;
1559 return InsertItem(info
);
1562 // For list view mode (only), inserts a column.
1563 long wxListCtrl::InsertColumn(long col
, wxListItem
& item
)
1566 wxConvertToMSWListCol(col
, item
, lvCol
);
1568 if ( !(lvCol
.mask
& LVCF_WIDTH
) )
1570 // always give some width to the new column: this one is compatible
1571 // with the generic version
1572 lvCol
.mask
|= LVCF_WIDTH
;
1576 long n
= ListView_InsertColumn(GetHwnd(), col
, &lvCol
);
1581 else // failed to insert?
1583 wxLogDebug(wxT("Failed to insert the column '%s' into listview!"),
1590 long wxListCtrl::InsertColumn(long col
,
1591 const wxString
& heading
,
1596 item
.m_mask
= wxLIST_MASK_TEXT
| wxLIST_MASK_FORMAT
;
1597 item
.m_text
= heading
;
1600 item
.m_mask
|= wxLIST_MASK_WIDTH
;
1601 item
.m_width
= width
;
1603 item
.m_format
= format
;
1605 return InsertColumn(col
, item
);
1608 // scroll the control by the given number of pixels (exception: in list view,
1609 // dx is interpreted as number of columns)
1610 bool wxListCtrl::ScrollList(int dx
, int dy
)
1612 if ( !ListView_Scroll(GetHwnd(), dx
, dy
) )
1614 wxLogDebug(_T("ListView_Scroll(%d, %d) failed"), dx
, dy
);
1624 // fn is a function which takes 3 long arguments: item1, item2, data.
1625 // item1 is the long data associated with a first item (NOT the index).
1626 // item2 is the long data associated with a second item (NOT the index).
1627 // data is the same value as passed to SortItems.
1628 // The return value is a negative number if the first item should precede the second
1629 // item, a positive number of the second item should precede the first,
1630 // or zero if the two items are equivalent.
1632 // data is arbitrary data to be passed to the sort function.
1634 // Internal structures for proxying the user compare function
1635 // so that we can pass it the *real* user data
1637 // translate lParam data and call user func
1638 struct wxInternalDataSort
1640 wxListCtrlCompare user_fn
;
1644 int CALLBACK
wxInternalDataCompareFunc(LPARAM lParam1
, LPARAM lParam2
, LPARAM lParamSort
)
1646 struct wxInternalDataSort
*internalData
= (struct wxInternalDataSort
*) lParamSort
;
1648 wxListItemInternalData
*data1
= (wxListItemInternalData
*) lParam1
;
1649 wxListItemInternalData
*data2
= (wxListItemInternalData
*) lParam2
;
1651 long d1
= (data1
== NULL
? 0 : data1
->lParam
);
1652 long d2
= (data2
== NULL
? 0 : data2
->lParam
);
1654 return internalData
->user_fn(d1
, d2
, internalData
->data
);
1658 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, long data
)
1660 struct wxInternalDataSort internalData
;
1661 internalData
.user_fn
= fn
;
1662 internalData
.data
= data
;
1664 // WPARAM cast is needed for mingw/cygwin
1665 if ( !ListView_SortItems(GetHwnd(),
1666 wxInternalDataCompareFunc
,
1667 (WPARAM
) &internalData
) )
1669 wxLogDebug(_T("ListView_SortItems() failed"));
1679 // ----------------------------------------------------------------------------
1680 // message processing
1681 // ----------------------------------------------------------------------------
1683 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1685 if (cmd
== EN_UPDATE
)
1687 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1688 event
.SetEventObject( this );
1689 ProcessCommand(event
);
1692 else if (cmd
== EN_KILLFOCUS
)
1694 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1695 event
.SetEventObject( this );
1696 ProcessCommand(event
);
1703 bool wxListCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
1706 // prepare the event
1707 // -----------------
1709 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1710 event
.SetEventObject(this);
1712 wxEventType eventType
= wxEVT_NULL
;
1714 NMHDR
*nmhdr
= (NMHDR
*)lParam
;
1716 // if your compiler is as broken as this, you should really change it: this
1717 // code is needed for normal operation! #ifdef below is only useful for
1718 // automatic rebuilds which are done with a very old compiler version
1719 #ifdef HDN_BEGINTRACKA
1721 // check for messages from the header (in report view)
1722 HWND hwndHdr
= ListView_GetHeader(GetHwnd());
1724 // is it a message from the header?
1725 if ( nmhdr
->hwndFrom
== hwndHdr
)
1727 HD_NOTIFY
*nmHDR
= (HD_NOTIFY
*)nmhdr
;
1729 event
.m_itemIndex
= -1;
1731 switch ( nmhdr
->code
)
1733 // yet another comctl32.dll bug: under NT/W2K it sends Unicode
1734 // TRACK messages even to ANSI programs: on my system I get
1735 // HDN_BEGINTRACKW and HDN_ENDTRACKA and no HDN_TRACK at all!
1737 // work around is to simply catch both versions and hope that it
1738 // works (why should this message exist in ANSI and Unicode is
1739 // beyond me as it doesn't deal with strings at all...)
1741 // note that fr HDN_TRACK another possibility could be to use
1742 // HDN_ITEMCHANGING but it is sent even after HDN_ENDTRACK and when
1743 // something other than the item width changes so we'd have to
1744 // filter out the unwanted events then
1745 case HDN_BEGINTRACKA
:
1746 case HDN_BEGINTRACKW
:
1747 eventType
= wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
;
1752 if ( eventType
== wxEVT_NULL
)
1753 eventType
= wxEVT_COMMAND_LIST_COL_DRAGGING
;
1758 if ( eventType
== wxEVT_NULL
)
1759 eventType
= wxEVT_COMMAND_LIST_COL_END_DRAG
;
1761 event
.m_item
.m_width
= nmHDR
->pitem
->cxy
;
1762 event
.m_col
= nmHDR
->iItem
;
1767 eventType
= wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
;
1770 // find the column clicked: we have to search for it
1771 // ourselves as the notification message doesn't provide
1774 // where did the click occur?
1776 if ( !::GetCursorPos(&ptClick
) )
1778 wxLogLastError(_T("GetCursorPos"));
1781 if ( !::ScreenToClient(hwndHdr
, &ptClick
) )
1783 wxLogLastError(_T("ScreenToClient(listctrl header)"));
1786 event
.m_pointDrag
.x
= ptClick
.x
;
1787 event
.m_pointDrag
.y
= ptClick
.y
;
1789 int colCount
= Header_GetItemCount(hwndHdr
);
1792 for ( int col
= 0; col
< colCount
; col
++ )
1794 if ( Header_GetItemRect(hwndHdr
, col
, &rect
) )
1796 if ( ::PtInRect(&rect
, ptClick
) )
1806 case HDN_GETDISPINFOW
:
1808 LPNMHDDISPINFOW info
= (LPNMHDDISPINFOW
) lParam
;
1809 // This is a fix for a strange bug under XP.
1810 // Normally, info->iItem is a valid index, but
1811 // sometimes this is a silly (large) number
1812 // and when we return FALSE via wxControl::MSWOnNotify
1813 // to indicate that it hasn't yet been processed,
1814 // there's a GPF in Windows.
1815 // By returning TRUE here, we avoid further processing
1816 // of this strange message.
1817 if ( info
->iItem
>= GetColumnCount() )
1823 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1827 #endif // defined(HDN_BEGINTRACKA)
1828 if ( nmhdr
->hwndFrom
== GetHwnd() )
1830 // almost all messages use NM_LISTVIEW
1831 NM_LISTVIEW
*nmLV
= (NM_LISTVIEW
*)nmhdr
;
1833 const int iItem
= nmLV
->iItem
;
1836 // FreeAllInternalData will cause LVN_ITEMCHANG* messages, which can be
1837 // ignored for efficiency. It is done here because the internal data is in the
1838 // process of being deleted so we don't want to try and access it below.
1839 if ( m_ignoreChangeMessages
&&
1840 ( (nmLV
->hdr
.code
== LVN_ITEMCHANGED
) || (nmLV
->hdr
.code
== LVN_ITEMCHANGING
)))
1846 // If we have a valid item then check if there is a data value
1847 // associated with it and put it in the event.
1848 if ( iItem
>= 0 && iItem
< GetItemCount() )
1850 wxListItemInternalData
*internaldata
=
1851 wxGetInternalData(GetHwnd(), iItem
);
1854 event
.m_item
.m_data
= internaldata
->lParam
;
1858 switch ( nmhdr
->code
)
1860 case LVN_BEGINRDRAG
:
1861 eventType
= wxEVT_COMMAND_LIST_BEGIN_RDRAG
;
1865 if ( eventType
== wxEVT_NULL
)
1867 eventType
= wxEVT_COMMAND_LIST_BEGIN_DRAG
;
1870 event
.m_itemIndex
= iItem
;
1871 event
.m_pointDrag
.x
= nmLV
->ptAction
.x
;
1872 event
.m_pointDrag
.y
= nmLV
->ptAction
.y
;
1875 // NB: we have to handle both *A and *W versions here because some
1876 // versions of comctl32.dll send ANSI message to an Unicode app
1877 case LVN_BEGINLABELEDITA
:
1879 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1880 wxLV_ITEM
item(((LV_DISPINFOA
*)lParam
)->item
);
1881 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, item
);
1882 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1885 case LVN_BEGINLABELEDITW
:
1887 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1888 wxLV_ITEM
item(((LV_DISPINFOW
*)lParam
)->item
);
1889 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, item
);
1890 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1894 case LVN_ENDLABELEDITA
:
1896 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1897 wxLV_ITEM
item(((LV_DISPINFOA
*)lParam
)->item
);
1898 wxConvertFromMSWListItem(NULL
, event
.m_item
, item
);
1899 if ( ((LV_ITEM
)item
).pszText
== NULL
||
1900 ((LV_ITEM
)item
).iItem
== -1 )
1902 // don't keep a stale wxTextCtrl around
1905 // EDIT control will be deleted by the list control itself so
1906 // prevent us from deleting it as well
1907 m_textCtrl
->UnsubclassWin();
1908 m_textCtrl
->SetHWND(0);
1915 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1918 case LVN_ENDLABELEDITW
:
1920 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1921 wxLV_ITEM
item(((LV_DISPINFOW
*)lParam
)->item
);
1922 wxConvertFromMSWListItem(NULL
, event
.m_item
, item
);
1923 if ( ((LV_ITEM
)item
).pszText
== NULL
||
1924 ((LV_ITEM
)item
).iItem
== -1 )
1926 // don't keep a stale wxTextCtrl around
1929 // EDIT control will be deleted by the list control itself so
1930 // prevent us from deleting it as well
1931 m_textCtrl
->UnsubclassWin();
1932 m_textCtrl
->SetHWND(0);
1939 event
.m_itemIndex
= event
.m_item
.m_itemId
;
1943 case LVN_COLUMNCLICK
:
1944 eventType
= wxEVT_COMMAND_LIST_COL_CLICK
;
1945 event
.m_itemIndex
= -1;
1946 event
.m_col
= nmLV
->iSubItem
;
1949 case LVN_DELETEALLITEMS
:
1951 eventType
= wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
;
1952 event
.m_itemIndex
= -1;
1955 case LVN_DELETEITEM
:
1957 // this should be prevented by the post-processing code below,
1958 // but "just in case"
1961 eventType
= wxEVT_COMMAND_LIST_DELETE_ITEM
;
1962 event
.m_itemIndex
= iItem
;
1963 // delete the assoicated internal data
1964 wxDeleteInternalData(this, iItem
);
1967 case LVN_SETDISPINFO
:
1969 eventType
= wxEVT_COMMAND_LIST_SET_INFO
;
1970 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1971 wxConvertFromMSWListItem(GetHwnd(), event
.m_item
, info
->item
);
1975 case LVN_INSERTITEM
:
1976 eventType
= wxEVT_COMMAND_LIST_INSERT_ITEM
;
1977 event
.m_itemIndex
= iItem
;
1980 case LVN_ITEMCHANGED
:
1981 // we translate this catch all message into more interesting
1982 // (and more easy to process) wxWindows events
1984 // first of all, we deal with the state change events only and
1985 // only for valid items (item == -1 for the virtual list
1987 if ( nmLV
->uChanged
& LVIF_STATE
&& iItem
!= -1 )
1989 // temp vars for readability
1990 const UINT stOld
= nmLV
->uOldState
;
1991 const UINT stNew
= nmLV
->uNewState
;
1993 event
.m_item
.SetId(iItem
);
1994 event
.m_item
.SetMask(wxLIST_MASK_TEXT
|
1997 GetItem(event
.m_item
);
1999 // has the focus changed?
2000 if ( !(stOld
& LVIS_FOCUSED
) && (stNew
& LVIS_FOCUSED
) )
2002 eventType
= wxEVT_COMMAND_LIST_ITEM_FOCUSED
;
2003 event
.m_itemIndex
= iItem
;
2006 if ( (stNew
& LVIS_SELECTED
) != (stOld
& LVIS_SELECTED
) )
2008 if ( eventType
!= wxEVT_NULL
)
2010 // focus and selection have both changed: send the
2011 // focus event from here and the selection one
2013 event
.SetEventType(eventType
);
2014 (void)GetEventHandler()->ProcessEvent(event
);
2016 else // no focus event to send
2018 // then need to set m_itemIndex as it wasn't done
2020 event
.m_itemIndex
= iItem
;
2023 eventType
= stNew
& LVIS_SELECTED
2024 ? wxEVT_COMMAND_LIST_ITEM_SELECTED
2025 : wxEVT_COMMAND_LIST_ITEM_DESELECTED
;
2029 if ( eventType
== wxEVT_NULL
)
2031 // not an interesting event for us
2039 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
2040 WORD wVKey
= info
->wVKey
;
2042 // get the current selection
2043 long lItem
= GetNextItem(-1,
2045 wxLIST_STATE_SELECTED
);
2047 // <Enter> or <Space> activate the selected item if any (but
2048 // not with Shift and/or Ctrl as then they have a predefined
2049 // meaning for the list view)
2051 (wVKey
== VK_RETURN
|| wVKey
== VK_SPACE
) &&
2052 !(wxIsShiftDown() || wxIsCtrlDown()) )
2054 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2058 eventType
= wxEVT_COMMAND_LIST_KEY_DOWN
;
2060 // wxCharCodeMSWToWX() returns 0 if the key is an ASCII
2061 // value which should be used as is
2062 int code
= wxCharCodeMSWToWX(wVKey
);
2063 event
.m_code
= code
? code
: wVKey
;
2067 event
.m_item
.m_itemId
= lItem
;
2071 // fill the other fields too
2072 event
.m_item
.m_text
= GetItemText(lItem
);
2073 event
.m_item
.m_data
= GetItemData(lItem
);
2079 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
2081 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2086 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
2087 // if it happened on an item (and not on empty place)
2094 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
2095 event
.m_itemIndex
= iItem
;
2096 event
.m_item
.m_text
= GetItemText(iItem
);
2097 event
.m_item
.m_data
= GetItemData(iItem
);
2101 // if the user processes it in wxEVT_COMMAND_RIGHT_CLICK(),
2102 // don't do anything else
2103 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
2108 // else translate it into wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK event
2109 LV_HITTESTINFO lvhti
;
2110 wxZeroMemory(lvhti
);
2112 ::GetCursorPos(&(lvhti
.pt
));
2113 ::ScreenToClient(GetHwnd(),&(lvhti
.pt
));
2114 if ( ListView_HitTest(GetHwnd(),&lvhti
) != -1 )
2116 if ( lvhti
.flags
& LVHT_ONITEM
)
2118 eventType
= wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
;
2119 event
.m_itemIndex
= lvhti
.iItem
;
2120 event
.m_pointDrag
.x
= lvhti
.pt
.x
;
2121 event
.m_pointDrag
.y
= lvhti
.pt
.y
;
2126 #ifdef NM_CUSTOMDRAW
2128 *result
= OnCustomDraw(lParam
);
2131 #endif // _WIN32_IE >= 0x300
2133 case LVN_ODCACHEHINT
:
2135 const NM_CACHEHINT
*cacheHint
= (NM_CACHEHINT
*)lParam
;
2137 eventType
= wxEVT_COMMAND_LIST_CACHE_HINT
;
2139 // we get some really stupid cache hints like ones for
2140 // items in range 0..0 for an empty control or, after
2141 // deleting an item, for items in invalid range -- filter
2143 if ( cacheHint
->iFrom
> cacheHint
->iTo
)
2146 event
.m_oldItemIndex
= cacheHint
->iFrom
;
2148 const long iMax
= GetItemCount();
2149 event
.m_itemIndex
= cacheHint
->iTo
< iMax
? cacheHint
->iTo
2154 case LVN_GETDISPINFO
:
2157 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
2159 LV_ITEM
& lvi
= info
->item
;
2160 long item
= lvi
.iItem
;
2162 if ( lvi
.mask
& LVIF_TEXT
)
2164 wxString text
= OnGetItemText(item
, lvi
.iSubItem
);
2165 wxStrncpy(lvi
.pszText
, text
, lvi
.cchTextMax
);
2168 // see comment at the end of wxListCtrl::GetColumn()
2169 #ifdef NM_CUSTOMDRAW
2170 if ( lvi
.mask
& LVIF_IMAGE
)
2172 lvi
.iImage
= OnGetItemImage(item
);
2174 #endif // NM_CUSTOMDRAW
2176 // a little dose of healthy paranoia: as we never use
2177 // LVM_SETCALLBACKMASK we're not supposed to get these ones
2178 wxASSERT_MSG( !(lvi
.mask
& LVIF_STATE
),
2179 _T("we don't support state callbacks yet!") );
2186 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
2191 // where did this one come from?
2195 // process the event
2196 // -----------------
2198 event
.SetEventType(eventType
);
2200 bool processed
= GetEventHandler()->ProcessEvent(event
);
2204 switch ( nmhdr
->code
)
2206 case LVN_DELETEALLITEMS
:
2207 // always return TRUE to suppress all additional LVN_DELETEITEM
2208 // notifications - this makes deleting all items from a list ctrl
2213 case LVN_ENDLABELEDITA
:
2214 case LVN_ENDLABELEDITW
:
2215 // logic here is inversed compared to all the other messages
2216 *result
= event
.IsAllowed();
2218 // don't keep a stale wxTextCtrl around
2221 // EDIT control will be deleted by the list control itself so
2222 // prevent us from deleting it as well
2223 m_textCtrl
->UnsubclassWin();
2224 m_textCtrl
->SetHWND(0);
2233 *result
= !event
.IsAllowed();
2238 // see comment at the end of wxListCtrl::GetColumn()
2239 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2241 WXLPARAM
wxListCtrl::OnCustomDraw(WXLPARAM lParam
)
2243 LPNMLVCUSTOMDRAW lplvcd
= (LPNMLVCUSTOMDRAW
)lParam
;
2244 NMCUSTOMDRAW
& nmcd
= lplvcd
->nmcd
;
2245 switch ( nmcd
.dwDrawStage
)
2248 // if we've got any items with non standard attributes,
2249 // notify us before painting each item
2251 // for virtual controls, always suppose that we have attributes as
2252 // there is no way to check for this
2253 return IsVirtual() || m_hasAnyAttr
? CDRF_NOTIFYITEMDRAW
2256 case CDDS_ITEMPREPAINT
:
2258 size_t item
= (size_t)nmcd
.dwItemSpec
;
2259 if ( item
>= (size_t)GetItemCount() )
2261 // we get this message with item == 0 for an empty control,
2262 // we must ignore it as calling OnGetItemAttr() would be
2264 return CDRF_DODEFAULT
;
2267 wxListItemAttr
*attr
=
2268 IsVirtual() ? OnGetItemAttr(item
)
2269 : wxGetInternalDataAttr(this, item
);
2273 // nothing to do for this item
2274 return CDRF_DODEFAULT
;
2278 wxColour colText
, colBack
;
2279 if ( attr
->HasFont() )
2281 wxFont font
= attr
->GetFont();
2282 hFont
= (HFONT
)font
.GetResourceHandle();
2289 if ( attr
->HasTextColour() )
2291 colText
= attr
->GetTextColour();
2295 colText
= GetTextColour();
2298 if ( attr
->HasBackgroundColour() )
2300 colBack
= attr
->GetBackgroundColour();
2304 colBack
= GetBackgroundColour();
2307 lplvcd
->clrText
= wxColourToRGB(colText
);
2308 lplvcd
->clrTextBk
= wxColourToRGB(colBack
);
2310 // note that if we wanted to set colours for
2311 // individual columns (subitems), we would have
2312 // returned CDRF_NOTIFYSUBITEMREDRAW from here
2315 ::SelectObject(nmcd
.hdc
, hFont
);
2317 return CDRF_NEWFONT
;
2320 // fall through to return CDRF_DODEFAULT
2323 return CDRF_DODEFAULT
;
2327 #endif // NM_CUSTOMDRAW supported
2329 // Necessary for drawing hrules and vrules, if specified
2330 void wxListCtrl::OnPaint(wxPaintEvent
& event
)
2334 wxControl::OnPaint(event
);
2336 // Reset the device origin since it may have been set
2337 dc
.SetDeviceOrigin(0, 0);
2339 bool drawHRules
= ((GetWindowStyle() & wxLC_HRULES
) != 0);
2340 bool drawVRules
= ((GetWindowStyle() & wxLC_VRULES
) != 0);
2342 if (!drawHRules
&& !drawVRules
)
2344 if ((GetWindowStyle() & wxLC_REPORT
) == 0)
2347 wxPen
pen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT
), 1, wxSOLID
);
2349 dc
.SetBrush(* wxTRANSPARENT_BRUSH
);
2351 wxSize clientSize
= GetClientSize();
2355 int itemCount
= GetItemCount();
2359 long top
= GetTopItem();
2360 for (i
= top
; i
< top
+ GetCountPerPage() + 1; i
++)
2362 if (GetItemRect(i
, itemRect
))
2364 cy
= itemRect
.GetTop();
2365 if (i
!= 0) // Don't draw the first one
2367 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2370 if (i
== itemCount
- 1)
2372 cy
= itemRect
.GetBottom();
2373 dc
.DrawLine(0, cy
, clientSize
.x
, cy
);
2379 if (drawVRules
&& (i
> -1))
2381 wxRect firstItemRect
;
2382 GetItemRect(0, firstItemRect
);
2384 if (GetItemRect(i
, itemRect
))
2387 int x
= itemRect
.GetX();
2388 for (col
= 0; col
< GetColumnCount(); col
++)
2390 int colWidth
= GetColumnWidth(col
);
2392 dc
.DrawLine(x
-1, firstItemRect
.GetY() - 2, x
-1, itemRect
.GetBottom());
2398 // ----------------------------------------------------------------------------
2399 // virtual list controls
2400 // ----------------------------------------------------------------------------
2402 wxString
wxListCtrl::OnGetItemText(long WXUNUSED(item
), long WXUNUSED(col
)) const
2404 // this is a pure virtual function, in fact - which is not really pure
2405 // because the controls which are not virtual don't need to implement it
2406 wxFAIL_MSG( _T("wxListCtrl::OnGetItemText not supposed to be called") );
2408 return wxEmptyString
;
2411 int wxListCtrl::OnGetItemImage(long WXUNUSED(item
)) const
2414 wxFAIL_MSG( _T("wxListCtrl::OnGetItemImage not supposed to be called") );
2419 wxListItemAttr
*wxListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item
)) const
2421 wxASSERT_MSG( item
>= 0 && item
< GetItemCount(),
2422 _T("invalid item index in OnGetItemAttr()") );
2424 // no attributes by default
2428 void wxListCtrl::SetItemCount(long count
)
2430 wxASSERT_MSG( IsVirtual(), _T("this is for virtual controls only") );
2432 if ( !::SendMessage(GetHwnd(), LVM_SETITEMCOUNT
, (WPARAM
)count
, LVSICF_NOSCROLL
) )
2434 wxLogLastError(_T("ListView_SetItemCount"));
2437 wxASSERT_MSG( m_count
== ListView_GetItemCount(GetHwnd()),
2438 wxT("m_count should match ListView_GetItemCount"));
2441 void wxListCtrl::RefreshItem(long item
)
2443 // strangely enough, ListView_Update() results in much more flicker here
2444 // than a dumb Refresh() -- why?
2446 if ( !ListView_Update(GetHwnd(), item
) )
2448 wxLogLastError(_T("ListView_Update"));
2452 GetItemRect(item
, rect
);
2457 void wxListCtrl::RefreshItems(long itemFrom
, long itemTo
)
2459 wxRect rect1
, rect2
;
2460 GetItemRect(itemFrom
, rect1
);
2461 GetItemRect(itemTo
, rect2
);
2463 wxRect rect
= rect1
;
2464 rect
.height
= rect2
.GetBottom() - rect1
.GetTop();
2469 static wxListItemInternalData
*wxGetInternalData(HWND hwnd
, long itemId
)
2472 it
.mask
= LVIF_PARAM
;
2475 bool success
= ListView_GetItem(hwnd
, &it
) != 0;
2477 return (wxListItemInternalData
*) it
.lParam
;
2482 static wxListItemInternalData
*wxGetInternalData(wxListCtrl
*ctl
, long itemId
)
2484 return wxGetInternalData((HWND
) ctl
->GetHWND(), itemId
);
2487 static wxListItemAttr
*wxGetInternalDataAttr(wxListCtrl
*ctl
, long itemId
)
2489 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2496 static void wxDeleteInternalData(wxListCtrl
* ctl
, long itemId
)
2498 wxListItemInternalData
*data
= wxGetInternalData(ctl
, itemId
);
2502 memset(&item
, 0, sizeof(item
));
2503 item
.iItem
= itemId
;
2504 item
.mask
= LVIF_PARAM
;
2505 item
.lParam
= (LPARAM
) 0;
2506 ListView_SetItem((HWND
)ctl
->GetHWND(), &item
);
2511 static void wxConvertFromMSWListItem(HWND hwndListCtrl
,
2515 wxListItemInternalData
*internaldata
=
2516 (wxListItemInternalData
*) lvItem
.lParam
;
2519 info
.m_data
= internaldata
->lParam
;
2523 info
.m_stateMask
= 0;
2524 info
.m_itemId
= lvItem
.iItem
;
2526 long oldMask
= lvItem
.mask
;
2528 bool needText
= FALSE
;
2529 if (hwndListCtrl
!= 0)
2531 if ( lvItem
.mask
& LVIF_TEXT
)
2538 lvItem
.pszText
= new wxChar
[513];
2539 lvItem
.cchTextMax
= 512;
2541 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
2542 ::SendMessage(hwndListCtrl
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
);
2545 if ( lvItem
.mask
& LVIF_STATE
)
2547 info
.m_mask
|= wxLIST_MASK_STATE
;
2549 if ( lvItem
.stateMask
& LVIS_CUT
)
2551 info
.m_stateMask
|= wxLIST_STATE_CUT
;
2552 if ( lvItem
.state
& LVIS_CUT
)
2553 info
.m_state
|= wxLIST_STATE_CUT
;
2555 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
2557 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
2558 if ( lvItem
.state
& LVIS_DROPHILITED
)
2559 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
2561 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
2563 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
2564 if ( lvItem
.state
& LVIS_FOCUSED
)
2565 info
.m_state
|= wxLIST_STATE_FOCUSED
;
2567 if ( lvItem
.stateMask
& LVIS_SELECTED
)
2569 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
2570 if ( lvItem
.state
& LVIS_SELECTED
)
2571 info
.m_state
|= wxLIST_STATE_SELECTED
;
2575 if ( lvItem
.mask
& LVIF_TEXT
)
2577 info
.m_mask
|= wxLIST_MASK_TEXT
;
2578 info
.m_text
= lvItem
.pszText
;
2580 if ( lvItem
.mask
& LVIF_IMAGE
)
2582 info
.m_mask
|= wxLIST_MASK_IMAGE
;
2583 info
.m_image
= lvItem
.iImage
;
2585 if ( lvItem
.mask
& LVIF_PARAM
)
2586 info
.m_mask
|= wxLIST_MASK_DATA
;
2587 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
2588 info
.m_mask
|= wxLIST_SET_ITEM
;
2589 info
.m_col
= lvItem
.iSubItem
;
2594 delete[] lvItem
.pszText
;
2596 lvItem
.mask
= oldMask
;
2599 static void wxConvertToMSWFlags(long state
, long stateMask
, LV_ITEM
& lvItem
)
2601 if (stateMask
& wxLIST_STATE_CUT
)
2603 lvItem
.stateMask
|= LVIS_CUT
;
2604 if (state
& wxLIST_STATE_CUT
)
2605 lvItem
.state
|= LVIS_CUT
;
2607 if (stateMask
& wxLIST_STATE_DROPHILITED
)
2609 lvItem
.stateMask
|= LVIS_DROPHILITED
;
2610 if (state
& wxLIST_STATE_DROPHILITED
)
2611 lvItem
.state
|= LVIS_DROPHILITED
;
2613 if (stateMask
& wxLIST_STATE_FOCUSED
)
2615 lvItem
.stateMask
|= LVIS_FOCUSED
;
2616 if (state
& wxLIST_STATE_FOCUSED
)
2617 lvItem
.state
|= LVIS_FOCUSED
;
2619 if (stateMask
& wxLIST_STATE_SELECTED
)
2621 lvItem
.stateMask
|= LVIS_SELECTED
;
2622 if (state
& wxLIST_STATE_SELECTED
)
2623 lvItem
.state
|= LVIS_SELECTED
;
2627 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
,
2628 const wxListItem
& info
,
2631 lvItem
.iItem
= (int) info
.m_itemId
;
2633 lvItem
.iImage
= info
.m_image
;
2634 lvItem
.stateMask
= 0;
2637 lvItem
.iSubItem
= info
.m_col
;
2639 if (info
.m_mask
& wxLIST_MASK_STATE
)
2641 lvItem
.mask
|= LVIF_STATE
;
2643 wxConvertToMSWFlags(info
.m_state
, info
.m_stateMask
, lvItem
);
2646 if (info
.m_mask
& wxLIST_MASK_TEXT
)
2648 lvItem
.mask
|= LVIF_TEXT
;
2649 if ( ctrl
->GetWindowStyleFlag() & wxLC_USER_TEXT
)
2651 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
2655 // pszText is not const, hence the cast
2656 lvItem
.pszText
= (wxChar
*)info
.m_text
.c_str();
2657 if ( lvItem
.pszText
)
2658 lvItem
.cchTextMax
= info
.m_text
.Length();
2660 lvItem
.cchTextMax
= 0;
2663 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
2664 lvItem
.mask
|= LVIF_IMAGE
;
2667 static void wxConvertToMSWListCol(int WXUNUSED(col
), const wxListItem
& item
,
2670 wxZeroMemory(lvCol
);
2672 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
2674 lvCol
.mask
|= LVCF_TEXT
;
2675 lvCol
.pszText
= (wxChar
*)item
.m_text
.c_str(); // cast is safe
2678 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
2680 lvCol
.mask
|= LVCF_FMT
;
2682 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
2683 lvCol
.fmt
= LVCFMT_LEFT
;
2684 else if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
2685 lvCol
.fmt
= LVCFMT_RIGHT
;
2686 else if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
2687 lvCol
.fmt
= LVCFMT_CENTER
;
2690 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
2692 lvCol
.mask
|= LVCF_WIDTH
;
2693 if ( item
.m_width
== wxLIST_AUTOSIZE
)
2694 lvCol
.cx
= LVSCW_AUTOSIZE
;
2695 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
2696 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
2698 lvCol
.cx
= item
.m_width
;
2701 // see comment at the end of wxListCtrl::GetColumn()
2702 #ifdef NM_CUSTOMDRAW // _WIN32_IE >= 0x0300
2703 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
2705 if ( wxTheApp
->GetComCtl32Version() >= 470 )
2707 lvCol
.mask
|= LVCF_IMAGE
| LVCF_FMT
;
2709 // we use LVCFMT_BITMAP_ON_RIGHT because thei mages on the right
2710 // seem to be generally nicer than on the left and the generic
2711 // version only draws them on the right (we don't have a flag to
2712 // specify the image location anyhow)
2714 // we don't use LVCFMT_COL_HAS_IMAGES because it doesn't seem to
2715 // make any difference in my tests -- but maybe we should?
2716 lvCol
.fmt
|= LVCFMT_BITMAP_ON_RIGHT
| LVCFMT_IMAGE
;
2718 lvCol
.iImage
= item
.m_image
;
2720 //else: it doesn't support item images anyhow
2722 #endif // _WIN32_IE >= 0x0300
2725 #endif // wxUSE_LISTCTRL