// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from webkit-gir-files
// DO NOT EDIT

use crate::{ffi, ScriptWorld};
use glib::translate::*;

glib::wrapper! {
    /// Result of a Hit Test (Web Process Extensions).
    ///
    /// WebKitWebHitTestResult extends #WebKitHitTestResult to provide information
    /// about the #WebKitDOMNode in the coordinates of the Hit Test.
    #[doc(alias = "WebKitWebHitTestResult")]
    pub struct WebHitTestResult(Object<ffi::WebKitWebHitTestResult, ffi::WebKitWebHitTestResultClass>);

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

impl WebHitTestResult {
    /// Check whether there is an editable element at the hit test position.
    ///
    /// Checks whether [`HitTestResultContext::EDITABLE`][crate::HitTestResultContext::EDITABLE] flag is present in
    /// the context flags.
    ///
    /// # Returns
    ///
    /// [`true`] if the hit test covers an editable element or [`false`] otherwise.
    #[doc(alias = "webkit_web_hit_test_result_context_is_editable")]
    pub fn context_is_editable(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_web_hit_test_result_context_is_editable(
                self.to_glib_none().0,
            ))
        }
    }

    /// Check whether there is an image element at the hit test position.
    ///
    /// Checks whether [`HitTestResultContext::IMAGE`][crate::HitTestResultContext::IMAGE] flag is present in
    /// the context flags.
    ///
    /// # Returns
    ///
    /// [`true`] if the hit test covers an image element or [`false`] otherwise.
    #[doc(alias = "webkit_web_hit_test_result_context_is_image")]
    pub fn context_is_image(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_web_hit_test_result_context_is_image(
                self.to_glib_none().0,
            ))
        }
    }

    /// Check whether there is a link element at the hit test position.
    ///
    /// Checks whether [`HitTestResultContext::LINK`][crate::HitTestResultContext::LINK] flag is present in
    /// the context flags.
    ///
    /// # Returns
    ///
    /// [`true`] if the hit test covers a link element or [`false`] otherwise.
    #[doc(alias = "webkit_web_hit_test_result_context_is_link")]
    pub fn context_is_link(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_web_hit_test_result_context_is_link(
                self.to_glib_none().0,
            ))
        }
    }

    /// Check whether there is a media element at the hit test position.
    ///
    /// Checks whether [`HitTestResultContext::MEDIA`][crate::HitTestResultContext::MEDIA] flag is present in
    /// the context flags.
    ///
    /// # Returns
    ///
    /// [`true`] if the hit test covers a media element or [`false`] otherwise.
    #[doc(alias = "webkit_web_hit_test_result_context_is_media")]
    pub fn context_is_media(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_web_hit_test_result_context_is_media(
                self.to_glib_none().0,
            ))
        }
    }

    /// Check whether there is a scrollbar at the hit test position.
    ///
    /// Checks whether [`HitTestResultContext::SCROLLBAR`][crate::HitTestResultContext::SCROLLBAR] flag is present in
    /// the context flags.
    ///
    /// # Returns
    ///
    /// [`true`] if the hit test covers a scrollbar or [`false`] otherwise.
    #[doc(alias = "webkit_web_hit_test_result_context_is_scrollbar")]
    pub fn context_is_scrollbar(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_web_hit_test_result_context_is_scrollbar(
                self.to_glib_none().0,
            ))
        }
    }

    /// Check whether there is a selected element at the hit test position.
    ///
    /// Checks whether [`HitTestResultContext::SELECTION`][crate::HitTestResultContext::SELECTION] flag is present in
    /// the context flags.
    ///
    /// # Returns
    ///
    /// [`true`] if the hit test covers a selected element or [`false`] otherwise.
    #[doc(alias = "webkit_web_hit_test_result_context_is_selection")]
    pub fn context_is_selection(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_web_hit_test_result_context_is_selection(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the the context flags for the hit test result.
    ///
    /// # Returns
    ///
    /// a bitmask of #WebKitHitTestResultContext flags
    #[doc(alias = "webkit_web_hit_test_result_get_context")]
    #[doc(alias = "get_context")]
    pub fn context(&self) -> u32 {
        unsafe { ffi::webkit_web_hit_test_result_get_context(self.to_glib_none().0) }
    }

    /// Obtains the URI associated with the image element at the hit test position.
    ///
    /// # Returns
    ///
    /// the URI of the image element, or [`None`] if the hit test does not cover an image element.
    #[doc(alias = "webkit_web_hit_test_result_get_image_uri")]
    #[doc(alias = "get_image_uri")]
    pub fn image_uri(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_web_hit_test_result_get_image_uri(
                self.to_glib_none().0,
            ))
        }
    }

    /// Get the #JSCValue for the DOM node in @world at the coordinates of the Hit Test.
    /// ## `world`
    /// a #WebKitScriptWorld, or [`None`] to use the default
    ///
    /// # Returns
    ///
    /// a #JSCValue for the DOM node, or [`None`]
    #[doc(alias = "webkit_web_hit_test_result_get_js_node")]
    #[doc(alias = "get_js_node")]
    pub fn js_node(&self, world: Option<&ScriptWorld>) -> Option<javascriptcore::Value> {
        unsafe {
            from_glib_full(ffi::webkit_web_hit_test_result_get_js_node(
                self.to_glib_none().0,
                world.to_glib_none().0,
            ))
        }
    }

    /// Obtains the label associated with the link element at the hit test position.
    ///
    /// # Returns
    ///
    /// the label of the link element, or [`None`] if the hit test does not cover a link element
    ///    or the link element does not have a label.
    #[doc(alias = "webkit_web_hit_test_result_get_link_label")]
    #[doc(alias = "get_link_label")]
    pub fn link_label(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_web_hit_test_result_get_link_label(
                self.to_glib_none().0,
            ))
        }
    }

    /// Obtains the title associated with the link element at the hit test position.
    ///
    /// # Returns
    ///
    /// the title of the link element, or [`None`] if the hit test does not cover a link element
    ///    or the link element does not have a title.
    #[doc(alias = "webkit_web_hit_test_result_get_link_title")]
    #[doc(alias = "get_link_title")]
    pub fn link_title(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_web_hit_test_result_get_link_title(
                self.to_glib_none().0,
            ))
        }
    }

    /// Obtains the URI associated with the link element at the hit test position.
    ///
    /// # Returns
    ///
    /// the URI of the link element, or [`None`] if the hit test does not cover a link element.
    #[doc(alias = "webkit_web_hit_test_result_get_link_uri")]
    #[doc(alias = "get_link_uri")]
    pub fn link_uri(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_web_hit_test_result_get_link_uri(
                self.to_glib_none().0,
            ))
        }
    }

    /// Obtains the URI associated with the media element at the hit test position.
    ///
    /// # Returns
    ///
    /// the URI of the media element, or [`None`] if the hit test does not cover a media element.
    #[doc(alias = "webkit_web_hit_test_result_get_media_uri")]
    #[doc(alias = "get_media_uri")]
    pub fn media_uri(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_web_hit_test_result_get_media_uri(
                self.to_glib_none().0,
            ))
        }
    }
}