Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::StateManager::StateObjectRuntime Class Reference

State object runtime. More...

#include <kanzi/core.ui/state_manager/state_manager.hpp>

Public Types

enum  ApplyTargetType { NotApplied, AppliedToNode, AppliedToClone }
 

Public Member Functions

void apply ()
 Applies state style to its target. More...
 
void assignTargetObject (StateObjectRuntimeSharedPtr runtime, TargetObjectSharedPtr targetObject)
 Assigns target object. More...
 
ObjectgetAppliedTarget ()
 Gets the object that has the style entry applied. More...
 
StateObjectgetStateObject () const
 Gets state object. More...
 
ObjectgetTarget () const
 Gets target, or null pointer if target is not acquired. More...
 
void onBeforeTargetLost ()
 Notification callback which is called by TargetObject just before target is lost. More...
 
void onTargetAcquired ()
 Notification callback which is called by TargetObject when target is acquired. More...
 
void unapply ()
 Unapplies state style from its target. More...
 
 ~StateObjectRuntime ()
 Destructor. More...
 

Static Public Member Functions

static StateObjectRuntimeSharedPtr create (const StateObjectPtr &stateObject)
 Create new state object runtime. More...
 

Detailed Description

State object runtime.

Member Enumeration Documentation

Enumerator
NotApplied 

Not applied.

AppliedToNode 

Applied to target node.

AppliedToClone 

Applied to clone.

Constructor & Destructor Documentation

kanzi::StateManager::StateObjectRuntime::~StateObjectRuntime ( )

Destructor.

Member Function Documentation

static StateObjectRuntimeSharedPtr kanzi::StateManager::StateObjectRuntime::create ( const StateObjectPtr stateObject)
static

Create new state object runtime.

StateObject* kanzi::StateManager::StateObjectRuntime::getStateObject ( ) const

Gets state object.

Object* kanzi::StateManager::StateObjectRuntime::getTarget ( ) const

Gets target, or null pointer if target is not acquired.

Object* kanzi::StateManager::StateObjectRuntime::getAppliedTarget ( )

Gets the object that has the style entry applied.

Returns
Pointer to cloned or base object, depending on which has the style entry applied.
void kanzi::StateManager::StateObjectRuntime::assignTargetObject ( StateObjectRuntimeSharedPtr  runtime,
TargetObjectSharedPtr  targetObject 
)

Assigns target object.

Parameters
runtimeShared pointer to this state object runtime.
targetObjectTarget object to track the target.
void kanzi::StateManager::StateObjectRuntime::apply ( )

Applies state style to its target.

void kanzi::StateManager::StateObjectRuntime::unapply ( )

Unapplies state style from its target.

void kanzi::StateManager::StateObjectRuntime::onTargetAcquired ( )

Notification callback which is called by TargetObject when target is acquired.

void kanzi::StateManager::StateObjectRuntime::onBeforeTargetLost ( )

Notification callback which is called by TargetObject just before target is lost.


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