-
Notifications
You must be signed in to change notification settings - Fork 0
/
wxExplorerBrowser.cpp
1634 lines (1270 loc) · 47 KB
/
wxExplorerBrowser.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
////////////////////////////////////////////////////////////////////////////////////
//
// Name: wxExplorerBrowser.cpp
// Purpose: Implements wxExplorerBrowser, a class for hosting
// IExplorerBrowser in wxWidgets applications
// Author: PB
// Copyright: (c) 2018 PB <pbfordev@gmail.com>
// Licence: wxWindows licence
//
////////////////////////////////////////////////////////////////////////////////////
#include "wxExplorerBrowser.h"
// @TODO
// no items in Control Panel
// select items
#if !defined(__WXMSW__) || !wxUSE_OLE || !wxUSE_DYNLIB_CLASS
#error wxExplorerBrowser requires wxWidgets to be built for MS Windows with support for OLE and DLLs
#endif
#if !wxCHECK_VERSION(3, 1, 0)
#error wxExplorerBrowser requires wxWidgets version 3.1 or higher
#endif
#include <wx/filename.h>
#include <wx/dcclient.h>
#include <wx/dynlib.h>
#include <wx/msw/private.h>
#include <wx/msw/private/comptr.h>
#include <wx/msw/wrapshl.h>
#include <wx/msw/winundef.h>
#define STRICT_TYPED_ITEMIDS
#include <shlwapi.h>
#include <shobjidl.h>
#include <shldisp.h>
#if !defined(_WIN32_WINNT) || (_WIN32_WINNT < 0x0600)
#error wxExplorerBrowser requires Windows SDK targetting Windows Vista or newer
#endif
// The code in this file took many things from the article (and comments on it)
// at https://www.codeproject.com/Articles/17809/Host-Windows-Explorer-in-your-applications-using-t
// and from the ExplorerBrowserHost sample by chrisg originally published on ShellRevealed.com
// For some reason ICommDlgBrowser::OnStateChange is called twice with CDBOSC_SELCHANGE
// for the same item.
// If WX_EXPLORER_BROWSER_PREVENT_DOUBLED_CHANGESEL_EVENTS is defined,
// the workaround code will be compiled-in which will try preventing that.
#define WX_EXPLORER_BROWSER_PREVENT_DOUBLED_CHANGESEL_EVENTS 1
namespace {
/***************************************************************************
class wxExplorerBrowserImplHelper
---------------------------------
implements several COM interfaces,
does the actual item filtering and contains
utility functions such as converting
pidl/IShellItem to ExplorerBrowserItem
*****************************************************************************/
class wxExplorerBrowserImplHelper :
public IServiceProvider,
public ICommDlgBrowser3,
public IExplorerBrowserEvents,
public IFolderFilter,
public IExplorerPaneVisibility
{
public:
wxExplorerBrowserImplHelper(wxWindow* host, IExplorerBrowser* explorerBrowser)
: m_host{host}, m_explorerBrowser{explorerBrowser} {}
// IUnknown methods implemented from scratch.
// For some reason the code kept crashing when using COM interface
// implementation helper macros from <wx/msw/ole/comimpl.h>
// and IUnknown_SetSite()
STDMETHODIMP_(ULONG) AddRef() override;
STDMETHODIMP_(ULONG) Release() override;
STDMETHODIMP QueryInterface(REFIID riid, void** ppv) override;
// IServiceProvider method
STDMETHODIMP QueryService(REFGUID guidService, REFIID riid, void** ppv) override;
// ICommDlgBrowser methods
STDMETHODIMP OnDefaultCommand(IShellView* ppshv) override;
STDMETHODIMP OnStateChange(IShellView* ppshv, ULONG uChange) override;
STDMETHODIMP IncludeObject(IShellView* ppshv, PCUITEMID_CHILD pidl) override;
// ICommDlgBrowser2 methods
STDMETHODIMP Notify(IShellView* ppshv, DWORD dwNotifyType) override;
STDMETHODIMP GetDefaultMenuText(IShellView* ppshv, LPWSTR pszText, int cchMax) override;
STDMETHODIMP GetViewFlags(DWORD* pdwFlags) override;
// ICommDlgBrowser3 methods
STDMETHODIMP GetCurrentFilter(LPWSTR pszFileSpec, int cchFileSpec) override;
STDMETHODIMP OnColumnClicked(IShellView*ppshv, int iColumn) override;
STDMETHODIMP OnPreViewCreated(IShellView* ppshv) override;
// IExplorerBrowserEvents methods
STDMETHODIMP OnNavigationPending(PCIDLIST_ABSOLUTE pidlFolder) override;
STDMETHODIMP OnViewCreated(IShellView* psv) override;
STDMETHODIMP OnNavigationComplete(PCIDLIST_ABSOLUTE pidlFolder) override;
STDMETHODIMP OnNavigationFailed(PCIDLIST_ABSOLUTE pidlFolder) override;
// IFolderFilter methods
STDMETHODIMP GetEnumFlags(IShellFolder*psf, PCIDLIST_ABSOLUTE pidlFolder, HWND* phwnd, DWORD* pgrfFlags) override;
STDMETHODIMP ShouldShow(IShellFolder* psf, PCIDLIST_ABSOLUTE pidlFolder, PCUITEMID_CHILD pidlItem) override;
// IExplorerPaneVisibility method
STDMETHODIMP GetPaneState(REFEXPLORERPANE ep, EXPLORERPANESTATE *peps) override;
// Names of all helper methods, i.e., those not implementing a COM interface,
// start with an underscore
bool _SetFilter(const wxArrayString& fileMasks, wxUint32 itemTypes);
bool _RemoveFilter();
bool _SetPaneSettings(const wxExplorerBrowser::PaneSettings& settings);
static wxExplorerBrowserItem::Type _SFGAO2wxExplorerBrowserItemType(SFGAOF attr);
static bool _IShellItem2wxExplorerBrowserItem(IShellItem* item, wxExplorerBrowserItem& ebi);
static bool _PPIDL2wxExplorerBrowserItem(PCIDLIST_ABSOLUTE pidl, wxExplorerBrowserItem& ebi);
private:
LONG m_refCount {1};
wxWindow* m_host {nullptr};
IExplorerBrowser* m_explorerBrowser {nullptr};
wxArrayString m_filterMasks; // list of filter masks, such as *.JPG
wxUint32 m_filterTypes {0}; // flags for item types, such as File, Directory
wxExplorerBrowser::PaneSettings m_paneSettings;
bool _SendNotifyEvent(wxEventType command, PCIDLIST_ABSOLUTE list) const;
bool _SendNotifyEvent(wxEventType command, const wxExplorerBrowserItem& ebi) const;
bool _GetSelectedItem(wxExplorerBrowserItem& ebi);
#ifdef WX_EXPLORER_BROWSER_PREVENT_DOUBLED_CHANGESEL_EVENTS
class ChangeSelEventData
{
public:
ChangeSelEventData() {}
void SetItem(const wxExplorerBrowserItem& item)
{
m_item = item;
}
bool IsDoubled(const ChangeSelEventData& previous) const
{
// If the difference between the two events is <=
// the doubledTime and the item contains the same data,
// then the event is considered a doubled event.
static const ULONGLONG doubledTime = 50; // in milliseconds
return
m_timeCreated - previous.m_timeCreated <= doubledTime
&& m_item.GetSFGAO() == previous.m_item.GetSFGAO()
&& m_item.GetPath() == previous.m_item.GetPath()
&& m_item.GetDisplayName() == previous.m_item.GetDisplayName();
}
private:
ULONGLONG m_timeCreated {::GetTickCount64()};
wxExplorerBrowserItem m_item;
};
ChangeSelEventData m_prevChangeSelEventData;
#endif // #ifdef WX_EXPLORER_BROWSER_PREVENT_DOUBLED_CHANGESEL_EVENTS
wxDECLARE_NO_COPY_CLASS(wxExplorerBrowserImplHelper);
};
// IUnknown_SetSite is not available on MinGW
// so it we must be load dynamically
HRESULT Call_IUnknown_SetSite(IUnknown* punk, IUnknown* punkSite)
{
typedef HRESULT (WINAPI *IUnknown_SetSite_t)(IUnknown*, IUnknown*);
static IUnknown_SetSite_t s_pfnIUnknown_SetSite = nullptr;
if ( !s_pfnIUnknown_SetSite )
{
wxDynamicLibrary dll(wxS("shlwapi.dll"));
if ( dll.IsLoaded() )
s_pfnIUnknown_SetSite = (IUnknown_SetSite_t)dll.GetSymbol(wxS("IUnknown_SetSite"));
}
if ( s_pfnIUnknown_SetSite )
return s_pfnIUnknown_SetSite(punk, punkSite);
else
return E_FAIL;
}
ULONG wxExplorerBrowserImplHelper::AddRef()
{
return ::InterlockedIncrement(&m_refCount);
}
ULONG wxExplorerBrowserImplHelper::Release()
{
LONG refCount = ::InterlockedDecrement(&m_refCount);
if ( refCount == 0 )
delete this;
return refCount;
}
HRESULT wxExplorerBrowserImplHelper::QueryInterface(REFIID riid, void** ppv)
{
if ( riid == IID_IUnknown )
*ppv = static_cast<IUnknown*>(static_cast<IServiceProvider*>(this));
else
if ( riid == IID_IServiceProvider )
*ppv = static_cast<IServiceProvider*>(this);
else
if ( riid == IID_ICommDlgBrowser
|| riid == IID_ICommDlgBrowser2
|| riid == IID_ICommDlgBrowser3
)
*ppv = static_cast<ICommDlgBrowser3*>(this);
else
if ( riid == IID_IExplorerBrowserEvents )
*ppv = static_cast<IExplorerBrowserEvents*>(this);
else
if ( riid == IID_IFolderFilter )
*ppv = static_cast<IFolderFilter*>(this);
else
if ( riid == IID_IExplorerPaneVisibility )
*ppv = static_cast<IExplorerPaneVisibility*>(this);
else
{
*ppv = nullptr;
return E_NOINTERFACE;
}
AddRef();
return S_OK;
}
HRESULT wxExplorerBrowserImplHelper::QueryService(REFGUID guidService, REFIID riid, void** ppv)
{
if ( guidService == SID_SExplorerBrowserFrame
|| guidService == SID_ExplorerPaneVisibility
)
return QueryInterface(riid, ppv);
*ppv = nullptr;
return E_NOINTERFACE;
}
HRESULT wxExplorerBrowserImplHelper::OnDefaultCommand(IShellView* WXUNUSED(ppshv))
{
wxExplorerBrowserItem ebi;
if ( _GetSelectedItem(ebi) )
{
if ( !_SendNotifyEvent(wxEVT_EXPLORER_BROWSER_DEFAULT_COMMAND, ebi) )
return S_OK; // event was vetoed, no default action will happen
}
return S_FALSE;
}
HRESULT wxExplorerBrowserImplHelper::OnStateChange(IShellView* WXUNUSED(ppshv), ULONG uChange)
{
if ( uChange == CDBOSC_SELCHANGE )
{
wxExplorerBrowserItem ebi;
_GetSelectedItem(ebi);
#ifdef WX_EXPLORER_BROWSER_PREVENT_DOUBLED_CHANGESEL_EVENTS
ChangeSelEventData csed;
csed.SetItem(ebi);
if ( csed.IsDoubled(m_prevChangeSelEventData) )
return S_OK; // do not send the same event
m_prevChangeSelEventData = csed;
#endif // #ifdef WX_EXPLORER_BROWSER_PREVENT_DOUBLED_CHANGESEL_EVENTS
_SendNotifyEvent(wxEVT_EXPLORER_BROWSER_SELECTION_CHANGED, ebi);
}
return S_OK;
}
// ShouldShow() is used to actually filter the items
HRESULT wxExplorerBrowserImplHelper::IncludeObject(IShellView* WXUNUSED(ppshv), PCUITEMID_CHILD WXUNUSED(pidl))
{
return S_OK;
}
HRESULT wxExplorerBrowserImplHelper::Notify(IShellView* WXUNUSED(ppshv), DWORD dwNotifyType)
{
if ( dwNotifyType == CDB2N_CONTEXTMENU_START )
{
wxExplorerBrowserItem ebi;
if ( _GetSelectedItem(ebi) )
{
if ( !_SendNotifyEvent(wxEVT_EXPLORER_BROWSER_CONTEXTMENU_START, ebi) )
return S_OK; // event was vetoed, context menu will not be shown
}
}
return S_FALSE;
}
HRESULT wxExplorerBrowserImplHelper::GetDefaultMenuText(IShellView* WXUNUSED(ppshv),
LPWSTR WXUNUSED(pszText),
int WXUNUSED(cchMax))
{
return S_FALSE;
}
HRESULT wxExplorerBrowserImplHelper::GetViewFlags(DWORD* pdwFlags)
{
*pdwFlags = CDB2GVF_NOSELECTVERB;
// if this flag is not set, neither IncludeObject nor ShouldShow are called
if ( m_filterMasks.empty() )
*pdwFlags |= CDB2GVF_NOINCLUDEITEM;
return S_OK;
}
/* Never gets called?! */
HRESULT wxExplorerBrowserImplHelper::GetCurrentFilter(LPWSTR WXUNUSED(pszFileSpec), int WXUNUSED(cchFileSpec))
{
return E_NOTIMPL;
}
/* Never gets called?! */
HRESULT wxExplorerBrowserImplHelper::OnColumnClicked(IShellView* WXUNUSED(ppshv), int WXUNUSED(iColumn))
{
return S_OK;
}
HRESULT wxExplorerBrowserImplHelper::OnPreViewCreated(IShellView* WXUNUSED(ppshv))
{
return S_OK;
}
HRESULT wxExplorerBrowserImplHelper::OnNavigationPending(PCIDLIST_ABSOLUTE pidlFolder)
{
if ( _SendNotifyEvent(wxEVT_EXPLORER_BROWSER_NAVIGATING, pidlFolder) )
return S_OK;
else
return E_FAIL;
}
HRESULT wxExplorerBrowserImplHelper::OnViewCreated(IShellView* psv)
{
HRESULT hr;
wxCOMPtr<IFolderView> fv;
hr = psv->QueryInterface(wxIID_PPV_ARGS(IFolderView, &fv));
if ( FAILED(hr) )
{
wxLogApiError(wxS("IShellView::QueryInterface(IFolderView)"), hr);
return E_FAIL;
}
wxCOMPtr<IPersistFolder2> pf2;
hr = fv->GetFolder(wxIID_PPV_ARGS(IPersistFolder2, &pf2));
if ( FAILED(hr) )
{
wxLogApiError(wxS("IFolderView::GetFolder()"), hr);
return E_FAIL;
}
PIDLIST_ABSOLUTE pidl = nullptr;
hr = pf2->GetCurFolder(&pidl);
if ( FAILED(hr) )
{
wxLogApiError(wxS("IPersistFolder2::GetCurFolder()"), hr);
return E_FAIL;
}
_SendNotifyEvent(wxEVT_EXPLORER_BROWSER_VIEW_CREATED, pidl);
::CoTaskMemFree(pidl);
return S_OK;
}
HRESULT wxExplorerBrowserImplHelper::OnNavigationComplete(PCIDLIST_ABSOLUTE pidlFolder)
{
_SendNotifyEvent(wxEVT_EXPLORER_BROWSER_NAVIGATION_COMPLETE, pidlFolder);
return S_OK;
}
HRESULT wxExplorerBrowserImplHelper::OnNavigationFailed(PCIDLIST_ABSOLUTE pidlFolder)
{
_SendNotifyEvent(wxEVT_EXPLORER_BROWSER_NAVIGATION_FAILED, pidlFolder);
return S_OK;
}
HRESULT wxExplorerBrowserImplHelper::GetEnumFlags(IShellFolder* WXUNUSED(psf),
PCIDLIST_ABSOLUTE WXUNUSED(pidlFolder),
HWND* WXUNUSED(phwnd),
DWORD* WXUNUSED(pgrfFlags))
{
return S_OK;
}
HRESULT wxExplorerBrowserImplHelper::ShouldShow(IShellFolder* psf,
PCIDLIST_ABSOLUTE WXUNUSED(pidlFolder),
PCUITEMID_CHILD pidlItem)
{
if ( m_filterMasks.empty() )
return S_OK;
HRESULT hr;
wxCOMPtr<IShellItem> si;
hr = ::SHCreateItemWithParent(nullptr, psf, pidlItem, wxIID_PPV_ARGS(IShellItem, &si));
if ( FAILED(hr) )
{
wxLogApiError(wxS("::SHCreateItemWithParent()"), hr);
return E_FAIL;
}
wxExplorerBrowserItem ebi;
if ( !_IShellItem2wxExplorerBrowserItem(si, ebi)
|| ebi.GetType() == wxExplorerBrowserItem::Unknown )
return E_FAIL;
if ( !(ebi.GetType() & m_filterTypes) )
return S_OK; // do not filter this item type
wxString name;
if ( ebi.GetType() == wxExplorerBrowserItem::Other )
{
name = ebi.GetDisplayName();
}
else
{
// Since the path for directories does not end with a slash,
// wxFileName::GetFullName here will also return the parent-relative
// directory name because it thinks it is a file
name = wxFileName(ebi.GetPath()).GetFullName();
}
// wxMatchWild() is surprisingly case sensitive even on MSW
name.MakeUpper();
for ( const auto& mask : m_filterMasks )
{
if ( wxMatchWild(mask, name, false) )
return S_OK;
}
return S_FALSE;
}
STDMETHODIMP wxExplorerBrowserImplHelper::GetPaneState(REFEXPLORERPANE ep, EXPLORERPANESTATE *peps)
{
if ( ep == EP_NavPane )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_NavPane);
else
if ( ep == EP_Commands )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_Commands);
else
if ( ep == EP_Commands_Organize )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_Commands_Organize);
else
if ( ep == EP_Commands_View )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_Commands_View);
else
if ( ep == EP_DetailsPane )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_DetailsPane);
else
if ( ep == EP_PreviewPane )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_PreviewPane);
else
if ( ep == EP_QueryPane )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_QueryPane);
else
if ( ep == EP_AdvQueryPane )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_AdvQueryPane);
else
if ( ep == EP_StatusBar )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_StatusBar);
else
if ( ep == EP_Ribbon )
*peps = m_paneSettings.GetFlags(wxExplorerBrowser::EP_Ribbon);
else
return E_INVALIDARG;
return S_OK;
}
// Filtering does not work for query-backed views such as libraries or search results.
// Neither ICommDlgBrowser::IncludeObject() nor IFolderFilter::ShouldShow() are called for those, see e.g.
// https://social.msdn.microsoft.com/Forums/windowsdesktop/en-US/252a9c82-617c-4126-8347-56dcedb4342f
// ICommDlgBrowser3::GetFilter() is never called for any folder at all...
bool wxExplorerBrowserImplHelper::_SetFilter(const wxArrayString& fileMasks, wxUint32 itemTypes)
{
m_filterMasks.reserve(fileMasks.size());
// we do not want case-sensitive filtering
for ( const auto& mask : fileMasks )
m_filterMasks.push_back(mask.Upper());
m_filterTypes = itemTypes;
return true;
}
bool wxExplorerBrowserImplHelper::_RemoveFilter()
{
m_filterMasks.clear();
return true;
}
bool wxExplorerBrowserImplHelper::_SetPaneSettings(const wxExplorerBrowser::PaneSettings& settings)
{
m_paneSettings = settings;
return true;
}
wxExplorerBrowserItem::Type wxExplorerBrowserImplHelper::_SFGAO2wxExplorerBrowserItemType(SFGAOF attr)
{
static const SFGAOF FileSystemFile = SFGAO_FILESYSTEM | SFGAO_STREAM;
static const SFGAOF FileSystemDirectory = SFGAO_FILESYSTEM | SFGAO_FOLDER;
static const SFGAOF VirtualZipDirectory = SFGAO_FILESYSTEM | SFGAO_FOLDER | SFGAO_STREAM;
// remove the the attributes we are not interested in
attr &= (SFGAO_FILESYSTEM | SFGAO_FOLDER | SFGAO_STREAM);
switch ( attr )
{
case 0:
return wxExplorerBrowserItem::Unknown;
case FileSystemFile:
case VirtualZipDirectory:
return wxExplorerBrowserItem::File;
case FileSystemDirectory:
return wxExplorerBrowserItem::Directory;
default:
return wxExplorerBrowserItem::Other;
}
}
bool wxExplorerBrowserImplHelper::_IShellItem2wxExplorerBrowserItem(IShellItem* item, wxExplorerBrowserItem& ebi)
{
wxCHECK(item, false);
static const SFGAOF mask = SFGAO_FILESYSTEM | SFGAO_FOLDER | SFGAO_STREAM | SFGAO_LINK;
HRESULT hr;
SFGAOF attr;
hr = item->GetAttributes(mask, &attr);
if ( FAILED(hr) )
{
wxLogApiError(wxS("(IShellItem::GetAttributesOf()"), hr);
return false;
}
PWSTR name = nullptr;
wxString path, displayName;
// will fail for non-filesystem items
if ( SUCCEEDED(item->GetDisplayName(SIGDN_FILESYSPATH, &name)) )
{
path = name;
::CoTaskMemFree(name);
}
hr = item->GetDisplayName(SIGDN_NORMALDISPLAY, &name);
if ( FAILED(hr) )
{
wxLogApiError(wxS("IShellItem::GetDisplayName(SIGDN_NORMALDISPLAY)"), hr);
return false;
}
else
{
displayName = name;
::CoTaskMemFree(name);
}
ebi.SetType(_SFGAO2wxExplorerBrowserItemType(attr));
ebi.SetPath(path);
ebi.SetDisplayName(displayName);
ebi.SetSFGAO(attr);
return true;
}
bool wxExplorerBrowserImplHelper::_PPIDL2wxExplorerBrowserItem(PCIDLIST_ABSOLUTE pidl, wxExplorerBrowserItem& ebi)
{
wxCHECK(pidl, false);
HRESULT hr;
wxCOMPtr<IShellItem> si;
hr = ::SHCreateItemFromIDList(pidl, wxIID_PPV_ARGS(IShellItem, &si));
if ( FAILED(hr) )
{
wxLogApiError(wxS("SHCreateItemFromIDList"), hr);
return false;
}
return _IShellItem2wxExplorerBrowserItem(si, ebi);
}
bool wxExplorerBrowserImplHelper::_SendNotifyEvent(wxEventType command, PCIDLIST_ABSOLUTE list) const
{
wxExplorerBrowserItem ebi;
if ( _PPIDL2wxExplorerBrowserItem(list, ebi) )
return _SendNotifyEvent(command, ebi);
return false;
}
bool wxExplorerBrowserImplHelper::_SendNotifyEvent(wxEventType command,
const wxExplorerBrowserItem& ebi) const
{
wxExplorerBrowserEvent evt(command, m_host->GetId());
evt.SetEventObject(m_host);
evt.SetItem(ebi);
if ( m_host->ProcessWindowEvent(evt) )
return evt.IsAllowed();
return true;
}
bool wxExplorerBrowserImplHelper::_GetSelectedItem(wxExplorerBrowserItem& ebi)
{
HRESULT hr;
wxCOMPtr<IFolderView2> fv2;
hr = m_explorerBrowser->GetCurrentView(wxIID_PPV_ARGS(IFolderView2, &fv2));
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::GetCurrentView()"), hr);
return false;
}
int selected;
if ( fv2->GetSelectedItem(-1, &selected) != S_OK )
{
// no selected items
return false;
}
wxCOMPtr<IShellItem> si;
hr = fv2->GetItem(selected, wxIID_PPV_ARGS(IShellItem, &si));
if ( FAILED(hr) )
{
wxLogApiError(wxS("IFolderView2::GetItem()"), hr);
return false;
}
return _IShellItem2wxExplorerBrowserItem(si, ebi);
}
} // unnamed namespace
/***************************************************************************
class wxExplorerBrowserImpl
---------------------------------
actual implemention of wxExplorerBrowser methods
*****************************************************************************/
class wxExplorerBrowser::wxExplorerBrowserImpl
{
public:
wxExplorerBrowserImpl(wxWindow* host) : m_host{host} {}
~wxExplorerBrowserImpl();
bool Create(const CreateStruct& createStruct, const wxString& path);
bool SetFolderSettings(const FolderSettings& folderSettings);
bool GetOptions(wxUint32& options);
bool SetOptions(wxUint32 options);
bool SetEmptyText(const wxString& text);
bool SetPropertyBag(const wxString& bag);
bool BrowseTo(const wxString& item, bool keepWordWheelText);
bool BrowseTo(BrowseTarget target, bool keepWordWheelText);
bool Refresh();
bool SearchFolder(const wxString& str);
bool RemoveAll();
bool SelectItems(const wxExplorerBrowserItem::List& items, bool notTakeFocus);
bool DeselectAllItems(bool notTakeFocus);
bool GetSelectedItems(wxExplorerBrowserItem::List& items, wxUint32 itemTypes);
bool GetAllItems(wxExplorerBrowserItem::List& items, wxUint32 itemTypes);
bool GetFolder(wxExplorerBrowserItem& item);
bool SetFilter(const wxArrayString& fileMasks, wxUint32 itemTypes);
bool RemoveFilter();
bool SetPaneSettings(const PaneSettings& settings);
void SetSize(const wxSize& size);
bool TranslateMessage(WXMSG* msg);
IExplorerBrowser* GetIExplorerBrowser() { return m_explorerBrowser.get(); }
private:
wxWindow* m_host {nullptr};;
wxCOMPtr<IExplorerBrowser> m_explorerBrowser;
wxCOMPtr<wxExplorerBrowserImplHelper> m_explorerBrowserHelper;
DWORD m_adviseCookie {0};
bool GetCurrentView(wxCOMPtr<IShellView>& sv);
bool GetCurrentView(wxCOMPtr<IFolderView2>& sv);
static bool ShellItemArrayToExplorerBrowserItemList(wxCOMPtr<IShellItemArray> shellItems,
wxExplorerBrowserItem::List& items, wxUint32 itemTypes);
};
wxExplorerBrowser::wxExplorerBrowserImpl::~wxExplorerBrowserImpl()
{
if ( m_explorerBrowser )
{
HRESULT hr;
if ( m_explorerBrowserHelper )
{
hr = Call_IUnknown_SetSite(m_explorerBrowser, nullptr);
if ( FAILED(hr) )
wxLogApiError(wxS("Call_IUnknown_SetSite()"), hr);
hr = m_explorerBrowser->Unadvise(m_adviseCookie);
if ( FAILED(hr) )
wxLogApiError(wxS("IExplorerBrowser::Unadvise()"), hr);
wxCOMPtr<IFolderFilterSite> ffs;
hr = m_explorerBrowser->QueryInterface(wxIID_PPV_ARGS(IFolderFilterSite, &ffs));
if ( SUCCEEDED(hr) )
{
hr = ffs->SetFilter(nullptr);
if ( FAILED(hr) )
wxLogApiError(wxS("IFolderFilterSite::SetFilter(nullptr)"), hr);
}
else
wxLogApiError(wxS("IExplorerBrowser::QueryInterface(IFolderFilterSite)"), hr);
}
hr = m_explorerBrowser->Destroy();
if ( FAILED(hr) )
wxLogApiError(wxS("IExplorerBrowser::Destroy()"), hr);
}
}
bool wxExplorerBrowser::wxExplorerBrowserImpl::Create(const CreateStruct& createStruct,
const wxString& path)
{
wxCHECK(m_host, false); // the host window must be already created
wxCHECK(!m_explorerBrowser, false); // prevent attempted multiple calls to Create()
HRESULT hr;
hr = ::CoCreateInstance(CLSID_ExplorerBrowser, nullptr, CLSCTX_INPROC,
wxIID_PPV_ARGS(IExplorerBrowser, &m_explorerBrowser));
if ( FAILED(hr) )
{
wxLogApiError(wxS("CoCreateInstance(CLSID_ExplorerBrowser)"), hr);
return false;
}
m_explorerBrowserHelper = new wxExplorerBrowserImplHelper(m_host, m_explorerBrowser.get());
// new wxExplorerBrowserImplHelper() creates the object with refcount = 1.
// wxCOMPtr lacks an attach-like method, assigning its value with operator=
// increases the refcount of the contained object to 2, which is wrong here,
// so we have to work around it and decrease the count back by calling Release()
// otherwise the owned object would never get destroyed.
m_explorerBrowserHelper->Release();
m_explorerBrowserHelper->_SetPaneSettings(createStruct.paneSettings);
hr = m_explorerBrowser->SetOptions(static_cast<::EXPLORER_BROWSER_OPTIONS>(createStruct.options));
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::SetOptions()"), hr);
return false;
}
hr = Call_IUnknown_SetSite(m_explorerBrowser,
static_cast<IUnknown*>(static_cast<IServiceProvider*>(m_explorerBrowserHelper)));
if ( FAILED(hr) )
{
wxLogApiError(wxS("Call_IUnknown_SetSite()"), hr);
return false;
}
wxCOMPtr<IFolderFilterSite> ffs;
hr = m_explorerBrowser->QueryInterface(wxIID_PPV_ARGS(IFolderFilterSite, &ffs));
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::QueryInterface(IFolderFilterSite)"), hr);
return false;
}
hr = ffs->SetFilter(static_cast<IUnknown*>(static_cast<IServiceProvider*>(m_explorerBrowserHelper)));
if ( FAILED(hr) )
{
wxLogApiError(wxS("IFolderFilterSite::SetFilter()"), hr);
return false;
}
RECT r = {0};
FOLDERSETTINGS fs = {0};
fs.ViewMode = createStruct.folderSettings.m_viewMode;
fs.fFlags = createStruct.folderSettings.m_flags;
hr = m_explorerBrowser->Initialize(m_host->GetHWND(), &r, &fs);
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::Initialize()"), hr);
return false;
}
hr = m_explorerBrowser->Advise(m_explorerBrowserHelper, &m_adviseCookie);
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::Advise()"), hr);
return false;
}
return BrowseTo(path, false);
}
bool wxExplorerBrowser::wxExplorerBrowserImpl::SetFolderSettings(const FolderSettings& folderSettings)
{
wxCHECK(m_explorerBrowser, false);
HRESULT hr;
FOLDERSETTINGS fs = {0};
fs.ViewMode = folderSettings.m_viewMode;
fs.fFlags = folderSettings.m_flags;
hr = m_explorerBrowser->SetFolderSettings(&fs);
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::SetFolderSettings()"), hr);
return false;
}
return true;
}
bool wxExplorerBrowser::wxExplorerBrowserImpl::SetPropertyBag(const wxString& bag)
{
wxCHECK(m_explorerBrowser, false);
HRESULT hr;
hr = m_explorerBrowser->SetPropertyBag(bag.wc_str());
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::SetPropertyBag()"), hr);
return false;
}
return true;
}
bool wxExplorerBrowser::wxExplorerBrowserImpl::GetOptions(wxUint32& options)
{
wxCHECK(m_explorerBrowser, false);
HRESULT hr;
::EXPLORER_BROWSER_OPTIONS ebo = static_cast<::EXPLORER_BROWSER_OPTIONS>(options);
hr = m_explorerBrowser->GetOptions(&ebo);
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::GetOptions()"), hr);
return false;
}
options = ebo;
return true;
}
bool wxExplorerBrowser::wxExplorerBrowserImpl::SetOptions(wxUint32 options)
{
wxCHECK(m_explorerBrowser, false);
HRESULT hr;
hr = m_explorerBrowser->SetOptions(static_cast<::EXPLORER_BROWSER_OPTIONS>(options));
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::SetOptions()"), hr);
return false;
}
return true;
}
bool wxExplorerBrowser::wxExplorerBrowserImpl::SetEmptyText(const wxString& text)
{
wxCHECK(m_explorerBrowser, false);
HRESULT hr;
hr = m_explorerBrowser->SetEmptyText(text.wc_str());
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::()"), hr);
return false;
}
return true;
}
bool wxExplorerBrowser::wxExplorerBrowserImpl::BrowseTo(const wxString& item, bool keepWordWheelText)
{
wxCHECK(m_explorerBrowser, false);
HRESULT hr;
PIDLIST_ABSOLUTE pidl = nullptr;
hr = ::SHParseDisplayName(PCWSTR(item.wc_str()), nullptr, &pidl, 0, nullptr);
if ( FAILED(hr) )
{
wxLogApiError(wxS("SHParseDisplayName()"), hr);
return false;
}
UINT flags = 0;
if ( keepWordWheelText )
flags |= SBSP_KEEPWORDWHEELTEXT;
hr = m_explorerBrowser->BrowseToIDList(pidl, flags);
::CoTaskMemFree(pidl);
if ( FAILED(hr) )
{
wxLogApiError(wxS("IExplorerBrowser::BrowseToIDList()"), hr);
return false;
}
return true;
}
bool wxExplorerBrowser::wxExplorerBrowserImpl::BrowseTo(BrowseTarget target, bool keepWordWheelText)
{
wxCHECK(m_explorerBrowser, false);
UINT flags;
switch ( target )
{
case Parent:
flags = SBSP_PARENT;
break;
case HistoryBack:
flags = SBSP_NAVIGATEBACK;
break;
case HistoryForward:
flags = SBSP_NAVIGATEFORWARD;
break;
default:
wxFAIL_MSG(wxS("Invalid item value"));
return false;
}
if ( keepWordWheelText )
flags |= SBSP_KEEPWORDWHEELTEXT;
HRESULT hr;