atk/auto/

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

glib::wrapper! {
    /// An ATK object which encapsulates a link or set of links in a hypertext document.
    ///
    /// An ATK object which encapsulates a link or set of links (for
    /// instance in the case of client-side image maps) in a hypertext
    /// document. It may implement the AtkAction interface. AtkHyperlink
    /// may also be used to refer to inline embedded content, since it
    /// allows specification of a start and end offset within the host
    /// AtkHypertext object.
    ///
    /// ## Properties
    ///
    ///
    /// #### `end-index`
    ///  Readable
    ///
    ///
    /// #### `number-of-anchors`
    ///  Readable
    ///
    ///
    /// #### `selected-link`
    ///  Selected link
    ///
    /// Readable
    ///
    ///
    /// #### `start-index`
    ///  Readable
    ///
    /// ## Signals
    ///
    ///
    /// #### `link-activated`
    ///  The signal link-activated is emitted when a link is activated.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`HyperlinkExt`][trait@crate::prelude::HyperlinkExt], [`trait@glib::ObjectExt`], [`AtkActionExt`][trait@crate::prelude::AtkActionExt]
    #[doc(alias = "AtkHyperlink")]
    pub struct Hyperlink(Object<ffi::AtkHyperlink, ffi::AtkHyperlinkClass>) @implements Action;

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

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

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

/// Trait containing all [`struct@Hyperlink`] methods.
///
/// # Implementors
///
/// [`Hyperlink`][struct@crate::Hyperlink]
pub trait HyperlinkExt: IsA<Hyperlink> + sealed::Sealed + 'static {
    /// Gets the index with the hypertext document at which this link ends.
    ///
    /// # Returns
    ///
    /// the index with the hypertext document at which this link ends
    #[doc(alias = "atk_hyperlink_get_end_index")]
    #[doc(alias = "get_end_index")]
    fn end_index(&self) -> i32 {
        unsafe { ffi::atk_hyperlink_get_end_index(self.as_ref().to_glib_none().0) }
    }

    /// Gets the number of anchors associated with this hyperlink.
    ///
    /// # Returns
    ///
    /// the number of anchors associated with this hyperlink
    #[doc(alias = "atk_hyperlink_get_n_anchors")]
    #[doc(alias = "get_n_anchors")]
    fn n_anchors(&self) -> i32 {
        unsafe { ffi::atk_hyperlink_get_n_anchors(self.as_ref().to_glib_none().0) }
    }

    /// Returns the item associated with this hyperlinks nth anchor.
    /// For instance, the returned [`Object`][crate::Object] will implement [`Text`][crate::Text]
    /// if `self` is a text hyperlink, [`Image`][crate::Image] if `self` is an image
    /// hyperlink etc.
    ///
    /// Multiple anchors are primarily used by client-side image maps.
    /// ## `i`
    /// a (zero-index) integer specifying the desired anchor
    ///
    /// # Returns
    ///
    /// an [`Object`][crate::Object] associated with this hyperlinks
    /// i-th anchor
    #[doc(alias = "atk_hyperlink_get_object")]
    #[doc(alias = "get_object")]
    fn object(&self, i: i32) -> Option<Object> {
        unsafe {
            from_glib_none(ffi::atk_hyperlink_get_object(
                self.as_ref().to_glib_none().0,
                i,
            ))
        }
    }

    /// Gets the index with the hypertext document at which this link begins.
    ///
    /// # Returns
    ///
    /// the index with the hypertext document at which this link begins
    #[doc(alias = "atk_hyperlink_get_start_index")]
    #[doc(alias = "get_start_index")]
    fn start_index(&self) -> i32 {
        unsafe { ffi::atk_hyperlink_get_start_index(self.as_ref().to_glib_none().0) }
    }

    /// Get a the URI associated with the anchor specified
    /// by `i` of `self`.
    ///
    /// Multiple anchors are primarily used by client-side image maps.
    /// ## `i`
    /// a (zero-index) integer specifying the desired anchor
    ///
    /// # Returns
    ///
    /// a string specifying the URI
    #[doc(alias = "atk_hyperlink_get_uri")]
    #[doc(alias = "get_uri")]
    fn uri(&self, i: i32) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::atk_hyperlink_get_uri(
                self.as_ref().to_glib_none().0,
                i,
            ))
        }
    }

    /// Indicates whether the link currently displays some or all of its
    ///  content inline. Ordinary HTML links will usually return
    ///  [`false`], but an inline &lt;src&gt; HTML element will return
    ///  [`true`].
    ///
    /// # Returns
    ///
    /// whether or not this link displays its content inline.
    #[doc(alias = "atk_hyperlink_is_inline")]
    fn is_inline(&self) -> bool {
        unsafe { from_glib(ffi::atk_hyperlink_is_inline(self.as_ref().to_glib_none().0)) }
    }

    /// Since the document that a link is associated with may have changed
    /// this method returns [`true`] if the link is still valid (with
    /// respect to the document it references) and [`false`] otherwise.
    ///
    /// # Returns
    ///
    /// whether or not this link is still valid
    #[doc(alias = "atk_hyperlink_is_valid")]
    fn is_valid(&self) -> bool {
        unsafe { from_glib(ffi::atk_hyperlink_is_valid(self.as_ref().to_glib_none().0)) }
    }

    #[doc(alias = "number-of-anchors")]
    fn number_of_anchors(&self) -> i32 {
        ObjectExt::property(self.as_ref(), "number-of-anchors")
    }

    /// The signal link-activated is emitted when a link is activated.
    #[doc(alias = "link-activated")]
    fn connect_link_activated<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn link_activated_trampoline<P: IsA<Hyperlink>, F: Fn(&P) + 'static>(
            this: *mut ffi::AtkHyperlink,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(Hyperlink::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"link-activated\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    link_activated_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

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

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

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

impl<O: IsA<Hyperlink>> HyperlinkExt for O {}

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