Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | List of all members
ADDON::IAddon Class Referenceabstract

#include <IAddon.h>

Inheritance diagram for ADDON::IAddon:
ADDON::CAddon ADDON::CAddonDll ADDON::CContextMenuAddon ADDON::CPluginSource ADDON::CRepository ADDON::CResource ADDON::CScraper ADDON::CService ADDON::CSkinInfo ADDON::CWebinterface KODI::GAME::CController

Public Member Functions

virtual ~IAddon ()=default
 
virtual TYPE Type () const =0
 
virtual TYPE FullType () const =0
 
virtual bool IsType (TYPE type) const =0
 
virtual std::string ID () const =0
 
virtual std::string Name () const =0
 
virtual bool IsInUse () const =0
 
virtual AddonVersion Version () const =0
 
virtual AddonVersion MinVersion () const =0
 
virtual std::string Summary () const =0
 
virtual std::string Description () const =0
 
virtual std::string Path () const =0
 
virtual std::string Profile () const =0
 
virtual std::string LibPath () const =0
 
virtual std::string ChangeLog () const =0
 
virtual std::string FanArt () const =0
 
virtual ArtMap Art () const =0
 
virtual std::vector< std::string > Screenshots () const =0
 
virtual std::string Author () const =0
 
virtual std::string Icon () const =0
 
virtual std::string Disclaimer () const =0
 
virtual std::string Broken () const =0
 
virtual CDateTime InstallDate () const =0
 
virtual CDateTime LastUpdated () const =0
 
virtual CDateTime LastUsed () const =0
 
virtual std::string Origin () const =0
 
virtual uint64_t PackageSize () const =0
 
virtual const InfoMap & ExtraInfo () const =0
 
virtual bool HasSettings ()=0
 
virtual void SaveSettings ()=0
 
virtual void UpdateSetting (const std::string &key, const std::string &value)=0
 
virtual bool UpdateSettingBool (const std::string &key, bool value)=0
 
virtual bool UpdateSettingInt (const std::string &key, int value)=0
 
virtual bool UpdateSettingNumber (const std::string &key, double value)=0
 
virtual bool UpdateSettingString (const std::string &key, const std::string &value)=0
 
virtual std::string GetSetting (const std::string &key)=0
 
virtual bool GetSettingBool (const std::string &key, bool &value)=0
 
virtual bool GetSettingInt (const std::string &key, int &value)=0
 
virtual bool GetSettingNumber (const std::string &key, double &value)=0
 
virtual bool GetSettingString (const std::string &key, std::string &value)=0
 
virtual CAddonSettings * GetSettings () const =0
 
virtual const std::vector< DependencyInfo > & GetDependencies () const =0
 
virtual AddonVersion GetDependencyVersion (const std::string &dependencyID) const =0
 
virtual bool MeetsVersion (const AddonVersion &version) const =0
 
virtual bool ReloadSettings ()=0
 
virtual AddonPtr GetRunningInstance () const =0
 
virtual void OnPreInstall ()=0
 
virtual void OnPostInstall (bool update, bool modal)=0
 
virtual void OnPreUnInstall ()=0
 
virtual void OnPostUnInstall ()=0
 

Constructor & Destructor Documentation

§ ~IAddon()

virtual ADDON::IAddon::~IAddon ( )
virtualdefault

Member Function Documentation

§ Art()

virtual ArtMap ADDON::IAddon::Art ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ Author()

virtual std::string ADDON::IAddon::Author ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ Broken()

virtual std::string ADDON::IAddon::Broken ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ ChangeLog()

virtual std::string ADDON::IAddon::ChangeLog ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ Description()

virtual std::string ADDON::IAddon::Description ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ Disclaimer()

virtual std::string ADDON::IAddon::Disclaimer ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ ExtraInfo()

virtual const InfoMap& ADDON::IAddon::ExtraInfo ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ FanArt()

virtual std::string ADDON::IAddon::FanArt ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ FullType()

virtual TYPE ADDON::IAddon::FullType ( ) const
pure virtual

Implemented in ADDON::CAddon, and ADDON::CPluginSource.

§ GetDependencies()

virtual const std::vector<DependencyInfo>& ADDON::IAddon::GetDependencies ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ GetDependencyVersion()

virtual AddonVersion ADDON::IAddon::GetDependencyVersion ( const std::string &  dependencyID) const
pure virtual

Implemented in ADDON::CAddon.

§ GetRunningInstance()

virtual AddonPtr ADDON::IAddon::GetRunningInstance ( ) const
pure virtual

Implemented in PVR::CPVRClient, ADDON::CAddon, ADDON::CAddonDll, and KODI::GAME::CGameClient.

§ GetSetting()

virtual std::string ADDON::IAddon::GetSetting ( const std::string &  key)
pure virtual

Implemented in ADDON::CAddon, and ADDON::CAddonDll.

§ GetSettingBool()

virtual bool ADDON::IAddon::GetSettingBool ( const std::string &  key,
bool &  value 
)
pure virtual

Implemented in ADDON::CAddon.

§ GetSettingInt()

