#include <AddonInfo.h>

Public Member Functions
	CAddonInfo ()=default

	CAddonInfo (std::string id, AddonType type)

void	SetMainType (AddonType type)

void	SetBinary (bool isBinary)

void	SetLibName (const std::string &libname)

void	SetPath (const std::string &path)

void	AddExtraInfo (const std::string &idName, const std::string &value)

void	SetLastUsed (const CDateTime &dateTime)

const std::string &	ID () const

AddonType	MainType () const
	To get the main type of this addon.

bool	HasType (AddonType type, bool mainOnly=false) const
	To check addon contains a type.

const std::vector< CAddonType > &	Types () const
	To get all available types inside the addon.

const CAddonType *	Type (AddonType type) const
	The get for given addon type information and extension data.

bool	ProvidesSubContent (AddonType content, AddonType mainType) const

bool	ProvidesSeveralSubContents () const

const CAddonVersion &	Version () const

const CAddonVersion &	MinVersion () const

bool	IsBinary () const

const CAddonVersion &	DependencyMinVersion (const std::string &dependencyID) const

const CAddonVersion &	DependencyVersion (const std::string &dependencyID) const

const std::string &	Name () const

const std::string &	License () const

const std::string &	Summary () const

const std::string &	Description () const

const std::string &	LibName () const

const std::string &	Author () const

const std::string &	Source () const

const std::string &	Website () const

const std::string &	Forum () const

const std::string &	EMail () const

const std::string &	Path () const

const std::string &	ProfilePath () const

const std::string &	ChangeLog () const

const std::string &	Icon () const

const ArtMap &	Art () const

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

const std::string &	Disclaimer () const

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

AddonLifecycleState	LifecycleState () const

const std::string &	LifecycleStateDescription () const

const std::string &	Origin () const

const std::string &	OriginName () const

const InfoMap &	ExtraInfo () const

bool	MeetsVersion (const CAddonVersion &versionMin, const CAddonVersion &version) const

uint64_t	PackageSize () const

CDateTime	InstallDate () const

CDateTime	LastUpdated () const

CDateTime	LastUsed () const

bool	SupportsMultipleInstances () const

AddonInstanceSupport	InstanceUseType () const

bool	SupportsAddonSettings () const

bool	SupportsInstanceSettings () const

std::vector< AddonInstanceId >	GetKnownInstanceIds () const

Static Public Member Functions
static std::string	TranslateType (AddonType type, bool pretty=false)
	Utilities to translate add-on parts to his requested part.

static std::string	TranslateIconType (AddonType type)

static AddonType	TranslateType (const std::string &string)

static AddonType	TranslateSubContent (const std::string &content)

static AddonInstanceSupport	InstanceSupportType (AddonType type)

Friends
class	CAddonInfoBuilder

class	CAddonInfoBuilderFromDB

Constructor & Destructor Documentation

◆ CAddonInfo() [1/2]

ADDON::CAddonInfo::CAddonInfo ( )

default

◆ CAddonInfo() [2/2]

ADDON::CAddonInfo::CAddonInfo	(	std::string	id,
		AddonType	type )

Member Function Documentation

◆ AddExtraInfo()

void ADDON::CAddonInfo::AddExtraInfo	(	const std::string &	idName,
		const std::string &	value )

inline

◆ Art()

const ArtMap & ADDON::CAddonInfo::Art ( ) const

inline

◆ Author()

const std::string & ADDON::CAddonInfo::Author ( ) const

inline

◆ ChangeLog()

const std::string & ADDON::CAddonInfo::ChangeLog ( ) const

inline

◆ DependencyMinVersion()

const CAddonVersion & ADDON::CAddonInfo::DependencyMinVersion ( const std::string & dependencyID ) const

◆ DependencyVersion()

const CAddonVersion & ADDON::CAddonInfo::DependencyVersion ( const std::string & dependencyID ) const

◆ Description()

const std::string & ADDON::CAddonInfo::Description ( ) const

inline

◆ Disclaimer()

const std::string & ADDON::CAddonInfo::Disclaimer ( ) const

inline

◆ EMail()

const std::string & ADDON::CAddonInfo::EMail ( ) const

inline

◆ ExtraInfo()

const InfoMap & ADDON::CAddonInfo::ExtraInfo ( ) const

inline

◆ Forum()

const std::string & ADDON::CAddonInfo::Forum ( ) const

inline

◆ GetDependencies()

const std::vector< DependencyInfo > & ADDON::CAddonInfo::GetDependencies ( ) const

inline

◆ GetKnownInstanceIds()

std::vector< AddonInstanceId > ADDON::CAddonInfo::GetKnownInstanceIds ( ) const

◆ HasType()

bool ADDON::CAddonInfo::HasType	(	AddonType	type,
		bool	mainOnly = false ) const

To check addon contains a type.

Parameters

[in]	type	The to checked type identifier
[in]	mainOnly	to check only in first defined main addon inside addon.xml

Returns: true in case the wanted type is supported, false if not

◆ Icon()

const std::string & ADDON::CAddonInfo::Icon ( ) const

inline

◆ ID()

const std::string & ADDON::CAddonInfo::ID ( ) const

inline

◆ InstallDate()

CDateTime ADDON::CAddonInfo::InstallDate ( ) const

inline

◆ InstanceSupportType()

AddonInstanceSupport ADDON::CAddonInfo::InstanceSupportType ( AddonType type )

static

◆ InstanceUseType()

AddonInstanceSupport ADDON::CAddonInfo::InstanceUseType ( ) const

inline

◆ IsBinary()

bool ADDON::CAddonInfo::IsBinary ( ) const

inline

◆ LastUpdated()

CDateTime ADDON::CAddonInfo::LastUpdated ( ) const

inline

◆ LastUsed()

CDateTime ADDON::CAddonInfo::LastUsed ( ) const

inline

◆ LibName()

const std::string & ADDON::CAddonInfo::LibName ( ) const

inline

◆ License()

const std::string & ADDON::CAddonInfo::License ( ) const

inline

◆ LifecycleState()

AddonLifecycleState ADDON::CAddonInfo::LifecycleState ( ) const

inline

◆ LifecycleStateDescription()

const std::string & ADDON::CAddonInfo::LifecycleStateDescription ( ) const

inline

◆ MainType()

AddonType ADDON::CAddonInfo::MainType ( ) const

inline

To get the main type of this addon.

This is the first type defined in addon.xml.

Returns: The used main type of addon

◆ MeetsVersion()

bool ADDON::CAddonInfo::MeetsVersion	(	const CAddonVersion &	versionMin,
		const CAddonVersion &	version ) const

◆ MinVersion()

const CAddonVersion & ADDON::CAddonInfo::MinVersion ( ) const

inline

◆ Name()

const std::string & ADDON::CAddonInfo::Name ( ) const

inline

◆ Origin()

const std::string & ADDON::CAddonInfo::Origin ( ) const

inline

◆ OriginName()

const std::string & ADDON::CAddonInfo::OriginName ( ) const

◆ PackageSize()

uint64_t ADDON::CAddonInfo::PackageSize ( ) const

inline

◆ Path()

const std::string & ADDON::CAddonInfo::Path ( ) const

inline

◆ ProfilePath()

const std::string & ADDON::CAddonInfo::ProfilePath ( ) const

inline

◆ ProvidesSeveralSubContents()

bool ADDON::CAddonInfo::ProvidesSeveralSubContents ( ) const

◆ ProvidesSubContent()

bool ADDON::CAddonInfo::ProvidesSubContent	(	AddonType	content,
		AddonType	mainType ) const

◆ Screenshots()

const std::vector< std::string > & ADDON::CAddonInfo::Screenshots ( ) const

inline

◆ SetBinary()

void ADDON::CAddonInfo::SetBinary ( bool isBinary )

inline

◆ SetLastUsed()

void ADDON::CAddonInfo::SetLastUsed ( const CDateTime & dateTime )

inline

◆ SetLibName()

void ADDON::CAddonInfo::SetLibName ( const std::string & libname )

inline

◆ SetMainType()

void ADDON::CAddonInfo::SetMainType ( AddonType type )

inline

◆ SetPath()

void ADDON::CAddonInfo::SetPath ( const std::string & path )

inline

