[]Struct gio::PropertyAction

pub struct PropertyAction(_, _);

A PropertyAction is a way to get a Action with a state value reflecting and controlling the value of a gobject::Object property.

The state of the action will correspond to the value of the property. Changing it will change the property (assuming the requested value matches the requirements as specified in the gobject::ParamSpec).

Only the most common types are presently supported. Booleans are mapped to booleans, strings to strings, signed/unsigned integers to int32/uint32 and floats and doubles to doubles.

If the property is an enum then the state will be string-typed and conversion will automatically be performed between the enum value and "nick" string as per the gobject::EnumValue table.

Flags types are not currently supported.

Properties of object types, boxed types and pointer types are not supported and probably never will be.

Properties of glib::Variant types are not currently supported.

If the property is boolean-valued then the action will have a NULL parameter type, and activating the action (with no parameter) will toggle the value of the property.

In all other cases, the parameter type will correspond to the type of the property.

The general idea here is to reduce the number of locations where a particular piece of state is kept (and therefore has to be synchronised between). PropertyAction does not have a separate state that is kept in sync with the property value -- its state is the property value.

For example, it might be useful to create a Action corresponding to the "visible-child-name" property of a GtkStack so that the current page can be switched from a menu. The active radio indication in the menu is then directly determined from the active page of the GtkStack.

An anti-example would be binding the "active-id" property on a GtkComboBox. This is because the state of the combobox itself is probably uninteresting and is actually being used to control something else.

Another anti-example would be to bind to the "visible-child-name" property of a GtkStack if this value is actually stored in Settings. In that case, the real source of the value is Settings. If you want a Action to control a setting stored in Settings, see SettingsExt::create_action instead, and possibly combine its use with SettingsExt::bind.

Implements

glib::object::ObjectExt, ActionExt

Implementations

impl PropertyAction[src]

pub fn new<P: IsA<Object>>(
    name: &str,
    object: &P,
    property_name: &str
) -> PropertyAction
[src]

Creates a Action corresponding to the value of property property_name on object.

The property must be existent and readable and writable (and not construct-only).

This function takes a reference on object and doesn't release it until the action is destroyed.

name

the name of the action to create

object

the object that has the property to wrap

property_name

the name of the property

Returns

a new PropertyAction

pub fn get_property_invert_boolean(&self) -> bool[src]

If true, the state of the action will be the negation of the property value, provided the property is boolean.

Feature: v2_46

pub fn connect_property_enabled_notify<F: Fn(&PropertyAction) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_property_parameter_type_notify<F: Fn(&PropertyAction) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_property_state_notify<F: Fn(&PropertyAction) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

pub fn connect_property_state_type_notify<F: Fn(&PropertyAction) + 'static>(
    &self,
    f: F
) -> SignalHandlerId
[src]

Trait Implementations

impl Clone for PropertyAction

impl Debug for PropertyAction

impl Display for PropertyAction[src]

impl Eq for PropertyAction

impl Hash for PropertyAction

impl IsA<Action> for PropertyAction

impl Ord for PropertyAction

impl<T: ObjectType> PartialEq<T> for PropertyAction

impl<T: ObjectType> PartialOrd<T> for PropertyAction

impl StaticType for PropertyAction

Auto Trait Implementations

impl RefUnwindSafe for PropertyAction

impl !Send for PropertyAction

impl !Sync for PropertyAction

impl Unpin for PropertyAction

impl UnwindSafe for PropertyAction

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<Super, Sub> CanDowncast<Sub> for Super where
    Sub: IsA<Super>,
    Super: IsA<Super>, 

impl<T> Cast for T where
    T: ObjectType, 

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ObjectExt for T where
    T: ObjectType, 

impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToSendValue for T where
    T: ToValue + SetValue + Send + ?Sized

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T> ToValue for T where
    T: SetValue + ?Sized

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.