Struct gtk4::PropertyExpression
source · #[repr(transparent)]pub struct PropertyExpression { /* private fields */ }
Expand description
A GObject
property value in a Expression
.
Implementations§
source§impl PropertyExpression
impl PropertyExpression
sourcepub fn as_ptr(&self) -> *mut GtkPropertyExpression
pub fn as_ptr(&self) -> *mut GtkPropertyExpression
Return the inner pointer to the underlying C value.
sourcepub unsafe fn from_glib_ptr_borrow<'a>(
ptr: *const *const GtkPropertyExpression
) -> &'a Self
pub unsafe fn from_glib_ptr_borrow<'a>( ptr: *const *const GtkPropertyExpression ) -> &'a Self
Borrows the underlying C value.
source§impl PropertyExpression
impl PropertyExpression
sourcepub fn new(
this_type: Type,
expression: Option<impl AsRef<Expression>>,
property_name: &str
) -> PropertyExpression
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
sourcepub fn for_pspec(
expression: Option<impl AsRef<Expression>>,
pspec: impl AsRef<ParamSpec>
) -> PropertyExpression
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
sourcepub fn expression(&self) -> Option<Expression>
pub fn expression(&self) -> Option<Expression>
source§impl PropertyExpression
impl PropertyExpression
pub fn upcast(self) -> Expression
pub fn upcast_ref(&self) -> &Expression
Methods from Deref<Target = Expression>§
sourcepub fn as_ptr(&self) -> *mut GtkExpression
pub fn as_ptr(&self) -> *mut GtkExpression
Return the inner pointer to the underlying C value.
pub const NONE: Option<&'static Expression> = None
sourcepub fn bind(
&self,
target: &impl IsA<Object>,
property: &str,
this_: Option<&impl IsA<Object>>
) -> ExpressionWatch
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
sourcepub fn value_type(&self) -> Type
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()
sourcepub fn is_static(&self) -> bool
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
sourcepub fn watch<P: Fn() + 'static>(
&self,
this_: Option<&impl IsA<Object>>,
notify: P
) -> ExpressionWatch
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 upcast_ref(&self) -> &Self
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>
sourcepub fn evaluate_as<V: for<'b> FromValue<'b> + 'static, T: IsA<Object>>(
&self,
this: Option<&T>
) -> Option<V>
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.
sourcepub fn chain_property<T: IsA<Object>>(
&self,
property_name: &str
) -> PropertyExpression
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
Expression
s.
sourcepub fn chain_closure<R>(&self, closure: RustClosure) -> ClosureExpressionwhere
R: ValueType,
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
Expression
s 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");
sourcepub fn chain_closure_with_callback<F, R>(&self, f: F) -> ClosureExpressionwhere
F: Fn(&[Value]) -> R + 'static,
R: ValueType,
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 Expression
s.
Trait Implementations§
source§impl AsRef<Expression> for PropertyExpression
impl AsRef<Expression> for PropertyExpression
source§fn as_ref(&self) -> &Expression
fn as_ref(&self) -> &Expression
source§impl Clone for PropertyExpression
impl Clone for PropertyExpression
source§impl Debug for PropertyExpression
impl Debug for PropertyExpression
source§impl Deref for PropertyExpression
impl Deref for PropertyExpression
source§impl Display for PropertyExpression
impl Display for PropertyExpression
source§impl From<PropertyExpression> for Value
impl From<PropertyExpression> for Value
source§fn from(e: PropertyExpression) -> Self
fn from(e: PropertyExpression) -> Self
source§impl<'a> FromValue<'a> for PropertyExpression
impl<'a> FromValue<'a> for PropertyExpression
§type Checker = GenericValueTypeOrNoneChecker<PropertyExpression>
type Checker = GenericValueTypeOrNoneChecker<PropertyExpression>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for PropertyExpression
impl HasParamSpec for PropertyExpression
type ParamSpec = ParamSpecExpression
§type SetValue = PropertyExpression
type SetValue = PropertyExpression
type BuilderFn = fn(_: &'a str) -> ParamSpecExpressionBuilder<'a>
fn param_spec_builder() -> Self::BuilderFn
source§impl StaticType for PropertyExpression
impl StaticType for PropertyExpression
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl ToValue for PropertyExpression
impl ToValue for PropertyExpression
source§impl ToValueOptional for PropertyExpression
impl ToValueOptional for PropertyExpression
source§impl ValueType for PropertyExpression
impl ValueType for PropertyExpression
§type Type = PropertyExpression
type Type = PropertyExpression
Type
from. Read more