View flow coordinator base class. More...

#include <HMUIViewFlowCoordinator.hpp>

Inheritance diagram for CP_SDK_BS::UI::HMUIViewFlowCoordinator:

Collaboration diagram for CP_SDK_BS::UI::HMUIViewFlowCoordinator:

[legend]

Classes
struct	t_Views

Public Member Functions
	CP_SDK_IL2CPP_OVERRIDE_METHOD_EX (HMUI, FlowCoordinator, void, DidActivate, bool p_FirstActivation, bool p_AddedToHierarchy, bool p_ScreenSystemEnabling)
	On activation.

	CP_SDK_IL2CPP_OVERRIDE_METHOD_EX (HMUI, FlowCoordinator, void, BackButtonWasPressed, HMUI::ViewController *p_TopViewController)
	When the back button is pressed.

void	Present (bool p_IgnoreBackuping=false)
	Present this HMUIViewFlowCoordinator.

void	Dismiss ()
	Dismiss this HMUIViewFlowCoordinator.

void	HideLeftScreen ()
	Hide the left screen.

void	HideRightScreen ()
	Hide the right screen.

void	ChangeView (HMUI::ViewController p_NewView, HMUI::ViewController p_Left=nullptr, HMUI::ViewController *p_Right=nullptr)
	Enqueue a main view controller change.

Static Public Member Functions
template<class t_Base > requires (std::is_assignable_v<HMUIViewFlowCoordinator&, t_Base>)
static _v::MonoPtr< t_Base > &	_Instance ()

template<class t_Base > requires (std::is_assignable_v<HMUIViewFlowCoordinator&, t_Base>)
static void	_Destroy ()

Protected Member Functions
template<class t_ViewController > requires (std::is_assignable_v<HMUI::ViewController*&, t_ViewController>)
t_ViewController	CreateViewController ()
	Create a view controller.

Static Protected Member Functions
template<class t_ViewController > requires (std::is_assignable_v<HMUI::ViewController&, t_ViewController>)
static void	DestroyViewController (_v::MonoPtr< t_ViewController > *p_ViewController)
	Destroy view controller.

Protected Attributes
_v::Func< std::u16string_view >	Title
	Initial title.

_v::Action< bool >	Present_Override
	Present this HMUIViewFlowCoordinator.

_v::Action	Dismiss_Override
	Dismiss this HMUIViewFlowCoordinator.

_v::Func< t_Views >	GetInitialViewsController
	Get initial views controller (Middle, Left, Right)

_v::Func< bool, HMUI::ViewController * >	OnBackButtonPressed
	On back button pressed.

Detailed Description

View flow coordinator base class.

Definition at line 33 of file HMUIViewFlowCoordinator.hpp.

Member Function Documentation

◆ _Destroy()

template<class t_Base >
requires (std::is_assignable_v<HMUIViewFlowCoordinator*&, t_Base*>)

static void CP_SDK_BS::UI::HMUIViewFlowCoordinator::_Destroy ( )

inlinestatic

Definition at line 54 of file HMUIViewFlowCoordinator.hpp.

◆ _Instance()

template<class t_Base >
requires (std::is_assignable_v<HMUIViewFlowCoordinator*&, t_Base*>)

static _v::MonoPtr< t_Base > & CP_SDK_BS::UI::HMUIViewFlowCoordinator::_Instance ( )

inlinestatic

Definition at line 44 of file HMUIViewFlowCoordinator.hpp.

◆ ChangeView()

void CP_SDK_BS::UI::HMUIViewFlowCoordinator::ChangeView	(	HMUI::ViewController *	p_NewView,
		HMUI::ViewController *	p_Left = `nullptr`,
		HMUI::ViewController *	p_Right = `nullptr`
	)

Enqueue a main view controller change.

Parameters

p_NewView New main view controller

◆ CP_SDK_IL2CPP_OVERRIDE_METHOD_EX() [1/2]

CP_SDK_BS::UI::HMUIViewFlowCoordinator::CP_SDK_IL2CPP_OVERRIDE_METHOD_EX	(	HMUI	,
		FlowCoordinator	,
		void	,
		BackButtonWasPressed	,
		HMUI::ViewController *	p_TopViewController
	)

When the back button is pressed.

Parameters

p_TopViewController Controller instance

◆ CP_SDK_IL2CPP_OVERRIDE_METHOD_EX() [2/2]

