All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kanzi::OnAttachedTrigger Class Reference

On Attached Trigger. More...

#include <kanzi/trigger/on_attached_trigger.hpp>

Inheritance diagram for kanzi::OnAttachedTrigger:
kanzi::Trigger kanzi::Object

Static Public Member Functions

static OnAttachedTriggerSharedPtr create (Domain *domain, string_view name)
 
- Static Public Member Functions inherited from kanzi::Trigger
static TriggerSharedPtr loadTrigger (KzcInputStream *inputStream, Domain *domain, const KzuBinaryFileInfo *file)
 Loads a trigger from stream. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static
PropertyTypeEditorInfoSharedPtr 
makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

 OnAttachedTrigger (Domain *domain, string_view name)
 
virtual void onAttach () KZ_OVERRIDE
 Attaches on attached trigger. More...
 
virtual TriggerSharedPtr clone () const KZ_OVERRIDE
 Creates a clone of this trigger. More...
 
- Protected Member Functions inherited from kanzi::Trigger
 Trigger (Domain *domain, string_view name)
 
virtual void onDetach ()
 Callback called during detach. More...
 
void onCopy (const Trigger &other)
 Class copy function. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 

Additional Inherited Members

- Public Types inherited from kanzi::Trigger
typedef vector< ActionSharedPtrActionContainer
 
typedef
ActionContainer::const_iterator 
ActionIterator
 
typedef vector
< ConditionSharedPtr
ConditionContainer
 
typedef
ConditionContainer::const_iterator 
ConditionIterator
 
- Public Member Functions inherited from kanzi::Trigger
string getName () const
 
void attach (Node *node)
 Attaches a trigger to node. More...
 
void detach ()
 Detaches a trigger. More...
 
bool isAttached () const
 Returns true if the trigger is attached to a node. More...
 
bool isAttaching () const
 Returns true if trigger is in the process of attaching, false otherwise. More...
 
bool isDetaching () const
 Returns true if the trigger currently detaching. More...
 
TriggerSharedPtr copy () const
 Creates a copy of trigger. More...
 
void addAction (ActionSharedPtr action)
 Adds an action to the trigger. More...
 
void invokeActions () const
 Invokes actions in the trigger. More...
 
ActionIterator beginActions () const
 
ActionIterator endActions () const
 
void addCondition (ConditionSharedPtr condition)
 Adds a condition to the trigger. More...
 
bool checkConditions () const
 Checks against all conditions in the trigger. More...
 
ConditionIterator beginConditions () const
 
ConditionIterator endConditions () const
 
NodegetNode () const
 Returns the node the trigger is attached to. More...
 
virtual void load (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 
void * getForwardedMessage () const
 Gets the value of ForwardedMessageProperty. More...
 
void setForwardedMessage (void *value)
 Sets the value of ForwardedMessageProperty. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuPropertyManager * getPropertyManager () const
 Returns the property manager of the object. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () 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...
 
AppliedStyleEntryapplyObjectStyle (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 Attributes inherited from kanzi::Trigger
static PropertyType< void * > ForwardedMessageProperty
 ForwardedMessage property. More...
 
- Protected Types inherited from kanzi::Object
typedef vector
< AppliedStyleEntry * > 
AppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::Trigger
static
PropertyTypeEditorInfoSharedPtr 
makeEditorInfo ()
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

On Attached Trigger.

Constructor & Destructor Documentation

kanzi::OnAttachedTrigger::OnAttachedTrigger ( Domain domain,
string_view  name 
)
explicitprotected

Member Function Documentation

static OnAttachedTriggerSharedPtr kanzi::OnAttachedTrigger::create ( Domain domain,
string_view  name 
)
static
virtual void kanzi::OnAttachedTrigger::onAttach ( )
protectedvirtual

Attaches on attached trigger.

Reimplemented from kanzi::Trigger.

virtual TriggerSharedPtr kanzi::OnAttachedTrigger::clone ( ) const
protectedvirtual

Creates a clone of this trigger.

Implements kanzi::Trigger.


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