Struct TimerTrigger

pub struct TimerTrigger(/* private fields */);

Use the TimerTrigger to execute actions at the time interval that you set with the IntervalProperty.

Implementations

impl TimerTrigger

pub fn create( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<TimerTrigger, Error>

Creates a timer trigger.

Arguments

• domain - The domain to which the trigger belongs.
• name - The name of the trigger.

Returns

Shared pointer to the created timer trigger instance.

impl TimerTrigger

pub fn get_interval(&self) -> Result<i32, Error>

See: INTERVAL_PROPERTY

pub fn set_interval(&self, value: i32) -> Result<(), Error>

See: INTERVAL_PROPERTY

Methods from Deref<Target = Trigger>

pub fn add_action(&self, action: &Action) -> Result<(), Error>

Adds an action to the trigger.

pub fn invoke_actions(&self) -> Result<(), Error>

Invokes actions in the trigger.

pub fn get_actions_iterator(&self) -> Result<TriggerActionsIterator, Error>

Gets an iterator over actions invoked when trigger is triggered.

pub fn get_actions(&self) -> Result<Vec<Weak<Action>>, Error>

Gets a list of actions invoked when trigger is triggered.

pub fn add_condition(&self, condition: &Condition) -> Result<(), Error>

Adds a condition to the trigger.

pub fn check_conditions(&self) -> Result<bool, Error>

Checks against all conditions in the trigger.

pub fn get_conditions_iterator( &self, ) -> Result<TriggerConditionsIterator, Error>

Gets an iterator over conditions evaluated when trigger is triggered.

pub fn get_conditions(&self) -> Result<Vec<Weak<Condition>>, Error>

Gets a list of conditions evaluated when trigger is triggered.

Methods from Deref<Target = NodeComponent>

pub fn get_name(&self) -> Result<KanziString, Error>

See: NAME_PROPERTY

pub fn set_name(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

See: NAME_PROPERTY

pub fn get_node(&self) -> Result<Option<Weak<Node>>, Error>

Returns the node the node component is attached to or None if node component is not attached to a node.

pub fn get_state(&self) -> Result<NodeComponentState, Error>

Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching.

Methods from Deref<Target = Object>

pub fn as_ptr(&self) -> *mut ObjectWrapper

pub fn as_wrapper(&self) -> &ObjectWrapper

pub fn as_object(&self) -> &Object

Represents any type inheriting from Object as &Object. This is useful for comparisions when PartialEq traits failed to compare objects of different types.

let child = screen.get_child(0)?;
let parent = child.get_parent()?.into_error(ErrorKind::ObjectNotFound)?;
// assert_eq!(screen, parent); // <- Fails to compile!
assert_eq!(screen.as_object(), parent.as_object());

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

Gets a pointer to the backing C++ instance.

pub fn is_stale(&self) -> bool

Checks whether the weak reference has expired.

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers.

Base value is affected by the following inputs where the highest entry in the list determines the base value:

1. Local value set with setProperty or loaded from kzb
2. Value set by a style affecting the property.
3. Value defined by class metadata.

Modifiers are not applied, the highest-priority base value is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>

where T: PropertyTypeConstraint,

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.

If there is no value sources, None is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the local value of a property type.

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>

where T: PropertyTypeConstraint,

Evaluates whether there are any inputs into the property value. Both value sources and modifiers are taken into account.

Returns

Returns true if there are inputs into the property value, false otherwise.

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Removes the local value associated with the property.

pub fn get_metaclass(&self) -> Result<Metaclass, Error>

Returns the metaclass of the dynamic type of the object.

pub fn get_domain(&self) -> Result<Domain, Error>

Returns the domain the object belongs to.

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the flag to indicate that the property was loaded from KZB.

pub fn debug_string(&self) -> Result<String, Error>

Builds a string representation of the object intended for debugging purposes.

Trait Implementations

impl Clone for TimerTrigger

fn clone(&self) -> TimerTrigger

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConcreteObjectConstraint for TimerTrigger

fn create_instance( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<Self, Error>

impl Debug for TimerTrigger

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for TimerTrigger

type Target = Trigger

The resulting type after dereferencing.

fn deref(&self) -> &<TimerTrigger as Deref>::Target

Dereferences the value.

impl Inheritable for TimerTrigger

unsafe fn downcast_unchecked<T>(self) -> T

where T: Inherits<Self>,

Downcast the object to a more specific type.

unsafe fn downcast_unchecked_ref<T>(&self) -> &T

where T: Inherits<Self>,

Downcast the object reference to a more specific type.

impl Inherits<NodeComponent> for TimerTrigger

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for TimerTrigger

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Trigger> for TimerTrigger

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for TimerTrigger

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for TimerTrigger

fn downcast<T>(self) -> Result<Option<T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by value.

fn downcast_ref<T>(&self) -> Result<Option<&T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by reference.

fn is_a<T>(&self) -> Result<bool, Error>

where T: MetaInherits<Self>,

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

fn downgrade(self) -> Weak<Self>

fn downgrade_ref(&self) -> Weak<Self>

fn lock(self) -> ThreadObject<Self>

fn lock_ref(&self) -> ThreadObject<Self>

impl<T> PartialEq<T> for TimerTrigger

where T: ObjectConstraint,

fn eq(&self, rhs: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq<Weak<T>> for TimerTrigger

where T: ObjectConstraint,

fn eq(&self, rhs: &Weak<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TimerTrigger