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"
20 // ---------------------------------------------------------------------------
21 // implements class ListView
23 // ListView Common Control
24 // ---------------------------------------------------------------------------
27 ListView::init(HWND parent
, int id
, HeaderList headers
)
31 // locate the listview control
32 hWndListView
= ::GetDlgItem(parent
, id
);
34 // configure the listview control
35 SendMessage(hWndListView
, CCM_SETVERSION
, 6, 0);
37 ListView_SetExtendedListViewStyle(hWndListView
,
38 LVS_EX_COLUMNSNAPPOINTS
| // use cxMin
39 LVS_EX_FULLROWSELECT
|
41 LVS_EX_HEADERDRAGDROP
); // headers can be re-ordered
43 // give the header control a border
44 HWND hWndHeader
= ListView_GetHeader(hWndListView
);
45 SetWindowLongPtr(hWndHeader
, GWL_STYLE
,
46 GetWindowLongPtr(hWndHeader
, GWL_STYLE
) | WS_BORDER
);
48 // ensure an initial item exists for width calculations...
53 lvi
.pszText
= const_cast <char *> ("Working...");
54 ListView_InsertItem(hWndListView
, &lvi
);
56 // populate with columns
59 // create a small icon imagelist
60 // (the order of images matches ListViewLine::State enum)
61 hImgList
= ImageList_Create(GetSystemMetrics(SM_CXSMICON
),
62 GetSystemMetrics(SM_CYSMICON
),
64 ImageList_AddIcon(hImgList
, LoadIcon(GetModuleHandle(NULL
), MAKEINTRESOURCE(IDI_TREE_PLUS
)));
65 ImageList_AddIcon(hImgList
, LoadIcon(GetModuleHandle(NULL
), MAKEINTRESOURCE(IDI_TREE_MINUS
)));
67 // create an empty imagelist, used to reset the indent
68 hEmptyImgList
= ImageList_Create(1, 1,
71 // LVS_EX_INFOTIP/LVN_GETINFOTIP doesn't work for subitems, so we have to do
72 // our own tooltip handling
73 hWndTip
= CreateWindowEx (0,
74 (LPCTSTR
) TOOLTIPS_CLASS
,
76 WS_POPUP
| TTS_NOPREFIX
| TTS_ALWAYSTIP
,
77 CW_USEDEFAULT
, CW_USEDEFAULT
, CW_USEDEFAULT
, CW_USEDEFAULT
,
80 GetModuleHandle(NULL
),
82 // must be topmost so that tooltips will display on top
83 SetWindowPos(hWndTip
, HWND_TOPMOST
,0, 0, 0, 0, SWP_NOMOVE
| SWP_NOSIZE
| SWP_NOACTIVATE
);
86 memset ((void *)&ti
, 0, sizeof(ti
));
87 ti
.cbSize
= sizeof(ti
);
88 ti
.uFlags
= TTF_IDISHWND
| TTF_SUBCLASS
;
90 ti
.uId
= (UINT_PTR
)hWndListView
;
91 ti
.lpszText
= LPSTR_TEXTCALLBACK
; // use TTN_GETDISPINFO
92 SendMessage(hWndTip
, TTM_ADDTOOL
, 0, (LPARAM
)&ti
);
94 // match long delay for tooltip to disappear used elsewhere (30s)
95 SendMessage(hWndTip
, TTM_SETDELAYTIME
, TTDT_AUTOPOP
, (LPARAM
) MAKELONG (30000, 0));
96 // match tip width used elsewhere
97 SendMessage(hWndTip
, TTM_SETMAXTIPWIDTH
, 0, 450);
101 ListView::initColumns(HeaderList headers_
)
103 // store HeaderList for later use
106 // create the columns
108 lvc
.mask
= LVCF_FMT
| LVCF_WIDTH
| LVCF_TEXT
| LVCF_SUBITEM
;
111 for (i
= 0; headers
[i
].text
!= 0; i
++)
114 lvc
.pszText
= const_cast <char *> (headers
[i
].text
);
116 lvc
.fmt
= headers
[i
].fmt
;
118 ListView_InsertColumn(hWndListView
, i
, &lvc
);
121 // now do some width calculations
122 for (i
= 0; headers
[i
].text
!= 0; i
++)
124 headers
[i
].width
= 0;
126 ListView_SetColumnWidth(hWndListView
, i
, LVSCW_AUTOSIZE_USEHEADER
);
127 headers
[i
].hdr_width
= ListView_GetColumnWidth(hWndListView
, i
);
132 ListView::noteColumnWidthStart()
134 dc
= GetDC (hWndListView
);
136 // we must set the font of the DC here, otherwise the width calculations
137 // will be off because the system will use the wrong font metrics
138 HANDLE sysfont
= GetStockObject (DEFAULT_GUI_FONT
);
139 SelectObject (dc
, sysfont
);
142 for (i
= 0; headers
[i
].text
!= 0; i
++)
144 headers
[i
].width
= 0;
149 ListView::noteColumnWidth(int col_num
, const std::string
& string
)
153 // A margin of 3*GetSystemMetrics(SM_CXEDGE) is used at each side of the
155 int addend
= 2*3*GetSystemMetrics(SM_CXEDGE
);
158 GetTextExtentPoint32 (dc
, string
.c_str(), string
.size(), &s
);
160 int width
= addend
+ s
.cx
;
162 // allow for width of dropdown button in popup columns
163 if (headers
[col_num
].type
== ListView::ControlType::popup
)
165 width
+= GetSystemMetrics(SM_CXVSCROLL
);
168 if (width
> headers
[col_num
].width
)
169 headers
[col_num
].width
= width
;
173 ListView::noteColumnWidthEnd()
175 ReleaseDC(hWndListView
, dc
);
179 ListView::resizeColumns(void)
181 // ensure the last column stretches all the way to the right-hand side of the
185 for (i
= 0; headers
[i
].text
!= 0; i
++)
186 total
= total
+ headers
[i
].width
;
189 GetClientRect(hWndListView
, &r
);
190 int width
= r
.right
- r
.left
;
193 headers
[i
-1].width
+= width
- total
;
197 lvc
.mask
= LVCF_WIDTH
| LVCF_MINWIDTH
;
198 for (i
= 0; headers
[i
].text
!= 0; i
++)
201 lvc
.cx
= (headers
[i
].width
< headers
[i
].hdr_width
) ? headers
[i
].hdr_width
: headers
[i
].width
;
202 lvc
.cxMin
= headers
[i
].hdr_width
;
204 Log (LOG_BABBLE
) << "resizeColumns: " << i
<< " cx " << lvc
.cx
<< " cxMin " << lvc
.cxMin
<<endLog
;
207 ListView_SetColumn(hWndListView
, i
, &lvc
);
212 ListView::setContents(ListViewContents
*_contents
, bool tree
)
214 contents
= _contents
;
216 // disable redrawing of ListView
217 // (otherwise it will redraw every time a row is added, which makes this very slow)
218 SendMessage(hWndListView
, WM_SETREDRAW
, FALSE
, 0);
220 // preserve focus/selection
221 int iRow
= ListView_GetSelectionMark(hWndListView
);
225 // assign imagelist to listview control (this also sets the size for indents)
227 ListView_SetImageList(hWndListView
, hImgList
, LVSIL_SMALL
);
229 ListView_SetImageList(hWndListView
, hEmptyImgList
, LVSIL_SMALL
);
232 for (i
= 0; i
< contents
->size(); i
++)
235 lvi
.mask
= LVIF_TEXT
| (tree
? LVIF_IMAGE
| LVIF_INDENT
: 0);
238 lvi
.pszText
= LPSTR_TEXTCALLBACK
;
241 lvi
.iImage
= I_IMAGECALLBACK
;
242 lvi
.iIndent
= (*contents
)[i
]->get_indent();
245 ListView_InsertItem(hWndListView
, &lvi
);
250 ListView_SetItemState(hWndListView
, iRow
, LVNI_SELECTED
| LVNI_FOCUSED
, LVNI_SELECTED
| LVNI_FOCUSED
);
251 ListView_EnsureVisible(hWndListView
, iRow
, false);
254 // enable redrawing of ListView and redraw
255 SendMessage(hWndListView
, WM_SETREDRAW
, TRUE
, 0);
256 RedrawWindow(hWndListView
, NULL
, NULL
, RDW_ERASE
| RDW_FRAME
| RDW_INVALIDATE
| RDW_ALLCHILDREN
);
259 // Helper class: The char * pointer we hand back needs to remain valid for some
260 // time after OnNotify returns, when the std::string we have retrieved has gone
261 // out of scope, so a static instance of this class maintains a local cache.
265 StringCache() : cache(NULL
), cache_size(0) { }
266 StringCache
& operator = (const std::string
& s
)
268 if ((s
.length() + 1) > cache_size
)
270 cache_size
= s
.length() + 1;
271 cache
= (char *)realloc(cache
, cache_size
);
273 strcpy(cache
, s
.c_str());
276 operator char *() const
286 ListView::OnNotify (NMHDR
*pNmHdr
, LRESULT
*pResult
)
289 Log (LOG_BABBLE
) << "ListView::OnNotify id:" << pNmHdr
->idFrom
<< " hwnd:" << pNmHdr
->hwndFrom
<< " code:" << (int)pNmHdr
->code
<< endLog
;
292 switch (pNmHdr
->code
)
294 case LVN_GETDISPINFO
:
296 NMLVDISPINFO
*pNmLvDispInfo
= (NMLVDISPINFO
*)pNmHdr
;
298 Log (LOG_BABBLE
) << "LVN_GETDISPINFO " << pNmLvDispInfo
->item
.iItem
<< endLog
;
302 int iRow
= pNmLvDispInfo
->item
.iItem
;
303 int iCol
= pNmLvDispInfo
->item
.iSubItem
;
305 static StringCache s
;
306 s
= (*contents
)[iRow
]->get_text(iCol
);
307 pNmLvDispInfo
->item
.pszText
= s
;
309 if (pNmLvDispInfo
->item
.iSubItem
== 0)
311 pNmLvDispInfo
->item
.iImage
= (int)((*contents
)[pNmLvDispInfo
->item
.iItem
]->get_state());
319 case LVN_GETEMPTYMARKUP
:
321 NMLVEMPTYMARKUP
*pNmMarkup
= (NMLVEMPTYMARKUP
*) pNmHdr
;
323 MultiByteToWideChar(CP_UTF8
, 0,
325 pNmMarkup
->szMarkup
, L_MAX_URL_LENGTH
);
334 NMITEMACTIVATE
*pNmItemAct
= (NMITEMACTIVATE
*) pNmHdr
;
336 Log (LOG_BABBLE
) << "NM_CLICK: pnmitem->iItem " << pNmItemAct
->iItem
<< " pNmItemAct->iSubItem " << pNmItemAct
->iSubItem
<< endLog
;
338 int iRow
= pNmItemAct
->iItem
;
339 int iCol
= pNmItemAct
->iSubItem
;
345 if (headers
[iCol
].type
== ListView::ControlType::popup
)
351 ListView_GetSubItemRect(hWndListView
, iRow
, iCol
, LVIR_BOUNDS
, &r
);
353 ::ScreenToClient(hWndListView
, &cp
);
355 // if the click isn't over the pop-up button, do nothing yet (but this
356 // might be followed by a NM_DBLCLK)
357 if (cp
.x
< r
.right
- GetSystemMetrics(SM_CXVSCROLL
))
360 // position pop-up menu at the location of the click
361 update
= popup_menu(iRow
, iCol
, p
);
365 // Inform the item of the click
366 update
= (*contents
)[iRow
]->do_action(iCol
, 0);
369 // Update items, if needed
372 ListView_RedrawItems(hWndListView
, iRow
, iRow
+ update
-1);
381 NMITEMACTIVATE
*pNmItemAct
= (NMITEMACTIVATE
*) pNmHdr
;
383 Log (LOG_BABBLE
) << "NM_DBLCLICK: pnmitem->iItem " << pNmItemAct
->iItem
<< " pNmItemAct->iSubItem " << pNmItemAct
->iSubItem
<< endLog
;
385 int iRow
= pNmItemAct
->iItem
;
386 int iCol
= pNmItemAct
->iSubItem
;
392 // Inform the item of the double-click
393 update
= (*contents
)[iRow
]->do_default_action(iCol
);
395 // Update items, if needed
398 ListView_RedrawItems(hWndListView
, iRow
, iRow
+ update
-1);
407 NMLVCUSTOMDRAW
*pNmLvCustomDraw
= (NMLVCUSTOMDRAW
*)pNmHdr
;
409 switch(pNmLvCustomDraw
->nmcd
.dwDrawStage
)
412 *pResult
= CDRF_NOTIFYITEMDRAW
;
414 case CDDS_ITEMPREPAINT
:
415 *pResult
= CDRF_NOTIFYSUBITEMDRAW
;
417 case CDDS_SUBITEM
| CDDS_ITEMPREPAINT
:
419 LRESULT result
= CDRF_DODEFAULT
;
420 int iCol
= pNmLvCustomDraw
->iSubItem
;
421 int iRow
= pNmLvCustomDraw
->nmcd
.dwItemSpec
;
423 switch (headers
[iCol
].type
)
426 case ListView::ControlType::text
:
427 result
= CDRF_DODEFAULT
;
430 case ListView::ControlType::checkbox
:
432 // get the subitem text
434 ListView_GetItemText(hWndListView
, iRow
, iCol
, buf
, _countof(buf
));
436 // map the subitem text to a checkbox state
437 UINT state
= DFCS_BUTTONCHECK
| DFCS_FLAT
;
438 if (buf
[0] == '\0') // empty
440 result
= CDRF_DODEFAULT
;
443 else if (buf
[0] == 'y') // yes
444 state
|= DFCS_CHECKED
;
445 else if ((buf
[0] == 'n') && (buf
[1] == 'o')) // no
448 state
|= DFCS_INACTIVE
;
450 // erase and draw a checkbox
452 ListView_GetSubItemRect(hWndListView
, iRow
, iCol
, LVIR_BOUNDS
, &r
);
454 if (pNmLvCustomDraw
->nmcd
.uItemState
& CDIS_SELECTED
)
455 bkg_color
= GetSysColor(COLOR_HIGHLIGHT
);
457 bkg_color
= ListView_GetBkColor(hWndListView
);
458 HBRUSH hBrush
= CreateSolidBrush(bkg_color
);
459 FillRect(pNmLvCustomDraw
->nmcd
.hdc
, &r
, hBrush
);
460 DeleteObject(hBrush
);
461 DrawFrameControl(pNmLvCustomDraw
->nmcd
.hdc
, &r
, DFC_BUTTON
, state
);
463 result
= CDRF_SKIPDEFAULT
;
467 case ListView::ControlType::popup
:
469 // let the control draw the text, but notify us afterwards
470 result
= CDRF_NOTIFYPOSTPAINT
;
478 case CDDS_SUBITEM
| CDDS_ITEMPOSTPAINT
:
480 LRESULT result
= CDRF_DODEFAULT
;
481 int iCol
= pNmLvCustomDraw
->iSubItem
;
482 int iRow
= pNmLvCustomDraw
->nmcd
.dwItemSpec
;
484 switch (headers
[iCol
].type
)
487 result
= CDRF_DODEFAULT
;
490 case ListView::ControlType::popup
:
492 // draw the control at the RHS of the cell
494 ListView_GetSubItemRect(hWndListView
, iRow
, iCol
, LVIR_BOUNDS
, &r
);
495 r
.left
= r
.right
- GetSystemMetrics(SM_CXVSCROLL
);
496 DrawFrameControl(pNmLvCustomDraw
->nmcd
.hdc
, &r
, DFC_SCROLL
,DFCS_SCROLLCOMBOBOX
);
498 result
= CDRF_DODEFAULT
;
511 NMLISTVIEW
*pNmListView
= (NMLISTVIEW
*)pNmHdr
;
512 int iRow
= pNmListView
->iItem
;
513 int iCol
= pNmListView
->iSubItem
;
515 Log (LOG_BABBLE
) << "LVN_HOTTRACK " << iRow
<< " " << iCol
<< endLog
;
520 // if we've tracked off to a different cell
521 if ((iRow
!= iRow_track
) || (iCol
!= iCol_track
))
524 Log (LOG_BABBLE
) << "LVN_HOTTRACK changed cell" << endLog
;
527 // if the tooltip for previous cell is displayed, remove it
528 // restart the tooltip AUTOPOP timer for this cell
529 SendMessage(hWndTip
, TTM_ACTIVATE
, FALSE
, 0);
530 SendMessage(hWndTip
, TTM_ACTIVATE
, TRUE
, 0);
542 NMLVKEYDOWN
*pNmLvKeyDown
= (NMLVKEYDOWN
*)pNmHdr
;
543 int iRow
= ListView_GetSelectionMark(hWndListView
);
545 Log (LOG_PLAIN
) << "LVN_KEYDOWN vkey " << pNmLvKeyDown
->wVKey
<< " on row " << iRow
<< endLog
;
548 if (contents
&& iRow
>= 0)
552 if ((*contents
)[iRow
]->map_key_to_action(pNmLvKeyDown
->wVKey
, &col_num
, &action_id
))
556 update
= (*contents
)[iRow
]->do_action(col_num
, action_id
);
561 ListView_GetSubItemRect(hWndListView
, iRow
, col_num
, LVIR_BOUNDS
, &r
);
564 ClientToScreen(hWndListView
, &p
);
566 update
= popup_menu(iRow
, col_num
, p
);
570 ListView_RedrawItems(hWndListView
, iRow
, iRow
+ update
-1);
576 case TTN_GETDISPINFO
:
578 // convert mouse position to item/subitem
579 LVHITTESTINFO lvHitTestInfo
;
580 lvHitTestInfo
.flags
= LVHT_ONITEM
;
581 GetCursorPos(&lvHitTestInfo
.pt
);
582 ::ScreenToClient(hWndListView
, &lvHitTestInfo
.pt
);
583 ListView_SubItemHitTest(hWndListView
, &lvHitTestInfo
);
585 int iRow
= lvHitTestInfo
.iItem
;
586 int iCol
= lvHitTestInfo
.iSubItem
;
591 Log (LOG_BABBLE
) << "TTN_GETDISPINFO " << iRow
<< " " << iCol
<< endLog
;
594 // get the tooltip text for that item/subitem
595 static StringCache tooltip
;
598 tooltip
= (*contents
)[iRow
]->get_tooltip(iCol
);
600 // set the tooltip text
601 NMTTDISPINFO
*pNmTTDispInfo
= (NMTTDISPINFO
*)pNmHdr
;
602 pNmTTDispInfo
->lpszText
= tooltip
;
603 pNmTTDispInfo
->hinst
= NULL
;
604 pNmTTDispInfo
->uFlags
= 0;
616 ListView::empty(void)
618 ListView_DeleteAllItems(hWndListView
);
622 ListView::setEmptyText(const char *text
)
624 empty_list_text
= text
;
628 ListView::popup_menu(int iRow
, int iCol
, POINT p
)
632 HMENU hMenu
= CreatePopupMenu();
635 memset(&mii
, 0, sizeof(mii
));
636 mii
.cbSize
= sizeof(mii
);
637 mii
.fMask
= MIIM_FTYPE
| MIIM_STATE
| MIIM_STRING
| MIIM_ID
;
638 mii
.fType
= MFT_STRING
;
640 ActionList
*al
= (*contents
)[iRow
]->get_actions(iCol
);
644 for (i
= al
->list
.begin (); i
!= al
->list
.end (); ++i
, ++j
)
647 mii
.dwTypeData
= (char *)i
->name
.c_str();
648 mii
.fState
= (i
->selected
? MFS_CHECKED
: MFS_UNCHECKED
|
649 i
->enabled
? MFS_ENABLED
: MFS_DISABLED
);
652 res
= InsertMenuItem(hMenu
, -1, TRUE
, &mii
);
653 if (!res
) Log (LOG_BABBLE
) << "InsertMenuItem failed " << endLog
;
656 int id
= TrackPopupMenu(hMenu
,
657 TPM_LEFTALIGN
| TPM_TOPALIGN
| TPM_RETURNCMD
| TPM_LEFTBUTTON
| TPM_NOANIMATION
,
658 p
.x
, p
.y
, 0, hWndListView
, NULL
);
660 // Inform the item of the menu choice
662 update
= (*contents
)[iRow
]->do_action(iCol
, al
->list
[id
-1].id
);