File indexing completed on 2024-04-14 15:05:37

 /***************************************************************************
     This class provides the network search toolbar.
                              -------------------
     begin                : Su Dec 23 2018
     copyright            : (C) 2018-2019 by Alexander Reinholdt
     email                : alexander.reinholdt@kdemail.net
  ***************************************************************************/
 
 /***************************************************************************
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
  *   (at your option) any later version.                                   *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful, but   *
  *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
  *   General Public License for more details.                              *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc., 51 Franklin Street, Suite 500, Boston,*
  *   MA 02110-1335, USA                                                    *
  ***************************************************************************/
 
 #ifndef SMB4KNETWORKSEARCHBAR_H
 #define SMB4KNETWORKSEARCHBAR_H
 
 // application specific includes
 #include "core/smb4kglobal.h"
 
 // Qt includes
 #include <QToolBar>
 #include <QList>
 #include <QListIterator>
 
 
 class Smb4KNetworkSearchToolBar : public QToolBar
 {
   Q_OBJECT
   
   public:
     /**
      * Constructor
      */
     Smb4KNetworkSearchToolBar(QWidget *parent = 0);
     
     /**
      * Destructor
      */
     ~Smb4KNetworkSearchToolBar();
     
     /**
      * Sets the focus to the search combo box
      */
     void prepareInput();
     
     /**
      * Set the active state
      * 
      * @param active          The state
      */
     void setActiveState(bool active);
     
     /**
      * Set the search result
      * 
      * @param list            The list of search results
      */
     void setSearchResults(const QList<SharePtr> &list);
     
     /**
      * Clear the search
      */
     void clearSearch();
     
     /**
      * Set the completion strings. This function should be invoked before the
      * search toolbar is shown.
      * 
      * @param strings         The list of completion strings
      */
     void setCompletionStrings(const QStringList &strings);
     
     /**
      * Get the completion strings.
      * 
      * @returns the completion strings
      */
     QStringList completionStrings() const;
     
   Q_SIGNALS:
     /**
      * Emitted when the search toolbar is to be closed (should be hidden)
      */
     void close();
     
     /**
      * Emitted when a search should be done
      */
     void search(const QString &item);
     
     /**
      * Emitted when a search should be stopped
      */
     void abort();
     
     /**
      * Emitted when either the up or down action was clicked
      */
     void jumpToResult(const QString &url);
     
     /**
      * Emitted when the search is cleared
      */
     void clearSearchResults();
     
   protected Q_SLOTS:
     /**
      * Called when the return key was pressed
      */
     void slotReturnKeyPressed();
     
     /**
      * Called when the search dual action is toggled
      */
     void slotSearchActionTriggered();
     
     /**
      * Called when the close button was pressed
      */
     void slotCloseButtonPressed();
     
     /**
      * Called when the down action was triggered
      */
     void slotDownActionTriggered();
     
     /**
      * Called when the up action was triggered
      */
     void slotUpActionTriggered();
     
     /**
      * Called when the search is cleared
      */
     void slotClearSearch();
     
   private:
     /**
      * The search results
      */
     QStringList m_searchResults;
     
     /**
      * String list iterator
      */
     QStringListIterator m_iterator;
 };
 
 #endif