glib/gobject/auto/

signal_group.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{Object, ffi, prelude::*, translate::*};

crate::wrapper! {
    /// `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 #GSignalGroup:target is set to a new value
    /// other than [`None`]. It is similar to #GObject::notify on `target` except it
    /// will not emit when #GSignalGroup:target is [`None`] and also allows for
    /// receiving the #GObject without a data-race.
    ///
    ///
    ///
    ///
    /// #### `unbind`
    ///  This signal is emitted when the target instance of @self_ is set to a
    /// new #GObject.
    ///
    /// This signal will only be emitted if the previous target of @self_ is
    /// non-[`None`].
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`ObjectExt`][trait@crate::prelude::ObjectExt]
    // rustdoc-stripper-ignore-next-stop
    /// `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 #GSignalGroup:target is set to a new value
    /// other than [`None`]. It is similar to #GObject::notify on `target` except it
    /// will not emit when #GSignalGroup:target is [`None`] and also allows for
    /// receiving the #GObject without a data-race.
    ///
    ///
    ///
    ///
    /// #### `unbind`
    ///  This signal is emitted when the target instance of @self_ is set to a
    /// new #GObject.
    ///
    /// This signal will only be emitted if the previous target of @self_ is
    /// non-[`None`].
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`ObjectExt`][trait@crate::prelude::ObjectExt]
    #[doc(alias = "GSignalGroup")]
    pub struct SignalGroup(Object<crate::gobject_ffi::GSignalGroup>);

    match fn {
        type_ => || crate::gobject_ffi::g_signal_group_get_type(),
    }
}

impl SignalGroup {
    /// Creates a new #GSignalGroup for target instances of @target_type.
    /// ## `target_type`
    /// the #GType of the target instance.
    ///
    /// # Returns
    ///
    /// a new #GSignalGroup
    // rustdoc-stripper-ignore-next-stop
    /// Creates a new #GSignalGroup for target instances of @target_type.
    /// ## `target_type`
    /// the #GType of the target instance.
    ///
    /// # Returns
    ///
    /// a new #GSignalGroup
    #[doc(alias = "g_signal_group_new")]
    #[doc(alias = "new")]
    pub fn with_type(target_type: crate::types::Type) -> SignalGroup {
        unsafe {
            from_glib_full(crate::gobject_ffi::g_signal_group_new(
                target_type.into_glib(),
            ))
        }
    }

    /// 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.
    // rustdoc-stripper-ignore-next-stop
    /// 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.
    #[doc(alias = "g_signal_group_block")]
    pub fn block(&self) {
        unsafe {
            crate::gobject_ffi::g_signal_group_block(self.to_glib_none().0);
        }
    }

    /// Gets the target instance used when connecting signals.
    ///
    /// # Returns
    ///
    /// The target instance
    // rustdoc-stripper-ignore-next-stop
    /// Gets the target instance used when connecting signals.
    ///
    /// # Returns
    ///
    /// The target instance
    #[doc(alias = "g_signal_group_dup_target")]
    #[doc(alias = "dup_target")]
    pub fn target(&self) -> Option<Object> {
        unsafe {
            from_glib_full(crate::gobject_ffi::g_signal_group_dup_target(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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.
    // rustdoc-stripper-ignore-next-stop
    /// 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.
    #[doc(alias = "g_signal_group_set_target")]
    #[doc(alias = "target")]
    pub fn set_target(&self, target: Option<&impl IsA<Object>>) {
        unsafe {
            crate::gobject_ffi::g_signal_group_set_target(
                self.to_glib_none().0,
                target.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// 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.
    // rustdoc-stripper-ignore-next-stop
    /// 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.
    #[doc(alias = "g_signal_group_unblock")]
    pub fn unblock(&self) {
        unsafe {
            crate::gobject_ffi::g_signal_group_unblock(self.to_glib_none().0);
        }
    }

    /// The #GType of the target property.
    // rustdoc-stripper-ignore-next-stop
    /// The #GType of the target property.
    #[cfg(feature = "v2_72")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v2_72")))]
    #[doc(alias = "target-type")]
    pub fn target_type(&self) -> crate::types::Type {
        ObjectExt::property(self, "target-type")
    }
}

unsafe impl Send for SignalGroup {}
unsafe impl Sync for SignalGroup {}