WSearchLineEdit: Model search history options as statics

As per the PR suggestions:

- #10942 (comment)
- #10942 (comment)

src/library/library_prefs.cpp

@@ -48,6 +48,16 @@ const ConfigKey mixxx::library::prefs::kSearchDebouncingTimeoutMillisConfigKey =
                 mixxx::library::prefs::kConfigGroup,
                 QStringLiteral("SearchDebouncingTimeoutMillis")};
 
+const ConfigKey mixxx::library::prefs::kEnableSearchCompletionsConfigKey =
+        ConfigKey{
+                mixxx::library::prefs::kConfigGroup,
+                QStringLiteral("EnableSearchCompletions")};
+
+const ConfigKey mixxx::library::prefs::kEnableSearchHistoryShortcutsConfigKey =
+        ConfigKey{
+                mixxx::library::prefs::kConfigGroup,
+                QStringLiteral("EnableSearchHistoryShortcuts")};
+
 // The "Export" suffix in the key is kept for backward compatibility
 const ConfigKey mixxx::library::prefs::kSyncTrackMetadataConfigKey =
         ConfigKey{

src/library/library_prefs.h

@@ -20,6 +20,10 @@ extern const ConfigKey kTrackDoubleClickActionConfigKey;
 
 extern const ConfigKey kSearchDebouncingTimeoutMillisConfigKey;
 
+extern const ConfigKey kEnableSearchCompletionsConfigKey;
+
+extern const ConfigKey kEnableSearchHistoryShortcutsConfigKey;
+
 extern const ConfigKey kEditMetadataSelectedClickConfigKey;
 
 extern const ConfigKey kHistoryMinTracksToKeepConfigKey;

src/preferences/dialog/dlgpreflibrary.cpp

@@ -23,13 +23,6 @@
 
 using namespace mixxx::library::prefs;
 
-namespace {
-
-const QString kEnableSearchCompletionsKey = QStringLiteral("EnableSearchCompletions");
-const QString kEnableSearchHistoryShortcutsKey = QStringLiteral("EnableSearchHistoryShortcuts");
-
-} // namespace
-
 DlgPrefLibrary::DlgPrefLibrary(
         QWidget* pParent,
         UserSettingsPointer pConfig,
@@ -97,12 +90,7 @@ DlgPrefLibrary::DlgPrefLibrary(
             this,
             &DlgPrefLibrary::slotSearchDebouncingTimeoutMillisChanged);
 
-    checkBoxEnableSearchCompletions->setChecked(m_pConfig->getValue(
-            ConfigKey(kConfigGroup, kEnableSearchCompletionsKey),
-            WSearchLineEdit::kEnableSearchCompletionsByDefault));
-    checkBoxEnableSearchHistoryShortcuts->setChecked(m_pConfig->getValue(
-            ConfigKey(kConfigGroup, kEnableSearchHistoryShortcutsKey),
-            WSearchLineEdit::kEnableSearchHistoryShortcutsByDefault));
+    searchHistoryOptionsChanged();
 
     connect(libraryFontButton, &QAbstractButton::clicked, this, &DlgPrefLibrary::slotSelectFont);
 
@@ -284,6 +272,13 @@ void DlgPrefLibrary::slotUpdate() {
     checkBoxEditMetadataSelectedClicked->setChecked(editMetadataSelectedClick);
     m_pLibrary->setEditMedatataSelectedClick(editMetadataSelectedClick);
 
+    checkBoxEnableSearchCompletions->setChecked(m_pConfig->getValue(
+            kEnableSearchCompletionsConfigKey,
+            WSearchLineEdit::kEnableSearchCompletionsByDefault));
+    checkBoxEnableSearchHistoryShortcuts->setChecked(m_pConfig->getValue(
+            kEnableSearchHistoryShortcutsConfigKey,
+            WSearchLineEdit::kEnableSearchHistoryShortcutsByDefault));
+
     m_originalTrackTableFont = m_pLibrary->getTrackTableFont();
     m_iOriginalTrackTableRowHeight = m_pLibrary->getTrackTableRowHeight();
     spinBoxRowHeight->setValue(m_iOriginalTrackTableRowHeight);
@@ -430,10 +425,11 @@ void DlgPrefLibrary::slotApply() {
     m_pConfig->set(kUseRelativePathOnExportConfigKey,
             ConfigValue((int)checkBox_use_relative_path->isChecked()));
 
-    m_pConfig->set(ConfigKey(kConfigGroup, kEnableSearchCompletionsKey),
+    m_pConfig->set(kEnableSearchCompletionsConfigKey,
             ConfigValue(checkBoxEnableSearchCompletions->isChecked()));
-    m_pConfig->set(ConfigKey(kConfigGroup, kEnableSearchHistoryShortcutsKey),
+    m_pConfig->set(kEnableSearchHistoryShortcutsConfigKey,
             ConfigValue(checkBoxEnableSearchHistoryShortcuts->isChecked()));
+    searchHistoryOptionsChanged();
 
     m_pConfig->set(ConfigKey("[Library]","ShowRhythmboxLibrary"),
                 ConfigValue((int)checkBox_show_rhythmbox->isChecked()));
@@ -517,6 +513,15 @@ void DlgPrefLibrary::slotSearchDebouncingTimeoutMillisChanged(int searchDebounci
     WSearchLineEdit::setDebouncingTimeoutMillis(searchDebouncingTimeoutMillis);
 }
 
+void DlgPrefLibrary::searchHistoryOptionsChanged() {
+    WSearchLineEdit::setSearchCompletionsEnabled(m_pConfig->getValue<bool>(
+            kEnableSearchCompletionsConfigKey,
+            WSearchLineEdit::kEnableSearchCompletionsByDefault));
+    WSearchLineEdit::setSearchHistoryShortcutsEnabled(m_pConfig->getValue<bool>(
+            kEnableSearchHistoryShortcutsConfigKey,
+            WSearchLineEdit::kEnableSearchHistoryShortcutsByDefault));
+}
+
 void DlgPrefLibrary::slotSyncTrackMetadataToggled() {
     if (isVisible() && checkBox_SyncTrackMetadata->isChecked()) {
         mixxx::DlgTrackMetadataExport::showMessageBoxOncePerSession();

src/preferences/dialog/dlgpreflibrary.h

@@ -59,6 +59,7 @@ class DlgPrefLibrary : public DlgPreferencePage, public Ui::DlgPrefLibraryDlg  {
   private:
     void initializeDirList();
     void setLibraryFont(const QFont& font);
+    void searchHistoryOptionsChanged();
 
     QStandardItemModel m_dirListModel;
     UserSettingsPointer m_pConfig;

src/widget/wsearchlineedit.cpp

@@ -32,9 +32,6 @@ const QString kDisabledText = QStringLiteral("- - -");
 const QString kLibraryConfigGroup = QStringLiteral("[Library]");
 const QString kSavedQueriesConfigGroup = QStringLiteral("[SearchQueries]");
 
-const QString kEnableSearchCompletionsKey = QStringLiteral("EnableSearchCompletions");
-const QString kEnableSearchHistoryShortcutsKey = QStringLiteral("EnableSearchHistoryShortcuts");
-
 // Border width, max. 2 px when focused (in official skins)
 constexpr int kBorderWidth = 2;
 
@@ -67,12 +64,24 @@ constexpr int WSearchLineEdit::kMaxSearchEntries;
 
 //static
 int WSearchLineEdit::s_debouncingTimeoutMillis = kDefaultDebouncingTimeoutMillis;
+bool WSearchLineEdit::s_searchCompletionsEnabled = kEnableSearchCompletionsByDefault;
+bool WSearchLineEdit::s_searchHistoryShortcutsEnabled = kEnableSearchHistoryShortcutsByDefault;
 
 //static
 void WSearchLineEdit::setDebouncingTimeoutMillis(int debouncingTimeoutMillis) {
     s_debouncingTimeoutMillis = verifyDebouncingTimeoutMillis(debouncingTimeoutMillis);
 }
 
+//static
+void WSearchLineEdit::setSearchCompletionsEnabled(bool searchCompletionsEnabled) {
+    s_searchCompletionsEnabled = searchCompletionsEnabled;
+}
+
+//static
+void WSearchLineEdit::setSearchHistoryShortcutsEnabled(bool searchHistoryShortcutsEnabled) {
+    s_searchHistoryShortcutsEnabled = searchHistoryShortcutsEnabled;
+}
+
 WSearchLineEdit::WSearchLineEdit(QWidget* pParent, UserSettingsPointer pConfig)
         : QComboBox(pParent),
           WBaseWidget(this),
@@ -321,8 +330,6 @@ bool WSearchLineEdit::eventFilter(QObject* obj, QEvent* event) {
 
 void WSearchLineEdit::keyPressEvent(QKeyEvent* keyEvent) {
     int currentTextIndex = 0;
-    bool isHistoryEnabled = m_pConfig->getValue<bool>(
-            ConfigKey(kLibraryConfigGroup, kEnableSearchHistoryShortcutsKey));
     switch (keyEvent->key()) {
     // Ctrl + F is handled in slotSetShortcutFocus()
     case Qt::Key_Backspace:
@@ -337,7 +344,7 @@ void WSearchLineEdit::keyPressEvent(QKeyEvent* keyEvent) {
         // If we're at the top of the list the Up key clears the search bar,
         // no matter if it's a saved or unsaved query.
         // Otherwise Up is handled by the combobox itself.
-        if (!isHistoryEnabled) {
+        if (!s_searchHistoryShortcutsEnabled) {
             return;
         }
         currentTextIndex = findCurrentTextIndex();
@@ -350,7 +357,7 @@ void WSearchLineEdit::keyPressEvent(QKeyEvent* keyEvent) {
     case Qt::Key_Down:
         // After clearing the text field the Down key
         // is expected to show the latest query
-        if (!isHistoryEnabled) {
+        if (!s_searchHistoryShortcutsEnabled) {
             return;
         }
         if (currentText().isEmpty()) {
@@ -380,7 +387,7 @@ void WSearchLineEdit::keyPressEvent(QKeyEvent* keyEvent) {
         return;
     case Qt::Key_Space:
         // Open/close popup with Ctrl + space
-        if (isHistoryEnabled && keyEvent->modifiers() == Qt::ControlModifier) {
+        if (s_searchHistoryShortcutsEnabled && keyEvent->modifiers() == Qt::ControlModifier) {
             if (view()->isVisible()) {
                 hidePopup();
             } else {
@@ -416,6 +423,7 @@ void WSearchLineEdit::focusInEvent(QFocusEvent* event) {
             << "focusInEvent";
 #endif // ENABLE_TRACE_LOG
     QComboBox::focusInEvent(event);
+    updateCompleter();
     updateClearAndDropdownButton(currentText());
 }
 
@@ -590,10 +598,6 @@ void WSearchLineEdit::refreshState() {
     } else {
         slotDisableSearch();
     }
-
-    bool isCompletionEnabled = m_pConfig->getValue<bool>(
-            ConfigKey(kLibraryConfigGroup, kEnableSearchCompletionsKey));
-    lineEdit()->setCompleter(isCompletionEnabled ? completer() : nullptr);
 }
 
 void WSearchLineEdit::showPopup() {
@@ -659,12 +663,8 @@ void WSearchLineEdit::updateClearAndDropdownButton(const QString& text) {
     const int paddingPx = text.isEmpty() ? 0 : m_innerHeight;
     const QString clearPos(layoutDirection() == Qt::RightToLeft ? "left" : "right");
 
-    // Hide the nonfunctional drop-down button (set width to 0) if the search or history is disabled.
-    const bool isHistoryEnabled = m_pConfig->getValue<bool>(
-            ConfigKey(kLibraryConfigGroup, kEnableSearchHistoryShortcutsKey));
-    const int dropDownWidth = isEnabled() && isHistoryEnabled
-            ? static_cast<int>(m_innerHeight * 0.7)
-            : 0;
+    // Hide the nonfunctional drop-down button (set width to 0) if the search is disabled.
+    const int dropDownWidth = isEnabled() ? static_cast<int>(m_innerHeight * 0.7) : 0;
 
     const QString styleSheet = QStringLiteral(
             "WSearchLineEdit { padding-%1: %2px; }"
@@ -682,6 +682,16 @@ void WSearchLineEdit::updateClearAndDropdownButton(const QString& text) {
     setStyleSheet(styleSheet);
 }
 
+void WSearchLineEdit::updateCompleter() {
+#if ENABLE_TRACE_LOG
+    kLogger.trace()
+            << "updateCompleter"
+            << text;
+#endif // ENABLE_TRACE_LOG
+
+    lineEdit()->setCompleter(s_searchCompletionsEnabled ? completer() : nullptr);
+}
+
 bool WSearchLineEdit::event(QEvent* pEvent) {
     if (pEvent->type() == QEvent::ToolTip) {
         updateTooltip();

src/widget/wsearchlineedit.h

@@ -27,6 +27,8 @@ class WSearchLineEdit : public QComboBox, public WBaseWidget {
 
     // TODO(XXX): Replace with a public slot
     static void setDebouncingTimeoutMillis(int debouncingTimeoutMillis);
+    static void setSearchCompletionsEnabled(bool searchCompletionsEnabled);
+    static void setSearchHistoryShortcutsEnabled(bool searchHistoryShortcutsEnabled);
     virtual void showPopup() override;
 
     explicit WSearchLineEdit(QWidget* pParent, UserSettingsPointer pConfig = nullptr);
@@ -76,12 +78,15 @@ class WSearchLineEdit : public QComboBox, public WBaseWidget {
     // value provider that sends signals whenever the corresponding
     // configuration value changes.
     static int s_debouncingTimeoutMillis;
+    static bool s_searchCompletionsEnabled;
+    static bool s_searchHistoryShortcutsEnabled;
 
     void refreshState();
 
     void enableSearch(const QString& text);
     void updateEditBox(const QString& text);
     void updateClearAndDropdownButton(const QString& text);
+    void updateCompleter();
     void deleteSelectedComboboxItem();
     void deleteSelectedListItem();