gstreamer/auto/

child_proxy.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::ffi;
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// This interface abstracts handling of property sets for elements with
    /// children. Imagine elements such as mixers or polyphonic generators. They all
    /// have multiple [`Pad`][crate::Pad] or some kind of voice objects. Another use case are
    /// container elements like [`Bin`][crate::Bin].
    /// The element implementing the interface acts as a parent for those child
    /// objects.
    ///
    /// By implementing this interface the child properties can be accessed from the
    /// parent element by using `gst_child_proxy_get()` and `gst_child_proxy_set()`.
    ///
    /// Property names are written as `child-name::property-name`. The whole naming
    /// scheme is recursive. Thus `child1::child2::property` is valid too, if
    /// `child1` and `child2` implement the [`ChildProxy`][crate::ChildProxy] interface.
    ///
    /// ## Signals
    ///
    ///
    /// #### `child-added`
    ///  Will be emitted after the `object` was added to the `child_proxy`.
    ///
    ///
    ///
    ///
    /// #### `child-removed`
    ///  Will be emitted after the `object` was removed from the `child_proxy`.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`ChildProxyExt`][trait@crate::prelude::ChildProxyExt], [`ChildProxyExtManual`][trait@crate::prelude::ChildProxyExtManual]
    #[doc(alias = "GstChildProxy")]
    pub struct ChildProxy(Interface<ffi::GstChildProxy, ffi::GstChildProxyInterface>);

    match fn {
        type_ => || ffi::gst_child_proxy_get_type(),
    }
}

impl ChildProxy {
    pub const NONE: Option<&'static ChildProxy> = None;
}

unsafe impl Send for ChildProxy {}
unsafe impl Sync for ChildProxy {}

