Struct SignalGroup

pub struct SignalGroup { /* private fields */ }

Available on crate feature v2_74 only.

GSignalGroup manages a collection of signals on a GObject.

GSignalGroup simplifies the process of connecting many signals to a GObject as a group. As such there is no API to disconnect a signal from the group.

In particular, this allows you to:

• Change the target instance, which automatically causes disconnection of the signals from the old instance and connecting to the new instance.
• Block and unblock signals as a group
• Ensuring that blocked state transfers across target instances.

One place you might want to use such a structure is with GtkTextView and GtkTextBuffer. Often times, you’ll need to connect to many signals on GtkTextBuffer from a GtkTextView subclass. This allows you to create a signal group during instance construction, simply bind the GtkTextView:buffer property to GSignalGroup:target and connect all the signals you need. When the GtkTextView:buffer property changes all of the signals will be transitioned correctly.

Properties

target

The target instance used when connecting signals.

Readable | Writeable

target-type

The GType of the target property.

Readable | Writeable | Construct Only

Signals

bind

This signal is emitted when target is set to a new value other than None. It is similar to notify on target except it will not emit when target is None and also allows for receiving the Object without a data-race.

unbind

This signal is emitted when the target instance of self_ is set to a new Object.

This signal will only be emitted if the previous target of self_ is non-None.

Implements

ObjectExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl SignalGroup

pub fn with_type(target_type: Type) -> SignalGroup

Creates a new SignalGroup for target instances of target_type.

target_type

the GType of the target instance.

Returns

a new SignalGroup

pub fn block(&self)

Blocks all signal handlers managed by self so they will not be called during any signal emissions. Must be unblocked exactly the same number of times it has been blocked to become active again.

This blocked state will be kept across changes of the target instance.

pub fn target(&self) -> Option<Object>

Gets the target instance used when connecting signals.

Returns

The target instance

pub fn set_target(&self, target: Option<&impl IsA<Object>>)

Sets the target instance used when connecting signals. Any signal that has been registered with g_signal_group_connect_object() or similar functions will be connected to this object.

If the target instance was previously set, signals will be disconnected from that object prior to connecting to target.

target

The target instance used when connecting signals.

pub fn unblock(&self)

Unblocks all signal handlers managed by self so they will be called again during any signal emissions unless it is blocked again. Must be unblocked exactly the same number of times it has been blocked to become active again.

pub fn target_type(&self) -> Type

Available on crate feature v2_72 only.

The GType of the target property.

impl SignalGroup

pub fn new<T: IsA<Object>>() -> Self

pub fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure, )

Connects closure to the signal detailed_signal on target.

You cannot connect a signal handler after target has been set.

detailed_signal

a string of the form signal-name with optional ::signal-detail

closure

the closure to connect.

after

whether the handler should be called before or after the default handler of the signal.

pub fn connect<F>(&self, signal_name: &str, after: bool, callback: F)

where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connects c_handler to the signal detailed_signal on the target instance of self.

You cannot connect a signal handler after target has been set.

detailed_signal

a string of the form “signal-name::detail”

c_handler

the GCallback to connect

pub fn connect_local<F>(&self, signal_name: &str, after: bool, callback: F)

where F: Fn(&[Value]) -> Option<Value> + 'static,

Like Self::connect but doesn’t require a Send+Sync closure. Signal emission will panic if the signal on the current target is emitted from a different thread from the thread that connected the signal.

pub fn connect_notify<F>(&self, name: Option<&str>, callback: F)

where F: Fn(&Object, &ParamSpec) + Send + Sync + 'static,

pub fn connect_notify_local<F>(&self, name: Option<&str>, callback: F)

where F: Fn(&Object, &ParamSpec) + 'static,

pub fn connect_bind<F: Fn(&Self, &Object) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when target is set to a new value other than None. It is similar to notify on target except it will not emit when target is None and also allows for receiving the Object without a data-race.

instance

a Object containing the new value for target

pub fn connect_bind_local<F: Fn(&Self, &Object) + 'static>( &self, f: F, ) -> SignalHandlerId

Like Self::connect_bind but doesn’t require a Send+Sync closure. Signal emission will panic if the signal is emitted from a different thread from the thread that connected the signal.

pub fn connect_unbind<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

This signal is emitted when the target instance of self_ is set to a new Object.

This signal will only be emitted if the previous target of self_ is non-None.

pub fn connect_unbind_local<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Like Self::connect_unbind but doesn’t require a Send+Sync closure. Signal emission will panic if the signal is emitted from a different thread from the thread that connected the signal.

Trait Implementations

impl Clone for SignalGroup

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl Debug for SignalGroup

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

Formats the value using the given formatter.

impl HasParamSpec for SignalGroup

type ParamSpec = ParamSpecObject

type SetValue = SignalGroup

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

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, SignalGroup>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SignalGroup

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SignalGroup

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for SignalGroup

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for SignalGroup

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for SignalGroup

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SignalGroup

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SignalGroup

impl Send for SignalGroup

impl Sync for SignalGroup