atk/auto/

relation.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, RelationType};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};

glib::wrapper! {
    /// An object used to describe a relation between a
    ///  object and one or more other objects.
    ///
    /// An AtkRelation describes a relation between an object and one or
    /// more other objects. The actual relations that an object has with
    /// other objects are defined as an AtkRelationSet, which is a set of
    /// AtkRelations.
    ///
    /// ## Properties
    ///
    ///
    /// #### `relation-type`
    ///  Readable | Writeable
    ///
    ///
    /// #### `target`
    ///  Readable | Writeable
    ///
    /// # Implements
    ///
    /// [`RelationExt`][trait@crate::prelude::RelationExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "AtkRelation")]
    pub struct Relation(Object<ffi::AtkRelation, ffi::AtkRelationClass>);

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

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

    /// Create a new relation for the specified key and the specified list
    /// of targets. See also [`AtkObjectExt::add_relationship()`][crate::prelude::AtkObjectExt::add_relationship()].
    /// ## `targets`
    /// an array of pointers to
    ///  `AtkObjects`
    /// ## `relationship`
    /// an [`RelationType`][crate::RelationType] with which to create the new
    ///  [`Relation`][crate::Relation]
    ///
    /// # Returns
    ///
    /// a pointer to a new [`Relation`][crate::Relation]
    #[doc(alias = "atk_relation_new")]
    pub fn new(targets: &[Object], relationship: RelationType) -> Relation {
        assert_initialized_main_thread!();
        let n_targets = targets.len() as _;
        unsafe {
            from_glib_full(ffi::atk_relation_new(
                targets.to_glib_none().0,
                n_targets,
                relationship.into_glib(),
            ))
        }
    }
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::Relation>> Sealed for T {}
}

/// Trait containing all [`struct@Relation`] methods.
///
/// # Implementors
///
/// [`Relation`][struct@crate::Relation]
pub trait RelationExt: IsA<Relation> + sealed::Sealed + 'static {
    /// Adds the specified AtkObject to the target for the relation, if it is
    /// not already present. See also [`AtkObjectExt::add_relationship()`][crate::prelude::AtkObjectExt::add_relationship()].
    /// ## `target`
    /// an [`Object`][crate::Object]
    #[doc(alias = "atk_relation_add_target")]
    fn add_target(&self, target: &impl IsA<Object>) {
        unsafe {
            ffi::atk_relation_add_target(
                self.as_ref().to_glib_none().0,
                target.as_ref().to_glib_none().0,
            );
        }
    }

    /// Gets the type of `self`
    ///
    /// # Returns
    ///
    /// the type of `self`
    #[doc(alias = "atk_relation_get_relation_type")]
    #[doc(alias = "get_relation_type")]
    fn relation_type(&self) -> RelationType {
        unsafe {
            from_glib(ffi::atk_relation_get_relation_type(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the target list of `self`
    ///
    /// # Returns
    ///
    /// the target list of `self`
    #[doc(alias = "atk_relation_get_target")]
    #[doc(alias = "get_target")]
    fn target(&self) -> Vec<Object> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::atk_relation_get_target(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Remove the specified AtkObject from the target for the relation.
    /// ## `target`
    /// an [`Object`][crate::Object]
    ///
    /// # Returns
    ///
    /// TRUE if the removal is successful.
    #[doc(alias = "atk_relation_remove_target")]
    fn remove_target(&self, target: &impl IsA<Object>) -> bool {
        unsafe {
            from_glib(ffi::atk_relation_remove_target(
                self.as_ref().to_glib_none().0,
                target.as_ref().to_glib_none().0,
            ))
        }
    }

    #[doc(alias = "relation-type")]
    fn set_relation_type(&self, relation_type: RelationType) {
        ObjectExt::set_property(self.as_ref(), "relation-type", relation_type)
    }

    fn set_target(&self, target: Option<&glib::ValueArray>) {
        ObjectExt::set_property(self.as_ref(), "target", target)
    }

    #[doc(alias = "relation-type")]
    fn connect_relation_type_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_relation_type_trampoline<
            P: IsA<Relation>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::AtkRelation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Relation::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::relation-type\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_relation_type_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "target")]
    fn connect_target_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_target_trampoline<P: IsA<Relation>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkRelation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Relation::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::target\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_target_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<Relation>> RelationExt for O {}

impl fmt::Display for Relation {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("Relation")
    }
}