Struct WriteLogAction

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

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.

Implementations

impl WriteLogAction

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

Creates a WriteLogAction.

Arguments

• domain - The domain passed to the constructor.
• name - The action name passed to the constructor.

Returns

A shared pointer to the created action.

impl WriteLogAction

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

See: LOG_TEXT_PROPERTY

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

See: LOG_TEXT_PROPERTY

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

See: ARGUMENT0_PROPERTY

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

See: ARGUMENT0_PROPERTY

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

See: ARGUMENT1_PROPERTY

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

See: ARGUMENT1_PROPERTY

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

See: ARGUMENT2_PROPERTY

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

See: ARGUMENT2_PROPERTY

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

See: ARGUMENT3_PROPERTY

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

See: ARGUMENT3_PROPERTY

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

See: ARGUMENT4_PROPERTY

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

See: ARGUMENT4_PROPERTY

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

See: ARGUMENT5_PROPERTY

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

See: ARGUMENT5_PROPERTY

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

See: ARGUMENT6_PROPERTY

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

See: ARGUMENT6_PROPERTY

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

See: ARGUMENT7_PROPERTY

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

See: ARGUMENT7_PROPERTY

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

See: ARGUMENT8_PROPERTY

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

See: ARGUMENT8_PROPERTY

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

See: ARGUMENT9_PROPERTY

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

See: ARGUMENT9_PROPERTY

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

See: ARGUMENT10_PROPERTY

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

See: ARGUMENT10_PROPERTY

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

See: ARGUMENT11_PROPERTY

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

See: ARGUMENT11_PROPERTY

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

See: ARGUMENT12_PROPERTY

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

See: ARGUMENT12_PROPERTY

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

See: ARGUMENT13_PROPERTY

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

See: ARGUMENT13_PROPERTY

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

See: ARGUMENT14_PROPERTY

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

See: ARGUMENT14_PROPERTY

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

See: ARGUMENT15_PROPERTY

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

See: ARGUMENT15_PROPERTY

Methods from Deref<Target = Action>

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

See: DELAY_PROPERTY

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

See: DELAY_PROPERTY

pub fn get_trigger(&self) -> Result<Option<Weak<Trigger>>, Error>

Returns the pointer to a Trigger to which an Action is attached.

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

Invokes the Action.

Errors

Returns an OBJECT_NOT_FOUND error if the function is called without an attached trigger.

Methods from Deref<Target = ActionBase>

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

Returns the name of the action

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 WriteLogAction

fn clone(&self) -> WriteLogAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConcreteObjectConstraint for WriteLogAction

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

impl Debug for WriteLogAction

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

Formats the value using the given formatter.

impl Deref for WriteLogAction

type Target = ForwardingAction

The resulting type after dereferencing.

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

Dereferences the value.

impl Inheritable for WriteLogAction

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<Action> for WriteLogAction

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<ActionBase> for WriteLogAction

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<ForwardingAction> for WriteLogAction

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for WriteLogAction

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for WriteLogAction

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for WriteLogAction

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 WriteLogAction

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 WriteLogAction

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 WriteLogAction