#include <searchwidget.h>

Inheritance diagram for SearchWidget:

Collaboration diagram for SearchWidget:

[legend]

Public Member Functions
	SearchWidget (MainWindow *mainWindow)

	~SearchWidget () override

void	giveFocusToSearchInput ()

Private Slots
void	on_searchButton_clicked ()

void	on_pluginsButton_clicked ()

Private Member Functions
bool	eventFilter (QObject object, QEvent event) override

void	tabChanged (int index)

void	closeTab (int index)

void	closeAllTabs ()

void	tabStatusChanged (QWidget *tab)

void	selectMultipleBox (int index)

void	toggleFocusBetweenLineEdits ()

void	fillCatCombobox ()

void	fillPluginComboBox ()

void	selectActivePage ()

void	searchTextEdited (const QString &)

QString	selectedCategory () const

QString	selectedPlugin () const

Private Attributes
Ui::SearchWidget *	m_ui

QPointer< SearchJobWidget >	m_currentSearchTab

QPointer< SearchJobWidget >	m_activeSearchTab

QList< SearchJobWidget * >	m_allTabs

MainWindow *	m_mainWindow

bool	m_isNewQueryString

Detailed Description

Definition at line 49 of file searchwidget.h.

Constructor & Destructor Documentation

◆ SearchWidget()

SearchWidget::SearchWidget ( MainWindow * mainWindow )

explicit

Definition at line 87 of file searchwidget.cpp.

     : QWidget(mainWindow)
     , m_ui(new Ui::SearchWidget())
     , m_mainWindow(mainWindow)
     , m_isNewQueryString(false)
 {
     m_ui->setupUi(this);
     m_ui->tabWidget->tabBar()->installEventFilter(this);
  
     QString searchPatternHint;
     QTextStream stream(&searchPatternHint, QIODevice::WriteOnly);
     stream << "<html><head/><body><p>"
            << tr("A phrase to search for.") << "<br>"
            << tr("Spaces in a search term may be protected by double quotes.")
            << "</p><p>"
            << tr("Example:", "Search phrase example")
            << "<br>"
            << tr("<b>foo bar</b>: search for <b>foo</b> and <b>bar</b>",
                  "Search phrase example, illustrates quotes usage, a pair of "
                  "space delimited words, individal words are highlighted")
            << "<br>"
            << tr("<b>&quot;foo bar&quot;</b>: search for <b>foo bar</b>",
                  "Search phrase example, illustrates quotes usage, double quoted"
                  "pair of space delimited words, the whole pair is highlighted")
            << "</p></body></html>";
     m_ui->lineEditSearchPattern->setToolTip(searchPatternHint);
  
 #ifndef Q_OS_MACOS
     // Icons
     m_ui->searchButton->setIcon(UIThemeManager::instance()->getIcon("edit-find"));
     m_ui->pluginsButton->setIcon(UIThemeManager::instance()->getIcon("preferences-system-network"));
 #else
     // On macOS the icons overlap the text otherwise
     QSize iconSize = m_ui->tabWidget->iconSize();
     iconSize.setWidth(iconSize.width() + 16);
     m_ui->tabWidget->setIconSize(iconSize);
 #endif
     connect(m_ui->tabWidget, &QTabWidget::tabCloseRequested, this, &SearchWidget::closeTab);
     connect(m_ui->tabWidget, &QTabWidget::currentChanged, this, &SearchWidget::tabChanged);
  
     const auto *searchManager = SearchPluginManager::instance();
     const auto onPluginChanged = [this]()
     {
         fillPluginComboBox();
         fillCatCombobox();
         selectActivePage();
     };
     connect(searchManager, &SearchPluginManager::pluginInstalled, this, onPluginChanged);
     connect(searchManager, &SearchPluginManager::pluginUninstalled, this, onPluginChanged);
     connect(searchManager, &SearchPluginManager::pluginUpdated, this, onPluginChanged);
     connect(searchManager, &SearchPluginManager::pluginEnabled, this, onPluginChanged);
  
     // Fill in category combobox
     onPluginChanged();
  
     connect(m_ui->lineEditSearchPattern, &LineEdit::returnPressed, m_ui->searchButton, &QPushButton::click);
     connect(m_ui->lineEditSearchPattern, &LineEdit::textEdited, this, &SearchWidget::searchTextEdited);
     connect(m_ui->selectPlugin, qOverload<int>(&QComboBox::currentIndexChanged)
             , this, &SearchWidget::selectMultipleBox);
     connect(m_ui->selectPlugin, qOverload<int>(&QComboBox::currentIndexChanged)
             , this, &SearchWidget::fillCatCombobox);
  
     const auto focusSearchHotkey = new QShortcut(QKeySequence::Find, this);
     connect(focusSearchHotkey, &QShortcut::activated, this, &SearchWidget::toggleFocusBetweenLineEdits);
 }

