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
|
// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl.html *
// * Copyright (C) Zenju (zenju AT gmx DOT de) - All Rights Reserved *
// **************************************************************************
#include "folder_history_box.h"
#include <list>
#include <zen/scope_guard.h>
#include <wx/scrolwin.h>
#include <wx+/string_conv.h>
#include "../lib/resolve_path.h"
using namespace zen;
namespace
{
const wxEventType wxEVT_VALIDATE_USER_SELECTION = wxNewEventType();
}
FolderHistoryBox::FolderHistoryBox(wxWindow* parent,
wxWindowID id,
const wxString& value,
const wxPoint& pos,
const wxSize& size,
int n,
const wxString choices[],
long style,
const wxValidator& validator,
const wxString& name) :
wxComboBox(parent, id, value, pos, size, n, choices, style, validator, name)
#if wxCHECK_VERSION(2, 9, 1)
,dropDownShown(false)
#endif
{
//#####################################
/*##*/ SetMinSize(wxSize(150, -1)); //## workaround yet another wxWidgets bug: default minimum size is much too large for a wxComboBox
//#####################################
Connect(wxEVT_KEY_DOWN, wxKeyEventHandler (FolderHistoryBox::OnKeyEvent ), nullptr, this);
Connect(wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEventHandler(FolderHistoryBox::OnSelection ), nullptr, this);
Connect(wxEVT_MOUSEWHEEL, wxMouseEventHandler (FolderHistoryBox::OnMouseWheel), nullptr, this);
warn_static("mac")
#if defined FFS_WIN
//on Win, this mouse click event only fires, when clicking on the small down arrow, NOT when clicking on the text field
//thanks to wxWidgets' non-portability it's exactly the converse on Linux!
Connect(wxEVT_LEFT_DOWN, wxEventHandler(FolderHistoryBox::OnMouseClick), nullptr, this);
#elif defined FFS_LINUX //update on each text change: maybe a little too often, but we have no choice as long as we don't have an event right before showing the drop-down list
Connect(wxEVT_COMMAND_TEXT_UPDATED, wxEventHandler(FolderHistoryBox::OnMouseClick), nullptr, this);
#elif defined FFS_MAC
/*
calling setValueAndUpdateList()...
- on wxEVT_COMMAND_TEXT_UPDATED leads to endless loop (SetValue() seems to emit another wxEVT_COMMAND_TEXT_UPDATED asychronously)
- on wxEVT_LEFT_DOWN leads to occasional crashes, especially when double-clicking
*/
#endif
#if wxCHECK_VERSION(2, 9, 1)
Connect(wxEVT_COMMAND_COMBOBOX_DROPDOWN, wxCommandEventHandler(FolderHistoryBox::OnShowDropDown), nullptr, this); //only supported on Win/GTK
Connect(wxEVT_COMMAND_COMBOBOX_CLOSEUP, wxCommandEventHandler(FolderHistoryBox::OnHideDropDown), nullptr, this); //
#endif
Connect(wxEVT_VALIDATE_USER_SELECTION, wxCommandEventHandler(FolderHistoryBox::OnValidateSelection), nullptr, this);
}
#if wxCHECK_VERSION(2, 9, 1)
void FolderHistoryBox::OnShowDropDown(wxCommandEvent& event)
{
dropDownShown = true;
event.Skip();
}
void FolderHistoryBox::OnHideDropDown(wxCommandEvent& event)
{
dropDownShown = false;
event.Skip();
}
#endif
//set value and update list are technically entangled: see potential bug description below
void FolderHistoryBox::setValueAndUpdateList(const wxString& dirname)
{
//it may be a little lame to update the list on each mouse-button click, but it should be working and we dont't have to manipulate wxComboBox internals
std::list<Zstring> dirList;
//add some aliases to allow user changing to volume name and back, if possible
std::vector<Zstring> aliases = getDirectoryAliases(toZ(dirname));
dirList.insert(dirList.end(), aliases.begin(), aliases.end());
if (sharedHistory_.get())
{
std::vector<Zstring> tmp = sharedHistory_->getList();
std::sort(tmp.begin(), tmp.end(), LessFilename());
if (!dirList.empty() && !tmp.empty())
dirList.push_back(toZ(FolderHistory::separationLine()));
dirList.insert(dirList.end(), tmp.begin(), tmp.end());
}
//###########################################################################################
//attention: if the target value is not part of the dropdown list, SetValue() will look for a string that *starts with* this value:
//e.g. if the dropdown list contains "222" SetValue("22") will erroneously set and select "222" instead, while "111" would be set correctly!
// -> by design on Windows!
if (std::find(dirList.begin(), dirList.end(), toZ(dirname)) == dirList.end())
dirList.push_front(toZ(dirname));
Clear();
std::for_each(dirList.begin(), dirList.end(), [&](const Zstring& dir) { this->Append(toWx(dir)); });
//this->SetSelection(wxNOT_FOUND); //don't select anything
this->SetValue(dirname); //preserve main text!
}
void FolderHistoryBox::OnSelection(wxCommandEvent& event)
{
wxCommandEvent dummy2(wxEVT_VALIDATE_USER_SELECTION); //we cannot replace built-in commands at this position in call stack, so defer to a later time!
if (wxEvtHandler* handler = GetEventHandler())
handler->AddPendingEvent(dummy2);
event.Skip();
}
void FolderHistoryBox::OnValidateSelection(wxCommandEvent& event)
{
//const auto& value = GetValue();
//if (value == FolderHistory::separationLine())
// setValueAndUpdateList(wxString()); -> not good enough (resolved folder name not updated)
}
void FolderHistoryBox::OnKeyEvent(wxKeyEvent& event)
{
const int keyCode = event.GetKeyCode();
if (keyCode == WXK_DELETE || keyCode == WXK_NUMPAD_DELETE)
{
//try to delete the currently selected config history item
int pos = this->GetCurrentSelection();
if (0 <= pos && pos < static_cast<int>(this->GetCount()) &&
#if wxCHECK_VERSION(2, 9, 1)
dropDownShown)
#else
//what a mess...:
(GetValue() != GetString(pos) || //avoid problems when a character shall be deleted instead of list item
GetValue() == wxEmptyString)) //exception: always allow removing empty entry
#endif
{
//save old (selected) value: deletion seems to have influence on this
const wxString currentVal = this->GetValue();
//this->SetSelection(wxNOT_FOUND);
//delete selected row
if (sharedHistory_.get())
sharedHistory_->delItem(toZ(GetString(pos)));
SetString(pos, wxString()); //in contrast to Delete(), this one does not kill the drop-down list and gives a nice visual feedback!
//Delete(pos);
//(re-)set value
this->SetValue(currentVal);
//eat up key event
return;
}
}
event.Skip();
}
void FolderHistoryBox::OnMouseWheel(wxMouseEvent& event)
{
//although switching to available items is wxWidgets default, this is NOT windows default, e.g. explorer
//additionally this will delete manual entries, although all the users wanted is scroll the parent window!
//redirect to parent scrolled window!
wxWindow* wnd = this;
while ((wnd = wnd->GetParent()) != nullptr) //silence MSVC warning
if (dynamic_cast<wxScrolledWindow*>(wnd) != nullptr)
if (wxEvtHandler* evtHandler = wnd->GetEventHandler())
{
evtHandler->AddPendingEvent(event);
break;
}
// event.Skip();
}
|
