File indexing completed on 2024-09-08 12:53:18

 /***************************************************************************
     smb4knetworkbrowser  -  The network browser widget of Smb4K.
                              -------------------
     begin                : Mo Jan 8 2007
     copyright            : (C) 2007-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 SMB4KNETWORKBROWSER_H
 #define SMB4KNETWORKBROWSER_H
 
 // Qt includes
 #include <QTreeWidget>
 
 // forward declarations
 class Smb4KNetworkBrowserItem;
 class Smb4KToolTip;
 
 /**
  * This is the network neighborhood browser widget.
  * 
  * @author Alexander Reinholdt <alexander.reinholdt@kdemail.net>
  */
 
 class Smb4KNetworkBrowser : public QTreeWidget
 {
   Q_OBJECT
 
   public:
     /**
      * The constructor
      *
      * @param parent        The parent widget
      */
     explicit Smb4KNetworkBrowser(QWidget *parent = 0);
 
     /**
      * The destructor
      */
     ~Smb4KNetworkBrowser();
 
     /**
      * Enumeration for the columns in the list view.
      */
     enum Columns{ Network = 0,
                   Type = 1,
                   IP = 2,
                   Comment = 3 };
 
     /**
      * This function returns TRUE if the mouse is inside the network
      * browser widget and FALSE otherwise.
      *
      * @returns TRUE if the mouse is inside the widget.
      */
     bool mouseInsideWidget() { return m_mouse_inside; }
 
   signals:
     /**
      * This signal is emitted when a tool tip is about to be shown.
      * 
      * @param item          The network browser item
      */
     void aboutToShowToolTip(Smb4KNetworkBrowserItem *item);
     
     /**
      * This signal is emitted when a tool tip is about to be hidden.
      * 
      * @param item          The network browser item
      */
     void aboutToHideToolTip(Smb4KNetworkBrowserItem *item);
 
   protected:
     /**
      * Reimplemented from QWidget.
      */
     bool event(QEvent *e) override;
 
     /**
      * Reimplemented from QWidget. This function keeps track of the
      * mouse position and handles the tool tips.
      *
      * @param e             The mouse event
      */
     void mouseMoveEvent(QMouseEvent *e) override;
 
     /**
      * Reimplemented from QWidget. This function emits the signal
      * mouseOutside().
      *
      * @param e             The event object
      */
     void leaveEvent(QEvent *e) override;
 
     /**
      * Reimplemented from QWidget. This function emits the signal
      * mouseInside().
      *
      * @param e             The event object
      */
     void enterEvent(QEvent *e) override;
 
     /**
      * Reimplemented from QAbstractItemView. This function handles
      * mouse press events.
      *
      * @param e             The mouse event object
      */
     void mousePressEvent(QMouseEvent *e) override;
 
     /**
      * Reimplemented from QAbstractItemView. This function is used
      * to stop the auto selection.
      *
      * @param e             The focus event
      */
     void focusOutEvent(QFocusEvent *e) override;
 
     /**
      * Reimplemented from QWidget. This function is used to handle
      * the tooltip.
      *
      * @param e             The wheel event
      */
     void wheelEvent(QWheelEvent *e) override;
 
   protected slots:
    /**
      * This slot is used to change the cursor over an item if appropriate.
      *
      * @param item          The item that was entered.
      *
      * @param column        The column where the item was entered.
      */
     void slotItemEntered(QTreeWidgetItem *item, int column);
 
     /**
      * This slot is invoked when the viewport is entered. It is used
      * to hide the tool tip if needed.
      */
     void slotViewportEntered();
 
     /**
      * This slot is called when the user activated an item. It is used
      * to open the item if it is expandable.
      * @param item          The item that has been activated.
      * @param column        The column where the item was activated.
      */
     void slotItemActivated(QTreeWidgetItem *item, int column);
 
     /**
      * Take care that only shares are selected when the user marks multiple
      * shares.
      */    
     void slotItemSelectionChanged();
 
   private:
     /**
      * The item for that a tool tip is shown
      */
     Smb4KNetworkBrowserItem *m_tooltip_item;
     
     /**
      * Mouse inside the widget?
      */
     bool m_mouse_inside;
 };
 
 #endif