References closeTab(), fillCatCombobox(), fillPluginComboBox(), SearchPluginManager::instance(), UIThemeManager::instance(), m_ui, SearchPluginManager::pluginEnabled(), SearchPluginManager::pluginInstalled(), SearchPluginManager::pluginUninstalled(), SearchPluginManager::pluginUpdated(), searchTextEdited(), selectActivePage(), selectMultipleBox(), tabChanged(), and toggleFocusBetweenLineEdits().

Here is the call graph for this function:

◆ ~SearchWidget()

SearchWidget::~SearchWidget ( )

override

Definition at line 253 of file searchwidget.cpp.

 {
     qDebug("Search destruction");
     delete m_ui;
 }

References m_ui.

Member Function Documentation

◆ closeAllTabs()

void SearchWidget::closeAllTabs ( )

private

Definition at line 397 of file searchwidget.cpp.

 {
     for (int i = (m_allTabs.size() - 1); i >= 0; --i)
         closeTab(i);
 }

References closeTab(), and m_allTabs.

Referenced by eventFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ closeTab()

void SearchWidget::closeTab ( int index )

private

Definition at line 388 of file searchwidget.cpp.

 {
     SearchJobWidget *tab = m_allTabs.takeAt(index);
     if (tab == m_activeSearchTab)
         m_ui->searchButton->setText(tr("Search"));
  
     delete tab;
 }

References m_activeSearchTab, m_allTabs, and m_ui.

Referenced by closeAllTabs(), eventFilter(), and SearchWidget().

Here is the caller graph for this function:

◆ eventFilter()

bool SearchWidget::eventFilter	(	QObject *	object,
		QEvent *	event
	)

overrideprivate

Definition at line 153 of file searchwidget.cpp.

 {
     if (object == m_ui->tabWidget->tabBar())
     {
         // Close tabs when middle-clicked
         if (event->type() != QEvent::MouseButtonRelease)
             return false;
  
         const auto mouseEvent = static_cast<QMouseEvent *>(event);
         const int tabIndex = m_ui->tabWidget->tabBar()->tabAt(mouseEvent->pos());
         if ((mouseEvent->button() == Qt::MiddleButton) && (tabIndex >= 0))
         {
             closeTab(tabIndex);
             return true;
         }
         if (mouseEvent->button() == Qt::RightButton)
         {
             QMenu *menu = new QMenu(this);
             menu->setAttribute(Qt::WA_DeleteOnClose);
             menu->addAction(tr("Close tab"), this, [this, tabIndex]() { closeTab(tabIndex); });
             menu->addAction(tr("Close all tabs"), this, &SearchWidget::closeAllTabs);
             menu->popup(QCursor::pos());
             return true;
         }
         return false;
     }
     return QWidget::eventFilter(object, event);
 }

References closeAllTabs(), closeTab(), and m_ui.

Here is the call graph for this function:

◆ fillCatCombobox()

void SearchWidget::fillCatCombobox ( )

private

Definition at line 182 of file searchwidget.cpp.

 {
     m_ui->comboCategory->clear();
     m_ui->comboCategory->addItem(SearchPluginManager::categoryFullName("all"), "all");
  
     using QStrPair = std::pair<QString, QString>;
     QVector<QStrPair> tmpList;
     for (const QString &cat : asConst(SearchPluginManager::instance()->getPluginCategories(selectedPlugin())))
         tmpList << std::make_pair(SearchPluginManager::categoryFullName(cat), cat);
     std::sort(tmpList.begin(), tmpList.end(), [](const QStrPair &l, const QStrPair &r) { return (QString::localeAwareCompare(l.first, r.first) < 0); });
  
     for (const QStrPair &p : asConst(tmpList))
     {
         qDebug("Supported category: %s", qUtf8Printable(p.second));
         m_ui->comboCategory->addItem(p.first, p.second);
     }
  
     if (m_ui->comboCategory->count() > 1)
         m_ui->comboCategory->insertSeparator(1);
 }