virtual bool ADDON::IAddon::GetSettingInt ( const std::string &  key,
int &  value 
)
pure virtual

Implemented in ADDON::CAddon.

§ GetSettingNumber()

virtual bool ADDON::IAddon::GetSettingNumber ( const std::string &  key,
double &  value 
)
pure virtual

Implemented in ADDON::CAddon.

§ GetSettings()

virtual CAddonSettings* ADDON::IAddon::GetSettings ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ GetSettingString()

virtual bool ADDON::IAddon::GetSettingString ( const std::string &  key,
std::string &  value 
)
pure virtual

Implemented in ADDON::CAddon.

§ HasSettings()

virtual bool ADDON::IAddon::HasSettings ( )
pure virtual

Implemented in ADDON::CSkinInfo, and ADDON::CAddon.

§ Icon()

virtual std::string ADDON::IAddon::Icon ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ ID()

virtual std::string ADDON::IAddon::ID ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ InstallDate()

virtual CDateTime ADDON::IAddon::InstallDate ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ IsInUse()

virtual bool ADDON::IAddon::IsInUse ( ) const
pure virtual

Implemented in ADDON::CSkinInfo, ADDON::CScraper, ADDON::CAddon, ADDON::CLanguageResource, and ADDON::CUISoundsResource.

§ IsType()

virtual bool ADDON::IAddon::IsType ( TYPE  type) const
pure virtual

Implemented in ADDON::CAddon, and ADDON::CPluginSource.

§ LastUpdated()

virtual CDateTime ADDON::IAddon::LastUpdated ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ LastUsed()

virtual CDateTime ADDON::IAddon::LastUsed ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ LibPath()

virtual std::string ADDON::IAddon::LibPath ( ) const
pure virtual

Implemented in KODI::GAME::CGameClient, ADDON::CAddon, and ADDON::CAddonDll.

§ MeetsVersion()

virtual bool ADDON::IAddon::MeetsVersion ( const AddonVersion &  version) const
pure virtual

Implemented in ADDON::CAddon.

§ MinVersion()

virtual AddonVersion ADDON::IAddon::MinVersion ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ Name()

virtual std::string ADDON::IAddon::Name ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ OnPostInstall()

virtual void ADDON::IAddon::OnPostInstall ( bool  update,
bool  modal 
)
pure virtual

Implemented in ADDON::CSkinInfo, ADDON::CAddon, ADDON::CLanguageResource, ADDON::CFontResource, and ADDON::CUISoundsResource.

§ OnPostUnInstall()

virtual void ADDON::IAddon::OnPostUnInstall ( )
pure virtual

Implemented in ADDON::CAddon.

§ OnPreInstall()

virtual void ADDON::IAddon::OnPreInstall ( )
pure virtual

Implemented in PVR::CPVRClient, ADDON::CSkinInfo, and ADDON::CAddon.

§ OnPreUnInstall()

virtual void ADDON::IAddon::OnPreUnInstall ( )
pure virtual

Implemented in PVR::CPVRClient, ADDON::CAddon, and ADDON::CImageResource.

§ Origin()

virtual std::string ADDON::IAddon::Origin ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ PackageSize()

virtual uint64_t ADDON::IAddon::PackageSize ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ Path()

virtual std::string ADDON::IAddon::Path ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ Profile()

virtual std::string ADDON::IAddon::Profile ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ ReloadSettings()

virtual bool ADDON::IAddon::ReloadSettings ( )
pure virtual

Implemented in ADDON::CAddon.

§ SaveSettings()

virtual void ADDON::IAddon::SaveSettings ( )
pure virtual

Implemented in ADDON::CAddon, and ADDON::CAddonDll.

§ Screenshots()

virtual std::vector<std::string> ADDON::IAddon::Screenshots ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ Summary()

virtual std::string ADDON::IAddon::Summary ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ Type()

virtual TYPE ADDON::IAddon::Type ( ) const
pure virtual

Implemented in ADDON::CAddon.

§ UpdateSetting()

virtual void ADDON::IAddon::UpdateSetting ( const std::string &  key,
const std::string &  value 
)
pure virtual

Implemented in ADDON::CAddon.

§ UpdateSettingBool()

virtual bool ADDON::IAddon::UpdateSettingBool ( const std::string &  key,
bool  value 
)
pure virtual

Implemented in ADDON::CAddon.

§ UpdateSettingInt()

virtual bool ADDON::IAddon::UpdateSettingInt ( const std::string &  key,
int  value 
)
pure virtual

Implemented in ADDON::CAddon.

§ UpdateSettingNumber()

virtual bool ADDON::IAddon::UpdateSettingNumber ( const std::string &  key,
double  value 
)
pure virtual

Implemented in ADDON::CAddon.

§ UpdateSettingString()

virtual bool ADDON::IAddon::UpdateSettingString ( const std::string &  key,
const std::string &  value 
)
pure virtual

Implemented in ADDON::CAddon.

§ Version()

virtual AddonVersion ADDON::IAddon::Version ( ) const
pure virtual

Implemented in ADDON::CAddon.

The documentation for this class was generated from the following file: