CP_SDK::IModuleBase Class Reference

Module base interface. More...

#include <ModuleBase.hpp>

Inheritance diagram for CP_SDK::IModuleBase:

Classes
struct	t_InitialViews

Public Member Functions
virtual EIModuleBaseType	Type () const =0
virtual std::u16string_view	Name () const =0
virtual std::u16string_view	FancyName () const =0
virtual std::u16string_view	Description () const =0
virtual std::u16string_view	DocumentationURL () const =0
virtual bool	UseChatFeatures () const =0
virtual bool	IsEnabled () const =0
virtual void	IsEnabled (bool p_Enabled)=0
virtual EIModuleBaseActivationType	ActivationType () const =0
virtual void	SetEnabled (bool p_Enabled)=0
	Set enabled.
virtual void	CheckForActivation (EIModuleBaseActivationType p_Kind)=0
	Check for module activation.
virtual void	OnApplicationExit ()=0
	On application exit.
virtual t_InitialViews	GetSettingsViewControllers ()
	Get Module settings UI.

Protected Member Functions
	IModuleBase ()=default
	Constructor.
virtual	~IModuleBase ()
	Destructor.

Detailed Description

Module base interface.

Definition at line 42 of file ModuleBase.hpp.

Constructor & Destructor Documentation

IModuleBase()

CP_SDK::IModuleBase::IModuleBase ( )

protecteddefault

Constructor.

~IModuleBase()

virtual CP_SDK::IModuleBase::~IModuleBase ( )

inlineprotectedvirtual

Destructor.

Definition at line 69 of file ModuleBase.hpp.

Member Function Documentation

CheckForActivation()

virtual void CP_SDK::IModuleBase::CheckForActivation ( EIModuleBaseActivationType  p_Kind )

pure virtual

Check for module activation.

Parameters

p_Kind

Activation type

Implemented in CP_SDK::ModuleBase< t_Type >.

GetSettingsViewControllers()

virtual t_InitialViews CP_SDK::IModuleBase::GetSettingsViewControllers ( )

inlinevirtual

Get Module settings UI.

Returns

Main, Left, Right

Definition at line 86 of file ModuleBase.hpp.

OnApplicationExit()

virtual void CP_SDK::IModuleBase::OnApplicationExit ( )

pure virtual

On application exit.

Implemented in CP_SDK::ModuleBase< t_Type >.

SetEnabled()

virtual void CP_SDK::IModuleBase::SetEnabled ( bool  p_Enabled )

pure virtual

Set enabled.

Parameters

p_Enabled

New state

Implemented in CP_SDK::ModuleBase< t_Type >.

---

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

• shared/CP_SDK/ModuleBase.hpp