|
| KZ_METACLASS_PROPERTY_TYPE (ActivationPathProperty) |
|
| KZ_METACLASS_PROPERTY_TYPE (ActivityHostPathProperty) |
|
void | apply () |
| Applies an ApplyAction to the node that this action targets.
|
|
void | attach (DataTriggerComponent *trigger) |
| Attaches an Action to a DataTrigger.
|
|
ApplyActionSharedPtr | copy () const |
|
void | detach () |
| Detaches the Action from the DataTrigger.
|
|
DataTriggerComponent * | getTrigger () const |
| Returns the pointer to a DataTrigger to which an Action is attached.
|
|
void | unapply () |
| Unapplies an ApplyAction by rolling back the changes made on apply(), and restoring the state of the target node to its previous value.
|
|
string | getName () const |
| Returns the name of the action.
|
|
AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
| Applies a style to an object.
|
|
void | applyObjectStyles () |
| Apply all styles for an object node.
|
|
Domain * | getDomain () const |
| Returns the domain the object belongs to.
|
|
const Metaclass * | getDynamicMetaclass () const override |
| Returns the metaclass of the dynamic type of the object.
|
|
MainLoopScheduler * | getMainLoopScheduler () const |
| Returns the MainLoopScheduler instance of the associated Domain.
|
|
detail::MessageDispatcher * | getMessageDispatcher () const |
| Returns the message dispatcher of the object.
|
|
ResourceManager * | getResourceManager () const |
| Returns the resource manager of the object.
|
|
ScriptingContextSharedPtr | getScriptingContext () const |
| Gets the scripting context of the object.
|
|
| Object (Domain *domain) |
|
void | setScriptingContext (ScriptingContextSharedPtr context) |
| Sets the scripting context of the object.
|
|
void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
|
void | unapplyObjectStyles () |
| Unapplies and removes all applied styles.
|
|
| ~Object () override |
|
bool | isTypeOf (const Metaclass *objectType) const |
| Determines if the type of this object is the given type or derived from it.
|
|
virtual | ~MetaObject () |
|
template<typename DataType > |
void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
|
template<typename DataType > |
void | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| Adds a property modifier without notifying handlers.
|
|
template<typename DataType > |
void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
|
template<typename DataType > |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
|
template<typename DataType > |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
|
PropertyStorageContainer::iterator | beginPropertyStorage () |
| Returns the begin iterator to the internal property storage container.
|
|
PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
| Returns the begin iterator to the internal property storage container.
|
|
void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
|
void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
| Copies local value of single property from another object.
|
|
void | copyLocalValues (const PropertyObject &other) |
| Copies all local values from another object.
|
|
PropertyStorageContainer::iterator | endPropertyStorage () |
| Returns the end iterator to the internal property storage container.
|
|
PropertyStorageContainer::const_iterator | endPropertyStorage () const |
| Returns the end iterator to the internal property storage container.
|
|
template<typename DataType > |
PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
|
template<typename DataType > |
PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
|
template<typename DataType > |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
|
template<typename DataType > |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
|
|
template<typename DataType > |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.
|
|
template<typename DataType > |
PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property type.
|
|
template<typename DataType > |
PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers.
|
|
template<typename DataType > |
size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
| Gets number of current notification handlers for given property type.
|
|
bool | hasBaseValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value, disregarding modifiers.
|
|
bool | hasLocalValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a local value set for the property.
|
|
bool | hasNonClassValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a value of any precedence higher than class default value set for the property.
|
|
bool | hasValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value.
|
|
bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
|
virtual void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) |
| Virtual function to handle property change notifications.
|
|
| PropertyObject () |
|
void | removeKzbProperties () |
| Remove all KZB properties.
|
|
void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
| Remove all KZB properties that are not included in a given set.
|
|
template<typename DataType > |
void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
|
void | removeLocalValue (AbstractPropertyType propertyType) |
| Removes the local value associated with the property.
|
|
template<typename DataType > |
void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
|
template<typename DataType > |
void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
|
template<typename DataType > |
void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
|
template<typename DataType > |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
|
template<typename DataType > |
void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| Sets the local value of a property type.
|
|
void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
|
KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers.
|
|
void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers.
|
|
virtual | ~PropertyObject () |
|
|
| ApplyActivationAction (Domain *domain, string_view name) |
| Creates an Apply Activation action.
|
|
void | applyOverride () override |
| ApplyAction::applyOverride() implementation.
|
|
ApplyActionSharedPtr | clone () const override |
| Action::clone() implementation.
|
|
void | setPropertyModifierOnTarget () |
| Sets a property modifier for a binding target runtime based on the stored binding.
|
|
void | unapplyOverride () override |
| ApplyAction::unapplyOverride() implementation.
|
|
| ApplyAction (Domain *domain, string_view name) |
| Constructor.
|
|
void | applyWhenTargetIsAlive (NodeSharedPtr hostNode, string_view targetPath, AbstractPropertyType targetPropertyType, PropertyValidatorFunctionType isPropertyChangeValid) |
| Use this method when Kanzi cannot find the node on which to apply an Action during ApplyAction.
|
|
| ActionBase (Domain *domain, string_view name) |
| Constructor.
|
|
virtual void | load (KzbFile &, KzbMemoryParser &parser) |
| Overridable function for loading an action from a kzb file.
|
|
virtual void | onAttach () |
| Overridable method called during attach.
|
|
virtual void | onDetach () |
| Overridable method called during detach.
|
|
void | initialize () |
|
void | onCopy (const Object &other) |
|
void | initialize () |
|
| MetaObject () |
|
AbstractPropertyTypeDescriptor::ValueSourceEntry * | acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage) |
| Acquires a local value source entry that is free for the assignment of a value.
|
|
AbstractPropertyTypeDescriptor::ModifierStorage * | acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) |
|
AbstractPropertyTypeDescriptor::NotificationStorage * | acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) |
|
PropertyStoragePtr | acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor) |
|
template<typename DataType > |
void | addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify) |
| Adds a property modifier entry to the property modifier stack and validates them.
|
|
void | addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| Internally adds a property value source.
|
|
void | addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| Internally adds a property value source.
|
|
AbstractPropertyTypeDescriptor::ValueSourceEntry * | constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) |
|
PropertyStoragePtr | constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) |
|
void | copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage) |
| Copy local value from property storage.
|
|
AbstractPropertyTypeDescriptor::ModifierStorage * | findModifierStorage (AbstractPropertyTypeDescriptor &descriptor) |
|
AbstractPropertyTypeDescriptor::NotificationStorage * | findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const |
|
AbstractPropertyTypeDescriptor::PropertyStorage * | findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const |
| Gets the property storage for given property type descriptor.
|
|
PropertyStoragePtr | findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const |
| Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
|
|
AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const |
| Finds a property type descriptor by name and data type.
|
|
AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const |
| Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
|
|
AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const |
| Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
|
|
AbstractPropertyTypeDescriptor::ValueSource * | getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
|
AbstractPropertyTypeDescriptor::ValueSource * | getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
|
AbstractPropertyTypeDescriptor::ValueSource * | getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
|
AbstractPropertyTypeDescriptor::ValueSource * | getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| Gets the top-level value source for a given property descriptor.
|
|
virtual void | notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason) |
| Notifies all property handlers on a property storage.
|
|
void | onCopy (const PropertyObject &other) |
|
void | removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage) |
| Removes a local value from the given property storage.
|
|
void | removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner) |
| Removes a property value source.
|
|
void | validatePropertyModifiers (PropertyStoragePtr &propertyStorage) |
| Validates property modifiers without notifying handlers.
|
|
void | validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage) |
| Validates property modifiers and notifies handlers.
|
|
An ApplyActivationAction keeps an Activity node activated for as long as the condition is met in a DataTrigger that contains this action.
When the trigger condition is no longer met, Kanzi rolls back the state of the Activity node to the state before the action was applied. Use the ApplyActivationAction only with a DataTrigger.
When you want to control the activation of an Activity, always use a DataTrigger. For example, use one DataTrigger with an ApplyActivationAction instead of using any other trigger to activate an Activity node when the conditions in that trigger are met and another trigger to deactivate the same Activity node when the conditions in the first trigger are no longer met.
An Activity node becomes inactive:
- In a Parallel Activity Host node when:
- An Activity node is inactive before you apply an ApplyActivationAction and there is no request to activate that Activity node, when Kanzi is applying the action to deactivate that node.
- The application requests an Activity node to be inactive when Kanzi is applying an ApplyActivationAction, and no other request to activate that Activity node exists.
- In an Exclusive Activity Host node, when any other Activity node becomes active or when you apply an ApplyActivationAction, or any other Action, to activate another Activity node.
To activate an Activity node, you can also use ActivityHostConcept::ActivateActivityMessage or ValueControlledExclusiveActivityHostConcept::ControllerProperty.
- Since
- Kanzi 3.9.0
Examples
To use an ApplyActivationAction to control the activation of an Activity node:
auto action = ApplyActivationAction::create(domain, "applyAction");
action->setProperty(ApplyActivationAction::ActivationPathProperty, firstActivityName);
action->setProperty(ApplyActivationAction::ActivityHostPathProperty, "../");
ExpressionBindingSource::ValueSourceContainer valueSources;
valueSources.push_back(ObjectPropertyExpressionValueSource::create(".", MyPropertyA, PropertyFieldWhole));
ExpressionBindingSource::BindingOperationContainer operations;
operations.push_back(BindingExpressionOpCode(BindingExpressionArgumentTypeSourceRegister0, PropertyFieldWhole,
BindingExpressionArgumentTypeConstantRegister0, PropertyFieldWhole,
KZU_EXPRESSION_VALIDATOR_OPERATION_COMPARE_EQUAL, 0, PropertyFieldWhole));
vector<Variant> constantRegisters;
constantRegisters.emplace_back(m_sourcePropertyTriggeringValue);
auto binding = ExpressionBinding::create(operations, valueSources, constantRegisters, 2);
auto dataTrigger = DataTrigger::create(domain, "data trigger");
dataTrigger->setConditionExpression(binding);
dataTrigger->addAction(action);
dataTriggerOwner->addNodeComponent(dataTrigger);
screen->attach();
dataTriggerOwner->setProperty(MyPropertyA, m_sourcePropertySomeOtherValue1);
domain->getResourceManager()->update();
auto firstActivity = activityHost->lookupNode<
Node>(firstActivityName);
auto secondActivity = activityHost->lookupNode<
Node>(secondActivityName);
assertTrue(!firstActivity);
assertTrue(!secondActivity);
dataTriggerOwner->setProperty(MyPropertyA, m_sourcePropertyTriggeringValue);
domain->getResourceManager()->update();
firstActivity = activityHost->lookupNode<
Node>(firstActivityName);
secondActivity = activityHost->lookupNode<
Node>(secondActivityName);
assertEquals(ActivityConcept::Status::Active, firstActivity->getProperty(ActivityConcept::StatusProperty));
assertTrue(!secondActivity);
dataTriggerOwner->setProperty(MyPropertyA, m_sourcePropertySomeOtherValue2);
domain->getResourceManager()->update();
firstActivity = activityHost->lookupNode<
Node>(firstActivityName);
secondActivity = activityHost->lookupNode<
Node>(secondActivityName);
assertTrue(!firstActivity);
assertTrue(!secondActivity);