atk/auto/

state_set.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::StateType;
use glib::{prelude::*, translate::*};
use std::fmt;

glib::wrapper! {
    /// An AtkStateSet contains the states of an object.
    ///
    /// An AtkStateSet is a read-only representation of the full set of `AtkStates`
    /// that apply to an object at a given time. This set is not meant to be
    /// modified, but rather created when [`AtkObjectExt::ref_state_set()`][crate::prelude::AtkObjectExt::ref_state_set()] is called.
    ///
    /// # Implements
    ///
    /// [`StateSetExt`][trait@crate::prelude::StateSetExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "AtkStateSet")]
    pub struct StateSet(Object<ffi::AtkStateSet, ffi::AtkStateSetClass>);

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

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

    /// Creates a new empty state set.
    ///
    /// # Returns
    ///
    /// a new [`StateSet`][crate::StateSet]
    #[doc(alias = "atk_state_set_new")]
    pub fn new() -> StateSet {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::atk_state_set_new()) }
    }
}

impl Default for StateSet {
    fn default() -> Self {
        Self::new()
    }
}

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

/// Trait containing all [`struct@StateSet`] methods.
///
/// # Implementors
///
/// [`StateSet`][struct@crate::StateSet]
pub trait StateSetExt: IsA<StateSet> + sealed::Sealed + 'static {
    /// Adds the state of the specified type to the state set if it is not already
    /// present.
    ///
    /// Note that because an [`StateSet`][crate::StateSet] is a read-only object, this method should
    /// be used to add a state to a newly-created set which will then be returned by
    /// `atk_object_ref_state_set`. It should not be used to modify the existing state
    /// of an object. See also `atk_object_notify_state_change`.
    /// ## `type_`
    /// an [`StateType`][crate::StateType]
    ///
    /// # Returns
    ///
    /// [`true`] if the state for `type_` is not already in `self`.
    #[doc(alias = "atk_state_set_add_state")]
    fn add_state(&self, type_: StateType) -> bool {
        unsafe {
            from_glib(ffi::atk_state_set_add_state(
                self.as_ref().to_glib_none().0,
                type_.into_glib(),
            ))
        }
    }

    //#[doc(alias = "atk_state_set_add_states")]
    //fn add_states(&self, types: /*Unimplemented*/&CArray TypeId { ns_id: 1, id: 69 }) {
    //    unsafe { TODO: call ffi:atk_state_set_add_states() }
    //}

    /// Constructs the intersection of the two sets, returning [`None`] if the
    /// intersection is empty.
    /// ## `compare_set`
    /// another [`StateSet`][crate::StateSet]
    ///
    /// # Returns
    ///
    /// a new [`StateSet`][crate::StateSet] which is the intersection of
    /// the two sets.
    #[doc(alias = "atk_state_set_and_sets")]
    #[must_use]
    fn and_sets(&self, compare_set: &impl IsA<StateSet>) -> Option<StateSet> {
        unsafe {
            from_glib_full(ffi::atk_state_set_and_sets(
                self.as_ref().to_glib_none().0,
                compare_set.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Removes all states from the state set.
    #[doc(alias = "atk_state_set_clear_states")]
    fn clear_states(&self) {
        unsafe {
            ffi::atk_state_set_clear_states(self.as_ref().to_glib_none().0);
        }
    }

    /// Checks whether the state for the specified type is in the specified set.
    /// ## `type_`
    /// an [`StateType`][crate::StateType]
    ///
    /// # Returns
    ///
    /// [`true`] if `type_` is the state type is in `self`.
    #[doc(alias = "atk_state_set_contains_state")]
    fn contains_state(&self, type_: StateType) -> bool {
        unsafe {
            from_glib(ffi::atk_state_set_contains_state(
                self.as_ref().to_glib_none().0,
                type_.into_glib(),
            ))
        }
    }

    //#[doc(alias = "atk_state_set_contains_states")]
    //fn contains_states(&self, types: /*Unimplemented*/&CArray TypeId { ns_id: 1, id: 69 }) -> bool {
    //    unsafe { TODO: call ffi:atk_state_set_contains_states() }
    //}

    /// Checks whether the state set is empty, i.e. has no states set.
    ///
    /// # Returns
    ///
    /// [`true`] if `self` has no states set, otherwise [`false`]
    #[doc(alias = "atk_state_set_is_empty")]
    fn is_empty(&self) -> bool {
        unsafe { from_glib(ffi::atk_state_set_is_empty(self.as_ref().to_glib_none().0)) }
    }

    /// Constructs the union of the two sets.
    /// ## `compare_set`
    /// another [`StateSet`][crate::StateSet]
    ///
    /// # Returns
    ///
    /// a new [`StateSet`][crate::StateSet] which is
    /// the union of the two sets, returning [`None`] is empty.
    #[doc(alias = "atk_state_set_or_sets")]
    #[must_use]
    fn or_sets(&self, compare_set: &impl IsA<StateSet>) -> Option<StateSet> {
        unsafe {
            from_glib_full(ffi::atk_state_set_or_sets(
                self.as_ref().to_glib_none().0,
                compare_set.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Removes the state for the specified type from the state set.
    ///
    /// Note that because an [`StateSet`][crate::StateSet] is a read-only object, this method should
    /// be used to remove a state to a newly-created set which will then be returned
    /// by `atk_object_ref_state_set`. It should not be used to modify the existing
    /// state of an object. See also `atk_object_notify_state_change`.
    /// ## `type_`
    /// an `AtkType`
    ///
    /// # Returns
    ///
    /// [`true`] if `type_` was the state type is in `self`.
    #[doc(alias = "atk_state_set_remove_state")]
    fn remove_state(&self, type_: StateType) -> bool {
        unsafe {
            from_glib(ffi::atk_state_set_remove_state(
                self.as_ref().to_glib_none().0,
                type_.into_glib(),
            ))
        }
    }

    /// Constructs the exclusive-or of the two sets, returning [`None`] is empty.
    /// The set returned by this operation contains the states in exactly
    /// one of the two sets.
    /// ## `compare_set`
    /// another [`StateSet`][crate::StateSet]
    ///
    /// # Returns
    ///
    /// a new [`StateSet`][crate::StateSet] which contains the states
    /// which are in exactly one of the two sets.
    #[doc(alias = "atk_state_set_xor_sets")]
    #[must_use]
    fn xor_sets(&self, compare_set: &impl IsA<StateSet>) -> Option<StateSet> {
        unsafe {
            from_glib_full(ffi::atk_state_set_xor_sets(
                self.as_ref().to_glib_none().0,
                compare_set.as_ref().to_glib_none().0,
            ))
        }
    }
}

impl<O: IsA<StateSet>> StateSetExt for O {}

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