References asConst(), SearchPluginManager::categoryFullName(), anonymous_namespace{searchcontroller.cpp}::getPluginCategories(), SearchPluginManager::instance(), m_ui, and selectedPlugin().

Referenced by SearchWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillPluginComboBox()

void SearchWidget::fillPluginComboBox ( )

private

Definition at line 203 of file searchwidget.cpp.

 {
     m_ui->selectPlugin->clear();
     m_ui->selectPlugin->addItem(tr("Only enabled"), "enabled");
     m_ui->selectPlugin->addItem(tr("All plugins"), "all");
     m_ui->selectPlugin->addItem(tr("Select..."), "multi");
  
     using QStrPair = std::pair<QString, QString>;
     QVector<QStrPair> tmpList;
     for (const QString &name : asConst(SearchPluginManager::instance()->enabledPlugins()))
         tmpList << std::make_pair(SearchPluginManager::instance()->pluginFullName(name), name);
     std::sort(tmpList.begin(), tmpList.end(), [](const QStrPair &l, const QStrPair &r) { return (l.first < r.first); } );
  
     for (const QStrPair &p : asConst(tmpList))
         m_ui->selectPlugin->addItem(p.first, p.second);
  
     if (m_ui->selectPlugin->count() > 3)
         m_ui->selectPlugin->insertSeparator(3);
 }

References asConst(), SearchPluginManager::instance(), and m_ui.

Referenced by SearchWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ giveFocusToSearchInput()

void SearchWidget::giveFocusToSearchInput ( )

Definition at line 299 of file searchwidget.cpp.

 {
     m_ui->lineEditSearchPattern->setFocus();
 }

References m_ui.

◆ on_pluginsButton_clicked

void SearchWidget::on_pluginsButton_clicked ( )

privateslot

Definition at line 287 of file searchwidget.cpp.

 {
     new PluginSelectDialog(SearchPluginManager::instance(), this);
 }

References SearchPluginManager::instance().

Referenced by selectMultipleBox().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ on_searchButton_clicked

void SearchWidget::on_searchButton_clicked ( )

privateslot

Definition at line 305 of file searchwidget.cpp.

 {
     if (!Utils::ForeignApps::pythonInfo().isValid())
     {
         m_mainWindow->showNotificationBalloon(tr("Search Engine"), tr("Please install Python to use the Search Engine."));
         return;
     }
  
     if (m_activeSearchTab)
     {
         m_activeSearchTab->cancelSearch();
         if (!m_isNewQueryString)
         {
             m_ui->searchButton->setText(tr("Search"));
             return;
         }
     }
  
     m_isNewQueryString = false;
  
     const QString pattern = m_ui->lineEditSearchPattern->text().trimmed();
     // No search pattern entered
     if (pattern.isEmpty())
     {
         QMessageBox::critical(this, tr("Empty search pattern"), tr("Please type a search pattern first"));
         return;
     }
  
     QStringList plugins;
     if (selectedPlugin() == "all")
         plugins = SearchPluginManager::instance()->allPlugins();
     else if (selectedPlugin() == "enabled")
         plugins = SearchPluginManager::instance()->enabledPlugins();
     else if (selectedPlugin() == "multi")
         plugins = SearchPluginManager::instance()->enabledPlugins();
     else
         plugins << selectedPlugin();
  
     qDebug("Search with category: %s", qUtf8Printable(selectedCategory()));
  
     // Launch search
     auto *searchHandler = SearchPluginManager::instance()->startSearch(pattern, selectedCategory(), plugins);
  
     // Tab Addition
     auto *newTab = new SearchJobWidget(searchHandler, this);
     m_allTabs.append(newTab);
  
     QString tabName = pattern;
     tabName.replace(QRegularExpression("&{1}"), "&&");
     m_ui->tabWidget->addTab(newTab, tabName);
     m_ui->tabWidget->setCurrentWidget(newTab);
  
     connect(newTab, &SearchJobWidget::statusChanged, this, [this, newTab]() { tabStatusChanged(newTab); });
  
     m_ui->searchButton->setText(tr("Stop"));
     m_activeSearchTab = newTab;
     tabStatusChanged(newTab);
 }

