Struct gtk4::ClosureExpression

#[repr(transparent)]
pub struct ClosureExpression { /* private fields */ }

An expression using a custom GClosure to compute the value from its parameters.

Implementations

impl ClosureExpression

pub fn upcast(self) -> Expression

pub fn upcast_ref(&self) -> &Expression

impl ClosureExpression

pub fn new<R, I, E>(params: I, closure: RustClosure) -> Selfwhere R: ValueType, I: IntoIterator<Item = E>, E: AsRef<Expression>,

Creates a Expression that calls closure when it is evaluated.

closure is called with the this object and the results of evaluating the params expressions.

value_type

the type of the value that this expression evaluates to

closure

closure to call when evaluating this expression. If closure is floating, it is adopted

params

expressions for each parameter

Returns

a new Expression

pub fn with_callback<R, F, I, E>(params: I, callback: F) -> Selfwhere F: Fn(&[Value]) -> R + 'static, I: IntoIterator<Item = E>, E: AsRef<Expression>, R: ValueType,

Methods from Deref<Target = Expression>

pub const NONE: Option<&'static Expression> = None

pub fn bind( &self, target: &impl IsA<Object>, property: &str, this_: Option<&impl IsA<Object>> ) -> ExpressionWatch

Bind target’s property named property to self.

The value that self evaluates to is set via g_object_set() on target. This is repeated whenever self changes to ensure that the object’s property stays synchronized with self.

If self’s evaluation fails, target’s property is not updated. You can ensure that this doesn’t happen by using a fallback expression.

Note that this function takes ownership of self. If you want to keep it around, you should Gtk::Expression::ref() it beforehand.

target

the target object to bind to

property

name of the property on target to bind to

this_

the this argument for the evaluation of self

Returns

a ExpressionWatch

pub fn value_type(&self) -> Type

Gets the GType that this expression evaluates to.

This type is constant and will not change over the lifetime of this expression.

Returns

The type returned from evaluate()

pub fn is_static(&self) -> bool

Checks if the expression is static.

A static expression will never change its result when evaluate() is called on it with the same arguments.

That means a call to watch() is not necessary because it will never trigger a notify.

Returns

TRUE if the expression is static

pub fn watch<P: Fn() + 'static>( &self, this_: Option<&impl IsA<Object>>, notify: P ) -> ExpressionWatch

Watch the given expression for changes.

The @notify function will be called whenever the evaluation of self may have changed.

GTK cannot guarantee that the evaluation did indeed change when the @notify gets invoked, but it guarantees the opposite: When it did in fact change, the @notify will be invoked.

this_

the this argument to watch

notify

callback to invoke when the expression changes

Returns

The newly installed watch. Note that the only reference held to the watch will be released when the watch is unwatched which can happen automatically, and not just via ExpressionWatch::unwatch(). You should call Gtk::ExpressionWatch::ref() if you want to keep the watch around.

pub fn is<E: IsExpression>(&self) -> bool

pub fn downcast_ref<E: IsExpression>(&self) -> Option<&E>

pub fn type_(&self) -> Type

pub fn evaluate(&self, this: Option<&impl IsA<Object>>) -> Option<Value>

pub fn evaluate_as<V: for<'b> FromValue<'b> + 'static, T: IsA<Object>>( &self, this: Option<&T> ) -> Option<V>

Similar to Self::evaluate but panics if the value is of a different type.

pub fn chain_property<T: IsA<Object>>( &self, property_name: &str ) -> PropertyExpression

Create a PropertyExpression that looks up for property_name with self as parameter. This is useful in long chains of Expressions.

pub fn chain_closure<R>(&self, closure: RustClosure) -> ClosureExpressionwhere R: ValueType,

Create a ClosureExpression from a glib::Closure with self as the second parameter and R as the return type. The return type is checked at run-time and must always be specified. This is useful in long chains of Expressions when using the [glib::closure!] macro.

Note that the first parameter will always be the this object bound to the expression. If None is passed as this then the type of the first parameter must be Option<glib::Object> otherwise type checking will panic.

use gtk::prelude::*;
use gtk::glib;
use glib::{closure, Object};

let button = gtk::Button::new();
button.set_label("Hello");
let label = button
    .property_expression("label")
    .chain_closure::<String>(closure!(|_: Option<Object>, label: &str| {
        format!("{} World", label)
    }))
    .evaluate_as::<String, _>(gtk::Widget::NONE);
assert_eq!(label.unwrap(), "Hello World");

pub fn chain_closure_with_callback<F, R>(&self, f: F) -> ClosureExpressionwhere F: Fn(&[Value]) -> R + 'static, R: ValueType,

Create a ClosureExpression with self as the second parameter. This is useful in long chains of Expressions.

Trait Implementations

impl AsRef<Expression> for ClosureExpression

fn as_ref(&self) -> &Expression

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ClosureExpression

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for ClosureExpression

type Target = Expression

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ClosureExpression

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

Formats the value using the given formatter.

impl<'a> FromValue<'a> for ClosureExpression

type Checker = GenericValueTypeOrNoneChecker<ClosureExpression>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl StaticType for ClosureExpression

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for ClosureExpression

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ToValueOptional for ClosureExpression

fn to_value_optional(s: Option<&Self>) -> Value

Convert an Option to a Value.

impl ValueType for ClosureExpression

type Type = ClosureExpression

Type to get the Type from.

impl IsExpression for ClosureExpression