gtk4

Struct PropertyExpression

source
pub struct PropertyExpression { /* private fields */ }
Expand description

A GObject property value in a Expression.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations§

source§

impl PropertyExpression

source

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

Return the inner pointer to the underlying C value.

source

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GtkPropertyExpression) -> &Self

Borrows the underlying C value.

source§

impl PropertyExpression

source

pub fn new( this_type: Type, expression: Option<impl AsRef<Expression>>, property_name: &str, ) -> PropertyExpression

Creates an expression that looks up a property.

The object to use is found by evaluating the expression, or using the this argument when expression is NULL.

If the resulting object conforms to this_type, its property named property_name will be queried. Otherwise, this expression’s evaluation will fail.

The given this_type must have a property with property_name.

§this_type

The type to expect for the this type

§expression

Expression to evaluate to get the object to query or NULL to query the this object

§property_name

name of the property

§Returns

a new Expression

source

pub fn for_pspec( expression: Option<impl AsRef<Expression>>, pspec: impl AsRef<ParamSpec>, ) -> PropertyExpression

Creates an expression that looks up a property.

The object to use is found by evaluating the expression, or using the this argument when expression is NULL.

If the resulting object conforms to this_type, its property specified by pspec will be queried. Otherwise, this expression’s evaluation will fail.

§expression

Expression to evaluate to get the object to query or NULL to query the this object

§pspec

the GParamSpec for the property to query

§Returns

a new Expression

source

pub fn expression(&self) -> Option<Expression>

Gets the expression specifying the object of a property expression.

§Returns

the object expression

source

pub fn pspec(&self) -> ParamSpec

Gets the GParamSpec specifying the property of a property expression.

§Returns

the GParamSpec for the property

source§

impl PropertyExpression

source

pub fn upcast(self) -> Expression

source

pub fn upcast_ref(&self) -> &Expression

Methods from Deref<Target = Expression>§

source

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

Return the inner pointer to the underlying C value.

source

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

source

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

source

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()

source

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

source

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.

source

pub fn upcast_ref(&self) -> &Self

source

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

source

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

source

pub fn type_(&self) -> Type

source

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

source

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.

source

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.

source

pub fn chain_closure<R>(&self, closure: RustClosure) -> ClosureExpression
where 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 glib::{closure, Object};
use gtk::{glib, prelude::*};

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");
source

pub fn chain_closure_with_callback<F, R>(&self, f: F) -> ClosureExpression
where 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§

source§

impl AsRef<Expression> for PropertyExpression

source§

fn as_ref(&self) -> &Expression

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

impl Clone for PropertyExpression

source§

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

1.6.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PropertyExpression

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for PropertyExpression

source§

type Target = Expression

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl From<PropertyExpression> for Value

source§

fn from(e: PropertyExpression) -> Self

Converts to this type from the input type.
source§

impl<'a> FromValue<'a> for PropertyExpression

source§

type Checker = GenericValueTypeOrNoneChecker<PropertyExpression>

Value type checker.
source§

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

Get the contained value from a Value. Read more
source§

impl HasParamSpec for PropertyExpression

source§

type ParamSpec = ParamSpecExpression

source§

type SetValue = PropertyExpression

Preferred value to be used as setter for the associated ParamSpec.
source§

type BuilderFn = for<'a> fn(_: &'a str) -> ParamSpecExpressionBuilder<'a>

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl StaticType for PropertyExpression

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl ToValue for PropertyExpression

source§

fn to_value(&self) -> Value

Convert a value to a Value.
source§

fn value_type(&self) -> Type

Returns the type identifier of self. Read more
source§

impl ToValueOptional for PropertyExpression

source§

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

Convert an Option to a Value.
source§

impl ValueType for PropertyExpression

source§

type Type = PropertyExpression

Type to get the Type from. Read more
source§

impl IsExpression for PropertyExpression

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize, ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize, ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<T> Property for T
where T: HasParamSpec,

source§

type Value = T

source§

impl<T> PropertyGet for T
where T: HasParamSpec,

source§

type Value = T

source§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> TransparentType for T

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,