References SearchPluginManager::allPlugins(), SearchPluginManager::enabledPlugins(), SearchPluginManager::instance(), m_activeSearchTab, m_allTabs, m_isNewQueryString, m_mainWindow, m_ui, Utils::ForeignApps::pythonInfo(), selectedCategory(), selectedPlugin(), MainWindow::showNotificationBalloon(), SearchPluginManager::startSearch(), SearchJobWidget::statusChanged(), and tabStatusChanged().

Here is the call graph for this function:

◆ searchTextEdited()

void SearchWidget::searchTextEdited ( const QString & )

private

Definition at line 292 of file searchwidget.cpp.

 {
     // Enable search button
     m_ui->searchButton->setText(tr("Search"));
     m_isNewQueryString = true;
 }

References m_isNewQueryString, and m_ui.

Referenced by SearchWidget().

Here is the caller graph for this function:

◆ selectActivePage()

void SearchWidget::selectActivePage ( )

private

Definition at line 233 of file searchwidget.cpp.

 {
     if (SearchPluginManager::instance()->allPlugins().isEmpty())
     {
         m_ui->stackedPages->setCurrentWidget(m_ui->emptyPage);
         m_ui->lineEditSearchPattern->setEnabled(false);
         m_ui->comboCategory->setEnabled(false);
         m_ui->selectPlugin->setEnabled(false);
         m_ui->searchButton->setEnabled(false);
     }
     else
     {
         m_ui->stackedPages->setCurrentWidget(m_ui->searchPage);
         m_ui->lineEditSearchPattern->setEnabled(true);
         m_ui->comboCategory->setEnabled(true);
         m_ui->selectPlugin->setEnabled(true);
         m_ui->searchButton->setEnabled(true);
     }
 }

References SearchPluginManager::instance(), and m_ui.

Referenced by SearchWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectedCategory()

QString SearchWidget::selectedCategory ( ) const

private

Definition at line 223 of file searchwidget.cpp.

 {
     return m_ui->comboCategory->itemData(m_ui->comboCategory->currentIndex()).toString();
 }

References m_ui.

Referenced by on_searchButton_clicked().

Here is the caller graph for this function:

◆ selectedPlugin()

QString SearchWidget::selectedPlugin ( ) const

private

Definition at line 228 of file searchwidget.cpp.

 {
     return m_ui->selectPlugin->itemData(m_ui->selectPlugin->currentIndex()).toString();
 }

References m_ui.

Referenced by fillCatCombobox(), on_searchButton_clicked(), and selectMultipleBox().

Here is the caller graph for this function:

◆ selectMultipleBox()

void SearchWidget::selectMultipleBox ( int index )

private

Definition at line 266 of file searchwidget.cpp.

 {
     Q_UNUSED(index);
     if (selectedPlugin() == "multi")
         on_pluginsButton_clicked();
 }

References on_pluginsButton_clicked(), and selectedPlugin().

Referenced by SearchWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tabChanged()

void SearchWidget::tabChanged ( int index )

private

Definition at line 259 of file searchwidget.cpp.

 {
     // when we switch from a tab that is not empty to another that is empty
     // the download button doesn't have to be available
     m_currentSearchTab = ((index < 0) ? nullptr : m_allTabs.at(m_ui->tabWidget->currentIndex()));
 }

References m_allTabs, m_currentSearchTab, and m_ui.

Referenced by SearchWidget().

Here is the caller graph for this function:

◆ tabStatusChanged()

void SearchWidget::tabStatusChanged ( QWidget * tab )

private

Definition at line 364 of file searchwidget.cpp.

 {
     const int tabIndex = m_ui->tabWidget->indexOf(tab);
     m_ui->tabWidget->setTabToolTip(tabIndex, tab->statusTip());
     m_ui->tabWidget->setTabIcon(tabIndex, UIThemeManager::instance()->getIcon(
                                  statusIconName(static_cast<SearchJobWidget *>(tab)->status())));
  
     if ((tab == m_activeSearchTab) && (m_activeSearchTab->status() != SearchJobWidget::Status::Ongoing))
     {
         Q_ASSERT(m_activeSearchTab->status() != SearchJobWidget::Status::Ongoing);
  
         if (m_mainWindow->isNotificationsEnabled() && (m_mainWindow->currentTabWidget() != this))
         {
             if (m_activeSearchTab->status() == SearchJobWidget::Status::Error)
                 m_mainWindow->showNotificationBalloon(tr("Search Engine"), tr("Search has failed"));
             else
                 m_mainWindow->showNotificationBalloon(tr("Search Engine"), tr("Search has finished"));
         }
  
         m_activeSearchTab = nullptr;
         m_ui->searchButton->setText(tr("Search"));
     }
 }

