1 /////////////////////////////////////////////////////////////////////////////
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "listctrl.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
37 #include "wx/listctrl.h"
40 #include "wx/msw/private.h"
43 #include "wx/msw/gnuwin32/extra.h"
48 // ----------------------------------------------------------------------------
50 // ----------------------------------------------------------------------------
52 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& tvItem
);
53 static void wxConvertFromMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& tvItem
, HWND getFullInfo
= 0);
55 // ----------------------------------------------------------------------------
57 // ----------------------------------------------------------------------------
59 #if !USE_SHARED_LIBRARY
60 IMPLEMENT_DYNAMIC_CLASS(wxListCtrl
, wxControl
)
61 IMPLEMENT_DYNAMIC_CLASS(wxListItem
, wxObject
)
62 #endif // USE_SHARED_LIBRARY
64 // ============================================================================
66 // ============================================================================
68 // ----------------------------------------------------------------------------
69 // wxListCtrl construction
70 // ----------------------------------------------------------------------------
72 wxListCtrl::wxListCtrl()
74 m_imageListNormal
= NULL
;
75 m_imageListSmall
= NULL
;
76 m_imageListState
= NULL
;
82 bool wxListCtrl::Create(wxWindow
*parent
,
87 const wxValidator
& validator
,
90 m_imageListNormal
= NULL
;
91 m_imageListSmall
= NULL
;
92 m_imageListState
= NULL
;
96 SetValidator(validator
);
104 m_windowStyle
= style
;
117 m_windowId
= (id
== -1) ? NewControlId() : id
;
119 DWORD wstyle
= WS_VISIBLE
| WS_CHILD
| WS_TABSTOP
|
120 LVS_SHAREIMAGELISTS
| LVS_SHOWSELALWAYS
;
121 if ( wxStyleHasBorder(m_windowStyle
) )
123 m_baseStyle
= wstyle
;
125 if ( !DoCreateControl(x
, y
, width
, height
) )
129 parent
->AddChild(this);
134 bool wxListCtrl::DoCreateControl(int x
, int y
, int w
, int h
)
136 DWORD wstyle
= m_baseStyle
;
139 WXDWORD exStyle
= Determine3DEffects(WS_EX_CLIENTEDGE
, &want3D
);
141 // Even with extended styles, need to combine with WS_BORDER
142 // for them to look right.
146 long oldStyle
= 0; // Dummy
147 wstyle
|= ConvertToMSWStyle(oldStyle
, m_windowStyle
);
149 // Create the ListView control.
150 m_hWnd
= (WXHWND
)CreateWindowEx(exStyle
,
155 GetWinHwnd(GetParent()),
162 wxLogError(_T("Can't create list control window."));
167 // for comctl32.dll v 4.70+ we want to have this attribute because it's
168 // prettier (and also because wxGTK does it like this)
169 #ifdef ListView_SetExtendedListViewStyle
170 if ( wstyle
& LVS_REPORT
)
172 ListView_SetExtendedListViewStyle(GetHwnd(),
173 LVS_EX_FULLROWSELECT
);
175 #endif // ListView_SetExtendedListViewStyle
177 wxSystemSettings settings
;
178 SetBackgroundColour(settings
.GetSystemColour(wxSYS_COLOUR_WINDOW
));
179 SetForegroundColour(GetParent()->GetForegroundColour());
186 void wxListCtrl::UpdateStyle()
190 // The new window view style
192 DWORD dwStyleNew
= ConvertToMSWStyle(dummy
, m_windowStyle
);
193 dwStyleNew
|= m_baseStyle
;
195 // Get the current window style.
196 DWORD dwStyleOld
= ::GetWindowLong(GetHwnd(), GWL_STYLE
);
198 // Only set the window style if the view bits have changed.
199 if ( dwStyleOld
!= dwStyleNew
)
201 ::SetWindowLong(GetHwnd(), GWL_STYLE
, dwStyleNew
);
206 wxListCtrl::~wxListCtrl()
210 m_textCtrl
->UnsubclassWin();
211 m_textCtrl
->SetHWND(0);
217 // ----------------------------------------------------------------------------
218 // set/get/change style
219 // ----------------------------------------------------------------------------
221 // Add or remove a single window style
222 void wxListCtrl::SetSingleStyle(long style
, bool add
)
224 long flag
= GetWindowStyleFlag();
226 // Get rid of conflicting styles
229 if ( style
& wxLC_MASK_TYPE
)
230 flag
= flag
& ~wxLC_MASK_TYPE
;
231 if ( style
& wxLC_MASK_ALIGN
)
232 flag
= flag
& ~wxLC_MASK_ALIGN
;
233 if ( style
& wxLC_MASK_SORT
)
234 flag
= flag
& ~wxLC_MASK_SORT
;
250 m_windowStyle
= flag
;
255 // Set the whole window style
256 void wxListCtrl::SetWindowStyleFlag(long flag
)
258 m_windowStyle
= flag
;
263 // Can be just a single style, or a bitlist
264 long wxListCtrl::ConvertToMSWStyle(long& oldStyle
, long style
) const
267 if ( style
& wxLC_ICON
)
269 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
270 oldStyle
-= LVS_SMALLICON
;
271 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
272 oldStyle
-= LVS_REPORT
;
273 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
274 oldStyle
-= LVS_LIST
;
278 if ( style
& wxLC_SMALL_ICON
)
280 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
281 oldStyle
-= LVS_ICON
;
282 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
283 oldStyle
-= LVS_REPORT
;
284 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
285 oldStyle
-= LVS_LIST
;
286 wstyle
|= LVS_SMALLICON
;
289 if ( style
& wxLC_LIST
)
291 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
292 oldStyle
-= LVS_ICON
;
293 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
294 oldStyle
-= LVS_REPORT
;
295 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
296 oldStyle
-= LVS_SMALLICON
;
300 if ( style
& wxLC_REPORT
)
302 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
303 oldStyle
-= LVS_ICON
;
304 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
305 oldStyle
-= LVS_LIST
;
306 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
307 oldStyle
-= LVS_SMALLICON
;
309 wstyle
|= LVS_REPORT
;
312 if ( style
& wxLC_ALIGN_LEFT
)
314 if ( oldStyle
& LVS_ALIGNTOP
)
315 oldStyle
-= LVS_ALIGNTOP
;
316 wstyle
|= LVS_ALIGNLEFT
;
319 if ( style
& wxLC_ALIGN_TOP
)
321 if ( oldStyle
& LVS_ALIGNLEFT
)
322 oldStyle
-= LVS_ALIGNLEFT
;
323 wstyle
|= LVS_ALIGNTOP
;
326 if ( style
& wxLC_AUTOARRANGE
)
327 wstyle
|= LVS_AUTOARRANGE
;
329 // Apparently, no such style (documentation wrong?)
331 if ( style & wxLC_BUTTON )
332 wstyle |= LVS_BUTTON;
335 if ( style
& wxLC_NO_SORT_HEADER
)
336 wstyle
|= LVS_NOSORTHEADER
;
338 if ( style
& wxLC_NO_HEADER
)
339 wstyle
|= LVS_NOCOLUMNHEADER
;
341 if ( style
& wxLC_EDIT_LABELS
)
342 wstyle
|= LVS_EDITLABELS
;
344 if ( style
& wxLC_SINGLE_SEL
)
345 wstyle
|= LVS_SINGLESEL
;
347 if ( style
& wxLC_SORT_ASCENDING
)
349 if ( oldStyle
& LVS_SORTDESCENDING
)
350 oldStyle
-= LVS_SORTDESCENDING
;
351 wstyle
|= LVS_SORTASCENDING
;
354 if ( style
& wxLC_SORT_DESCENDING
)
356 if ( oldStyle
& LVS_SORTASCENDING
)
357 oldStyle
-= LVS_SORTASCENDING
;
358 wstyle
|= LVS_SORTDESCENDING
;
364 // ----------------------------------------------------------------------------
366 // ----------------------------------------------------------------------------
368 // Sets the background colour (GetBackgroundColour already implicit in
370 bool wxListCtrl::SetBackgroundColour(const wxColour
& col
)
372 if ( !wxWindow::SetBackgroundColour(col
) )
375 ListView_SetBkColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
380 // Gets information about this column
381 bool wxListCtrl::GetColumn(int col
, wxListItem
& item
) const
386 lvCol
.pszText
= NULL
;
388 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
390 lvCol
.mask
|= LVCF_TEXT
;
391 lvCol
.pszText
= new wxChar
[513];
392 lvCol
.cchTextMax
= 512;
395 bool success
= (ListView_GetColumn(GetHwnd(), col
, & lvCol
) != 0);
397 // item.m_subItem = lvCol.iSubItem;
398 item
.m_width
= lvCol
.cx
;
400 if ( (item
.m_mask
& wxLIST_MASK_TEXT
) && lvCol
.pszText
)
402 item
.m_text
= lvCol
.pszText
;
403 delete[] lvCol
.pszText
;
406 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
408 if (lvCol
.fmt
== LVCFMT_LEFT
)
409 item
.m_format
= wxLIST_FORMAT_LEFT
;
410 else if (lvCol
.fmt
== LVCFMT_RIGHT
)
411 item
.m_format
= wxLIST_FORMAT_RIGHT
;
412 else if (lvCol
.fmt
== LVCFMT_CENTER
)
413 item
.m_format
= wxLIST_FORMAT_CENTRE
;
419 // Sets information about this column
420 bool wxListCtrl::SetColumn(int col
, wxListItem
& item
)
425 lvCol
.pszText
= NULL
;
427 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
429 lvCol
.mask
|= LVCF_TEXT
;
430 lvCol
.pszText
= WXSTRINGCAST item
.m_text
;
431 lvCol
.cchTextMax
= 0; // Ignored
433 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
435 lvCol
.mask
|= LVCF_FMT
;
437 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
438 lvCol
.fmt
= LVCFMT_LEFT
;
439 if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
440 lvCol
.fmt
= LVCFMT_RIGHT
;
441 if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
442 lvCol
.fmt
= LVCFMT_CENTER
;
445 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
447 lvCol
.mask
|= LVCF_WIDTH
;
448 lvCol
.cx
= item
.m_width
;
450 if ( lvCol
.cx
== wxLIST_AUTOSIZE
)
451 lvCol
.cx
= LVSCW_AUTOSIZE
;
452 else if ( lvCol
.cx
== wxLIST_AUTOSIZE_USEHEADER
)
453 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
455 lvCol
.mask
|= LVCF_SUBITEM
;
456 lvCol
.iSubItem
= col
;
457 return (ListView_SetColumn(GetHwnd(), col
, & lvCol
) != 0);
460 // Gets the column width
461 int wxListCtrl::GetColumnWidth(int col
) const
463 return ListView_GetColumnWidth(GetHwnd(), col
);
466 // Sets the column width
467 bool wxListCtrl::SetColumnWidth(int col
, int width
)
470 if ( m_windowStyle
& wxLC_LIST
)
474 if ( width2
== wxLIST_AUTOSIZE
)
475 width2
= LVSCW_AUTOSIZE
;
476 else if ( width2
== wxLIST_AUTOSIZE_USEHEADER
)
477 width2
= LVSCW_AUTOSIZE_USEHEADER
;
479 return (ListView_SetColumnWidth(GetHwnd(), col2
, width2
) != 0);
482 // Gets the number of items that can fit vertically in the
483 // visible area of the list control (list or report view)
484 // or the total number of items in the list control (icon
485 // or small icon view)
486 int wxListCtrl::GetCountPerPage(void) const
488 return ListView_GetCountPerPage(GetHwnd());
491 // Gets the edit control for editing labels.
492 wxTextCtrl
* wxListCtrl::GetEditControl(void) const
497 // Gets information about the item
498 bool wxListCtrl::GetItem(wxListItem
& info
) const
502 memset(&lvItem
, 0, sizeof(lvItem
));
504 ZeroMemory(&lvItem
, sizeof(lvItem
)); // must set all fields to 0
507 lvItem
.iItem
= info
.m_itemId
;
508 lvItem
.iSubItem
= info
.m_col
;
510 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
512 lvItem
.mask
|= LVIF_TEXT
;
513 lvItem
.pszText
= new wxChar
[513];
514 lvItem
.cchTextMax
= 512;
518 lvItem
.pszText
= NULL
;
521 if (info
.m_mask
& wxLIST_MASK_DATA
)
522 lvItem
.mask
|= LVIF_PARAM
;
524 if ( info
.m_mask
& wxLIST_MASK_STATE
)
526 lvItem
.mask
|= LVIF_STATE
;
527 // the other bits are hardly interesting anyhow
528 lvItem
.stateMask
= LVIS_SELECTED
| LVIS_FOCUSED
;
531 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
534 wxLogError(_("Couldn't retrieve information about list control item %d."),
539 wxConvertFromMSWListItem(this, info
, lvItem
);
543 delete[] lvItem
.pszText
;
548 // Sets information about the item
549 bool wxListCtrl::SetItem(wxListItem
& info
)
552 wxConvertToMSWListItem(this, info
, item
);
554 return (ListView_SetItem(GetHwnd(), &item
) != 0);
557 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
561 info
.m_mask
= wxLIST_MASK_TEXT
;
562 info
.m_itemId
= index
;
566 info
.m_image
= imageId
;
567 info
.m_mask
|= wxLIST_MASK_IMAGE
;
569 return SetItem(info
);
573 // Gets the item state
574 int wxListCtrl::GetItemState(long item
, long stateMask
) const
578 info
.m_mask
= wxLIST_MASK_STATE
;
579 info
.m_stateMask
= stateMask
;
580 info
.m_itemId
= item
;
588 // Sets the item state
589 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
593 info
.m_mask
= wxLIST_MASK_STATE
;
594 info
.m_state
= state
;
595 info
.m_stateMask
= stateMask
;
596 info
.m_itemId
= item
;
598 return SetItem(info
);
601 // Sets the item image
602 bool wxListCtrl::SetItemImage(long item
, int image
, int selImage
)
606 info
.m_mask
= wxLIST_MASK_IMAGE
;
607 info
.m_image
= image
;
608 info
.m_itemId
= item
;
610 return SetItem(info
);
613 // Gets the item text
614 wxString
wxListCtrl::GetItemText(long item
) const
618 info
.m_mask
= wxLIST_MASK_TEXT
;
619 info
.m_itemId
= item
;
626 // Sets the item text
627 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
631 info
.m_mask
= wxLIST_MASK_TEXT
;
632 info
.m_itemId
= item
;
638 // Gets the item data
639 long wxListCtrl::GetItemData(long item
) const
643 info
.m_mask
= wxLIST_MASK_DATA
;
644 info
.m_itemId
= item
;
651 // Sets the item data
652 bool wxListCtrl::SetItemData(long item
, long data
)
656 info
.m_mask
= wxLIST_MASK_DATA
;
657 info
.m_itemId
= item
;
660 return SetItem(info
);
663 // Gets the item rectangle
664 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
668 int code2
= LVIR_BOUNDS
;
669 if ( code
== wxLIST_RECT_BOUNDS
)
671 else if ( code
== wxLIST_RECT_ICON
)
673 else if ( code
== wxLIST_RECT_LABEL
)
677 bool success
= (ListView_GetItemRect(GetHwnd(), (int) item
, &rect2
) != 0);
679 bool success
= (ListView_GetItemRect(GetHwnd(), (int) item
, &rect2
, code2
) != 0);
684 rect
.width
= rect2
.right
- rect2
.left
;
685 rect
.height
= rect2
.bottom
- rect2
.left
;
689 // Gets the item position
690 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
694 bool success
= (ListView_GetItemPosition(GetHwnd(), (int) item
, &pt
) != 0);
696 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
700 // Sets the item position.
701 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
703 return (ListView_SetItemPosition(GetHwnd(), (int) item
, pos
.x
, pos
.y
) != 0);
706 // Gets the number of items in the list control
707 int wxListCtrl::GetItemCount(void) const
709 return ListView_GetItemCount(GetHwnd());
712 // Retrieves the spacing between icons in pixels.
713 // If small is TRUE, gets the spacing for the small icon
714 // view, otherwise the large icon view.
715 int wxListCtrl::GetItemSpacing(bool isSmall
) const
717 return ListView_GetItemSpacing(GetHwnd(), (BOOL
) isSmall
);
720 // Gets the number of selected items in the list control
721 int wxListCtrl::GetSelectedItemCount(void) const
723 return ListView_GetSelectedCount(GetHwnd());
726 // Gets the text colour of the listview
727 wxColour
wxListCtrl::GetTextColour(void) const
729 COLORREF ref
= ListView_GetTextColor(GetHwnd());
730 wxColour
col(GetRValue(ref
), GetGValue(ref
), GetBValue(ref
));
734 // Sets the text colour of the listview
735 void wxListCtrl::SetTextColour(const wxColour
& col
)
737 ListView_SetTextColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Blue(), col
.Green()));
740 // Gets the index of the topmost visible item when in
741 // list or report view
742 long wxListCtrl::GetTopItem(void) const
744 return (long) ListView_GetTopIndex(GetHwnd());
747 // Searches for an item, starting from 'item'.
748 // 'geometry' is one of
749 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
750 // 'state' is a state bit flag, one or more of
751 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
752 // item can be -1 to find the first item that matches the
754 // Returns the item or -1 if unsuccessful.
755 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
759 if ( geom
== wxLIST_NEXT_ABOVE
)
761 if ( geom
== wxLIST_NEXT_ALL
)
763 if ( geom
== wxLIST_NEXT_BELOW
)
765 if ( geom
== wxLIST_NEXT_LEFT
)
766 flags
|= LVNI_TOLEFT
;
767 if ( geom
== wxLIST_NEXT_RIGHT
)
768 flags
|= LVNI_TORIGHT
;
770 if ( state
& wxLIST_STATE_CUT
)
772 if ( state
& wxLIST_STATE_DROPHILITED
)
773 flags
|= LVNI_DROPHILITED
;
774 if ( state
& wxLIST_STATE_FOCUSED
)
775 flags
|= LVNI_FOCUSED
;
776 if ( state
& wxLIST_STATE_SELECTED
)
777 flags
|= LVNI_SELECTED
;
779 return (long) ListView_GetNextItem(GetHwnd(), item
, flags
);
783 wxImageList
*wxListCtrl::GetImageList(int which
) const
785 if ( which
== wxIMAGE_LIST_NORMAL
)
787 return m_imageListNormal
;
789 else if ( which
== wxIMAGE_LIST_SMALL
)
791 return m_imageListSmall
;
793 else if ( which
== wxIMAGE_LIST_STATE
)
795 return m_imageListState
;
800 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
803 if ( which
== wxIMAGE_LIST_NORMAL
)
805 flags
= LVSIL_NORMAL
;
806 m_imageListNormal
= imageList
;
808 else if ( which
== wxIMAGE_LIST_SMALL
)
811 m_imageListSmall
= imageList
;
813 else if ( which
== wxIMAGE_LIST_STATE
)
816 m_imageListState
= imageList
;
818 ListView_SetImageList(GetHwnd(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
821 // ----------------------------------------------------------------------------
823 // ----------------------------------------------------------------------------
825 // Arranges the items
826 bool wxListCtrl::Arrange(int flag
)
829 if ( flag
== wxLIST_ALIGN_LEFT
)
830 code
= LVA_ALIGNLEFT
;
831 else if ( flag
== wxLIST_ALIGN_TOP
)
833 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
835 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
836 code
= LVA_SNAPTOGRID
;
838 return (ListView_Arrange(GetHwnd(), code
) != 0);
842 bool wxListCtrl::DeleteItem(long item
)
844 return (ListView_DeleteItem(GetHwnd(), (int) item
) != 0);
848 bool wxListCtrl::DeleteAllItems()
850 return (ListView_DeleteAllItems(GetHwnd()) != 0);
854 bool wxListCtrl::DeleteAllColumns()
856 while ( m_colCount
> 0 )
858 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
860 wxLogLastError("ListView_DeleteColumn");
868 wxASSERT_MSG( m_colCount
== 0, _T("no columns should be left") );
874 bool wxListCtrl::DeleteColumn(int col
)
876 bool success
= (ListView_DeleteColumn(GetHwnd(), col
) != 0);
878 if ( success
&& (m_colCount
> 0) )
883 // Clears items, and columns if there are any.
884 void wxListCtrl::ClearAll()
887 if ( m_colCount
> 0 )
891 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
893 wxASSERT( (textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
))) );
895 HWND hWnd
= (HWND
) ListView_EditLabel(GetHwnd(), item
);
899 m_textCtrl
->UnsubclassWin();
900 m_textCtrl
->SetHWND(0);
905 m_textCtrl
= (wxTextCtrl
*) textControlClass
->CreateObject();
906 m_textCtrl
->SetHWND((WXHWND
) hWnd
);
907 m_textCtrl
->SubclassWin((WXHWND
) hWnd
);
912 // End label editing, optionally cancelling the edit
913 bool wxListCtrl::EndEditLabel(bool cancel
)
917 /* I don't know how to implement this: there's no such macro as ListView_EndEditLabelNow.
919 bool success = (ListView_EndEditLabelNow(GetHwnd(), cancel) != 0);
923 m_textCtrl->UnsubclassWin();
924 m_textCtrl->SetHWND(0);
934 // Ensures this item is visible
935 bool wxListCtrl::EnsureVisible(long item
)
937 return (ListView_EnsureVisible(GetHwnd(), (int) item
, FALSE
) != 0);
940 // Find an item whose label matches this string, starting from the item after 'start'
941 // or the beginning if 'start' is -1.
942 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
944 LV_FINDINFO findInfo
;
946 findInfo
.flags
= LVFI_STRING
;
948 findInfo
.flags
|= LVFI_STRING
;
949 findInfo
.psz
= WXSTRINGCAST str
;
951 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
954 // Find an item whose data matches this data, starting from the item after 'start'
955 // or the beginning if 'start' is -1.
956 long wxListCtrl::FindItem(long start
, long data
)
958 LV_FINDINFO findInfo
;
960 findInfo
.flags
= LVFI_PARAM
;
961 findInfo
.lParam
= data
;
963 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
966 // Find an item nearest this position in the specified direction, starting from
967 // the item after 'start' or the beginning if 'start' is -1.
968 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
970 LV_FINDINFO findInfo
;
972 findInfo
.flags
= LVFI_NEARESTXY
;
973 findInfo
.pt
.x
= pt
.x
;
974 findInfo
.pt
.y
= pt
.y
;
975 findInfo
.vkDirection
= VK_RIGHT
;
977 if ( direction
== wxLIST_FIND_UP
)
978 findInfo
.vkDirection
= VK_UP
;
979 else if ( direction
== wxLIST_FIND_DOWN
)
980 findInfo
.vkDirection
= VK_DOWN
;
981 else if ( direction
== wxLIST_FIND_LEFT
)
982 findInfo
.vkDirection
= VK_LEFT
;
983 else if ( direction
== wxLIST_FIND_RIGHT
)
984 findInfo
.vkDirection
= VK_RIGHT
;
986 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
989 // Determines which item (if any) is at the specified point,
990 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
991 long wxListCtrl::HitTest(const wxPoint
& point
, int& flags
)
993 LV_HITTESTINFO hitTestInfo
;
994 hitTestInfo
.pt
.x
= (int) point
.x
;
995 hitTestInfo
.pt
.y
= (int) point
.y
;
997 ListView_HitTest(GetHwnd(), & hitTestInfo
);
1000 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
1001 flags
|= wxLIST_HITTEST_ABOVE
;
1002 if ( hitTestInfo
.flags
& LVHT_BELOW
)
1003 flags
|= wxLIST_HITTEST_BELOW
;
1004 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
1005 flags
|= wxLIST_HITTEST_NOWHERE
;
1006 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
1007 flags
|= wxLIST_HITTEST_ONITEMICON
;
1008 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
1009 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
1010 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
1011 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
1012 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
1013 flags
|= wxLIST_HITTEST_TOLEFT
;
1014 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
1015 flags
|= wxLIST_HITTEST_TORIGHT
;
1017 return (long) hitTestInfo
.iItem
;
1020 // Inserts an item, returning the index of the new item if successful,
1022 long wxListCtrl::InsertItem(wxListItem
& info
)
1025 wxConvertToMSWListItem(this, info
, item
);
1027 return (long) ListView_InsertItem(GetHwnd(), & item
);
1030 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1033 info
.m_text
= label
;
1034 info
.m_mask
= wxLIST_MASK_TEXT
;
1035 info
.m_itemId
= index
;
1036 return InsertItem(info
);
1039 // Inserts an image item
1040 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1043 info
.m_image
= imageIndex
;
1044 info
.m_mask
= wxLIST_MASK_IMAGE
;
1045 info
.m_itemId
= index
;
1046 return InsertItem(info
);
1049 // Inserts an image/string item
1050 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1053 info
.m_image
= imageIndex
;
1054 info
.m_text
= label
;
1055 info
.m_mask
= wxLIST_MASK_IMAGE
| wxLIST_MASK_TEXT
;
1056 info
.m_itemId
= index
;
1057 return InsertItem(info
);
1060 // For list view mode (only), inserts a column.
1061 long wxListCtrl::InsertColumn(long col
, wxListItem
& item
)
1066 lvCol
.pszText
= NULL
;
1068 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
1070 lvCol
.mask
|= LVCF_TEXT
;
1071 lvCol
.pszText
= WXSTRINGCAST item
.m_text
;
1072 lvCol
.cchTextMax
= 0; // Ignored
1074 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
1076 lvCol
.mask
|= LVCF_FMT
;
1078 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
1079 lvCol
.fmt
= LVCFMT_LEFT
;
1080 if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
1081 lvCol
.fmt
= LVCFMT_RIGHT
;
1082 if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
1083 lvCol
.fmt
= LVCFMT_CENTER
;
1086 lvCol
.mask
|= LVCF_WIDTH
;
1087 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
1089 if ( item
.m_width
== wxLIST_AUTOSIZE
)
1090 lvCol
.cx
= LVSCW_AUTOSIZE
;
1091 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
1092 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
1094 lvCol
.cx
= item
.m_width
;
1098 // always give some width to the new column: this one is compatible
1103 lvCol
.mask
|= LVCF_SUBITEM
;
1104 lvCol
.iSubItem
= col
;
1106 bool success
= ListView_InsertColumn(GetHwnd(), col
, & lvCol
) != -1;
1113 wxLogDebug(_T("Failed to insert the column '%s' into listview!"),
1120 long wxListCtrl::InsertColumn(long col
, const wxString
& heading
, int format
,
1124 item
.m_mask
= wxLIST_MASK_TEXT
| wxLIST_MASK_FORMAT
;
1125 item
.m_text
= heading
;
1128 item
.m_mask
|= wxLIST_MASK_WIDTH
;
1129 item
.m_width
= width
;
1131 item
.m_format
= format
;
1133 return InsertColumn(col
, item
);
1136 // Scrolls the list control. If in icon, small icon or report view mode,
1137 // x specifies the number of pixels to scroll. If in list view mode, x
1138 // specifies the number of columns to scroll.
1139 // If in icon, small icon or list view mode, y specifies the number of pixels
1140 // to scroll. If in report view mode, y specifies the number of lines to scroll.
1141 bool wxListCtrl::ScrollList(int dx
, int dy
)
1143 return (ListView_Scroll(GetHwnd(), dx
, dy
) != 0);
1148 // fn is a function which takes 3 long arguments: item1, item2, data.
1149 // item1 is the long data associated with a first item (NOT the index).
1150 // item2 is the long data associated with a second item (NOT the index).
1151 // data is the same value as passed to SortItems.
1152 // The return value is a negative number if the first item should precede the second
1153 // item, a positive number of the second item should precede the first,
1154 // or zero if the two items are equivalent.
1156 // data is arbitrary data to be passed to the sort function.
1157 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, long data
)
1159 return (ListView_SortItems(GetHwnd(), (PFNLVCOMPARE
) fn
, data
) != 0);
1162 // ----------------------------------------------------------------------------
1163 // message processing
1164 // ----------------------------------------------------------------------------
1166 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1168 if (cmd
== EN_UPDATE
)
1170 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1171 event
.SetEventObject( this );
1172 ProcessCommand(event
);
1175 else if (cmd
== EN_KILLFOCUS
)
1177 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1178 event
.SetEventObject( this );
1179 ProcessCommand(event
);
1186 bool wxListCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
1188 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1189 wxEventType eventType
= wxEVT_NULL
;
1190 NMHDR
*hdr1
= (NMHDR
*) lParam
;
1191 switch ( hdr1
->code
)
1193 case LVN_BEGINRDRAG
:
1194 eventType
= wxEVT_COMMAND_LIST_BEGIN_RDRAG
;
1198 if ( eventType
== wxEVT_NULL
)
1200 eventType
= wxEVT_COMMAND_LIST_BEGIN_DRAG
;
1204 NM_LISTVIEW
*hdr
= (NM_LISTVIEW
*)lParam
;
1205 event
.m_itemIndex
= hdr
->iItem
;
1206 event
.m_pointDrag
.x
= hdr
->ptAction
.x
;
1207 event
.m_pointDrag
.y
= hdr
->ptAction
.y
;
1211 case LVN_BEGINLABELEDIT
:
1213 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1214 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1215 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, GetHwnd());
1219 case LVN_COLUMNCLICK
:
1221 eventType
= wxEVT_COMMAND_LIST_COL_CLICK
;
1222 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1223 event
.m_itemIndex
= -1;
1224 event
.m_col
= hdr
->iSubItem
;
1227 case LVN_DELETEALLITEMS
:
1229 eventType
= wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
;
1230 // NM_LISTVIEW* hdr = (NM_LISTVIEW*)lParam;
1231 event
.m_itemIndex
= -1;
1234 case LVN_DELETEITEM
:
1236 eventType
= wxEVT_COMMAND_LIST_DELETE_ITEM
;
1237 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1238 event
.m_itemIndex
= hdr
->iItem
;
1241 case LVN_ENDLABELEDIT
:
1243 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1244 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1245 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, GetHwnd());
1246 if ( info
->item
.pszText
== NULL
|| info
->item
.iItem
== -1 )
1247 event
.m_cancelled
= TRUE
;
1250 case LVN_GETDISPINFO
:
1253 // this provokes stack overflow: indeed, wxConvertFromMSWListItem()
1254 // sends us WM_NOTIFY! As it doesn't do anything for now, just leave
1258 // TODO: some text buffering here, I think
1259 // TODO: API for getting Windows to retrieve values
1261 eventType
= wxEVT_COMMAND_LIST_GET_INFO
;
1262 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1263 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, GetHwnd());
1268 case LVN_INSERTITEM
:
1270 eventType
= wxEVT_COMMAND_LIST_INSERT_ITEM
;
1271 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1272 event
.m_itemIndex
= hdr
->iItem
;
1275 case LVN_ITEMCHANGED
:
1277 // This needs to be sent to wxListCtrl as a rather more
1278 // concrete event. For now, just detect a selection
1280 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1281 if ( (hdr
->uNewState
& LVIS_SELECTED
) && !(hdr
->uOldState
& LVIS_SELECTED
) )
1283 eventType
= wxEVT_COMMAND_LIST_ITEM_SELECTED
;
1284 event
.m_itemIndex
= hdr
->iItem
;
1286 else if ( !(hdr
->uNewState
& LVIS_SELECTED
) && (hdr
->uOldState
& LVIS_SELECTED
) )
1288 eventType
= wxEVT_COMMAND_LIST_ITEM_DESELECTED
;
1289 event
.m_itemIndex
= hdr
->iItem
;
1298 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
1299 WORD wVKey
= info
->wVKey
;
1301 // get the current selection
1302 long lItem
= GetNextItem(-1,
1304 wxLIST_STATE_SELECTED
);
1306 // <Enter> or <Space> activate the selected item if any
1307 if ( lItem
!= -1 && (wVKey
== VK_RETURN
|| wVKey
== VK_SPACE
) )
1309 // TODO this behaviour probably should be optional
1310 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
1311 event
.m_itemIndex
= lItem
;
1315 eventType
= wxEVT_COMMAND_LIST_KEY_DOWN
;
1316 event
.m_code
= wxCharCodeMSWToWX(wVKey
);
1322 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
1324 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
1329 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
1330 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
1333 case LVN_SETDISPINFO
:
1335 eventType
= wxEVT_COMMAND_LIST_SET_INFO
;
1336 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1337 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, GetHwnd());
1342 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1345 event
.SetEventObject( this );
1346 event
.SetEventType(eventType
);
1348 if ( !GetEventHandler()->ProcessEvent(event
) )
1351 if (hdr1
->code
== LVN_GETDISPINFO
)
1353 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1354 if ( info
->item
.mask
& LVIF_TEXT
)
1356 if ( !event
.m_item
.m_text
.IsNull() )
1358 info
->item
.pszText
= AddPool(event
.m_item
.m_text
);
1359 info
->item
.cchTextMax
= wxStrlen(info
->item
.pszText
) + 1;
1362 // wxConvertToMSWListItem(this, event.m_item, info->item);
1365 *result
= !event
.IsAllowed();
1370 wxChar
*wxListCtrl::AddPool(const wxString
& str
)
1372 // Remove the first element if 3 strings exist
1373 if ( m_stringPool
.Number() == 3 )
1375 wxNode
*node
= m_stringPool
.First();
1376 delete[] (char *)node
->Data();
1379 wxNode
*node
= m_stringPool
.Add(WXSTRINGCAST str
);
1380 return (wxChar
*)node
->Data();
1383 // ----------------------------------------------------------------------------
1385 // ----------------------------------------------------------------------------
1387 // List item structure
1388 wxListItem::wxListItem()
1398 m_format
= wxLIST_FORMAT_CENTRE
;
1402 static void wxConvertFromMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& lvItem
, HWND getFullInfo
)
1404 info
.m_data
= lvItem
.lParam
;
1407 info
.m_stateMask
= 0;
1408 info
.m_itemId
= lvItem
.iItem
;
1410 long oldMask
= lvItem
.mask
;
1412 bool needText
= FALSE
;
1413 if (getFullInfo
!= 0)
1415 if ( lvItem
.mask
& LVIF_TEXT
)
1422 lvItem
.pszText
= new wxChar
[513];
1423 lvItem
.cchTextMax
= 512;
1425 // lvItem.mask |= TVIF_HANDLE | TVIF_STATE | TVIF_TEXT | TVIF_IMAGE | TVIF_SELECTEDIMAGE | TVIF_CHILDREN | TVIF_PARAM;
1426 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
1427 ::SendMessage(getFullInfo
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
);
1430 if ( lvItem
.mask
& LVIF_STATE
)
1432 info
.m_mask
|= wxLIST_MASK_STATE
;
1434 if ( lvItem
.stateMask
& LVIS_CUT
)
1436 info
.m_stateMask
|= wxLIST_STATE_CUT
;
1437 if ( lvItem
.state
& LVIS_CUT
)
1438 info
.m_state
|= wxLIST_STATE_CUT
;
1440 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
1442 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
1443 if ( lvItem
.state
& LVIS_DROPHILITED
)
1444 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
1446 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
1448 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
1449 if ( lvItem
.state
& LVIS_FOCUSED
)
1450 info
.m_state
|= wxLIST_STATE_FOCUSED
;
1452 if ( lvItem
.stateMask
& LVIS_SELECTED
)
1454 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
1455 if ( lvItem
.state
& LVIS_SELECTED
)
1456 info
.m_state
|= wxLIST_STATE_SELECTED
;
1460 if ( lvItem
.mask
& LVIF_TEXT
)
1462 info
.m_mask
|= wxLIST_MASK_TEXT
;
1463 info
.m_text
= lvItem
.pszText
;
1465 if ( lvItem
.mask
& LVIF_IMAGE
)
1467 info
.m_mask
|= wxLIST_MASK_IMAGE
;
1468 info
.m_image
= lvItem
.iImage
;
1470 if ( lvItem
.mask
& LVIF_PARAM
)
1471 info
.m_mask
|= wxLIST_MASK_DATA
;
1472 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
1473 info
.m_mask
|= wxLIST_SET_ITEM
;
1474 info
.m_col
= lvItem
.iSubItem
;
1479 delete[] lvItem
.pszText
;
1481 lvItem
.mask
= oldMask
;
1484 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& lvItem
)
1486 lvItem
.iItem
= (int) info
.m_itemId
;
1488 lvItem
.iImage
= info
.m_image
;
1489 lvItem
.lParam
= info
.m_data
;
1490 lvItem
.stateMask
= 0;
1493 lvItem
.iSubItem
= info
.m_col
;
1495 if (info
.m_mask
& wxLIST_MASK_STATE
)
1497 lvItem
.mask
|= LVIF_STATE
;
1498 if (info
.m_stateMask
& wxLIST_STATE_CUT
)
1500 lvItem
.stateMask
|= LVIS_CUT
;
1501 if (info
.m_state
& wxLIST_STATE_CUT
)
1502 lvItem
.state
|= LVIS_CUT
;
1504 if (info
.m_stateMask
& wxLIST_STATE_DROPHILITED
)
1506 lvItem
.stateMask
|= LVIS_DROPHILITED
;
1507 if (info
.m_state
& wxLIST_STATE_DROPHILITED
)
1508 lvItem
.state
|= LVIS_DROPHILITED
;
1510 if (info
.m_stateMask
& wxLIST_STATE_FOCUSED
)
1512 lvItem
.stateMask
|= LVIS_FOCUSED
;
1513 if (info
.m_state
& wxLIST_STATE_FOCUSED
)
1514 lvItem
.state
|= LVIS_FOCUSED
;
1516 if (info
.m_stateMask
& wxLIST_STATE_SELECTED
)
1518 lvItem
.stateMask
|= LVIS_SELECTED
;
1519 if (info
.m_state
& wxLIST_STATE_SELECTED
)
1520 lvItem
.state
|= LVIS_SELECTED
;
1524 if (info
.m_mask
& wxLIST_MASK_TEXT
)
1526 lvItem
.mask
|= LVIF_TEXT
;
1527 if ( ctrl
->GetWindowStyleFlag() & wxLC_USER_TEXT
)
1529 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
1533 lvItem
.pszText
= WXSTRINGCAST info
.m_text
;
1534 if ( lvItem
.pszText
)
1535 lvItem
.cchTextMax
= info
.m_text
.Length();
1537 lvItem
.cchTextMax
= 0;
1540 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
1541 lvItem
.mask
|= LVIF_IMAGE
;
1542 if (info
.m_mask
& wxLIST_MASK_DATA
)
1543 lvItem
.mask
|= LVIF_PARAM
;
1546 // ----------------------------------------------------------------------------
1548 // ----------------------------------------------------------------------------
1550 IMPLEMENT_DYNAMIC_CLASS(wxListEvent
, wxNotifyEvent
)
1552 wxListEvent::wxListEvent(wxEventType commandType
, int id
)
1553 : wxNotifyEvent(commandType
, id
)
1558 m_cancelled
= FALSE
;