File indexing completed on 2024-04-21 15:42:43

 /***************************************************************************
     This class provides the basic network item for the core library of 
     Smb4K.
                              -------------------
     begin                : Do Apr 2 2009
     copyright            : (C) 2009-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 SMB4KBASICNETWORKITEM_H
 #define SMB4KBASICNETWORKITEM_H
 
 // application specific includes
 #include "smb4kglobal.h"
 
 // Qt includes
 #include <QString>
 #include <QScopedPointer>
 #include <QIcon>
 #include <QUrl>
 
 // forward declarations
 class Smb4KBasicNetworkItemPrivate;
 
 /**
  * This is the basic class from which all other network item classes
  * are derived.
  * 
  * @author Alexander Reinholdt <alexander.reinholdt@kdemail.net>
  * @since 1.0.0
  */
 
 class Q_DECL_EXPORT Smb4KBasicNetworkItem
 {
   public:
     /**
      * The constructor
      */
     explicit Smb4KBasicNetworkItem(Smb4KGlobal::NetworkItem type = Smb4KGlobal::UnknownNetworkItem);
 
     /**
      * The copy constructor
      */
     Smb4KBasicNetworkItem(const Smb4KBasicNetworkItem &item);
     
     /**
      * The destructor
      */
     ~Smb4KBasicNetworkItem();
 
     /**
      * This function returns the type of the basic network
      * item.
      *
      * @returns the type.
      */
     Smb4KGlobal::NetworkItem type() const;
 
     /**
      * This function sets the icon of the network item.
      * 
      * @param icon          The icon
      */
     void setIcon(const QIcon &icon);
     
     /**
      * This function returns the icon of the network item. By default, it
      * is the null icon. You must set the appropriate icon either in
      * a class that inherits this one or from somewhere else.
      * 
      * @returns the network item's icon.
      */
     QIcon icon() const;
     
     /**
      * Set the URL for this network item.
      * 
      * @param url           The URL
      */
     void setUrl(const QUrl &url);
     
     /**
      * Return the URL for this network item.
      * 
      * @returns the URL
      */
     QUrl url() const;
     
   protected:
     /**
      * Expose a pointer to the private URL variable.
      */
     QUrl *pUrl;
     
     /**
      * Export a pointer to the private icon variable.
      */
     QIcon *pIcon;
     
   private:
     const QScopedPointer<Smb4KBasicNetworkItemPrivate> d;
 };
 
 #endif