Warning, file /multimedia/amarok/src/core/capabilities/SourceInfoCapability.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).
0001 /**************************************************************************************** 0002 * Copyright (c) 2008 Nikolaj Hald Nielsen <nhn@kde.org> * 0003 * * 0004 * This program is free software; you can redistribute it and/or modify it under * 0005 * the terms of the GNU General Public License as published by the Free Software * 0006 * Foundation; either version 2 of the License, or (at your option) any later * 0007 * version. * 0008 * * 0009 * This program is distributed in the hope that it will be useful, but WITHOUT ANY * 0010 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A * 0011 * PARTICULAR PURPOSE. See the GNU General Public License for more details. * 0012 * * 0013 * You should have received a copy of the GNU General Public License along with * 0014 * this program. If not, see <http://www.gnu.org/licenses/>. * 0015 ****************************************************************************************/ 0016 0017 #ifndef SOURCEINFOCAPABILITY_H 0018 #define SOURCEINFOCAPABILITY_H 0019 0020 #include "core/amarokcore_export.h" 0021 #include "core/capabilities/Capability.h" 0022 0023 class QPixmap; 0024 0025 namespace Capabilities 0026 { 0027 0028 /** 0029 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... 0030 0031 @author Nikolaj Hald Nielsen <nhn@kde.org> 0032 */ 0033 class AMAROKCORE_EXPORT SourceInfoCapability : public Capabilities::Capability{ 0034 public: 0035 Q_OBJECT 0036 public: 0037 /** 0038 * Constructor 0039 */ 0040 SourceInfoCapability(); 0041 /** 0042 * Destructor 0043 */ 0044 ~SourceInfoCapability() override; 0045 0046 /** 0047 * Get the human readable name of the source, for instance "Magnatune.com" 0048 * @return The name of the source 0049 */ 0050 virtual QString sourceName() = 0; 0051 /** 0052 * Get a brief human readable description or the source 0053 * @return The source description 0054 */ 0055 virtual QString sourceDescription() = 0; 0056 /** 0057 * Get a small 16x16 pixle emblem that represents the source. 0058 * @return The source emblem 0059 */ 0060 virtual QPixmap emblem() = 0; 0061 0062 /** 0063 * Get a path to a scalable (svg) version of the source emblem. 0064 */ 0065 virtual QString scalableEmblem() = 0; 0066 0067 /** 0068 * Get the capabilityInterfaceType of this capability 0069 * @return The capabilityInterfaceType ( always Capabilities::Capability::SourceInfo; ) 0070 */ 0071 static Type capabilityInterfaceType() { return Capabilities::Capability::SourceInfo; } 0072 0073 }; 0074 0075 } 0076 0077 #endif