Execute script action. More...
#include <kanzi/execute_script_action.hpp>
Classes | |
struct | Scope |
Public Member Functions | |
virtual | ~ExecuteScriptAction () |
string | getScriptSource () const |
void | setScriptSource (string_view scriptSource) |
Scope * | getScope () |
virtual void | load (KzcInputStream *inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE |
![]() | |
string | getName () const |
void | attach (Trigger *trigger) |
Attaches the action to a trigger. More... | |
void | detach () |
Detaches the action. More... | |
void | invoke () |
Invokes the action. More... | |
ActionSharedPtr | copy () const |
Create a copy of the action. More... | |
Trigger * | getTrigger () const |
Returns the trigger the action is attached to. More... | |
chrono::milliseconds | getDelay () const |
void | setDelay (chrono::milliseconds interval) |
![]() | |
Object (Domain *domain) | |
virtual | ~Object () |
Domain * | getDomain () const |
Returns the domain the object belongs to. More... | |
KzuPropertyManager * | getPropertyManager () const |
Returns the property manager of the object. More... | |
KzuTaskScheduler * | getTaskScheduler () const |
Returns the task scheduler of the object. More... | |
KzuMessageDispatcher * | getMessageDispatcher () const |
Returns the message dispatcher of the object. More... | |
ResourceManager * | getResourceManager () const |
Returns the resource manager of the object. More... | |
virtual const Metaclass * | getDynamicMetaclass () const |
Returns the metaclass of the dynamic type of the object. More... | |
bool | isTypeOf (const Metaclass *objectType) const |
Determines if the type of this object is the given type or derived from it. More... | |
template<typename DataType > | |
void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value) |
Sets the local value of a property. More... | |
void | setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value) |
Sets the local value of a resource id property with a resource pointer. More... | |
template<typename DataType > | |
DataType | getProperty (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property. More... | |
template<typename DataType > | |
bool | getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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. More... | |
template<typename DataType > | |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value) |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value) |
template<typename DataType > | |
DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
bool | getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const |
bool | hasValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value. More... | |
bool | hasLocalValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a local value set for the property. More... | |
void | removeLocalValue (AbstractPropertyType propertyType) |
Removes the local value associated with the property. More... | |
void | copyLocalValues (const Object &other) |
Copies all local values from another object. More... | |
virtual void | onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason) |
Virtual function to handle property change notifications. More... | |
AppliedStyleEntry * | applyObjectStyle (kanzi::StyleSharedPtr style) |
Applies a style to an object. More... | |
void | unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry) |
void | applyObjectStyles () |
Apply all styles for an object node. More... | |
void | unapplyObjectStyles () |
Unapplies and removes all applied styles. More... | |
Static Public Member Functions | |
static ExecuteScriptActionSharedPtr | create (Domain *uiDomain, string_view name) |
![]() | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
static ActionSharedPtr | loadAction (KzcInputStream *inputStream, Domain *domain, const KzuBinaryFileInfo *file) |
![]() | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. More... | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. More... | |
Static Public Attributes | |
static PropertyType< string > | ExecuteScriptActionScriptSourceProperty |
ExecuteScriptActionScriptSource property. More... | |
static const string | exceptionPropertyTypeNotFound |
static const string | exceptionTypeNotFound |
static const string | exceptionNodeNotItemCollection |
![]() | |
static PropertyType< int > | DelayProperty |
Delay property. More... | |
Protected Member Functions | |
ExecuteScriptAction (Domain *uiDomain, string_view name) | |
Create a set property action. More... | |
virtual void | onAttach () KZ_OVERRIDE |
Attach implementation. More... | |
virtual void | onDetach () KZ_OVERRIDE |
Callback called during detach. More... | |
virtual void | onInvoke () KZ_OVERRIDE |
Invoke set property action. More... | |
virtual void | onDelayedInvoke () KZ_OVERRIDE |
Implementation of delayed invoke of set property action. More... | |
virtual ActionSharedPtr | clone () const KZ_OVERRIDE |
void | onCopy (ExecuteScriptAction const &other) |
![]() | |
Action (Domain *domain, string_view name) | |
virtual void | onPrepareDelayedInvoke () |
Callback called before delayed invoke. More... | |
virtual void | onUnprepareDelayedInvoke () |
Callback called after delayed invoke. More... | |
void | onCopy (const Action &other) |
![]() | |
void | initialize () |
void | onCopy (const Object &other) |
Additional Inherited Members | |
![]() | |
typedef vector < AppliedStyleEntry * > | AppliedStyleContainer |
Applied style container. More... | |
![]() | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. More... | |
Execute script action.
|
virtual |
|
explicitprotected |
Create a set property action.
|
inline |
|
inline |
|
inline |
|
virtual |
Reimplemented from kanzi::Action.
|
static |
|
protectedvirtual |
Attach implementation.
Reimplemented from kanzi::Action.
|
protectedvirtual |
Callback called during detach.
Reimplemented from kanzi::Action.
|
protectedvirtual |
Invoke set property action.
Reimplemented from kanzi::Action.
|
protectedvirtual |
Implementation of delayed invoke of set property action.
Reimplemented from kanzi::Action.
|
protectedvirtual |
Implements kanzi::Action.
|
protected |
|
static |
ExecuteScriptActionScriptSource property.
The default value is "".
|
static |
|
static |
|
static |