Kanzi 3.9.10
kanzi::ActivityElementImpl< TBaseClass, TDerivedClass > Class Template Reference

ActivityElement implementation class. More...

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

Inheritance diagram for kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >:
[legend]

Public Member Functions

const NodegetNode () const override
 Gets the underlying Node object.
 
NodegetNode () override
 Gets the underlying Node object.
 
- Public Member Functions inherited from kanzi::ActivityElement
vector< NodeSharedPtr >::const_iterator beginChildHosts () const
 Returns the begin iterator to the registered child Activity Host.
 
virtual void deserialize (string_view data)
 Deserializes the activity element from a byte buffer.
 
vector< NodeSharedPtr >::const_iterator endChildHosts () const
 Returns the end iterator to the registered child Activity Host.
 
NodefindChildHost (string_view hostName)
 Finds a child Activity Host by name.
 
vector< string > getCommands () const
 Gets the list of commands handled by code behind of this activity element.
 
ActivityHistoryManagergetHistoryManager () const
 Gets the history manager of this activity element.
 
ActivityElementgetParentElement ()
 Gets the parent ActivityElement type node.
 
bool isLeafActivityNode () const
 Returns whether an ActivityElement has a child Activity Host.
 
virtual string serialize ()
 Serializes the activity element to a byte buffer.
 
void setCodeBehind (CodeBehindSharedPtr codeBehind)
 Attaches a code behind object.
 
void setCodeBehind (const Metaclass *metaclass)
 Instantiates and attaches a code behind object by specifying its metaclass.
 
virtual ~ActivityElement ()=default
 Destructor.
 

Protected Member Functions

 ActivityElementImpl (Domain *domain, string_view name)
 Constructor.
 
void initialize ()
 Initializes the activity element.
 
void onAttached () override
 Node::onAttached implementation.
 
virtual void onAttachedOverride ()
 Overrides the onAttached method.
 
void onDetached () override
 Node::onDetached implementation.
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged implementation.
 
 ~ActivityElementImpl () override=default
 Destructor.
 
- Protected Member Functions inherited from kanzi::ActivityElement
optional< ActivityBrowserController::ActivityIDgetActivityID () const
 Gets the unique ID that is used by the implementation of the Activity Browser.
 
string getPathInParent ()
 Gets the activation path of this activity element relative to its parent.
 
void initialize ()
 Initializes the activity element.
 
bool isRootActivityElement () const
 Returns whether an ActivityElement is the root Activity Host node of the Screen node.
 
virtual void notifyChildrenNodeTreeAvailable ()
 Notifies child activity elements that node info tree is available.
 
void onForceTrigger (const ActivityBrowserController::ForceTriggerMessageArguments &args)
 Message handler for ActivityBrowserController::ForceTriggerMessage.
 
void onNodeInfoTreeAvailable (const ActivityBrowserController::NodeInfoTreeAvailableArguments &)
 Message handler for ActivityBrowserController::NodeInfoTreeAvailableMessage.
 
void registerChildHost (string_view hostPath)
 Registers a child host in this activity element.
 
virtual void registerInParentActivityElement ()=0
 Derived classes implement this function to register themselves in the parent during the construction of the activity graph.
 
void setActivityID (optional< ActivityBrowserController::ActivityID > activityID)
 Sets the unique ID that is used by the implementation of the Activity Browser.
 
void unregisterChildHost (string_view hostName)
 Unregisters a child host from this activity element.
 
virtual void unregisterInParentActivityElement ()=0
 Derived classes implement this function to unregister themselves from the parent during the destruction of the activity graph.
 
void updateActivityBrowserProperties ()
 Triggers the Activity Browser to update the properties of the Activity Element.
 

Additional Inherited Members

- Static Public Member Functions inherited from kanzi::ActivityElement
static string getFirstElement (string_view activationSequence)
 Gets the first element of the activation sequence.
 
static string getRestToForward (string_view activationSequence)
 Gets the remainder of the activation sequence.
 
template<typename Type >
static bool isActivityElement (const Type &object)
 Returns whether an object is an ActivityElement.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Attributes inherited from kanzi::ActivityElement
static PropertyType< boolAttachedProperty
 
static PropertyType< boolPreserveHistoryProperty
 Enables the preservation of Activity property values when that Activity becomes inactive.
 

Detailed Description

template<typename TBaseClass, typename TDerivedClass>
class kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >

ActivityElement implementation class.

See also
ActivityElement.

Constructor & Destructor Documentation

◆ ActivityElementImpl()

template<typename TBaseClass , typename TDerivedClass >
kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >::ActivityElementImpl ( Domain * domain,
string_view name )
explicitprotected

Constructor.

Parameters
domainThe UI domain the new node belongs to.
nameThe name of the node.

◆ ~ActivityElementImpl()

template<typename TBaseClass , typename TDerivedClass >
kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >::~ActivityElementImpl ( )
overrideprotecteddefault

Destructor.

Member Function Documentation

◆ getNode() [1/2]

◆ getNode() [2/2]

◆ initialize()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >::initialize ( )
protected

Initializes the activity element.

◆ onAttached()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >::onAttached ( )
overrideprotected

Node::onAttached implementation.

◆ onAttachedOverride()

◆ onDetached()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >::onDetached ( )
overrideprotected

Node::onDetached implementation.

◆ onNodePropertyChanged()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >::onNodePropertyChanged ( AbstractPropertyType propertyType,
PropertyNotificationReason reason )
overrideprotected

Node::onNodePropertyChanged implementation.


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