◆ Source()

const std::string & ADDON::CAddonInfo::Source ( ) const

inline

◆ Summary()

const std::string & ADDON::CAddonInfo::Summary ( ) const

inline

◆ SupportsAddonSettings()

bool ADDON::CAddonInfo::SupportsAddonSettings ( ) const

inline

◆ SupportsInstanceSettings()

bool ADDON::CAddonInfo::SupportsInstanceSettings ( ) const

inline

◆ SupportsMultipleInstances()

bool ADDON::CAddonInfo::SupportsMultipleInstances ( ) const

◆ TranslateIconType()

std::string ADDON::CAddonInfo::TranslateIconType ( AddonType type )

static

◆ TranslateSubContent()

AddonType ADDON::CAddonInfo::TranslateSubContent ( const std::string & content )

static

◆ TranslateType() [1/2]

std::string ADDON::CAddonInfo::TranslateType	(	AddonType	type,
		bool	pretty = false )

static

Utilities to translate add-on parts to his requested part.

static public helper functions

◆ TranslateType() [2/2]

AddonType ADDON::CAddonInfo::TranslateType ( const std::string & string )

static

◆ Type()

const CAddonType * ADDON::CAddonInfo::Type ( AddonType type ) const

The get for given addon type information and extension data.

Parameters

[in] type The wanted type data

Returns: addon type class with CAddonExtensions as information

Note: This function return never a "nullptr", in case the wanted type is not supported, becomes a dummy of CAddonType given.

Example:

// To get <extension ... name="blablabla" /> from addon.xml

std::string name = Type(ADDON_...)->GetValue("@name").asString();

Type

Definition PackerMAT.h:16

name

enum const char * name

Definition addon_base.h:203

◆ Types()

const std::vector< CAddonType > & ADDON::CAddonInfo::Types ( ) const

inline

To get all available types inside the addon.

To have all <extension point="..." /> defined in addon.xml inside a list.

Returns: List of all supported types

◆ Version()

const CAddonVersion & ADDON::CAddonInfo::Version ( ) const

inline

◆ Website()

const std::string & ADDON::CAddonInfo::Website ( ) const

inline

Friends And Related Symbol Documentation

◆ CAddonInfoBuilder

friend class CAddonInfoBuilder

friend

◆ CAddonInfoBuilderFromDB

friend class CAddonInfoBuilderFromDB

friend

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

Public Member Functions

Static Public Member Functions

Friends

Constructor & Destructor Documentation

◆ CAddonInfo() [1/2]

◆ CAddonInfo() [2/2]

Member Function Documentation

◆ AddExtraInfo()

◆ Art()

◆ Author()

◆ ChangeLog()

◆ DependencyMinVersion()

◆ DependencyVersion()

◆ Description()

◆ Disclaimer()

◆ EMail()

◆ ExtraInfo()

◆ Forum()

◆ GetDependencies()

◆ GetKnownInstanceIds()

◆ HasType()

◆ Icon()

◆ ID()

◆ InstallDate()

◆ InstanceSupportType()

◆ InstanceUseType()

◆ IsBinary()

◆ LastUpdated()

◆ LastUsed()

◆ LibName()

◆ License()

◆ LifecycleState()

◆ LifecycleStateDescription()

◆ MainType()

◆ MeetsVersion()

◆ MinVersion()

◆ Name()

◆ Origin()

◆ OriginName()

◆ PackageSize()

◆ Path()

◆ ProfilePath()

◆ ProvidesSeveralSubContents()

◆ ProvidesSubContent()

◆ Screenshots()

◆ SetBinary()

◆ SetLastUsed()

◆ SetLibName()

◆ SetMainType()

◆ SetPath()

◆ Source()

◆ Summary()

◆ SupportsAddonSettings()

◆ SupportsInstanceSettings()

◆ SupportsMultipleInstances()

◆ TranslateIconType()

◆ TranslateSubContent()

◆ TranslateType() [1/2]

◆ TranslateType() [2/2]

◆ Type()

◆ Types()

◆ Version()

◆ Website()

Friends And Related Symbol Documentation

◆ CAddonInfoBuilder

◆ CAddonInfoBuilderFromDB