/// Trait containing all [`struct@ChildProxy`] methods.
///
/// # Implementors
///
/// [`Bin`][struct@crate::Bin], [`ChildProxy`][struct@crate::ChildProxy], [`Pipeline`][struct@crate::Pipeline]
pub trait ChildProxyExt: IsA<ChildProxy> + 'static {
    /// Emits the [`child-added`][struct@crate::ChildProxy#child-added] signal.
    /// ## `child`
    /// the newly added child
    /// ## `name`
    /// the name of the new child
    #[doc(alias = "gst_child_proxy_child_added")]
    fn child_added(&self, child: &impl IsA<glib::Object>, name: &str) {
        unsafe {
            ffi::gst_child_proxy_child_added(
                self.as_ref().to_glib_none().0,
                child.as_ref().to_glib_none().0,
                name.to_glib_none().0,
            );
        }
    }

    /// Emits the [`child-removed`][struct@crate::ChildProxy#child-removed] signal.
    /// ## `child`
    /// the removed child
    /// ## `name`
    /// the name of the old child
    #[doc(alias = "gst_child_proxy_child_removed")]
    fn child_removed(&self, child: &impl IsA<glib::Object>, name: &str) {
        unsafe {
            ffi::gst_child_proxy_child_removed(
                self.as_ref().to_glib_none().0,
                child.as_ref().to_glib_none().0,
                name.to_glib_none().0,
            );
        }
    }

    //#[doc(alias = "gst_child_proxy_get")]
    //fn get(&self, first_property_name: &str, : /*Unknown conversion*//*Unimplemented*/Basic: VarArgs) {
    //    unsafe { TODO: call ffi:gst_child_proxy_get() }
    //}

    /// Fetches a child by its number.
    /// ## `index`
    /// the child's position in the child list
    ///
    /// # Returns
    ///
    /// the child object or [`None`] if
    ///  not found (index too high).
    #[doc(alias = "gst_child_proxy_get_child_by_index")]
    #[doc(alias = "get_child_by_index")]
    fn child_by_index(&self, index: u32) -> Option<glib::Object> {
        unsafe {
            from_glib_full(ffi::gst_child_proxy_get_child_by_index(
                self.as_ref().to_glib_none().0,
                index,
            ))
        }
    }

    /// Looks up a child element by the given name.
    ///
    /// This virtual method has a default implementation that uses [`Object`][crate::Object]
    /// together with [`GstObjectExt::name()`][crate::prelude::GstObjectExt::name()]. If the interface is to be used with
    /// `GObjects`, this methods needs to be overridden.
    /// ## `name`
    /// the child's name
    ///
    /// # Returns
    ///
    /// the child object or [`None`] if
    ///  not found.
    #[doc(alias = "gst_child_proxy_get_child_by_name")]
    #[doc(alias = "get_child_by_name")]
    fn child_by_name(&self, name: &str) -> Option<glib::Object> {
        unsafe {
            from_glib_full(ffi::gst_child_proxy_get_child_by_name(
                self.as_ref().to_glib_none().0,
                name.to_glib_none().0,
            ))
        }
    }

    /// Looks up a child element by the given full-path name.
    ///
    /// Similar to [`child_by_name()`][Self::child_by_name()], this method
    /// searches and returns a child given a name. The difference is that
    /// this method allows a hierarchical path in the form of
    /// child1::child2::child3. In the later example this method would
    /// return a reference to child3, if found. The name should be made of
    /// element names only and should not contain any property names.
    /// ## `name`
    /// the full-path child's name
    ///
    /// # Returns
    ///
    /// the child object or [`None`] if
    ///  not found.
    #[cfg(feature = "v1_22")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_22")))]
    #[doc(alias = "gst_child_proxy_get_child_by_name_recurse")]
    #[doc(alias = "get_child_by_name_recurse")]
    fn child_by_name_recurse(&self, name: &str) -> Option<glib::Object> {
        unsafe {
            from_glib_full(ffi::gst_child_proxy_get_child_by_name_recurse(
                self.as_ref().to_glib_none().0,
                name.to_glib_none().0,
            ))
        }
    }

    /// Gets the number of child objects this parent contains.
    ///
    /// # Returns
    ///
    /// the number of child objects
    #[doc(alias = "gst_child_proxy_get_children_count")]
    #[doc(alias = "get_children_count")]
    fn children_count(&self) -> u32 {
        unsafe { ffi::gst_child_proxy_get_children_count(self.as_ref().to_glib_none().0) }
    }

    //#[doc(alias = "gst_child_proxy_get_valist")]
    //#[doc(alias = "get_valist")]
    //fn valist(&self, first_property_name: &str, var_args: /*Unknown conversion*//*Unimplemented*/Unsupported) {
    //    unsafe { TODO: call ffi:gst_child_proxy_get_valist() }
    //}

    //#[doc(alias = "gst_child_proxy_set")]
    //fn set(&self, first_property_name: &str, : /*Unknown conversion*//*Unimplemented*/Basic: VarArgs) {
    //    unsafe { TODO: call ffi:gst_child_proxy_set() }
    //}

    //#[doc(alias = "gst_child_proxy_set_valist")]
    //fn set_valist(&self, first_property_name: &str, var_args: /*Unknown conversion*//*Unimplemented*/Unsupported) {
    //    unsafe { TODO: call ffi:gst_child_proxy_set_valist() }
    //}

    /// Will be emitted after the `object` was added to the `child_proxy`.
    /// ## `object`
    /// the [`glib::Object`][crate::glib::Object] that was added
    /// ## `name`
    /// the name of the new child
    #[doc(alias = "child-added")]
    fn connect_child_added<F: Fn(&Self, &glib::Object, &str) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn child_added_trampoline<
            P: IsA<ChildProxy>,
            F: Fn(&P, &glib::Object, &str) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstChildProxy,
            object: *mut glib::gobject_ffi::GObject,
            name: *mut std::ffi::c_char,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                ChildProxy::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(object),
                &glib::GString::from_glib_borrow(name),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"child-added".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    child_added_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Will be emitted after the `object` was removed from the `child_proxy`.
    /// ## `object`
    /// the [`glib::Object`][crate::glib::Object] that was removed
    /// ## `name`
    /// the name of the old child
    #[doc(alias = "child-removed")]
    fn connect_child_removed<F: Fn(&Self, &glib::Object, &str) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn child_removed_trampoline<
            P: IsA<ChildProxy>,
            F: Fn(&P, &glib::Object, &str) + Send + Sync + 'static,
        >(
            this: *mut ffi::GstChildProxy,
            object: *mut glib::gobject_ffi::GObject,
            name: *mut std::ffi::c_char,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(
                ChildProxy::from_glib_borrow(this).unsafe_cast_ref(),
                &from_glib_borrow(object),
                &glib::GString::from_glib_borrow(name),
            )
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"child-removed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    child_removed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<ChildProxy>> ChildProxyExt for O {}