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
|
#include <QFont>
#include <QShortcut>
#include <QStyle>
#include "wsearchlineedit.h"
#include "wskincolor.h"
#include "wwidget.h"
#include "skin/skincontext.h"
#include "util/assert.h"
#include "util/logger.h"
namespace {
const mixxx::Logger kLogger("WSearchLineEdit");
const QColor kDefaultForegroundColor = QColor(0, 0, 0);
const QColor kDefaultBackgroundColor = QColor(255, 255, 255);
const QString kEmptySearch = "";
const QString kDisabledText = "- - -";
int verifyDebouncingTimeoutMillis(int debouncingTimeoutMillis) {
VERIFY_OR_DEBUG_ASSERT(debouncingTimeoutMillis >= WSearchLineEdit::kMinDebouncingTimeoutMillis) {
debouncingTimeoutMillis = WSearchLineEdit::kMinDebouncingTimeoutMillis;
}
VERIFY_OR_DEBUG_ASSERT(debouncingTimeoutMillis <= WSearchLineEdit::kMaxDebouncingTimeoutMillis) {
debouncingTimeoutMillis = WSearchLineEdit::kMaxDebouncingTimeoutMillis;
}
return debouncingTimeoutMillis;
}
} // namespace
//static
constexpr int WSearchLineEdit::kMinDebouncingTimeoutMillis;
//static
constexpr int WSearchLineEdit::kDefaultDebouncingTimeoutMillis;
//static
constexpr int WSearchLineEdit::kMaxDebouncingTimeoutMillis;
//static
int WSearchLineEdit::s_debouncingTimeoutMillis = kDefaultDebouncingTimeoutMillis;
//static
void WSearchLineEdit::setDebouncingTimeoutMillis(int debouncingTimeoutMillis) {
s_debouncingTimeoutMillis = verifyDebouncingTimeoutMillis(debouncingTimeoutMillis);
}
WSearchLineEdit::WSearchLineEdit(QWidget* pParent)
: QLineEdit(pParent),
WBaseWidget(this),
m_clearButton(new QToolButton(this)),
m_foregroundColor(kDefaultForegroundColor),
m_state(State::Inactive) {
DEBUG_ASSERT(kEmptySearch.isEmpty());
DEBUG_ASSERT(!kEmptySearch.isNull());
setAcceptDrops(false);
m_clearButton->setCursor(Qt::ArrowCursor);
m_clearButton->setObjectName("SearchClearButton");
// Assume the qss border is at least 1px wide
m_frameWidth = 1;
m_clearButton->hide();
connect(m_clearButton,
&QAbstractButton::clicked,
this,
&WSearchLineEdit::clearSearch);
// This prevents the searchbox from being focused by Tab key (real or emulated)
// so it is skipped when using the library controls 'MoveFocus[...]'
// The Clear button can still be focused by Tab.
setFocusPolicy(Qt::ClickFocus);
QShortcut* setFocusShortcut = new QShortcut(QKeySequence(tr("Ctrl+F", "Search|Focus")), this);
connect(setFocusShortcut,
&QShortcut::activated,
this,
&WSearchLineEdit::setShortcutFocus);
// Set up a timer to search after a few hundred milliseconds timeout. This
// stops us from thrashing the database if you type really fast.
m_debouncingTimer.setSingleShot(true);
connect(&m_debouncingTimer,
&QTimer::timeout,
this,
&WSearchLineEdit::triggerSearch);
connect(this,
&QLineEdit::textChanged,
this,
&WSearchLineEdit::updateText);
// When you hit enter, it will trigger the search.
connect(this,
&QLineEdit::returnPressed,
this,
&WSearchLineEdit::triggerSearch);
QSize clearButtonSize = m_clearButton->sizeHint();
// Ensures the text does not obscure the clear image.
setStyleSheet(QString("QLineEdit { padding-right: %1px; } ")
.arg(clearButtonSize.width() + m_frameWidth + 1));
showPlaceholder();
}
void WSearchLineEdit::setup(const QDomNode& node, const SkinContext& context) {
auto backgroundColor = kDefaultBackgroundColor;
QString bgColorName;
if (context.hasNodeSelectString(node, "BgColor", &bgColorName)) {
auto namedColor = QColor(bgColorName);
if (namedColor.isValid()) {
backgroundColor = namedColor;
setAutoFillBackground(true);
} else {
kLogger.warning()
<< "Failed to parse background color"
<< bgColorName;
}
}
backgroundColor = WSkinColor::getCorrectColor(backgroundColor);
kLogger.debug()
<< "Background color:"
<< backgroundColor;
const auto defaultForegroundColor =
QColor(
255 - backgroundColor.red(),
255 - backgroundColor.green(),
255 - backgroundColor.blue());
m_foregroundColor = defaultForegroundColor;
QString fgColorName;
if (context.hasNodeSelectString(node, "FgColor", &fgColorName)) {
auto namedColor = QColor(fgColorName);
if (namedColor.isValid()) {
m_foregroundColor = namedColor;
} else {
kLogger.warning()
<< "Failed to parse foreground color"
<< fgColorName;
}
}
m_foregroundColor = WSkinColor::getCorrectColor(m_foregroundColor);
VERIFY_OR_DEBUG_ASSERT(m_foregroundColor != backgroundColor) {
kLogger.warning()
<< "Invisible foreground color - using default color as fallback";
m_foregroundColor = defaultForegroundColor;
}
kLogger.debug()
<< "Foreground color:"
<< m_foregroundColor;
QPalette pal = palette();
DEBUG_ASSERT(backgroundColor != m_foregroundColor);
pal.setBrush(backgroundRole(), backgroundColor);
pal.setBrush(foregroundRole(), m_foregroundColor);
setPalette(pal);
m_clearButton->setToolTip(tr("Clear input") + "\n" +
tr("Clear the search bar input field") + "\n\n" +
tr("Shortcut") + ": \n" +
tr("Ctrl+Backspace"));
setToolTip(tr("Search", "noun") + "\n" +
tr("Enter a string to search for") + "\n" +
tr("Use operators like bpm:115-128, artist:BooFar, -year:1990") + "\n" +
tr("For more information see User Manual > Mixxx Library") + "\n\n" +
tr("Shortcut") + ": \n" +
tr("Ctrl+F") + " " + tr("Focus", "Give search bar input focus") + "\n" +
tr("Ctrl+Backspace") + " " + tr("Clear input", "Clear the search bar input field") + "\n" +
tr("Esc") + " " + tr("Exit search", "Exit search bar and leave focus"));
}
void WSearchLineEdit::resizeEvent(QResizeEvent* e) {
QLineEdit::resizeEvent(e);
m_innerHeight = this->height() - 2 * m_frameWidth;
// Test if this is a vertical resize due to changed library font.
// Assuming current button height is innerHeight from last resize,
// we will resize the Clear button icon only if height has changed.
if (m_clearButton->size().height() != m_innerHeight) {
QSize newSize = QSize(m_innerHeight, m_innerHeight);
m_clearButton->resize(newSize);
m_clearButton->setIconSize(newSize);
// Note(ronso0): For some reason this ensures the search text
// is being displayed after skin change/reload.
updateEditBox(getSearchText());
}
int top = rect().top() + m_frameWidth;
if (layoutDirection() == Qt::LeftToRight) {
m_clearButton->move(rect().right() - m_innerHeight - m_frameWidth, top);
} else {
m_clearButton->move(m_frameWidth, top);
}
}
QString WSearchLineEdit::getSearchText() const {
if (isEnabled() && (m_state == State::Active)) {
return text();
} else {
return QString();
}
}
void WSearchLineEdit::focusInEvent(QFocusEvent* event) {
QLineEdit::focusInEvent(event);
showSearchText(getSearchText());
}
void WSearchLineEdit::focusOutEvent(QFocusEvent* event) {
QLineEdit::focusOutEvent(event);
updateEditBox(getSearchText());
}
// slot
void WSearchLineEdit::disableSearch() {
restoreSearch(QString());
}
// slot
void WSearchLineEdit::restoreSearch(const QString& text) {
if (text.isNull()) {
// disable
setEnabled(false);
setText(kDisabledText);
} else {
setEnabled(true);
// Updating the placeholder implicitly updates the text and the clear button
updateEditBox(text);
}
}
// slot
void WSearchLineEdit::triggerSearch() {
m_debouncingTimer.stop();
emit search(getSearchText());
}
void WSearchLineEdit::showPlaceholder() {
DEBUG_ASSERT(isEnabled());
// Deactivate text change listener
m_state = State::Inactive;
setText(tr("Search...", "noun"));
QPalette pal = palette();
pal.setColor(foregroundRole(), Qt::lightGray);
setPalette(pal);
}
void WSearchLineEdit::showSearchText(const QString& text) {
|