Kanzi  3.9.4
Kanzi Engine API
kanzi::ExclusiveActivityHostContentHandler Struct Reference

Helper class used to modify the ExclusiveActivityHostContent of an ExclusiveActivityHost. More...

#include <kanzi/ui/node/concept/activity/exclusive_activity_host_content_handler.hpp>

Static Public Member Functions

static ExclusiveActivityHostConcept::ExclusiveActivityHostContent addActivity (Node &hostNode, string_view name, string_view controllerPropertyValue, string_view prefabPath)
 Adds an Activity node to the given ExclusiveActivityHost by modifying its ExclusiveActivityHostContentProperty. More...
 
static ExclusiveActivityHostConcept::ExclusiveActivityHostContent read (string_view value)
 Converts an Exclusive Activity Host Content from a string to an ExclusiveActivityHostContent object. More...
 
static ExclusiveActivityHostConcept::ExclusiveActivityHostContent removeActivity (Node &hostNode, string_view name)
 Removes an Activity node from the given ExclusiveActivityHost by modifying its ExclusiveActivityHostContentProperty. More...
 
static string write (const ExclusiveActivityHostConcept::ExclusiveActivityHostContent &content)
 Converts an Exclusive Activity Host Content from an ExclusiveActivityHostContent object to a string. More...
 

Detailed Description

Helper class used to modify the ExclusiveActivityHostContent of an ExclusiveActivityHost.

Since
Kanzi 3.9.0

Member Function Documentation

◆ addActivity()

static ExclusiveActivityHostConcept::ExclusiveActivityHostContent kanzi::ExclusiveActivityHostContentHandler::addActivity ( Node hostNode,
string_view  name,
string_view  controllerPropertyValue,
string_view  prefabPath 
)
static

Adds an Activity node to the given ExclusiveActivityHost by modifying its ExclusiveActivityHostContentProperty.

Parameters
hostNodeThe ExclusiveActivityHost node whose ExclusiveActivityHostContentProperty this function modifies.
nameThe name of the Activity node that this function adds as a child node of the given ExclusiveActivityHost node.
controllerPropertyValueThe value of the ControllerProperty that activates the Activity node.
prefabPathThe path to the prefab of the Activity node.
Returns
The structure that describes the ExclusiveActivityHostContent after modification.

◆ removeActivity()

static ExclusiveActivityHostConcept::ExclusiveActivityHostContent kanzi::ExclusiveActivityHostContentHandler::removeActivity ( Node hostNode,
string_view  name 
)
static

Removes an Activity node from the given ExclusiveActivityHost by modifying its ExclusiveActivityHostContentProperty.

Parameters
hostNodeThe ExclusiveActivityHost node whose ExclusiveActivityHostContentProperty this function modifies.
nameThe name of the Activity node that this function removes from the given ExclusiveActivityHost node.
Returns
The structure that describes the ExclusiveActivityHostContent after modification.

◆ read()

static ExclusiveActivityHostConcept::ExclusiveActivityHostContent kanzi::ExclusiveActivityHostContentHandler::read ( string_view  value)
static

Converts an Exclusive Activity Host Content from a string to an ExclusiveActivityHostContent object.

Parameters
valueContent description as a string.
Returns
The Exclusive Activity Host Content as an ExclusiveActivityHostContent object.

◆ write()

static string kanzi::ExclusiveActivityHostContentHandler::write ( const ExclusiveActivityHostConcept::ExclusiveActivityHostContent content)
static

Converts an Exclusive Activity Host Content from an ExclusiveActivityHostContent object to a string.

Parameters
contentStructure that describes the Activity nodes.
Returns
The Exclusive Activity Host Content as a string.

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