1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
// 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::{
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 {}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::ChildProxy>> Sealed for T {}
}
/// Trait containing all [`struct@ChildProxy`] methods.
///
/// # Implementors
///
/// [`Bin`][struct@crate::Bin], [`ChildProxy`][struct@crate::ChildProxy], [`Pipeline`][struct@crate::Pipeline]
pub trait ChildProxyExt: IsA<ChildProxy> + sealed::Sealed + '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 libc::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 _,
b"child-added\0".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 libc::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 _,
b"child-removed\0".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 {}