|
| string | getLogText () |
| | Returns the value of the LogTextProperty.
|
| |
| void | setLogText (string text) |
| | Sets the value of the LogTextProperty.
|
| |
| ManualBindingRuntimeSharedPtr | addArgumentBinding (AbstractPropertyType sourceArgument, AbstractPropertyType targetArgument) |
| | Adds a binding from message argument to a node or a message argument.
|
| |
| ManualBindingRuntimeSharedPtr | addArgumentBinding (AbstractPropertyType sourceArgument, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField) |
| | Adds a binding from message argument to a node or a message argument.
|
| |
| ManualBindingRuntimeSharedPtr | addBinding (string_view targetPath, AbstractPropertyType targetArgument, PropertyField targetField, ManualBindingSharedPtr binding) |
| | Adds an arbitrary binding object to an action.
|
| |
| ManualBindingRuntimeSharedPtr | addPropertyBinding (AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField) |
| | Adds a binding from property to a node or a message argument.
|
| |
| ManualBindingRuntimeSharedPtr | addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, AbstractPropertyType targetArgument) |
| | Adds a binding from property to a node or a message argument.
|
| |
| ManualBindingRuntimeSharedPtr | addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField, AbstractPropertyType targetArgument, PropertyField targetField) |
| | Adds a binding from property to a node or a message argument.
|
| |
| ManualBindingRuntimeSharedPtr | addPropertyBinding (string_view sourceObjectPath, AbstractPropertyType sourcePropertyType, PropertyField sourceField, string_view targetObjectPath, AbstractPropertyType targetArgument, PropertyField targetField) |
| | Adds a binding from property to a node or a message argument.
|
| |
| void | addResourceBinding (ResourceID id, AbstractPropertyType targetArgument) |
| | Adds a binding from resource ID to a property.
|
| |
| void | addResourceBinding (ResourceID id, AbstractPropertyType targetArgument, PropertyField targetField) |
| | Adds a binding from resource ID to a property field.
|
| |
| void | addResourceBinding (string_view id, AbstractPropertyType targetArgument) |
| | Adds a binding from resource ID to an object property.
|
| |
| void | addResourceBinding (string_view id, AbstractPropertyType targetArgument, PropertyField targetField) |
| | Adds a binding from resource ID to a property field.
|
| |
| ManualBindingRuntimeSharedPtr | addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument) |
| | Adds a binding from value to a node or a message argument.
|
| |
| ManualBindingRuntimeSharedPtr | addValueBinding (const Variant &sourceValue, AbstractPropertyType targetArgument, PropertyField targetField) |
| | Adds a binding from a value to a node or a message argument.
|
| |
| BindingRuntimeConstIterator | beginBindingRuntimes () const |
| | Returns a const iterator pointing to the first binding runtimes.
|
| |
| BindingConstIterator | beginBindings () const |
| | Returns a const iterator pointing to the first bindings.
|
| |
| BindingRuntimeConstIterator | endBindingRuntimes () const |
| | Returns a const iterator pointing to the end of binding runtimes.
|
| |
| BindingConstIterator | endBindings () const |
| | Returns a const iterator pointing to the end of bindings.
|
| |
| void | attach (Trigger *trigger) |
| | Attaches an Action to a Trigger.
|
| |
| ActionSharedPtr | copy () const |
| |
| void | detach () |
| | Detaches the Action from the Trigger.
|
| |
| Trigger * | getTrigger () const |
| | Returns the pointer to a Trigger to which an Action is attached.
|
| |
| void | invoke () |
| | Invokes the Action.
|
| |
| chrono::milliseconds | getDelay () const |
| | Returns the delay in milliseconds that Kanzi waits before it invokes an action.
|
| |
| void | setDelay (chrono::milliseconds delay) |
| | Sets the delay in milliseconds that Kanzi waits before it invokes an action.
|
| |
| 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 () |
| |
|
| ActionSharedPtr | clone () const override |
| | Clones an action.
|
| |
| void | onDelayedInvoke () override |
| | Kanzi calls this method after a delay set in setDelay() has passed when a trigger executes a WriteLogAction.
|
| |
| void | onInvoke () override |
| | Kanzi calls this method when a trigger executes a WriteLogAction and the action writes to the Kanzi Studio Log window in the log category KZ_LOG_CATEGORY_GENERIC the message that you set in setLogText().
|
| |
| | WriteLogAction (Domain *domain, string_view name) |
| | Constructor.
|
| |
| void | applyResourceBindings (string_view path) |
| | Sets all resource bindings to their respective target items, if possible.
|
| |
| void | attachMessageToSourceRuntimes () |
| | Updates a message on message binding source runtimes.
|
| |
| void | attachTriggerToLookUpContexts () |
| | Updates triggers on binding trigger look-up contexts.
|
| |
| virtual BindingTargetRuntimePtr | createTriggerBindingTargetRuntime (string_view targetPath, AbstractPropertyType targetArgument, PropertyField targetField) |
| | Creates a binding target for a manual binding.
|
| |
| | ForwardingAction (Domain *domain, string_view name) |
| | Constructor.
|
| |
| Variant | getArgument (AbstractPropertyType argumentType) |
| | Gets the value of the argument with given property type in the forwarded message of associated trigger.
|
| |
| void | load (KzbFile &kzbFile, KzbMemoryParser &parser) override |
| | Action::load() implementation.
|
| |
| void | loadBinding (KzbFile &kzbFile, KzbMemoryParser &parser) |
| | Loads a binding object from a kzb file.
|
| |
| void | onAttach () override |
| | Action::onAttach() implementation.
|
| |
| void | onCopy (const ForwardingAction &other) |
| | Must be called by deriving classes on new instances created inside implementations of clone().
|
| |
| void | onPrepareDelayedInvoke () override |
| | Action::onPrepareDelayedInvoke() implementation.
|
| |
| void | removeAllBindings () |
| | Removes all binding objects from an action.
|
| |
| void | removeBinding (AbstractBindingRuntimeSharedPtr bindingRuntime) |
| | Removes a binding object from an action.
|
| |
| void | removeBinding (AbstractPropertyType argumentType) |
| | Removes a binding object from an action.
|
| |
| | Action (Domain *domain, string_view name) |
| | Constructor.
|
| |
| virtual void | onUnprepareDelayedInvoke () |
| | Kanzi calls this callback when an action is invoked by trigger with delay, after onDelayedInvoke() callback, or when it cancels a delayed execution.
|
| |
| | ActionBase (Domain *domain, string_view name) |
| | Constructor.
|
| |
| 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.
|
| |
Use the WriteLogAction class to attach logging functionality to a trigger.
When a trigger that has a WriteLogAction attached is set off, the action is executed and it writes the string that you set in the LogTextProperty to the Kanzi Studio Log window in the log category KZ_LOG_CATEGORY_GENERIC.
Public Member Functions inherited from kanzi::ForwardingAction