1 /////////////////////////////////////////////////////////////////////////////
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "listctrl.h"
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
27 #if defined(__WIN95__)
29 #include "wx/listctrl.h"
32 #include "wx/msw/private.h"
34 #if (defined(__WIN95__) && !defined(__GNUWIN32__)) || defined(__TWIN32__)
40 #include "wx/msw/gnuwin32/extra.h"
44 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& tvItem
);
45 static void wxConvertFromMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& tvItem
, HWND getFullInfo
= 0);
47 #if !USE_SHARED_LIBRARY
48 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl
, wxControl
)
49 IMPLEMENT_DYNAMIC_CLASS(wxListItem
, wxObject
)
50 #endif // USE_SHARED_LIBRARY
52 wxListCtrl::wxListCtrl()
54 m_imageListNormal
= NULL
;
55 m_imageListSmall
= NULL
;
56 m_imageListState
= NULL
;
62 bool wxListCtrl::Create(wxWindow
*parent
,
67 const wxValidator
& validator
,
70 m_imageListNormal
= NULL
;
71 m_imageListSmall
= NULL
;
72 m_imageListState
= NULL
;
76 SetValidator(validator
);
84 m_windowStyle
= style
;
97 m_windowId
= (id
== -1) ? NewControlId() : id
;
99 DWORD wstyle
= WS_VISIBLE
| WS_CHILD
| WS_TABSTOP
;
102 WXDWORD exStyle
= Determine3DEffects(WS_EX_CLIENTEDGE
, &want3D
) ;
104 // Even with extended styles, need to combine with WS_BORDER
105 // for them to look right.
106 if ( want3D
|| wxStyleHasBorder(m_windowStyle
) )
109 wstyle
|= LVS_SHAREIMAGELISTS
| LVS_SHOWSELALWAYS
;
110 m_baseStyle
= wstyle
;
112 long oldStyle
= 0; // Dummy
113 wstyle
|= ConvertToMSWStyle(oldStyle
, m_windowStyle
);
115 // Create the ListView control.
116 m_hWnd
= (WXHWND
)CreateWindowEx(exStyle
,
121 (HWND
) parent
->GetHWND(),
127 wxLogError("Can't create list control window.");
132 // for comctl32.dll v 4.70+ we want to have this attribute because it's
133 // prettier (and also because wxGTK does it like this)
134 #ifdef ListView_SetExtendedListViewStyle
135 if ( wstyle
& LVS_REPORT
)
137 ListView_SetExtendedListViewStyle((HWND
)GetHWND(),
138 LVS_EX_FULLROWSELECT
);
140 #endif // ListView_SetExtendedListViewStyle
142 wxSystemSettings settings
;
143 SetBackgroundColour(settings
.GetSystemColour(wxSYS_COLOUR_WINDOW
));
144 SetForegroundColour(parent
->GetForegroundColour());
146 if (parent
) parent
->AddChild(this);
148 SubclassWin((WXHWND
) m_hWnd
);
153 wxListCtrl::~wxListCtrl()
157 m_textCtrl
->UnsubclassWin();
158 m_textCtrl
->SetHWND(0);
164 // Add or remove a single window style
165 void wxListCtrl::SetSingleStyle(long style
, bool add
)
167 long flag
= GetWindowStyleFlag();
169 // Get rid of conflicting styles
172 if ( style
& wxLC_MASK_TYPE
)
173 flag
= flag
& ~wxLC_MASK_TYPE
;
174 if ( style
& wxLC_MASK_ALIGN
)
175 flag
= flag
& ~wxLC_MASK_ALIGN
;
176 if ( style
& wxLC_MASK_SORT
)
177 flag
= flag
& ~wxLC_MASK_SORT
;
193 m_windowStyle
= flag
;
198 // Set the whole window style
199 void wxListCtrl::SetWindowStyleFlag(long flag
)
201 m_windowStyle
= flag
;
206 void wxListCtrl::RecreateWindow()
211 long style
= ConvertToMSWStyle(oldStyle
, m_windowStyle
);
212 style
|= m_baseStyle
;
213 // ::SetWindowLong((HWND) GetHWND(), GWL_STYLE, style);
215 // The following recreation of the window appears to be necessary
216 // because SetWindowLong doesn't seem to do it.
218 int x
, y
, width
, height
;
220 GetSize(&width
, &height
);
223 ::DestroyWindow((HWND
) GetHWND());
226 // Recreate the ListView control: unfortunately I can't
227 // make it work by using SetWindowLong.
229 WXDWORD exStyle
= Determine3DEffects(WS_EX_CLIENTEDGE
, &want3D
) ;
230 HWND hWndListControl
= CreateWindowEx(exStyle
,
235 (HWND
) GetParent()->GetHWND(),
240 m_hWnd
= (WXHWND
) hWndListControl
;
241 SubclassWin((WXHWND
) m_hWnd
);
243 #ifdef ListView_SetExtendedListViewStyle
244 if ( style
& LVS_REPORT
)
246 ListView_SetExtendedListViewStyle((HWND
)GetHWND(),
247 LVS_EX_FULLROWSELECT
);
249 #endif // ListView_SetExtendedListViewStyle
251 if ( m_imageListNormal
)
252 SetImageList(m_imageListNormal
, wxIMAGE_LIST_NORMAL
);
253 if ( m_imageListSmall
)
254 SetImageList(m_imageListSmall
, wxIMAGE_LIST_SMALL
);
255 if ( m_imageListState
)
256 SetImageList(m_imageListState
, wxIMAGE_LIST_STATE
);
260 // Can be just a single style, or a bitlist
261 long wxListCtrl::ConvertToMSWStyle(long& oldStyle
, long style
) const
264 if ( style
& wxLC_ICON
)
266 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
267 oldStyle
-= LVS_SMALLICON
;
268 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
269 oldStyle
-= LVS_REPORT
;
270 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
271 oldStyle
-= LVS_LIST
;
275 if ( style
& wxLC_SMALL_ICON
)
277 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
278 oldStyle
-= LVS_ICON
;
279 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
280 oldStyle
-= LVS_REPORT
;
281 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
282 oldStyle
-= LVS_LIST
;
283 wstyle
|= LVS_SMALLICON
;
286 if ( style
& wxLC_LIST
)
288 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
289 oldStyle
-= LVS_ICON
;
290 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
291 oldStyle
-= LVS_REPORT
;
292 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
293 oldStyle
-= LVS_SMALLICON
;
297 if ( style
& wxLC_REPORT
)
299 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
300 oldStyle
-= LVS_ICON
;
301 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
302 oldStyle
-= LVS_LIST
;
303 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
304 oldStyle
-= LVS_SMALLICON
;
306 wstyle
|= LVS_REPORT
;
309 if ( style
& wxLC_ALIGN_LEFT
)
311 if ( oldStyle
& LVS_ALIGNTOP
)
312 oldStyle
-= LVS_ALIGNTOP
;
313 wstyle
|= LVS_ALIGNLEFT
;
316 if ( style
& wxLC_ALIGN_TOP
)
318 if ( oldStyle
& LVS_ALIGNLEFT
)
319 oldStyle
-= LVS_ALIGNLEFT
;
320 wstyle
|= LVS_ALIGNTOP
;
323 if ( style
& wxLC_AUTOARRANGE
)
324 wstyle
|= LVS_AUTOARRANGE
;
326 // Apparently, no such style (documentation wrong?)
328 if ( style & wxLC_BUTTON )
329 wstyle |= LVS_BUTTON;
332 if ( style
& wxLC_NO_SORT_HEADER
)
333 wstyle
|= LVS_NOSORTHEADER
;
335 if ( style
& wxLC_NO_HEADER
)
336 wstyle
|= LVS_NOCOLUMNHEADER
;
338 if ( style
& wxLC_EDIT_LABELS
)
339 wstyle
|= LVS_EDITLABELS
;
341 if ( style
& wxLC_SINGLE_SEL
)
342 wstyle
|= LVS_SINGLESEL
;
344 if ( style
& wxLC_SORT_ASCENDING
)
346 if ( oldStyle
& LVS_SORTDESCENDING
)
347 oldStyle
-= LVS_SORTDESCENDING
;
348 wstyle
|= LVS_SORTASCENDING
;
351 if ( style
& wxLC_SORT_DESCENDING
)
353 if ( oldStyle
& LVS_SORTASCENDING
)
354 oldStyle
-= LVS_SORTASCENDING
;
355 wstyle
|= LVS_SORTDESCENDING
;
361 // Sets the background colour (GetBackgroundColour already implicit in
363 bool wxListCtrl::SetBackgroundColour(const wxColour
& col
)
365 if ( !wxWindow::SetBackgroundColour(col
) )
368 ListView_SetBkColor((HWND
) GetHWND(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
373 // Gets information about this column
374 bool wxListCtrl::GetColumn(int col
, wxListItem
& item
) const
379 lvCol
.pszText
= NULL
;
381 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
383 lvCol
.mask
|= LVCF_TEXT
;
384 lvCol
.pszText
= new char[513];
385 lvCol
.cchTextMax
= 512;
388 bool success
= (ListView_GetColumn((HWND
) GetHWND(), col
, & lvCol
) != 0);
390 // item.m_subItem = lvCol.iSubItem;
391 item
.m_width
= lvCol
.cx
;
393 if ( (item
.m_mask
& wxLIST_MASK_TEXT
) && lvCol
.pszText
)
395 item
.m_text
= lvCol
.pszText
;
396 delete[] lvCol
.pszText
;
399 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
401 if (lvCol
.fmt
== LVCFMT_LEFT
)
402 item
.m_format
= wxLIST_FORMAT_LEFT
;
403 else if (lvCol
.fmt
== LVCFMT_RIGHT
)
404 item
.m_format
= wxLIST_FORMAT_RIGHT
;
405 else if (lvCol
.fmt
== LVCFMT_CENTER
)
406 item
.m_format
= wxLIST_FORMAT_CENTRE
;
412 // Sets information about this column
413 bool wxListCtrl::SetColumn(int col
, wxListItem
& item
)
418 lvCol
.pszText
= NULL
;
420 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
422 lvCol
.mask
|= LVCF_TEXT
;
423 lvCol
.pszText
= WXSTRINGCAST item
.m_text
;
424 lvCol
.cchTextMax
= 0; // Ignored
426 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
428 lvCol
.mask
|= LVCF_FMT
;
430 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
431 lvCol
.fmt
= LVCFMT_LEFT
;
432 if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
433 lvCol
.fmt
= LVCFMT_RIGHT
;
434 if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
435 lvCol
.fmt
= LVCFMT_CENTER
;
438 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
440 lvCol
.mask
|= LVCF_WIDTH
;
441 lvCol
.cx
= item
.m_width
;
443 if ( lvCol
.cx
== wxLIST_AUTOSIZE
)
444 lvCol
.cx
= LVSCW_AUTOSIZE
;
445 else if ( lvCol
.cx
== wxLIST_AUTOSIZE_USEHEADER
)
446 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
448 lvCol
.mask
|= LVCF_SUBITEM
;
449 lvCol
.iSubItem
= col
;
450 return (ListView_SetColumn((HWND
) GetHWND(), col
, & lvCol
) != 0);
453 // Gets the column width
454 int wxListCtrl::GetColumnWidth(int col
) const
456 return ListView_GetColumnWidth((HWND
) GetHWND(), col
);
459 // Sets the column width
460 bool wxListCtrl::SetColumnWidth(int col
, int width
)
463 if ( m_windowStyle
& wxLC_LIST
)
467 if ( width2
== wxLIST_AUTOSIZE
)
468 width2
= LVSCW_AUTOSIZE
;
469 else if ( width2
== wxLIST_AUTOSIZE_USEHEADER
)
470 width2
= LVSCW_AUTOSIZE_USEHEADER
;
472 return (ListView_SetColumnWidth((HWND
) GetHWND(), col2
, width2
) != 0);
475 // Gets the number of items that can fit vertically in the
476 // visible area of the list control (list or report view)
477 // or the total number of items in the list control (icon
478 // or small icon view)
479 int wxListCtrl::GetCountPerPage(void) const
481 return ListView_GetCountPerPage((HWND
) GetHWND());
484 // Gets the edit control for editing labels.
485 wxTextCtrl
* wxListCtrl::GetEditControl(void) const
490 // Gets information about the item
491 bool wxListCtrl::GetItem(wxListItem
& info
) const
495 memset(&lvItem
, 0, sizeof(lvItem
));
497 ZeroMemory(&lvItem
, sizeof(lvItem
)); // must set all fields to 0
500 lvItem
.iItem
= info
.m_itemId
;
502 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
504 lvItem
.mask
|= LVIF_TEXT
;
505 lvItem
.pszText
= new char[513];
506 lvItem
.cchTextMax
= 512;
510 lvItem
.pszText
= NULL
;
513 if (info
.m_mask
& wxLIST_MASK_DATA
)
514 lvItem
.mask
|= LVIF_PARAM
;
516 if ( info
.m_mask
& wxLIST_MASK_STATE
)
518 lvItem
.mask
|= LVIF_STATE
;
519 // the other bits are hardly interesting anyhow
520 lvItem
.stateMask
= LVIS_SELECTED
| LVIS_FOCUSED
;
523 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
526 wxLogError(_("Couldn't retrieve information about list control item %d."),
531 wxConvertFromMSWListItem(this, info
, lvItem
);
535 delete[] lvItem
.pszText
;
540 // Sets information about the item
541 bool wxListCtrl::SetItem(wxListItem
& info
)
544 wxConvertToMSWListItem(this, info
, item
);
546 return (ListView_SetItem((HWND
) GetHWND(), &item
) != 0);
549 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
553 info
.m_mask
= wxLIST_MASK_TEXT
;
554 info
.m_itemId
= index
;
558 info
.m_image
= imageId
;
559 info
.m_mask
|= wxLIST_MASK_IMAGE
;
561 return SetItem(info
);
565 // Gets the item state
566 int wxListCtrl::GetItemState(long item
, long stateMask
) const
570 info
.m_mask
= wxLIST_MASK_STATE
;
571 info
.m_stateMask
= stateMask
;
572 info
.m_itemId
= item
;
580 // Sets the item state
581 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
585 info
.m_mask
= wxLIST_MASK_STATE
;
586 info
.m_state
= state
;
587 info
.m_stateMask
= stateMask
;
588 info
.m_itemId
= item
;
590 return SetItem(info
);
593 // Sets the item image
594 bool wxListCtrl::SetItemImage(long item
, int image
, int selImage
)
598 info
.m_mask
= wxLIST_MASK_IMAGE
;
599 info
.m_image
= image
;
600 info
.m_itemId
= item
;
602 return SetItem(info
);
605 // Gets the item text
606 wxString
wxListCtrl::GetItemText(long item
) const
610 info
.m_mask
= wxLIST_MASK_TEXT
;
611 info
.m_itemId
= item
;
618 // Sets the item text
619 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
623 info
.m_mask
= wxLIST_MASK_TEXT
;
624 info
.m_itemId
= item
;
630 // Gets the item data
631 long wxListCtrl::GetItemData(long item
) const
635 info
.m_mask
= wxLIST_MASK_DATA
;
636 info
.m_itemId
= item
;
643 // Sets the item data
644 bool wxListCtrl::SetItemData(long item
, long data
)
648 info
.m_mask
= wxLIST_MASK_DATA
;
649 info
.m_itemId
= item
;
652 return SetItem(info
);
655 // Gets the item rectangle
656 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
660 int code2
= LVIR_BOUNDS
;
661 if ( code
== wxLIST_RECT_BOUNDS
)
663 else if ( code
== wxLIST_RECT_ICON
)
665 else if ( code
== wxLIST_RECT_LABEL
)
668 bool success
= (ListView_GetItemRect((HWND
) GetHWND(), (int) item
, &rect2
, code2
) != 0);
672 rect
.width
= rect2
.right
- rect2
.left
;
673 rect
.height
= rect2
.bottom
- rect2
.left
;
677 // Gets the item position
678 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
682 bool success
= (ListView_GetItemPosition((HWND
) GetHWND(), (int) item
, &pt
) != 0);
684 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
688 // Sets the item position.
689 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
691 return (ListView_SetItemPosition((HWND
) GetHWND(), (int) item
, pos
.x
, pos
.y
) != 0);
694 // Gets the number of items in the list control
695 int wxListCtrl::GetItemCount(void) const
697 return ListView_GetItemCount((HWND
) GetHWND());
700 // Retrieves the spacing between icons in pixels.
701 // If small is TRUE, gets the spacing for the small icon
702 // view, otherwise the large icon view.
703 int wxListCtrl::GetItemSpacing(bool isSmall
) const
705 return ListView_GetItemSpacing((HWND
) GetHWND(), (BOOL
) isSmall
);
708 // Gets the number of selected items in the list control
709 int wxListCtrl::GetSelectedItemCount(void) const
711 return ListView_GetSelectedCount((HWND
) GetHWND());
714 // Gets the text colour of the listview
715 wxColour
wxListCtrl::GetTextColour(void) const
717 COLORREF ref
= ListView_GetTextColor((HWND
) GetHWND());
718 wxColour
col(GetRValue(ref
), GetGValue(ref
), GetBValue(ref
));
722 // Sets the text colour of the listview
723 void wxListCtrl::SetTextColour(const wxColour
& col
)
725 ListView_SetTextColor((HWND
) GetHWND(), PALETTERGB(col
.Red(), col
.Blue(), col
.Green()));
728 // Gets the index of the topmost visible item when in
729 // list or report view
730 long wxListCtrl::GetTopItem(void) const
732 return (long) ListView_GetTopIndex((HWND
) GetHWND());
735 // Searches for an item, starting from 'item'.
736 // 'geometry' is one of
737 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
738 // 'state' is a state bit flag, one or more of
739 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
740 // item can be -1 to find the first item that matches the
742 // Returns the item or -1 if unsuccessful.
743 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
747 if ( geom
== wxLIST_NEXT_ABOVE
)
749 if ( geom
== wxLIST_NEXT_ALL
)
751 if ( geom
== wxLIST_NEXT_BELOW
)
753 if ( geom
== wxLIST_NEXT_LEFT
)
754 flags
|= LVNI_TOLEFT
;
755 if ( geom
== wxLIST_NEXT_RIGHT
)
756 flags
|= LVNI_TORIGHT
;
758 if ( state
& wxLIST_STATE_CUT
)
760 if ( state
& wxLIST_STATE_DROPHILITED
)
761 flags
|= LVNI_DROPHILITED
;
762 if ( state
& wxLIST_STATE_FOCUSED
)
763 flags
|= LVNI_FOCUSED
;
764 if ( state
& wxLIST_STATE_SELECTED
)
765 flags
|= LVNI_SELECTED
;
767 return (long) ListView_GetNextItem((HWND
) GetHWND(), item
, flags
);
771 wxImageList
*wxListCtrl::GetImageList(int which
) const
773 if ( which
== wxIMAGE_LIST_NORMAL
)
775 return m_imageListNormal
;
777 else if ( which
== wxIMAGE_LIST_SMALL
)
779 return m_imageListSmall
;
781 else if ( which
== wxIMAGE_LIST_STATE
)
783 return m_imageListState
;
788 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
791 if ( which
== wxIMAGE_LIST_NORMAL
)
793 flags
= LVSIL_NORMAL
;
794 m_imageListNormal
= imageList
;
796 else if ( which
== wxIMAGE_LIST_SMALL
)
799 m_imageListSmall
= imageList
;
801 else if ( which
== wxIMAGE_LIST_STATE
)
804 m_imageListState
= imageList
;
806 ListView_SetImageList((HWND
) GetHWND(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
810 ////////////////////////////////////////////////////////////////////////////
812 // Arranges the items
813 bool wxListCtrl::Arrange(int flag
)
816 if ( flag
== wxLIST_ALIGN_LEFT
)
817 code
= LVA_ALIGNLEFT
;
818 else if ( flag
== wxLIST_ALIGN_TOP
)
820 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
822 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
823 code
= LVA_SNAPTOGRID
;
825 return (ListView_Arrange((HWND
) GetHWND(), code
) != 0);
829 bool wxListCtrl::DeleteItem(long item
)
831 return (ListView_DeleteItem((HWND
) GetHWND(), (int) item
) != 0);
835 bool wxListCtrl::DeleteAllItems()
837 return (ListView_DeleteAllItems((HWND
) GetHWND()) != 0);
841 bool wxListCtrl::DeleteAllColumns()
844 for ( i
= 0; i
< m_colCount
; i
++)
846 if (ListView_DeleteColumn((HWND
) GetHWND(), 0) != 0)
849 return (m_colCount
== 0);
853 bool wxListCtrl::DeleteColumn(int col
)
855 bool success
= (ListView_DeleteColumn((HWND
) GetHWND(), col
) != 0);
857 if ( success
&& (m_colCount
> 0) )
862 // Clears items, and columns if there are any.
863 void wxListCtrl::ClearAll()
866 if ( m_colCount
> 0 )
870 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
872 wxASSERT( (textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
))) );
874 HWND hWnd
= (HWND
) ListView_EditLabel((HWND
) GetHWND(), item
);
878 m_textCtrl
->UnsubclassWin();
879 m_textCtrl
->SetHWND(0);
884 m_textCtrl
= (wxTextCtrl
*) textControlClass
->CreateObject();
885 m_textCtrl
->SetHWND((WXHWND
) hWnd
);
886 m_textCtrl
->SubclassWin((WXHWND
) hWnd
);
891 // End label editing, optionally cancelling the edit
892 bool wxListCtrl::EndEditLabel(bool cancel
)
896 /* I don't know how to implement this: there's no such macro as ListView_EndEditLabelNow.
898 bool success = (ListView_EndEditLabelNow((HWND) GetHWND(), cancel) != 0);
902 m_textCtrl->UnsubclassWin();
903 m_textCtrl->SetHWND(0);
913 // Ensures this item is visible
914 bool wxListCtrl::EnsureVisible(long item
)
916 return (ListView_EnsureVisible((HWND
) GetHWND(), (int) item
, FALSE
) != 0);
919 // Find an item whose label matches this string, starting from the item after 'start'
920 // or the beginning if 'start' is -1.
921 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
923 LV_FINDINFO findInfo
;
925 findInfo
.flags
= LVFI_STRING
;
927 findInfo
.flags
|= LVFI_STRING
;
928 findInfo
.psz
= WXSTRINGCAST str
;
930 return ListView_FindItem((HWND
) GetHWND(), (int) start
, & findInfo
);
933 // Find an item whose data matches this data, starting from the item after 'start'
934 // or the beginning if 'start' is -1.
935 long wxListCtrl::FindItem(long start
, long data
)
937 LV_FINDINFO findInfo
;
939 findInfo
.flags
= LVFI_PARAM
;
940 findInfo
.lParam
= data
;
942 return ListView_FindItem((HWND
) GetHWND(), (int) start
, & findInfo
);
945 // Find an item nearest this position in the specified direction, starting from
946 // the item after 'start' or the beginning if 'start' is -1.
947 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
949 LV_FINDINFO findInfo
;
951 findInfo
.flags
= LVFI_NEARESTXY
;
952 findInfo
.pt
.x
= pt
.x
;
953 findInfo
.pt
.y
= pt
.y
;
954 findInfo
.vkDirection
= VK_RIGHT
;
956 if ( direction
== wxLIST_FIND_UP
)
957 findInfo
.vkDirection
= VK_UP
;
958 else if ( direction
== wxLIST_FIND_DOWN
)
959 findInfo
.vkDirection
= VK_DOWN
;
960 else if ( direction
== wxLIST_FIND_LEFT
)
961 findInfo
.vkDirection
= VK_LEFT
;
962 else if ( direction
== wxLIST_FIND_RIGHT
)
963 findInfo
.vkDirection
= VK_RIGHT
;
965 return ListView_FindItem((HWND
) GetHWND(), (int) start
, & findInfo
);
968 // Determines which item (if any) is at the specified point,
969 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
970 long wxListCtrl::HitTest(const wxPoint
& point
, int& flags
)
972 LV_HITTESTINFO hitTestInfo
;
973 hitTestInfo
.pt
.x
= (int) point
.x
;
974 hitTestInfo
.pt
.y
= (int) point
.y
;
976 ListView_HitTest((HWND
) GetHWND(), & hitTestInfo
);
979 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
980 flags
|= wxLIST_HITTEST_ABOVE
;
981 if ( hitTestInfo
.flags
& LVHT_BELOW
)
982 flags
|= wxLIST_HITTEST_BELOW
;
983 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
984 flags
|= wxLIST_HITTEST_NOWHERE
;
985 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
986 flags
|= wxLIST_HITTEST_ONITEMICON
;
987 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
988 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
989 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
990 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
991 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
992 flags
|= wxLIST_HITTEST_TOLEFT
;
993 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
994 flags
|= wxLIST_HITTEST_TORIGHT
;
996 return (long) hitTestInfo
.iItem
;
999 // Inserts an item, returning the index of the new item if successful,
1001 long wxListCtrl::InsertItem(wxListItem
& info
)
1004 wxConvertToMSWListItem(this, info
, item
);
1006 return (long) ListView_InsertItem((HWND
) GetHWND(), & item
);
1009 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1012 info
.m_text
= label
;
1013 info
.m_mask
= wxLIST_MASK_TEXT
;
1014 info
.m_itemId
= index
;
1015 return InsertItem(info
);
1018 // Inserts an image item
1019 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1022 info
.m_image
= imageIndex
;
1023 info
.m_mask
= wxLIST_MASK_IMAGE
;
1024 info
.m_itemId
= index
;
1025 return InsertItem(info
);
1028 // Inserts an image/string item
1029 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1032 info
.m_image
= imageIndex
;
1033 info
.m_text
= label
;
1034 info
.m_mask
= wxLIST_MASK_IMAGE
| wxLIST_MASK_TEXT
;
1035 info
.m_itemId
= index
;
1036 return InsertItem(info
);
1039 // For list view mode (only), inserts a column.
1040 long wxListCtrl::InsertColumn(long col
, wxListItem
& item
)
1045 lvCol
.pszText
= NULL
;
1047 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
1049 lvCol
.mask
|= LVCF_TEXT
;
1050 lvCol
.pszText
= WXSTRINGCAST item
.m_text
;
1051 lvCol
.cchTextMax
= 0; // Ignored
1053 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
1055 lvCol
.mask
|= LVCF_FMT
;
1057 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
1058 lvCol
.fmt
= LVCFMT_LEFT
;
1059 if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
1060 lvCol
.fmt
= LVCFMT_RIGHT
;
1061 if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
1062 lvCol
.fmt
= LVCFMT_CENTER
;
1065 lvCol
.mask
|= LVCF_WIDTH
;
1066 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
1068 if ( item
.m_width
== wxLIST_AUTOSIZE
)
1069 lvCol
.cx
= LVSCW_AUTOSIZE
;
1070 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
1071 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
1073 lvCol
.cx
= item
.m_width
;
1077 // always give some width to the new column: this one is compatible
1082 lvCol
.mask
|= LVCF_SUBITEM
;
1083 lvCol
.iSubItem
= col
;
1085 bool success
= ListView_InsertColumn((HWND
) GetHWND(), col
, & lvCol
) != -1;
1092 wxLogDebug("Failed to insert the column '%s' into listview!",
1099 long wxListCtrl::InsertColumn(long col
, const wxString
& heading
, int format
,
1103 item
.m_mask
= wxLIST_MASK_TEXT
| wxLIST_MASK_FORMAT
;
1104 item
.m_text
= heading
;
1107 item
.m_mask
|= wxLIST_MASK_WIDTH
;
1108 item
.m_width
= width
;
1110 item
.m_format
= format
;
1112 return InsertColumn(col
, item
);
1115 // Scrolls the list control. If in icon, small icon or report view mode,
1116 // x specifies the number of pixels to scroll. If in list view mode, x
1117 // specifies the number of columns to scroll.
1118 // If in icon, small icon or list view mode, y specifies the number of pixels
1119 // to scroll. If in report view mode, y specifies the number of lines to scroll.
1120 bool wxListCtrl::ScrollList(int dx
, int dy
)
1122 return (ListView_Scroll((HWND
) GetHWND(), dx
, dy
) != 0);
1127 // fn is a function which takes 3 long arguments: item1, item2, data.
1128 // item1 is the long data associated with a first item (NOT the index).
1129 // item2 is the long data associated with a second item (NOT the index).
1130 // data is the same value as passed to SortItems.
1131 // The return value is a negative number if the first item should precede the second
1132 // item, a positive number of the second item should precede the first,
1133 // or zero if the two items are equivalent.
1135 // data is arbitrary data to be passed to the sort function.
1136 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, long data
)
1138 return (ListView_SortItems((HWND
) GetHWND(), (PFNLVCOMPARE
) fn
, data
) != 0);
1141 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1143 if (cmd
== EN_UPDATE
)
1145 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1146 event
.SetEventObject( this );
1147 ProcessCommand(event
);
1150 else if (cmd
== EN_KILLFOCUS
)
1152 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1153 event
.SetEventObject( this );
1154 ProcessCommand(event
);
1160 bool wxListCtrl::MSWNotify(WXWPARAM wParam
, WXLPARAM lParam
, WXLPARAM
*result
)
1162 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1163 wxEventType eventType
= wxEVT_NULL
;
1164 NMHDR
*hdr1
= (NMHDR
*) lParam
;
1165 switch ( hdr1
->code
)
1167 case LVN_BEGINRDRAG
:
1168 eventType
= wxEVT_COMMAND_LIST_BEGIN_RDRAG
;
1172 if ( eventType
== wxEVT_NULL
)
1174 eventType
= wxEVT_COMMAND_LIST_BEGIN_DRAG
;
1178 NM_LISTVIEW
*hdr
= (NM_LISTVIEW
*)lParam
;
1179 event
.m_itemIndex
= hdr
->iItem
;
1180 event
.m_pointDrag
.x
= hdr
->ptAction
.x
;
1181 event
.m_pointDrag
.y
= hdr
->ptAction
.y
;
1185 case LVN_BEGINLABELEDIT
:
1187 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1188 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1189 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, (HWND
) GetHWND());
1193 case LVN_COLUMNCLICK
:
1195 eventType
= wxEVT_COMMAND_LIST_COL_CLICK
;
1196 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1197 event
.m_itemIndex
= -1;
1198 event
.m_col
= hdr
->iSubItem
;
1201 case LVN_DELETEALLITEMS
:
1203 eventType
= wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
;
1204 // NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam;
1205 event
.m_itemIndex
= -1;
1208 case LVN_DELETEITEM
:
1210 eventType
= wxEVT_COMMAND_LIST_DELETE_ITEM
;
1211 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1212 event
.m_itemIndex
= hdr
->iItem
;
1215 case LVN_ENDLABELEDIT
:
1217 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1218 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1219 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, (HWND
) GetHWND());
1220 if ( info
->item
.pszText
== NULL
|| info
->item
.iItem
== -1 )
1221 event
.m_cancelled
= TRUE
;
1224 case LVN_GETDISPINFO
:
1227 // TODO: some text buffering here, I think
1228 // TODO: API for getting Windows to retrieve values
1230 eventType
= wxEVT_COMMAND_LIST_GET_INFO
;
1231 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1232 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, (HWND
) GetHWND());
1235 case LVN_INSERTITEM
:
1237 eventType
= wxEVT_COMMAND_LIST_INSERT_ITEM
;
1238 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1239 event
.m_itemIndex
= hdr
->iItem
;
1242 case LVN_ITEMCHANGED
:
1244 // This needs to be sent to wxListCtrl as a rather more
1245 // concrete event. For now, just detect a selection
1247 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1248 if ( (hdr
->uNewState
& LVIS_SELECTED
) && !(hdr
->uOldState
& LVIS_SELECTED
) )
1250 eventType
= wxEVT_COMMAND_LIST_ITEM_SELECTED
;
1251 event
.m_itemIndex
= hdr
->iItem
;
1253 else if ( !(hdr
->uNewState
& LVIS_SELECTED
) && (hdr
->uOldState
& LVIS_SELECTED
) )
1255 eventType
= wxEVT_COMMAND_LIST_ITEM_DESELECTED
;
1256 event
.m_itemIndex
= hdr
->iItem
;
1264 eventType
= wxEVT_COMMAND_LIST_KEY_DOWN
;
1265 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
1266 event
.m_code
= wxCharCodeMSWToWX(info
->wVKey
);
1269 case LVN_SETDISPINFO
:
1271 eventType
= wxEVT_COMMAND_LIST_SET_INFO
;
1272 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1273 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, (HWND
) GetHWND());
1278 return wxControl::MSWNotify(wParam
, lParam
, result
);
1281 event
.SetEventObject( this );
1282 event
.SetEventType(eventType
);
1284 if ( !GetEventHandler()->ProcessEvent(event
) )
1287 if (hdr1
->code
== LVN_GETDISPINFO
)
1289 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1290 if ( info
->item
.mask
& LVIF_TEXT
)
1292 if ( !event
.m_item
.m_text
.IsNull() )
1294 info
->item
.pszText
= AddPool(event
.m_item
.m_text
);
1295 info
->item
.cchTextMax
= strlen(info
->item
.pszText
) + 1;
1298 // wxConvertToMSWListItem(this, event.m_item, info->item);
1301 *result
= !event
.IsAllowed();
1306 char *wxListCtrl::AddPool(const wxString
& str
)
1308 // Remove the first element if 3 strings exist
1309 if ( m_stringPool
.Number() == 3 )
1311 wxNode
*node
= m_stringPool
.First();
1312 delete[] (char *)node
->Data();
1315 wxNode
*node
= m_stringPool
.Add((char *) (const char *)str
);
1316 return (char *)node
->Data();
1319 // List item structure
1320 wxListItem::wxListItem()
1330 m_format
= wxLIST_FORMAT_CENTRE
;
1334 static void wxConvertFromMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& lvItem
, HWND getFullInfo
)
1336 info
.m_data
= lvItem
.lParam
;
1339 info
.m_stateMask
= 0;
1340 info
.m_itemId
= lvItem
.iItem
;
1342 long oldMask
= lvItem
.mask
;
1344 bool needText
= FALSE
;
1345 if (getFullInfo
!= 0)
1347 if ( lvItem
.mask
& LVIF_TEXT
)
1354 lvItem
.pszText
= new char[513];
1355 lvItem
.cchTextMax
= 512;
1357 // lvItem.mask |= TVIF_HANDLE | TVIF_STATE | TVIF_TEXT | TVIF_IMAGE | TVIF_SELECTEDIMAGE | TVIF_CHILDREN | TVIF_PARAM ;
1358 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
1359 ::SendMessage(getFullInfo
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
) ;
1362 if ( lvItem
.mask
& LVIF_STATE
)
1364 info
.m_mask
|= wxLIST_MASK_STATE
;
1366 if ( lvItem
.stateMask
& LVIS_CUT
)
1368 info
.m_stateMask
|= wxLIST_STATE_CUT
;
1369 if ( lvItem
.state
& LVIS_CUT
)
1370 info
.m_state
|= wxLIST_STATE_CUT
;
1372 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
1374 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
1375 if ( lvItem
.state
& LVIS_DROPHILITED
)
1376 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
1378 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
1380 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
1381 if ( lvItem
.state
& LVIS_FOCUSED
)
1382 info
.m_state
|= wxLIST_STATE_FOCUSED
;
1384 if ( lvItem
.stateMask
& LVIS_SELECTED
)
1386 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
1387 if ( lvItem
.state
& LVIS_SELECTED
)
1388 info
.m_state
|= wxLIST_STATE_SELECTED
;
1392 if ( lvItem
.mask
& LVIF_TEXT
)
1394 info
.m_mask
|= wxLIST_MASK_TEXT
;
1395 info
.m_text
= lvItem
.pszText
;
1397 if ( lvItem
.mask
& LVIF_IMAGE
)
1399 info
.m_mask
|= wxLIST_MASK_IMAGE
;
1400 info
.m_image
= lvItem
.iImage
;
1402 if ( lvItem
.mask
& LVIF_PARAM
)
1403 info
.m_mask
|= wxLIST_MASK_DATA
;
1404 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
1405 info
.m_mask
|= wxLIST_SET_ITEM
;
1406 info
.m_col
= lvItem
.iSubItem
;
1411 delete[] lvItem
.pszText
;
1413 lvItem
.mask
= oldMask
;
1416 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& lvItem
)
1418 lvItem
.iItem
= (int) info
.m_itemId
;
1420 lvItem
.iImage
= info
.m_image
;
1421 lvItem
.lParam
= info
.m_data
;
1422 lvItem
.stateMask
= 0;
1425 lvItem
.iSubItem
= info
.m_col
;
1427 if (info
.m_mask
& wxLIST_MASK_STATE
)
1429 lvItem
.mask
|= LVIF_STATE
;
1430 if (info
.m_stateMask
& wxLIST_STATE_CUT
)
1432 lvItem
.stateMask
|= LVIS_CUT
;
1433 if (info
.m_state
& wxLIST_STATE_CUT
)
1434 lvItem
.state
|= LVIS_CUT
;
1436 if (info
.m_stateMask
& wxLIST_STATE_DROPHILITED
)
1438 lvItem
.stateMask
|= LVIS_DROPHILITED
;
1439 if (info
.m_state
& wxLIST_STATE_DROPHILITED
)
1440 lvItem
.state
|= LVIS_DROPHILITED
;
1442 if (info
.m_stateMask
& wxLIST_STATE_FOCUSED
)
1444 lvItem
.stateMask
|= LVIS_FOCUSED
;
1445 if (info
.m_state
& wxLIST_STATE_FOCUSED
)
1446 lvItem
.state
|= LVIS_FOCUSED
;
1448 if (info
.m_stateMask
& wxLIST_STATE_SELECTED
)
1450 lvItem
.stateMask
|= LVIS_SELECTED
;
1451 if (info
.m_state
& wxLIST_STATE_SELECTED
)
1452 lvItem
.state
|= LVIS_SELECTED
;
1456 if (info
.m_mask
& wxLIST_MASK_TEXT
)
1458 lvItem
.mask
|= LVIF_TEXT
;
1459 if ( ctrl
->GetWindowStyleFlag() & wxLC_USER_TEXT
)
1461 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
1465 lvItem
.pszText
= (char *) (const char *)info
.m_text
;
1466 if ( lvItem
.pszText
)
1467 lvItem
.cchTextMax
= info
.m_text
.Length();
1469 lvItem
.cchTextMax
= 0;
1472 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
1473 lvItem
.mask
|= LVIF_IMAGE
;
1474 if (info
.m_mask
& wxLIST_MASK_DATA
)
1475 lvItem
.mask
|= LVIF_PARAM
;
1479 IMPLEMENT_DYNAMIC_CLASS(wxListEvent
, wxNotifyEvent
)
1481 wxListEvent::wxListEvent(wxEventType commandType
, int id
)
1482 : wxNotifyEvent(commandType
, id
)
1487 m_cancelled
= FALSE
;