CP_SDK_BS::UI::HMUIViewFlowCoordinator::CP_SDK_IL2CPP_OVERRIDE_METHOD_EX	(	HMUI	,
		FlowCoordinator	,
		void	,
		DidActivate	,
		bool	p_FirstActivation,
		bool	p_AddedToHierarchy,
		bool	p_ScreenSystemEnabling
	)

On activation.

Parameters

p_FirstActivation	Is the first activation?
p_AddedToHierarchy	Activation type
p_ScreenSystemEnabling	Is the screen system enabling?

◆ CreateViewController()

template<class t_ViewController >
requires (std::is_assignable_v<HMUI::ViewController*&, t_ViewController>)

t_ViewController CP_SDK_BS::UI::HMUIViewFlowCoordinator::CreateViewController ( )

inlineprotected

Create a view controller.

Template Parameters

t_ViewController View controller type

Definition at line 136 of file HMUIViewFlowCoordinator.hpp.

◆ DestroyViewController()

template<class t_ViewController >
requires (std::is_assignable_v<HMUI::ViewController*&, t_ViewController*>)

static void CP_SDK_BS::UI::HMUIViewFlowCoordinator::DestroyViewController ( _v::MonoPtr< t_ViewController > * p_ViewController )

inlinestaticprotected

Destroy view controller.

Template Parameters

t_ViewController View type

Parameters

p_ViewController View to destroy

Definition at line 144 of file HMUIViewFlowCoordinator.hpp.

◆ Dismiss()

void CP_SDK_BS::UI::HMUIViewFlowCoordinator::Dismiss ( )

Dismiss this HMUIViewFlowCoordinator.

◆ HideLeftScreen()

void CP_SDK_BS::UI::HMUIViewFlowCoordinator::HideLeftScreen ( )

Hide the left screen.

◆ HideRightScreen()

void CP_SDK_BS::UI::HMUIViewFlowCoordinator::HideRightScreen ( )

Hide the right screen.

◆ Present()

void CP_SDK_BS::UI::HMUIViewFlowCoordinator::Present ( bool p_IgnoreBackuping = false )

Present this HMUIViewFlowCoordinator.

Parameters

p_IgnoreBackuping Ignore existing flow coordinator

Member Data Documentation

◆ Dismiss_Override

_v::Action CP_SDK_BS::UI::HMUIViewFlowCoordinator::Dismiss_Override

protected

Dismiss this HMUIViewFlowCoordinator.

Definition at line 106 of file HMUIViewFlowCoordinator.hpp.

◆ GetInitialViewsController

_v::Func<t_Views> CP_SDK_BS::UI::HMUIViewFlowCoordinator::GetInitialViewsController

protected

Get initial views controller (Middle, Left, Right)

Definition at line 110 of file HMUIViewFlowCoordinator.hpp.

◆ OnBackButtonPressed

_v::Func<bool, HMUI::ViewController*> CP_SDK_BS::UI::HMUIViewFlowCoordinator::OnBackButtonPressed

protected

On back button pressed.

Parameters

p_TopViewController Current top view controller

Definition at line 113 of file HMUIViewFlowCoordinator.hpp.

◆ Present_Override

_v::Action<bool> CP_SDK_BS::UI::HMUIViewFlowCoordinator::Present_Override

protected

Present this HMUIViewFlowCoordinator.

Parameters

p_IgnoreBackuping Ignore existing flow coordinator

Definition at line 104 of file HMUIViewFlowCoordinator.hpp.

◆ Title

_v::Func<std::u16string_view> CP_SDK_BS::UI::HMUIViewFlowCoordinator::Title

protected

Initial title.

Definition at line 82 of file HMUIViewFlowCoordinator.hpp.

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

shared/CP_SDK_BS/UI/HMUIViewFlowCoordinator.hpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _Destroy()

◆ _Instance()

◆ ChangeView()

◆ CP_SDK_IL2CPP_OVERRIDE_METHOD_EX() [1/2]

◆ CP_SDK_IL2CPP_OVERRIDE_METHOD_EX() [2/2]

◆ CreateViewController()

◆ DestroyViewController()

◆ Dismiss()

◆ HideLeftScreen()

◆ HideRightScreen()

◆ Present()

Member Data Documentation

◆ Dismiss_Override

◆ GetInitialViewsController

◆ OnBackButtonPressed

◆ Present_Override

◆ Title