File indexing completed on 2024-05-05 04:48:13

 /****************************************************************************************
  * Copyright (c) 2008 Nikolaj Hald Nielsen <nhn@kde.org>                                *
  *                                                                                      *
  * 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, see <http://www.gnu.org/licenses/>.                           *
  ****************************************************************************************/
 
 #ifndef SOURCEINFOCAPABILITY_H
 #define SOURCEINFOCAPABILITY_H
 
 #include "core/amarokcore_export.h"
 #include "core/capabilities/Capability.h"
 
 class QPixmap;
 
 namespace Capabilities
 {
 
     /**
     This capability allows getting additional information about the source of a meta item. For now, it is intended for allowing the playlist to display a little emblem to let users know if a track is a Magnatune preview track, a lastfm stream or so on...
 
         @author Nikolaj Hald Nielsen <nhn@kde.org>
     */
     class AMAROKCORE_EXPORT SourceInfoCapability : public Capabilities::Capability{
     public:
         Q_OBJECT
         public:
             /**
              * Constructor
              */
             SourceInfoCapability();
             /**
              * Destructor
              */
             ~SourceInfoCapability() override;
 
             /**
              * Get the human readable name of the source, for instance "Magnatune.com"
              * @return The name of the source
              */
             virtual QString sourceName() = 0;
             /**
              * Get a brief human readable description or the source
              * @return The source description
              */
             virtual QString sourceDescription() = 0;
             /**
              * Get a small 16x16 pixle emblem that represents the source.
              * @return The source emblem
              */
             virtual QPixmap emblem() = 0;
 
             /**
              * Get a path to a scalable (svg) version of the source emblem.
              */
             virtual QString scalableEmblem() = 0;
 
             /**
              * Get the capabilityInterfaceType of this capability
              * @return The capabilityInterfaceType ( always Capabilities::Capability::SourceInfo; )
              */
             static Type capabilityInterfaceType() { return Capabilities::Capability::SourceInfo; }
 
     };
 
 }
 
 #endif