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"
42 #if defined(__GNUWIN32__) && !defined(wxUSE_NORLANDER_HEADERS)
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 SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW
));
178 SetForegroundColour(GetParent()->GetForegroundColour());
185 void wxListCtrl::UpdateStyle()
189 // The new window view style
191 DWORD dwStyleNew
= ConvertToMSWStyle(dummy
, m_windowStyle
);
192 dwStyleNew
|= m_baseStyle
;
194 // Get the current window style.
195 DWORD dwStyleOld
= ::GetWindowLong(GetHwnd(), GWL_STYLE
);
197 // Only set the window style if the view bits have changed.
198 if ( dwStyleOld
!= dwStyleNew
)
200 ::SetWindowLong(GetHwnd(), GWL_STYLE
, dwStyleNew
);
205 wxListCtrl::~wxListCtrl()
209 m_textCtrl
->UnsubclassWin();
210 m_textCtrl
->SetHWND(0);
216 // ----------------------------------------------------------------------------
217 // set/get/change style
218 // ----------------------------------------------------------------------------
220 // Add or remove a single window style
221 void wxListCtrl::SetSingleStyle(long style
, bool add
)
223 long flag
= GetWindowStyleFlag();
225 // Get rid of conflicting styles
228 if ( style
& wxLC_MASK_TYPE
)
229 flag
= flag
& ~wxLC_MASK_TYPE
;
230 if ( style
& wxLC_MASK_ALIGN
)
231 flag
= flag
& ~wxLC_MASK_ALIGN
;
232 if ( style
& wxLC_MASK_SORT
)
233 flag
= flag
& ~wxLC_MASK_SORT
;
249 m_windowStyle
= flag
;
254 // Set the whole window style
255 void wxListCtrl::SetWindowStyleFlag(long flag
)
257 m_windowStyle
= flag
;
262 // Can be just a single style, or a bitlist
263 long wxListCtrl::ConvertToMSWStyle(long& oldStyle
, long style
) const
266 if ( style
& wxLC_ICON
)
268 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
269 oldStyle
-= LVS_SMALLICON
;
270 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
271 oldStyle
-= LVS_REPORT
;
272 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
273 oldStyle
-= LVS_LIST
;
277 if ( style
& wxLC_SMALL_ICON
)
279 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
280 oldStyle
-= LVS_ICON
;
281 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
282 oldStyle
-= LVS_REPORT
;
283 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
284 oldStyle
-= LVS_LIST
;
285 wstyle
|= LVS_SMALLICON
;
288 if ( style
& wxLC_LIST
)
290 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
291 oldStyle
-= LVS_ICON
;
292 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_REPORT
)
293 oldStyle
-= LVS_REPORT
;
294 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
295 oldStyle
-= LVS_SMALLICON
;
299 if ( style
& wxLC_REPORT
)
301 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_ICON
)
302 oldStyle
-= LVS_ICON
;
303 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_LIST
)
304 oldStyle
-= LVS_LIST
;
305 if ( (oldStyle
& LVS_TYPEMASK
) == LVS_SMALLICON
)
306 oldStyle
-= LVS_SMALLICON
;
308 wstyle
|= LVS_REPORT
;
311 if ( style
& wxLC_ALIGN_LEFT
)
313 if ( oldStyle
& LVS_ALIGNTOP
)
314 oldStyle
-= LVS_ALIGNTOP
;
315 wstyle
|= LVS_ALIGNLEFT
;
318 if ( style
& wxLC_ALIGN_TOP
)
320 if ( oldStyle
& LVS_ALIGNLEFT
)
321 oldStyle
-= LVS_ALIGNLEFT
;
322 wstyle
|= LVS_ALIGNTOP
;
325 if ( style
& wxLC_AUTOARRANGE
)
326 wstyle
|= LVS_AUTOARRANGE
;
328 // Apparently, no such style (documentation wrong?)
330 if ( style & wxLC_BUTTON )
331 wstyle |= LVS_BUTTON;
334 if ( style
& wxLC_NO_SORT_HEADER
)
335 wstyle
|= LVS_NOSORTHEADER
;
337 if ( style
& wxLC_NO_HEADER
)
338 wstyle
|= LVS_NOCOLUMNHEADER
;
340 if ( style
& wxLC_EDIT_LABELS
)
341 wstyle
|= LVS_EDITLABELS
;
343 if ( style
& wxLC_SINGLE_SEL
)
344 wstyle
|= LVS_SINGLESEL
;
346 if ( style
& wxLC_SORT_ASCENDING
)
348 if ( oldStyle
& LVS_SORTDESCENDING
)
349 oldStyle
-= LVS_SORTDESCENDING
;
350 wstyle
|= LVS_SORTASCENDING
;
353 if ( style
& wxLC_SORT_DESCENDING
)
355 if ( oldStyle
& LVS_SORTASCENDING
)
356 oldStyle
-= LVS_SORTASCENDING
;
357 wstyle
|= LVS_SORTDESCENDING
;
363 // ----------------------------------------------------------------------------
365 // ----------------------------------------------------------------------------
367 // Sets the background colour (GetBackgroundColour already implicit in
369 bool wxListCtrl::SetBackgroundColour(const wxColour
& col
)
371 if ( !wxWindow::SetBackgroundColour(col
) )
374 ListView_SetBkColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
379 // Gets information about this column
380 bool wxListCtrl::GetColumn(int col
, wxListItem
& item
) const
385 lvCol
.pszText
= NULL
;
387 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
389 lvCol
.mask
|= LVCF_TEXT
;
390 lvCol
.pszText
= new wxChar
[513];
391 lvCol
.cchTextMax
= 512;
394 bool success
= (ListView_GetColumn(GetHwnd(), col
, & lvCol
) != 0);
396 // item.m_subItem = lvCol.iSubItem;
397 item
.m_width
= lvCol
.cx
;
399 if ( (item
.m_mask
& wxLIST_MASK_TEXT
) && lvCol
.pszText
)
401 item
.m_text
= lvCol
.pszText
;
402 delete[] lvCol
.pszText
;
405 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
407 if (lvCol
.fmt
== LVCFMT_LEFT
)
408 item
.m_format
= wxLIST_FORMAT_LEFT
;
409 else if (lvCol
.fmt
== LVCFMT_RIGHT
)
410 item
.m_format
= wxLIST_FORMAT_RIGHT
;
411 else if (lvCol
.fmt
== LVCFMT_CENTER
)
412 item
.m_format
= wxLIST_FORMAT_CENTRE
;
418 // Sets information about this column
419 bool wxListCtrl::SetColumn(int col
, wxListItem
& item
)
424 lvCol
.pszText
= NULL
;
426 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
428 lvCol
.mask
|= LVCF_TEXT
;
429 lvCol
.pszText
= WXSTRINGCAST item
.m_text
;
430 lvCol
.cchTextMax
= 0; // Ignored
432 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
434 lvCol
.mask
|= LVCF_FMT
;
436 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
437 lvCol
.fmt
= LVCFMT_LEFT
;
438 if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
439 lvCol
.fmt
= LVCFMT_RIGHT
;
440 if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
441 lvCol
.fmt
= LVCFMT_CENTER
;
444 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
446 lvCol
.mask
|= LVCF_WIDTH
;
447 lvCol
.cx
= item
.m_width
;
449 if ( lvCol
.cx
== wxLIST_AUTOSIZE
)
450 lvCol
.cx
= LVSCW_AUTOSIZE
;
451 else if ( lvCol
.cx
== wxLIST_AUTOSIZE_USEHEADER
)
452 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
454 lvCol
.mask
|= LVCF_SUBITEM
;
455 lvCol
.iSubItem
= col
;
456 return (ListView_SetColumn(GetHwnd(), col
, & lvCol
) != 0);
459 // Gets the column width
460 int wxListCtrl::GetColumnWidth(int col
) const
462 return ListView_GetColumnWidth(GetHwnd(), col
);
465 // Sets the column width
466 bool wxListCtrl::SetColumnWidth(int col
, int width
)
469 if ( m_windowStyle
& wxLC_LIST
)
473 if ( width2
== wxLIST_AUTOSIZE
)
474 width2
= LVSCW_AUTOSIZE
;
475 else if ( width2
== wxLIST_AUTOSIZE_USEHEADER
)
476 width2
= LVSCW_AUTOSIZE_USEHEADER
;
478 return (ListView_SetColumnWidth(GetHwnd(), col2
, width2
) != 0);
481 // Gets the number of items that can fit vertically in the
482 // visible area of the list control (list or report view)
483 // or the total number of items in the list control (icon
484 // or small icon view)
485 int wxListCtrl::GetCountPerPage(void) const
487 return ListView_GetCountPerPage(GetHwnd());
490 // Gets the edit control for editing labels.
491 wxTextCtrl
* wxListCtrl::GetEditControl(void) const
496 // Gets information about the item
497 bool wxListCtrl::GetItem(wxListItem
& info
) const
501 memset(&lvItem
, 0, sizeof(lvItem
));
503 ZeroMemory(&lvItem
, sizeof(lvItem
)); // must set all fields to 0
506 lvItem
.iItem
= info
.m_itemId
;
507 lvItem
.iSubItem
= info
.m_col
;
509 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
511 lvItem
.mask
|= LVIF_TEXT
;
512 lvItem
.pszText
= new wxChar
[513];
513 lvItem
.cchTextMax
= 512;
517 lvItem
.pszText
= NULL
;
520 if (info
.m_mask
& wxLIST_MASK_DATA
)
521 lvItem
.mask
|= LVIF_PARAM
;
523 if ( info
.m_mask
& wxLIST_MASK_STATE
)
525 lvItem
.mask
|= LVIF_STATE
;
526 // the other bits are hardly interesting anyhow
527 lvItem
.stateMask
= LVIS_SELECTED
| LVIS_FOCUSED
;
530 bool success
= ListView_GetItem((HWND
)GetHWND(), &lvItem
) != 0;
533 wxLogError(_("Couldn't retrieve information about list control item %d."),
538 wxConvertFromMSWListItem(this, info
, lvItem
);
542 delete[] lvItem
.pszText
;
547 // Sets information about the item
548 bool wxListCtrl::SetItem(wxListItem
& info
)
551 wxConvertToMSWListItem(this, info
, item
);
553 bool ok
= ListView_SetItem(GetHwnd(), &item
) != 0;
554 if ( ok
&& (info
.m_mask
& wxLIST_MASK_IMAGE
) )
556 // make the change visible
557 ListView_Update(GetHwnd(), item
.iItem
);
563 long wxListCtrl::SetItem(long index
, int col
, const wxString
& label
, int imageId
)
567 info
.m_mask
= wxLIST_MASK_TEXT
;
568 info
.m_itemId
= index
;
572 info
.m_image
= imageId
;
573 info
.m_mask
|= wxLIST_MASK_IMAGE
;
575 return SetItem(info
);
579 // Gets the item state
580 int wxListCtrl::GetItemState(long item
, long stateMask
) const
584 info
.m_mask
= wxLIST_MASK_STATE
;
585 info
.m_stateMask
= stateMask
;
586 info
.m_itemId
= item
;
594 // Sets the item state
595 bool wxListCtrl::SetItemState(long item
, long state
, long stateMask
)
599 info
.m_mask
= wxLIST_MASK_STATE
;
600 info
.m_state
= state
;
601 info
.m_stateMask
= stateMask
;
602 info
.m_itemId
= item
;
604 return SetItem(info
);
607 // Sets the item image
608 bool wxListCtrl::SetItemImage(long item
, int image
, int selImage
)
612 info
.m_mask
= wxLIST_MASK_IMAGE
;
613 info
.m_image
= image
;
614 info
.m_itemId
= item
;
616 return SetItem(info
);
619 // Gets the item text
620 wxString
wxListCtrl::GetItemText(long item
) const
624 info
.m_mask
= wxLIST_MASK_TEXT
;
625 info
.m_itemId
= item
;
632 // Sets the item text
633 void wxListCtrl::SetItemText(long item
, const wxString
& str
)
637 info
.m_mask
= wxLIST_MASK_TEXT
;
638 info
.m_itemId
= item
;
644 // Gets the item data
645 long wxListCtrl::GetItemData(long item
) const
649 info
.m_mask
= wxLIST_MASK_DATA
;
650 info
.m_itemId
= item
;
657 // Sets the item data
658 bool wxListCtrl::SetItemData(long item
, long data
)
662 info
.m_mask
= wxLIST_MASK_DATA
;
663 info
.m_itemId
= item
;
666 return SetItem(info
);
669 // Gets the item rectangle
670 bool wxListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
674 int code2
= LVIR_BOUNDS
;
675 if ( code
== wxLIST_RECT_BOUNDS
)
677 else if ( code
== wxLIST_RECT_ICON
)
679 else if ( code
== wxLIST_RECT_LABEL
)
683 bool success
= (ListView_GetItemRect(GetHwnd(), (int) item
, &rect2
) != 0);
685 bool success
= (ListView_GetItemRect(GetHwnd(), (int) item
, &rect2
, code2
) != 0);
690 rect
.width
= rect2
.right
- rect2
.left
;
691 rect
.height
= rect2
.bottom
- rect2
.left
;
695 // Gets the item position
696 bool wxListCtrl::GetItemPosition(long item
, wxPoint
& pos
) const
700 bool success
= (ListView_GetItemPosition(GetHwnd(), (int) item
, &pt
) != 0);
702 pos
.x
= pt
.x
; pos
.y
= pt
.y
;
706 // Sets the item position.
707 bool wxListCtrl::SetItemPosition(long item
, const wxPoint
& pos
)
709 return (ListView_SetItemPosition(GetHwnd(), (int) item
, pos
.x
, pos
.y
) != 0);
712 // Gets the number of items in the list control
713 int wxListCtrl::GetItemCount(void) const
715 return ListView_GetItemCount(GetHwnd());
718 // Retrieves the spacing between icons in pixels.
719 // If small is TRUE, gets the spacing for the small icon
720 // view, otherwise the large icon view.
721 int wxListCtrl::GetItemSpacing(bool isSmall
) const
723 return ListView_GetItemSpacing(GetHwnd(), (BOOL
) isSmall
);
726 // Gets the number of selected items in the list control
727 int wxListCtrl::GetSelectedItemCount(void) const
729 return ListView_GetSelectedCount(GetHwnd());
732 // Gets the text colour of the listview
733 wxColour
wxListCtrl::GetTextColour(void) const
735 COLORREF ref
= ListView_GetTextColor(GetHwnd());
736 wxColour
col(GetRValue(ref
), GetGValue(ref
), GetBValue(ref
));
740 // Sets the text colour of the listview
741 void wxListCtrl::SetTextColour(const wxColour
& col
)
743 ListView_SetTextColor(GetHwnd(), PALETTERGB(col
.Red(), col
.Green(), col
.Blue()));
746 // Gets the index of the topmost visible item when in
747 // list or report view
748 long wxListCtrl::GetTopItem(void) const
750 return (long) ListView_GetTopIndex(GetHwnd());
753 // Searches for an item, starting from 'item'.
754 // 'geometry' is one of
755 // wxLIST_NEXT_ABOVE/ALL/BELOW/LEFT/RIGHT.
756 // 'state' is a state bit flag, one or more of
757 // wxLIST_STATE_DROPHILITED/FOCUSED/SELECTED/CUT.
758 // item can be -1 to find the first item that matches the
760 // Returns the item or -1 if unsuccessful.
761 long wxListCtrl::GetNextItem(long item
, int geom
, int state
) const
765 if ( geom
== wxLIST_NEXT_ABOVE
)
767 if ( geom
== wxLIST_NEXT_ALL
)
769 if ( geom
== wxLIST_NEXT_BELOW
)
771 if ( geom
== wxLIST_NEXT_LEFT
)
772 flags
|= LVNI_TOLEFT
;
773 if ( geom
== wxLIST_NEXT_RIGHT
)
774 flags
|= LVNI_TORIGHT
;
776 if ( state
& wxLIST_STATE_CUT
)
778 if ( state
& wxLIST_STATE_DROPHILITED
)
779 flags
|= LVNI_DROPHILITED
;
780 if ( state
& wxLIST_STATE_FOCUSED
)
781 flags
|= LVNI_FOCUSED
;
782 if ( state
& wxLIST_STATE_SELECTED
)
783 flags
|= LVNI_SELECTED
;
785 return (long) ListView_GetNextItem(GetHwnd(), item
, flags
);
789 wxImageList
*wxListCtrl::GetImageList(int which
) const
791 if ( which
== wxIMAGE_LIST_NORMAL
)
793 return m_imageListNormal
;
795 else if ( which
== wxIMAGE_LIST_SMALL
)
797 return m_imageListSmall
;
799 else if ( which
== wxIMAGE_LIST_STATE
)
801 return m_imageListState
;
806 void wxListCtrl::SetImageList(wxImageList
*imageList
, int which
)
809 if ( which
== wxIMAGE_LIST_NORMAL
)
811 flags
= LVSIL_NORMAL
;
812 m_imageListNormal
= imageList
;
814 else if ( which
== wxIMAGE_LIST_SMALL
)
817 m_imageListSmall
= imageList
;
819 else if ( which
== wxIMAGE_LIST_STATE
)
822 m_imageListState
= imageList
;
824 ListView_SetImageList(GetHwnd(), (HIMAGELIST
) imageList
? imageList
->GetHIMAGELIST() : 0, flags
);
827 // ----------------------------------------------------------------------------
829 // ----------------------------------------------------------------------------
831 // Arranges the items
832 bool wxListCtrl::Arrange(int flag
)
835 if ( flag
== wxLIST_ALIGN_LEFT
)
836 code
= LVA_ALIGNLEFT
;
837 else if ( flag
== wxLIST_ALIGN_TOP
)
839 else if ( flag
== wxLIST_ALIGN_DEFAULT
)
841 else if ( flag
== wxLIST_ALIGN_SNAP_TO_GRID
)
842 code
= LVA_SNAPTOGRID
;
844 return (ListView_Arrange(GetHwnd(), code
) != 0);
848 bool wxListCtrl::DeleteItem(long item
)
850 return (ListView_DeleteItem(GetHwnd(), (int) item
) != 0);
854 bool wxListCtrl::DeleteAllItems()
856 return (ListView_DeleteAllItems(GetHwnd()) != 0);
860 bool wxListCtrl::DeleteAllColumns()
862 while ( m_colCount
> 0 )
864 if ( ListView_DeleteColumn(GetHwnd(), 0) == 0 )
866 wxLogLastError("ListView_DeleteColumn");
874 wxASSERT_MSG( m_colCount
== 0, T("no columns should be left") );
880 bool wxListCtrl::DeleteColumn(int col
)
882 bool success
= (ListView_DeleteColumn(GetHwnd(), col
) != 0);
884 if ( success
&& (m_colCount
> 0) )
889 // Clears items, and columns if there are any.
890 void wxListCtrl::ClearAll()
893 if ( m_colCount
> 0 )
897 wxTextCtrl
* wxListCtrl::EditLabel(long item
, wxClassInfo
* textControlClass
)
899 wxASSERT( (textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
))) );
901 HWND hWnd
= (HWND
) ListView_EditLabel(GetHwnd(), item
);
905 m_textCtrl
->UnsubclassWin();
906 m_textCtrl
->SetHWND(0);
911 m_textCtrl
= (wxTextCtrl
*) textControlClass
->CreateObject();
912 m_textCtrl
->SetHWND((WXHWND
) hWnd
);
913 m_textCtrl
->SubclassWin((WXHWND
) hWnd
);
918 // End label editing, optionally cancelling the edit
919 bool wxListCtrl::EndEditLabel(bool cancel
)
923 /* I don't know how to implement this: there's no such macro as ListView_EndEditLabelNow.
925 bool success = (ListView_EndEditLabelNow(GetHwnd(), cancel) != 0);
929 m_textCtrl->UnsubclassWin();
930 m_textCtrl->SetHWND(0);
940 // Ensures this item is visible
941 bool wxListCtrl::EnsureVisible(long item
)
943 return (ListView_EnsureVisible(GetHwnd(), (int) item
, FALSE
) != 0);
946 // Find an item whose label matches this string, starting from the item after 'start'
947 // or the beginning if 'start' is -1.
948 long wxListCtrl::FindItem(long start
, const wxString
& str
, bool partial
)
950 LV_FINDINFO findInfo
;
952 findInfo
.flags
= LVFI_STRING
;
954 findInfo
.flags
|= LVFI_STRING
;
955 findInfo
.psz
= WXSTRINGCAST str
;
957 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
960 // Find an item whose data matches this data, starting from the item after 'start'
961 // or the beginning if 'start' is -1.
962 long wxListCtrl::FindItem(long start
, long data
)
964 LV_FINDINFO findInfo
;
966 findInfo
.flags
= LVFI_PARAM
;
967 findInfo
.lParam
= data
;
969 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
972 // Find an item nearest this position in the specified direction, starting from
973 // the item after 'start' or the beginning if 'start' is -1.
974 long wxListCtrl::FindItem(long start
, const wxPoint
& pt
, int direction
)
976 LV_FINDINFO findInfo
;
978 findInfo
.flags
= LVFI_NEARESTXY
;
979 findInfo
.pt
.x
= pt
.x
;
980 findInfo
.pt
.y
= pt
.y
;
981 findInfo
.vkDirection
= VK_RIGHT
;
983 if ( direction
== wxLIST_FIND_UP
)
984 findInfo
.vkDirection
= VK_UP
;
985 else if ( direction
== wxLIST_FIND_DOWN
)
986 findInfo
.vkDirection
= VK_DOWN
;
987 else if ( direction
== wxLIST_FIND_LEFT
)
988 findInfo
.vkDirection
= VK_LEFT
;
989 else if ( direction
== wxLIST_FIND_RIGHT
)
990 findInfo
.vkDirection
= VK_RIGHT
;
992 return ListView_FindItem(GetHwnd(), (int) start
, & findInfo
);
995 // Determines which item (if any) is at the specified point,
996 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
997 long wxListCtrl::HitTest(const wxPoint
& point
, int& flags
)
999 LV_HITTESTINFO hitTestInfo
;
1000 hitTestInfo
.pt
.x
= (int) point
.x
;
1001 hitTestInfo
.pt
.y
= (int) point
.y
;
1003 ListView_HitTest(GetHwnd(), & hitTestInfo
);
1006 if ( hitTestInfo
.flags
& LVHT_ABOVE
)
1007 flags
|= wxLIST_HITTEST_ABOVE
;
1008 if ( hitTestInfo
.flags
& LVHT_BELOW
)
1009 flags
|= wxLIST_HITTEST_BELOW
;
1010 if ( hitTestInfo
.flags
& LVHT_NOWHERE
)
1011 flags
|= wxLIST_HITTEST_NOWHERE
;
1012 if ( hitTestInfo
.flags
& LVHT_ONITEMICON
)
1013 flags
|= wxLIST_HITTEST_ONITEMICON
;
1014 if ( hitTestInfo
.flags
& LVHT_ONITEMLABEL
)
1015 flags
|= wxLIST_HITTEST_ONITEMLABEL
;
1016 if ( hitTestInfo
.flags
& LVHT_ONITEMSTATEICON
)
1017 flags
|= wxLIST_HITTEST_ONITEMSTATEICON
;
1018 if ( hitTestInfo
.flags
& LVHT_TOLEFT
)
1019 flags
|= wxLIST_HITTEST_TOLEFT
;
1020 if ( hitTestInfo
.flags
& LVHT_TORIGHT
)
1021 flags
|= wxLIST_HITTEST_TORIGHT
;
1023 return (long) hitTestInfo
.iItem
;
1026 // Inserts an item, returning the index of the new item if successful,
1028 long wxListCtrl::InsertItem(wxListItem
& info
)
1031 wxConvertToMSWListItem(this, info
, item
);
1033 return (long) ListView_InsertItem(GetHwnd(), & item
);
1036 long wxListCtrl::InsertItem(long index
, const wxString
& label
)
1039 info
.m_text
= label
;
1040 info
.m_mask
= wxLIST_MASK_TEXT
;
1041 info
.m_itemId
= index
;
1042 return InsertItem(info
);
1045 // Inserts an image item
1046 long wxListCtrl::InsertItem(long index
, int imageIndex
)
1049 info
.m_image
= imageIndex
;
1050 info
.m_mask
= wxLIST_MASK_IMAGE
;
1051 info
.m_itemId
= index
;
1052 return InsertItem(info
);
1055 // Inserts an image/string item
1056 long wxListCtrl::InsertItem(long index
, const wxString
& label
, int imageIndex
)
1059 info
.m_image
= imageIndex
;
1060 info
.m_text
= label
;
1061 info
.m_mask
= wxLIST_MASK_IMAGE
| wxLIST_MASK_TEXT
;
1062 info
.m_itemId
= index
;
1063 return InsertItem(info
);
1066 // For list view mode (only), inserts a column.
1067 long wxListCtrl::InsertColumn(long col
, wxListItem
& item
)
1072 lvCol
.pszText
= NULL
;
1074 if ( item
.m_mask
& wxLIST_MASK_TEXT
)
1076 lvCol
.mask
|= LVCF_TEXT
;
1077 lvCol
.pszText
= WXSTRINGCAST item
.m_text
;
1078 lvCol
.cchTextMax
= 0; // Ignored
1080 if ( item
.m_mask
& wxLIST_MASK_FORMAT
)
1082 lvCol
.mask
|= LVCF_FMT
;
1084 if ( item
.m_format
== wxLIST_FORMAT_LEFT
)
1085 lvCol
.fmt
= LVCFMT_LEFT
;
1086 if ( item
.m_format
== wxLIST_FORMAT_RIGHT
)
1087 lvCol
.fmt
= LVCFMT_RIGHT
;
1088 if ( item
.m_format
== wxLIST_FORMAT_CENTRE
)
1089 lvCol
.fmt
= LVCFMT_CENTER
;
1092 lvCol
.mask
|= LVCF_WIDTH
;
1093 if ( item
.m_mask
& wxLIST_MASK_WIDTH
)
1095 if ( item
.m_width
== wxLIST_AUTOSIZE
)
1096 lvCol
.cx
= LVSCW_AUTOSIZE
;
1097 else if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
1098 lvCol
.cx
= LVSCW_AUTOSIZE_USEHEADER
;
1100 lvCol
.cx
= item
.m_width
;
1104 // always give some width to the new column: this one is compatible
1109 lvCol
.mask
|= LVCF_SUBITEM
;
1110 lvCol
.iSubItem
= col
;
1112 bool success
= ListView_InsertColumn(GetHwnd(), col
, & lvCol
) != -1;
1119 wxLogDebug(T("Failed to insert the column '%s' into listview!"),
1126 long wxListCtrl::InsertColumn(long col
, const wxString
& heading
, int format
,
1130 item
.m_mask
= wxLIST_MASK_TEXT
| wxLIST_MASK_FORMAT
;
1131 item
.m_text
= heading
;
1134 item
.m_mask
|= wxLIST_MASK_WIDTH
;
1135 item
.m_width
= width
;
1137 item
.m_format
= format
;
1139 return InsertColumn(col
, item
);
1142 // Scrolls the list control. If in icon, small icon or report view mode,
1143 // x specifies the number of pixels to scroll. If in list view mode, x
1144 // specifies the number of columns to scroll.
1145 // If in icon, small icon or list view mode, y specifies the number of pixels
1146 // to scroll. If in report view mode, y specifies the number of lines to scroll.
1147 bool wxListCtrl::ScrollList(int dx
, int dy
)
1149 return (ListView_Scroll(GetHwnd(), dx
, dy
) != 0);
1154 // fn is a function which takes 3 long arguments: item1, item2, data.
1155 // item1 is the long data associated with a first item (NOT the index).
1156 // item2 is the long data associated with a second item (NOT the index).
1157 // data is the same value as passed to SortItems.
1158 // The return value is a negative number if the first item should precede the second
1159 // item, a positive number of the second item should precede the first,
1160 // or zero if the two items are equivalent.
1162 // data is arbitrary data to be passed to the sort function.
1163 bool wxListCtrl::SortItems(wxListCtrlCompare fn
, long data
)
1165 return (ListView_SortItems(GetHwnd(), (PFNLVCOMPARE
) fn
, data
) != 0);
1168 // ----------------------------------------------------------------------------
1169 // message processing
1170 // ----------------------------------------------------------------------------
1172 bool wxListCtrl::MSWCommand(WXUINT cmd
, WXWORD id
)
1174 if (cmd
== EN_UPDATE
)
1176 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, id
);
1177 event
.SetEventObject( this );
1178 ProcessCommand(event
);
1181 else if (cmd
== EN_KILLFOCUS
)
1183 wxCommandEvent
event(wxEVT_KILL_FOCUS
, id
);
1184 event
.SetEventObject( this );
1185 ProcessCommand(event
);
1192 bool wxListCtrl::MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
)
1194 wxListEvent
event(wxEVT_NULL
, m_windowId
);
1195 wxEventType eventType
= wxEVT_NULL
;
1196 NMHDR
*hdr1
= (NMHDR
*) lParam
;
1197 switch ( hdr1
->code
)
1199 case LVN_BEGINRDRAG
:
1200 eventType
= wxEVT_COMMAND_LIST_BEGIN_RDRAG
;
1204 if ( eventType
== wxEVT_NULL
)
1206 eventType
= wxEVT_COMMAND_LIST_BEGIN_DRAG
;
1210 NM_LISTVIEW
*hdr
= (NM_LISTVIEW
*)lParam
;
1211 event
.m_itemIndex
= hdr
->iItem
;
1212 event
.m_pointDrag
.x
= hdr
->ptAction
.x
;
1213 event
.m_pointDrag
.y
= hdr
->ptAction
.y
;
1217 case LVN_BEGINLABELEDIT
:
1219 eventType
= wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
;
1220 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1221 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, GetHwnd());
1225 case LVN_COLUMNCLICK
:
1227 eventType
= wxEVT_COMMAND_LIST_COL_CLICK
;
1228 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1229 event
.m_itemIndex
= -1;
1230 event
.m_col
= hdr
->iSubItem
;
1234 case LVN_DELETEALLITEMS
:
1235 // what's the sense of generating a wxWin event for this when
1236 // it's absolutely not portable?
1238 eventType
= wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
;
1239 event
.m_itemIndex
= -1;
1242 // return TRUE to suppress all additional LVN_DELETEITEM
1243 // notifications - this makes deleting all items from a list ctrl
1248 case LVN_DELETEITEM
:
1250 eventType
= wxEVT_COMMAND_LIST_DELETE_ITEM
;
1251 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1252 event
.m_itemIndex
= hdr
->iItem
;
1255 case LVN_ENDLABELEDIT
:
1257 eventType
= wxEVT_COMMAND_LIST_END_LABEL_EDIT
;
1258 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1259 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, GetHwnd());
1260 if ( info
->item
.pszText
== NULL
|| info
->item
.iItem
== -1 )
1261 event
.m_cancelled
= TRUE
;
1264 case LVN_GETDISPINFO
:
1267 // this provokes stack overflow: indeed, wxConvertFromMSWListItem()
1268 // sends us WM_NOTIFY! As it doesn't do anything for now, just leave
1272 // TODO: some text buffering here, I think
1273 // TODO: API for getting Windows to retrieve values
1275 eventType
= wxEVT_COMMAND_LIST_GET_INFO
;
1276 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1277 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, GetHwnd());
1282 case LVN_INSERTITEM
:
1284 eventType
= wxEVT_COMMAND_LIST_INSERT_ITEM
;
1285 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1286 event
.m_itemIndex
= hdr
->iItem
;
1289 case LVN_ITEMCHANGED
:
1291 // This needs to be sent to wxListCtrl as a rather more
1292 // concrete event. For now, just detect a selection
1294 NM_LISTVIEW
* hdr
= (NM_LISTVIEW
*)lParam
;
1295 if ( (hdr
->uNewState
& LVIS_SELECTED
) && !(hdr
->uOldState
& LVIS_SELECTED
) )
1297 eventType
= wxEVT_COMMAND_LIST_ITEM_SELECTED
;
1298 event
.m_itemIndex
= hdr
->iItem
;
1300 else if ( !(hdr
->uNewState
& LVIS_SELECTED
) && (hdr
->uOldState
& LVIS_SELECTED
) )
1302 eventType
= wxEVT_COMMAND_LIST_ITEM_DESELECTED
;
1303 event
.m_itemIndex
= hdr
->iItem
;
1312 LV_KEYDOWN
*info
= (LV_KEYDOWN
*)lParam
;
1313 WORD wVKey
= info
->wVKey
;
1315 // get the current selection
1316 long lItem
= GetNextItem(-1,
1318 wxLIST_STATE_SELECTED
);
1320 // <Enter> or <Space> activate the selected item if any
1321 if ( lItem
!= -1 && (wVKey
== VK_RETURN
|| wVKey
== VK_SPACE
) )
1323 // TODO this behaviour probably should be optional
1324 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
1325 event
.m_itemIndex
= lItem
;
1329 eventType
= wxEVT_COMMAND_LIST_KEY_DOWN
;
1330 event
.m_code
= wxCharCodeMSWToWX(wVKey
);
1336 // if the user processes it in wxEVT_COMMAND_LEFT_CLICK(), don't do
1338 if ( wxControl::MSWOnNotify(idCtrl
, lParam
, result
) )
1343 // else translate it into wxEVT_COMMAND_LIST_ITEM_ACTIVATED event
1344 eventType
= wxEVT_COMMAND_LIST_ITEM_ACTIVATED
;
1347 case LVN_SETDISPINFO
:
1349 eventType
= wxEVT_COMMAND_LIST_SET_INFO
;
1350 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1351 wxConvertFromMSWListItem(this, event
.m_item
, info
->item
, GetHwnd());
1356 return wxControl::MSWOnNotify(idCtrl
, lParam
, result
);
1359 event
.SetEventObject( this );
1360 event
.SetEventType(eventType
);
1362 if ( !GetEventHandler()->ProcessEvent(event
) )
1365 if (hdr1
->code
== LVN_GETDISPINFO
)
1367 LV_DISPINFO
*info
= (LV_DISPINFO
*)lParam
;
1368 if ( info
->item
.mask
& LVIF_TEXT
)
1370 if ( !event
.m_item
.m_text
.IsNull() )
1372 info
->item
.pszText
= AddPool(event
.m_item
.m_text
);
1373 info
->item
.cchTextMax
= wxStrlen(info
->item
.pszText
) + 1;
1376 // wxConvertToMSWListItem(this, event.m_item, info->item);
1379 *result
= !event
.IsAllowed();
1384 wxChar
*wxListCtrl::AddPool(const wxString
& str
)
1386 // Remove the first element if 3 strings exist
1387 if ( m_stringPool
.Number() == 3 )
1389 wxNode
*node
= m_stringPool
.First();
1390 delete[] (char *)node
->Data();
1393 wxNode
*node
= m_stringPool
.Add(WXSTRINGCAST str
);
1394 return (wxChar
*)node
->Data();
1397 // ----------------------------------------------------------------------------
1399 // ----------------------------------------------------------------------------
1401 // List item structure
1402 wxListItem::wxListItem()
1412 m_format
= wxLIST_FORMAT_CENTRE
;
1416 static void wxConvertFromMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& lvItem
, HWND getFullInfo
)
1418 info
.m_data
= lvItem
.lParam
;
1421 info
.m_stateMask
= 0;
1422 info
.m_itemId
= lvItem
.iItem
;
1424 long oldMask
= lvItem
.mask
;
1426 bool needText
= FALSE
;
1427 if (getFullInfo
!= 0)
1429 if ( lvItem
.mask
& LVIF_TEXT
)
1436 lvItem
.pszText
= new wxChar
[513];
1437 lvItem
.cchTextMax
= 512;
1439 // lvItem.mask |= TVIF_HANDLE | TVIF_STATE | TVIF_TEXT | TVIF_IMAGE | TVIF_SELECTEDIMAGE | TVIF_CHILDREN | TVIF_PARAM;
1440 lvItem
.mask
|= LVIF_TEXT
| LVIF_IMAGE
| LVIF_PARAM
;
1441 ::SendMessage(getFullInfo
, LVM_GETITEM
, 0, (LPARAM
)& lvItem
);
1444 if ( lvItem
.mask
& LVIF_STATE
)
1446 info
.m_mask
|= wxLIST_MASK_STATE
;
1448 if ( lvItem
.stateMask
& LVIS_CUT
)
1450 info
.m_stateMask
|= wxLIST_STATE_CUT
;
1451 if ( lvItem
.state
& LVIS_CUT
)
1452 info
.m_state
|= wxLIST_STATE_CUT
;
1454 if ( lvItem
.stateMask
& LVIS_DROPHILITED
)
1456 info
.m_stateMask
|= wxLIST_STATE_DROPHILITED
;
1457 if ( lvItem
.state
& LVIS_DROPHILITED
)
1458 info
.m_state
|= wxLIST_STATE_DROPHILITED
;
1460 if ( lvItem
.stateMask
& LVIS_FOCUSED
)
1462 info
.m_stateMask
|= wxLIST_STATE_FOCUSED
;
1463 if ( lvItem
.state
& LVIS_FOCUSED
)
1464 info
.m_state
|= wxLIST_STATE_FOCUSED
;
1466 if ( lvItem
.stateMask
& LVIS_SELECTED
)
1468 info
.m_stateMask
|= wxLIST_STATE_SELECTED
;
1469 if ( lvItem
.state
& LVIS_SELECTED
)
1470 info
.m_state
|= wxLIST_STATE_SELECTED
;
1474 if ( lvItem
.mask
& LVIF_TEXT
)
1476 info
.m_mask
|= wxLIST_MASK_TEXT
;
1477 info
.m_text
= lvItem
.pszText
;
1479 if ( lvItem
.mask
& LVIF_IMAGE
)
1481 info
.m_mask
|= wxLIST_MASK_IMAGE
;
1482 info
.m_image
= lvItem
.iImage
;
1484 if ( lvItem
.mask
& LVIF_PARAM
)
1485 info
.m_mask
|= wxLIST_MASK_DATA
;
1486 if ( lvItem
.mask
& LVIF_DI_SETITEM
)
1487 info
.m_mask
|= wxLIST_SET_ITEM
;
1488 info
.m_col
= lvItem
.iSubItem
;
1493 delete[] lvItem
.pszText
;
1495 lvItem
.mask
= oldMask
;
1498 static void wxConvertToMSWListItem(const wxListCtrl
*ctrl
, wxListItem
& info
, LV_ITEM
& lvItem
)
1500 lvItem
.iItem
= (int) info
.m_itemId
;
1502 lvItem
.iImage
= info
.m_image
;
1503 lvItem
.lParam
= info
.m_data
;
1504 lvItem
.stateMask
= 0;
1507 lvItem
.iSubItem
= info
.m_col
;
1509 if (info
.m_mask
& wxLIST_MASK_STATE
)
1511 lvItem
.mask
|= LVIF_STATE
;
1512 if (info
.m_stateMask
& wxLIST_STATE_CUT
)
1514 lvItem
.stateMask
|= LVIS_CUT
;
1515 if (info
.m_state
& wxLIST_STATE_CUT
)
1516 lvItem
.state
|= LVIS_CUT
;
1518 if (info
.m_stateMask
& wxLIST_STATE_DROPHILITED
)
1520 lvItem
.stateMask
|= LVIS_DROPHILITED
;
1521 if (info
.m_state
& wxLIST_STATE_DROPHILITED
)
1522 lvItem
.state
|= LVIS_DROPHILITED
;
1524 if (info
.m_stateMask
& wxLIST_STATE_FOCUSED
)
1526 lvItem
.stateMask
|= LVIS_FOCUSED
;
1527 if (info
.m_state
& wxLIST_STATE_FOCUSED
)
1528 lvItem
.state
|= LVIS_FOCUSED
;
1530 if (info
.m_stateMask
& wxLIST_STATE_SELECTED
)
1532 lvItem
.stateMask
|= LVIS_SELECTED
;
1533 if (info
.m_state
& wxLIST_STATE_SELECTED
)
1534 lvItem
.state
|= LVIS_SELECTED
;
1538 if (info
.m_mask
& wxLIST_MASK_TEXT
)
1540 lvItem
.mask
|= LVIF_TEXT
;
1541 if ( ctrl
->GetWindowStyleFlag() & wxLC_USER_TEXT
)
1543 lvItem
.pszText
= LPSTR_TEXTCALLBACK
;
1547 lvItem
.pszText
= WXSTRINGCAST info
.m_text
;
1548 if ( lvItem
.pszText
)
1549 lvItem
.cchTextMax
= info
.m_text
.Length();
1551 lvItem
.cchTextMax
= 0;
1554 if (info
.m_mask
& wxLIST_MASK_IMAGE
)
1555 lvItem
.mask
|= LVIF_IMAGE
;
1556 if (info
.m_mask
& wxLIST_MASK_DATA
)
1557 lvItem
.mask
|= LVIF_PARAM
;
1560 // ----------------------------------------------------------------------------
1562 // ----------------------------------------------------------------------------
1564 IMPLEMENT_DYNAMIC_CLASS(wxListEvent
, wxNotifyEvent
)
1566 wxListEvent::wxListEvent(wxEventType commandType
, int id
)
1567 : wxNotifyEvent(commandType
, id
)
1573 m_cancelled
= FALSE
;