#include <Webinterface.h>

Inheritance diagram for ADDON::CWebinterface:

Public Member Functions
	CWebinterface (CAddonInfo addonInfo)

	CWebinterface (ADDON::CAddonInfo addonInfo, WebinterfaceType type, const std::string &entryPoint)

WebinterfaceType	GetType () const

const std::string &	EntryPoint () const

std::string	GetEntryPoint (const std::string &path) const

std::string	GetBaseLocation () const

Public Member Functions inherited from ADDON::CAddon
	CAddon (CAddonInfo addonInfo)

	~CAddon () override=default

TYPE	Type () const override

TYPE	FullType () const override

bool	IsType (TYPE type) const override

std::string	ID () const override

std::string	Name () const override

bool	IsInUse () const override

AddonVersion	Version () const override

AddonVersion	MinVersion () const override

std::string	Summary () const override

std::string	Description () const override

std::string	Path () const override

std::string	Profile () const override

std::string	LibPath () const override

std::string	Author () const override

std::string	ChangeLog () const override

std::string	Icon () const override

ArtMap	Art () const override

std::vector< std::string >	Screenshots () const override

std::string	Disclaimer () const override

std::string	Broken () const override

CDateTime	InstallDate () const override

CDateTime	LastUpdated () const override

CDateTime	LastUsed () const override

std::string	Origin () const override

uint64_t	PackageSize () const override

const InfoMap &	ExtraInfo () const override

const std::vector< DependencyInfo > &	GetDependencies () const override

std::string	FanArt () const override

bool	HasSettings () override
	Check whether the this addon can be configured or not. More...

virtual bool	HasUserSettings ()
	Check whether the user has configured this addon or not. More...

void	SaveSettings () override
	Save any user configured settings. More...

void	UpdateSetting (const std::string &key, const std::string &value) override
	Update a user-configured setting with a new value. More...

bool	UpdateSettingBool (const std::string &key, bool value) override
	Update a user-configured setting with a new boolean value. More...

bool	UpdateSettingInt (const std::string &key, int value) override
	Update a user-configured setting with a new integer value. More...

bool	UpdateSettingNumber (const std::string &key, double value) override
	Update a user-configured setting with a new number value. More...

bool	UpdateSettingString (const std::string &key, const std::string &value) override
	Update a user-configured setting with a new string value. More...

std::string	GetSetting (const std::string &key) override
	Retrieve a particular settings value If a previously configured user setting is available, we return it's value, else we return the default (if available) More...

bool	GetSettingBool (const std::string &key, bool &value) override
	Retrieve a particular settings value as boolean If a previously configured user setting is available, we return it's value, else we return the default (if available) More...

bool	GetSettingInt (const std::string &key, int &value) override
	Retrieve a particular settings value as integer If a previously configured user setting is available, we return it's value, else we return the default (if available) More...

bool	GetSettingNumber (const std::string &key, double &value) override
	Retrieve a particular settings value as number If a previously configured user setting is available, we return it's value, else we return the default (if available) More...

bool	GetSettingString (const std::string &key, std::string &value) override
	Retrieve a particular settings value as string If a previously configured user setting is available, we return it's value, else we return the default (if available) More...

CAddonSettings *	GetSettings () const override

AddonVersion	GetDependencyVersion (const std::string &dependencyID) const override
	get the required version of a dependency. More...

bool	MeetsVersion (const AddonVersion &version) const override
	return whether or not this addon satisfies the given version requirements More...

bool	ReloadSettings () override

AddonPtr	GetRunningInstance () const override
	retrieve the running instance of an add-on if it persists while running. More...

void	OnPreInstall () override

void	OnPostInstall (bool update, bool modal) override

void	OnPreUnInstall () override

void	OnPostUnInstall () override

Public Member Functions inherited from ADDON::IAddon
virtual	~IAddon ()=default

Static Public Member Functions
static std::unique_ptr< CWebinterface >	FromExtension (CAddonInfo addonInfo, const cp_extension_t *ext)

Additional Inherited Members
Protected Member Functions inherited from ADDON::CAddon
virtual bool	SettingsInitialized () const
	Whether or not the settings have been initialized. More...

virtual bool	SettingsLoaded () const
	Whether or not the settings have been loaded. More...

bool	LoadSettings (bool bForce, bool loadUserSettings=true)
	Load the default settings and override these with any previously configured user settings. More...

virtual bool	LoadUserSettings ()
	Load the user settings. More...

virtual bool	HasSettingsToSave () const

virtual bool	SettingsFromXML (const CXBMCTinyXML &doc, bool loadDefaults=false)
	Parse settings from an XML document. More...

virtual bool	SettingsToXML (CXBMCTinyXML &doc) const
	Write settings into an XML document. More...

Protected Attributes inherited from ADDON::CAddon
const CAddonInfo	m_addonInfo

std::string	m_userSettingsPath

Constructor & Destructor Documentation

§ CWebinterface() [1/2]

ADDON::CWebinterface::CWebinterface ( CAddonInfo addonInfo )

inlineexplicit

§ CWebinterface() [2/2]

CWebinterface::CWebinterface	(	ADDON::CAddonInfo	addonInfo,
		WebinterfaceType	type,
		const std::string &	entryPoint
	)

Member Function Documentation

§ EntryPoint()

const std::string& ADDON::CWebinterface::EntryPoint ( ) const

inline

§ FromExtension()

std::unique_ptr< CWebinterface > CWebinterface::FromExtension	(	CAddonInfo	addonInfo,
		const cp_extension_t *	ext
	)

static

§ GetBaseLocation()

std::string CWebinterface::GetBaseLocation ( ) const

§ GetEntryPoint()

std::string CWebinterface::GetEntryPoint ( const std::string & path ) const

§ GetType()

WebinterfaceType ADDON::CWebinterface::GetType ( ) const