2 * Copyright (c) 2016 Jon Turney
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * A copy of the GNU General Public License can be found at
15 #include "LogSingleton.h"
21 // ---------------------------------------------------------------------------
22 // implements class ListView
24 // ListView Common Control
25 // ---------------------------------------------------------------------------
28 ListView::init(HWND parent
, int id
, HeaderList headers
)
32 // locate the listview control
33 hWndListView
= ::GetDlgItem(parent
, id
);
35 // configure the listview control
36 SendMessage(hWndListView
, CCM_SETVERSION
, 6, 0);
38 ListView_SetExtendedListViewStyle(hWndListView
,
39 LVS_EX_COLUMNSNAPPOINTS
| // use cxMin
40 LVS_EX_FULLROWSELECT
|
42 LVS_EX_HEADERDRAGDROP
); // headers can be re-ordered
44 // give the header control a border
45 HWND hWndHeader
= ListView_GetHeader(hWndListView
);
46 SetWindowLongPtr(hWndHeader
, GWL_STYLE
,
47 GetWindowLongPtr(hWndHeader
, GWL_STYLE
) | WS_BORDER
);
49 // ensure an initial item exists for width calculations...
54 lvi
.pszText
= const_cast <char *> ("Working...");
55 ListView_InsertItem(hWndListView
, &lvi
);
57 // populate with columns
60 // create a small icon imagelist
61 // (the order of images matches ListViewLine::State enum)
62 hImgList
= ImageList_Create(GetSystemMetrics(SM_CXSMICON
),
63 GetSystemMetrics(SM_CYSMICON
),
65 ImageList_AddIcon(hImgList
, LoadIcon(GetModuleHandle(NULL
), MAKEINTRESOURCE(IDI_TREE_PLUS
)));
66 ImageList_AddIcon(hImgList
, LoadIcon(GetModuleHandle(NULL
), MAKEINTRESOURCE(IDI_TREE_MINUS
)));
68 // create an empty imagelist, used to reset the indent
69 hEmptyImgList
= ImageList_Create(1, 1,
72 // LVS_EX_INFOTIP/LVN_GETINFOTIP doesn't work for subitems, so we have to do
73 // our own tooltip handling
74 hWndTip
= CreateWindowEx (0,
75 (LPCTSTR
) TOOLTIPS_CLASS
,
77 WS_POPUP
| TTS_NOPREFIX
| TTS_ALWAYSTIP
,
78 CW_USEDEFAULT
, CW_USEDEFAULT
, CW_USEDEFAULT
, CW_USEDEFAULT
,
81 GetModuleHandle(NULL
),
83 // must be topmost so that tooltips will display on top
84 SetWindowPos(hWndTip
, HWND_TOPMOST
,0, 0, 0, 0, SWP_NOMOVE
| SWP_NOSIZE
| SWP_NOACTIVATE
);
87 memset ((void *)&ti
, 0, sizeof(ti
));
88 ti
.cbSize
= sizeof(ti
);
89 ti
.uFlags
= TTF_IDISHWND
| TTF_SUBCLASS
;
91 ti
.uId
= (UINT_PTR
)hWndListView
;
92 ti
.lpszText
= LPSTR_TEXTCALLBACK
; // use TTN_GETDISPINFO
93 SendMessage(hWndTip
, TTM_ADDTOOL
, 0, (LPARAM
)&ti
);
95 // match long delay for tooltip to disappear used elsewhere (30s)
96 SendMessage(hWndTip
, TTM_SETDELAYTIME
, TTDT_AUTOPOP
, (LPARAM
) MAKELONG (30000, 0));
97 // match tip width used elsewhere
98 SendMessage(hWndTip
, TTM_SETMAXTIPWIDTH
, 0, 450);
100 // switch to using wide-char WM_NOTIFY messages
101 ListView_SetUnicodeFormat(hWndListView
, TRUE
);
105 ListView::initColumns(HeaderList headers_
)
107 // store HeaderList for later use
110 // create the columns
112 lvc
.mask
= LVCF_FMT
| LVCF_WIDTH
| LVCF_TEXT
| LVCF_SUBITEM
;
115 for (i
= 0; headers
[i
].text
!= 0; i
++)
117 std::wstring h
= LoadStringW(headers
[i
].text
);
120 lvc
.pszText
= const_cast <wchar_t *> (h
.c_str());
122 lvc
.fmt
= headers
[i
].fmt
;
124 SendMessage(hWndListView
, LVM_INSERTCOLUMNW
, i
, (LPARAM
)&lvc
);
127 // now do some width calculations
128 for (i
= 0; headers
[i
].text
!= 0; i
++)
130 headers
[i
].width
= 0;
132 ListView_SetColumnWidth(hWndListView
, i
, LVSCW_AUTOSIZE_USEHEADER
);
133 headers
[i
].hdr_width
= ListView_GetColumnWidth(hWndListView
, i
);
138 ListView::noteColumnWidthStart()
140 dc
= GetDC (hWndListView
);
142 // we must set the font of the DC here, otherwise the width calculations
143 // will be off because the system will use the wrong font metrics
144 HANDLE sysfont
= GetStockObject (DEFAULT_GUI_FONT
);
145 SelectObject (dc
, sysfont
);
148 for (i
= 0; headers
[i
].text
!= 0; i
++)
150 headers
[i
].width
= 0;
154 // wrappers to help instantiations of the noteColumnWidth() template call the
155 // right version of GetTextExtentPoint32
156 #undef GetTextExtentPoint32
158 static BOOL
GetTextExtentPoint32(HDC hdc
, LPCSTR lpString
, int c
, LPSIZE psizl
)
160 return GetTextExtentPoint32A(hdc
, lpString
, c
, psizl
);
163 static BOOL
GetTextExtentPoint32(HDC hdc
, LPCWSTR lpString
, int c
, LPSIZE psizl
)
165 return GetTextExtentPoint32W(hdc
, lpString
, c
, psizl
);
168 template <typename T
>
170 ListView::noteColumnWidth(int col_num
, const T
& string
)
174 // A margin of 3*GetSystemMetrics(SM_CXEDGE) is used at each side of the
176 int addend
= 2*3*GetSystemMetrics(SM_CXEDGE
);
179 GetTextExtentPoint32 (dc
, string
.c_str(), string
.size(), &s
);
181 int width
= addend
+ s
.cx
;
183 // allow for width of dropdown button in popup columns
184 if (headers
[col_num
].type
== ListView::ControlType::popup
)
186 width
+= GetSystemMetrics(SM_CXVSCROLL
);
189 if (width
> headers
[col_num
].width
)
190 headers
[col_num
].width
= width
;
193 // explicit instantiation
194 template void ListView::noteColumnWidth(int col_num
, const std::string
& string
);
195 template void ListView::noteColumnWidth(int col_num
, const std::wstring
& wstring
);
198 ListView::noteColumnWidthEnd()
200 ReleaseDC(hWndListView
, dc
);
204 ListView::resizeColumns(void)
206 // ensure the last column stretches all the way to the right-hand side of the
210 for (i
= 0; headers
[i
].text
!= 0; i
++)
211 total
= total
+ headers
[i
].width
;
214 GetClientRect(hWndListView
, &r
);
215 int width
= r
.right
- r
.left
;
218 headers
[i
-1].width
+= width
- total
;
222 lvc
.mask
= LVCF_WIDTH
| LVCF_MINWIDTH
;
223 for (i
= 0; headers
[i
].text
!= 0; i
++)
226 lvc
.cx
= (headers
[i
].width
< headers
[i
].hdr_width
) ? headers
[i
].hdr_width
: headers
[i
].width
;
227 lvc
.cxMin
= headers
[i
].hdr_width
;
229 Log (LOG_BABBLE
) << "resizeColumns: " << i
<< " cx " << lvc
.cx
<< " cxMin " << lvc
.cxMin
<<endLog
;
232 ListView_SetColumn(hWndListView
, i
, &lvc
);
237 ListView::setContents(ListViewContents
*_contents
, bool tree
)
239 contents
= _contents
;
241 // disable redrawing of ListView
242 // (otherwise it will redraw every time a row is added, which makes this very slow)
243 SendMessage(hWndListView
, WM_SETREDRAW
, FALSE
, 0);
245 // preserve focus/selection
246 int iRow
= ListView_GetSelectionMark(hWndListView
);
250 // assign imagelist to listview control (this also sets the size for indents)
252 ListView_SetImageList(hWndListView
, hImgList
, LVSIL_SMALL
);
254 ListView_SetImageList(hWndListView
, hEmptyImgList
, LVSIL_SMALL
);
257 for (i
= 0; i
< contents
->size(); i
++)
260 lvi
.mask
= LVIF_TEXT
| (tree
? LVIF_IMAGE
| LVIF_INDENT
: 0);
263 lvi
.pszText
= LPSTR_TEXTCALLBACK
;
266 lvi
.iImage
= I_IMAGECALLBACK
;
267 lvi
.iIndent
= (*contents
)[i
]->get_indent();
270 ListView_InsertItem(hWndListView
, &lvi
);
275 ListView_SetItemState(hWndListView
, iRow
, LVNI_SELECTED
| LVNI_FOCUSED
, LVNI_SELECTED
| LVNI_FOCUSED
);
276 ListView_EnsureVisible(hWndListView
, iRow
, false);
279 // enable redrawing of ListView and redraw
280 SendMessage(hWndListView
, WM_SETREDRAW
, TRUE
, 0);
281 RedrawWindow(hWndListView
, NULL
, NULL
, RDW_ERASE
| RDW_FRAME
| RDW_INVALIDATE
| RDW_ALLCHILDREN
);
284 // Helper class: The pointer we hand back needs to remain valid for some time
285 // after OnNotify returns, when the string object we have retrieved has gone out
286 // of scope, so a static instance of this class maintains a local cache.
287 template <class T
> class StringCache
289 typedef typename
T::traits_type::char_type char_type
;
291 StringCache() : cache(NULL
), cache_size(0) { }
292 StringCache
& operator = (const T
& s
)
294 if ((s
.length() + 1) > cache_size
)
296 cache_size
= s
.length() + 1;
297 cache
= (char_type
*)realloc(cache
, cache_size
* sizeof(char_type
));
299 memcpy(cache
, s
.c_str(), (s
.length() + 1) * sizeof(char_type
));
302 operator char_type
*() const
312 ListView::OnNotify (NMHDR
*pNmHdr
, LRESULT
*pResult
)
315 Log (LOG_BABBLE
) << "ListView::OnNotify id:" << pNmHdr
->idFrom
<< " hwnd:" << pNmHdr
->hwndFrom
<< " code:" << (int)pNmHdr
->code
<< endLog
;
318 switch (pNmHdr
->code
)
320 case LVN_GETDISPINFOW
:
322 NMLVDISPINFOW
*pNmLvDispInfo
= (NMLVDISPINFOW
*)pNmHdr
;
324 Log (LOG_BABBLE
) << "LVN_GETDISPINFO " << pNmLvDispInfo
->item
.iItem
<< endLog
;
328 int iRow
= pNmLvDispInfo
->item
.iItem
;
329 int iCol
= pNmLvDispInfo
->item
.iSubItem
;
331 static StringCache
<std::wstring
> s
;
332 s
= (*contents
)[iRow
]->get_text(iCol
);
333 pNmLvDispInfo
->item
.pszText
= s
;
335 if (pNmLvDispInfo
->item
.iSubItem
== 0)
337 pNmLvDispInfo
->item
.iImage
= (int)((*contents
)[pNmLvDispInfo
->item
.iItem
]->get_state());
345 case LVN_GETEMPTYMARKUP
:
347 NMLVEMPTYMARKUP
*pNmMarkup
= (NMLVEMPTYMARKUP
*) pNmHdr
;
349 MultiByteToWideChar(CP_UTF8
, 0,
351 pNmMarkup
->szMarkup
, L_MAX_URL_LENGTH
);
360 NMITEMACTIVATE
*pNmItemAct
= (NMITEMACTIVATE
*) pNmHdr
;
362 Log (LOG_BABBLE
) << "NM_CLICK: pnmitem->iItem " << pNmItemAct
->iItem
<< " pNmItemAct->iSubItem " << pNmItemAct
->iSubItem
<< endLog
;
364 int iRow
= pNmItemAct
->iItem
;
365 int iCol
= pNmItemAct
->iSubItem
;
371 if (headers
[iCol
].type
== ListView::ControlType::popup
)
377 ListView_GetSubItemRect(hWndListView
, iRow
, iCol
, LVIR_BOUNDS
, &r
);
379 ::ScreenToClient(hWndListView
, &cp
);
381 // if the click isn't over the pop-up button, do nothing yet (but this
382 // might be followed by a NM_DBLCLK)
383 if (cp
.x
< r
.right
- GetSystemMetrics(SM_CXVSCROLL
))
386 // position pop-up menu at the location of the click
387 update
= popup_menu(iRow
, iCol
, p
);
391 // Inform the item of the click
392 update
= (*contents
)[iRow
]->do_action(iCol
, 0);
395 // Update items, if needed
398 ListView_RedrawItems(hWndListView
, iRow
, iRow
+ update
-1);
407 NMITEMACTIVATE
*pNmItemAct
= (NMITEMACTIVATE
*) pNmHdr
;
409 Log (LOG_BABBLE
) << "NM_DBLCLICK: pnmitem->iItem " << pNmItemAct
->iItem
<< " pNmItemAct->iSubItem " << pNmItemAct
->iSubItem
<< endLog
;
411 int iRow
= pNmItemAct
->iItem
;
412 int iCol
= pNmItemAct
->iSubItem
;
418 // Inform the item of the double-click
419 update
= (*contents
)[iRow
]->do_default_action(iCol
);
421 // Update items, if needed
424 ListView_RedrawItems(hWndListView
, iRow
, iRow
+ update
-1);
433 NMLVCUSTOMDRAW
*pNmLvCustomDraw
= (NMLVCUSTOMDRAW
*)pNmHdr
;
435 switch(pNmLvCustomDraw
->nmcd
.dwDrawStage
)
438 *pResult
= CDRF_NOTIFYITEMDRAW
;
440 case CDDS_ITEMPREPAINT
:
441 *pResult
= CDRF_NOTIFYSUBITEMDRAW
;
443 case CDDS_SUBITEM
| CDDS_ITEMPREPAINT
:
445 LRESULT result
= CDRF_DODEFAULT
;
446 int iCol
= pNmLvCustomDraw
->iSubItem
;
447 int iRow
= pNmLvCustomDraw
->nmcd
.dwItemSpec
;
449 switch (headers
[iCol
].type
)
452 case ListView::ControlType::text
:
453 result
= CDRF_DODEFAULT
;
456 case ListView::ControlType::checkbox
:
458 // get the subitem text (as ASCII)
460 ListView_GetItemText(hWndListView
, iRow
, iCol
, buf
, _countof(buf
));
462 // map the subitem text to a checkbox state
463 UINT state
= DFCS_BUTTONCHECK
| DFCS_FLAT
;
464 if (buf
[0] == '\0') // empty
466 result
= CDRF_DODEFAULT
;
469 else if (buf
[0] == 'y') // yes
470 state
|= DFCS_CHECKED
;
471 else if ((buf
[0] == 'n') && (buf
[1] == 'o')) // no
474 state
|= DFCS_INACTIVE
;
476 // erase and draw a checkbox
478 ListView_GetSubItemRect(hWndListView
, iRow
, iCol
, LVIR_BOUNDS
, &r
);
480 if (pNmLvCustomDraw
->nmcd
.uItemState
& CDIS_SELECTED
)
481 bkg_color
= GetSysColor(COLOR_HIGHLIGHT
);
483 bkg_color
= ListView_GetBkColor(hWndListView
);
484 HBRUSH hBrush
= CreateSolidBrush(bkg_color
);
485 FillRect(pNmLvCustomDraw
->nmcd
.hdc
, &r
, hBrush
);
486 DeleteObject(hBrush
);
487 DrawFrameControl(pNmLvCustomDraw
->nmcd
.hdc
, &r
, DFC_BUTTON
, state
);
489 result
= CDRF_SKIPDEFAULT
;
493 case ListView::ControlType::popup
:
495 // let the control draw the text, but notify us afterwards
496 result
= CDRF_NOTIFYPOSTPAINT
;
504 case CDDS_SUBITEM
| CDDS_ITEMPOSTPAINT
:
506 LRESULT result
= CDRF_DODEFAULT
;
507 int iCol
= pNmLvCustomDraw
->iSubItem
;
508 int iRow
= pNmLvCustomDraw
->nmcd
.dwItemSpec
;
510 switch (headers
[iCol
].type
)
513 result
= CDRF_DODEFAULT
;
516 case ListView::ControlType::popup
:
518 // draw the control at the RHS of the cell
520 ListView_GetSubItemRect(hWndListView
, iRow
, iCol
, LVIR_BOUNDS
, &r
);
521 r
.left
= r
.right
- GetSystemMetrics(SM_CXVSCROLL
);
522 DrawFrameControl(pNmLvCustomDraw
->nmcd
.hdc
, &r
, DFC_SCROLL
,DFCS_SCROLLCOMBOBOX
);
524 result
= CDRF_DODEFAULT
;
537 NMLISTVIEW
*pNmListView
= (NMLISTVIEW
*)pNmHdr
;
538 int iRow
= pNmListView
->iItem
;
539 int iCol
= pNmListView
->iSubItem
;
541 Log (LOG_BABBLE
) << "LVN_HOTTRACK " << iRow
<< " " << iCol
<< endLog
;
546 // if we've tracked off to a different cell
547 if ((iRow
!= iRow_track
) || (iCol
!= iCol_track
))
550 Log (LOG_BABBLE
) << "LVN_HOTTRACK changed cell" << endLog
;
553 // if the tooltip for previous cell is displayed, remove it
554 // restart the tooltip AUTOPOP timer for this cell
555 SendMessage(hWndTip
, TTM_ACTIVATE
, FALSE
, 0);
556 SendMessage(hWndTip
, TTM_ACTIVATE
, TRUE
, 0);
568 NMLVKEYDOWN
*pNmLvKeyDown
= (NMLVKEYDOWN
*)pNmHdr
;
569 int iRow
= ListView_GetSelectionMark(hWndListView
);
571 Log (LOG_PLAIN
) << "LVN_KEYDOWN vkey " << pNmLvKeyDown
->wVKey
<< " on row " << iRow
<< endLog
;
574 if (contents
&& iRow
>= 0)
578 if ((*contents
)[iRow
]->map_key_to_action(pNmLvKeyDown
->wVKey
, &col_num
, &action_id
))
582 update
= (*contents
)[iRow
]->do_action(col_num
, action_id
);
587 ListView_GetSubItemRect(hWndListView
, iRow
, col_num
, LVIR_BOUNDS
, &r
);
590 ClientToScreen(hWndListView
, &p
);
592 update
= popup_menu(iRow
, col_num
, p
);
596 ListView_RedrawItems(hWndListView
, iRow
, iRow
+ update
-1);
602 case TTN_GETDISPINFO
:
604 // convert mouse position to item/subitem
605 LVHITTESTINFO lvHitTestInfo
;
606 lvHitTestInfo
.flags
= LVHT_ONITEM
;
607 GetCursorPos(&lvHitTestInfo
.pt
);
608 ::ScreenToClient(hWndListView
, &lvHitTestInfo
.pt
);
609 ListView_SubItemHitTest(hWndListView
, &lvHitTestInfo
);
611 int iRow
= lvHitTestInfo
.iItem
;
612 int iCol
= lvHitTestInfo
.iSubItem
;
617 Log (LOG_BABBLE
) << "TTN_GETDISPINFO " << iRow
<< " " << iCol
<< endLog
;
620 // get the tooltip text for that item/subitem
621 static StringCache
<std::string
> tooltip
;
624 tooltip
= (*contents
)[iRow
]->get_tooltip(iCol
);
626 // set the tooltip text
627 NMTTDISPINFO
*pNmTTDispInfo
= (NMTTDISPINFO
*)pNmHdr
;
628 pNmTTDispInfo
->lpszText
= tooltip
;
629 pNmTTDispInfo
->hinst
= NULL
;
630 pNmTTDispInfo
->uFlags
= 0;
642 ListView::empty(void)
644 ListView_DeleteAllItems(hWndListView
);
648 ListView::setEmptyText(const char *text
)
650 empty_list_text
= text
;
654 ListView::popup_menu(int iRow
, int iCol
, POINT p
)
658 HMENU hMenu
= CreatePopupMenu();
661 memset(&mii
, 0, sizeof(mii
));
662 mii
.cbSize
= sizeof(mii
);
663 mii
.fMask
= MIIM_FTYPE
| MIIM_STATE
| MIIM_STRING
| MIIM_ID
;
664 mii
.fType
= MFT_STRING
;
666 ActionList
*al
= (*contents
)[iRow
]->get_actions(iCol
);
670 for (i
= al
->list
.begin (); i
!= al
->list
.end (); ++i
, ++j
)
673 mii
.dwTypeData
= const_cast <wchar_t *> (i
->name
.c_str());
674 mii
.fState
= (i
->selected
? MFS_CHECKED
: MFS_UNCHECKED
|
675 i
->enabled
? MFS_ENABLED
: MFS_DISABLED
);
678 res
= InsertMenuItemW(hMenu
, -1, TRUE
, &mii
);
679 if (!res
) Log (LOG_BABBLE
) << "InsertMenuItem failed " << endLog
;
682 int id
= TrackPopupMenu(hMenu
,
683 TPM_LEFTALIGN
| TPM_TOPALIGN
| TPM_RETURNCMD
| TPM_LEFTBUTTON
| TPM_NOANIMATION
,
684 p
.x
, p
.y
, 0, hWndListView
, NULL
);
686 // Inform the item of the menu choice
688 update
= (*contents
)[iRow
]->do_action(iCol
, al
->list
[id
-1].id
);