References MainWindow::currentTabWidget(), SearchJobWidget::Error, UIThemeManager::instance(), MainWindow::isNotificationsEnabled(), m_activeSearchTab, m_mainWindow, m_ui, SearchJobWidget::Ongoing, MainWindow::showNotificationBalloon(), and anonymous_namespace{searchwidget.cpp}::statusIconName().

Referenced by on_searchButton_clicked().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toggleFocusBetweenLineEdits()

void SearchWidget::toggleFocusBetweenLineEdits ( )

private

Definition at line 273 of file searchwidget.cpp.

 {
     if (m_ui->lineEditSearchPattern->hasFocus() && m_currentSearchTab)
     {
         m_currentSearchTab->lineEditSearchResultsFilter()->setFocus();
         m_currentSearchTab->lineEditSearchResultsFilter()->selectAll();
     }
     else
     {
         m_ui->lineEditSearchPattern->setFocus();
         m_ui->lineEditSearchPattern->selectAll();
     }
 }

References m_currentSearchTab, and m_ui.

Referenced by SearchWidget().

Here is the caller graph for this function:

Member Data Documentation

◆ m_activeSearchTab

QPointer<SearchJobWidget> SearchWidget::m_activeSearchTab

private

Definition at line 83 of file searchwidget.h.

Referenced by closeTab(), on_searchButton_clicked(), and tabStatusChanged().

◆ m_allTabs

QList<SearchJobWidget *> SearchWidget::m_allTabs

private

Definition at line 84 of file searchwidget.h.

Referenced by closeAllTabs(), closeTab(), on_searchButton_clicked(), and tabChanged().

◆ m_currentSearchTab

QPointer<SearchJobWidget> SearchWidget::m_currentSearchTab

private

Definition at line 82 of file searchwidget.h.

Referenced by tabChanged(), and toggleFocusBetweenLineEdits().

◆ m_isNewQueryString

bool SearchWidget::m_isNewQueryString

private

Definition at line 86 of file searchwidget.h.

Referenced by on_searchButton_clicked(), and searchTextEdited().

◆ m_mainWindow

MainWindow* SearchWidget::m_mainWindow

private

Definition at line 85 of file searchwidget.h.

Referenced by on_searchButton_clicked(), and tabStatusChanged().

◆ m_ui

Ui::SearchWidget* SearchWidget::m_ui

private

Definition at line 81 of file searchwidget.h.

Referenced by closeTab(), eventFilter(), fillCatCombobox(), fillPluginComboBox(), giveFocusToSearchInput(), on_searchButton_clicked(), searchTextEdited(), SearchWidget(), selectActivePage(), selectedCategory(), selectedPlugin(), tabChanged(), tabStatusChanged(), toggleFocusBetweenLineEdits(), and ~SearchWidget().

The documentation for this class was generated from the following files:

src/gui/search/searchwidget.h
src/gui/search/searchwidget.cpp

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SearchWidget()

◆ ~SearchWidget()

Member Function Documentation

◆ closeAllTabs()

◆ closeTab()

◆ eventFilter()

◆ fillCatCombobox()

◆ fillPluginComboBox()

◆ giveFocusToSearchInput()

◆ on_pluginsButton_clicked

◆ on_searchButton_clicked

◆ searchTextEdited()

◆ selectActivePage()

◆ selectedCategory()

◆ selectedPlugin()

◆ selectMultipleBox()

◆ tabChanged()

◆ tabStatusChanged()

◆ toggleFocusBetweenLineEdits()

Member Data Documentation

◆ m_activeSearchTab

◆ m_allTabs

◆ m_currentSearchTab

◆ m_isNewQueryString

◆ m_mainWindow

◆ m_ui