// 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;
use glib::translate::*;

glib::wrapper! {
    /// Result of a Hit Test.
    ///
    /// A Hit Test is an operation to get context information about a given
    /// point in a #WebKitWebView. #WebKitHitTestResult represents the
    /// result of a Hit Test. It provides context information about what is
    /// at the coordinates of the Hit Test, such as if there's a link,
    /// an image or a media.
    ///
    /// You can get the context of the HitTestResult with
    /// webkit_hit_test_result_get_context() that returns a bitmask of
    /// #WebKitHitTestResultContext flags. You can also use
    /// webkit_hit_test_result_context_is_link(), webkit_hit_test_result_context_is_image() and
    /// webkit_hit_test_result_context_is_media() to determine whether there's
    /// a link, image or a media element at the coordinates of the Hit Test.
    /// Note that it's possible that several #WebKitHitTestResultContext flags
    /// are active at the same time, for example if there's a link containing an image.
    ///
    /// When the mouse is moved over a #WebKitWebView a Hit Test is performed
    /// for the mouse coordinates and #WebKitWebView::mouse-target-changed
    /// signal is emitted with a #WebKitHitTestResult.
    ///
    /// ## Properties
    ///
    ///
    /// #### `context`
    ///  Bitmask of #WebKitHitTestResultContext flags representing
    /// the context of the #WebKitHitTestResult.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `image-uri`
    ///  The URI of the image if flag [`HitTestResultContext::IMAGE`][crate::HitTestResultContext::IMAGE]
    /// is present in #WebKitHitTestResult:context
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `link-label`
    ///  The label of the link if flag [`HitTestResultContext::LINK`][crate::HitTestResultContext::LINK]
    /// is present in #WebKitHitTestResult:context
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `link-title`
    ///  The title of the link if flag [`HitTestResultContext::LINK`][crate::HitTestResultContext::LINK]
    /// is present in #WebKitHitTestResult:context
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `link-uri`
    ///  The URI of the link if flag [`HitTestResultContext::LINK`][crate::HitTestResultContext::LINK]
    /// is present in #WebKitHitTestResult:context
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `media-uri`
    ///  The URI of the media if flag [`HitTestResultContext::MEDIA`][crate::HitTestResultContext::MEDIA]
    /// is present in #WebKitHitTestResult:context
    ///
    /// Readable | Writeable | Construct Only
    #[doc(alias = "WebKitHitTestResult")]
    pub struct HitTestResult(Object<ffi::WebKitHitTestResult, ffi::WebKitHitTestResultClass>);

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

impl HitTestResult {
    /// Gets whether [`HitTestResultContext::EDITABLE`][crate::HitTestResultContext::EDITABLE] flag is present in
    /// #WebKitHitTestResult:context.
    ///
    /// # Returns
    ///
    /// [`true`] if there's an editable element at the coordinates of the @self,
    ///    or [`false`] otherwise
    #[doc(alias = "webkit_hit_test_result_context_is_editable")]
    pub fn context_is_editable(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_hit_test_result_context_is_editable(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets whether [`HitTestResultContext::IMAGE`][crate::HitTestResultContext::IMAGE] flag is present in
    /// #WebKitHitTestResult:context.
    ///
    /// # Returns
    ///
    /// [`true`] if there's an image element in the coordinates of the Hit Test,
    ///    or [`false`] otherwise
    #[doc(alias = "webkit_hit_test_result_context_is_image")]
    pub fn context_is_image(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_hit_test_result_context_is_image(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets whether [`HitTestResultContext::LINK`][crate::HitTestResultContext::LINK] flag is present in
    /// #WebKitHitTestResult:context.
    ///
    /// # Returns
    ///
    /// [`true`] if there's a link element in the coordinates of the Hit Test,
    ///    or [`false`] otherwise
    #[doc(alias = "webkit_hit_test_result_context_is_link")]
    pub fn context_is_link(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_hit_test_result_context_is_link(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets whether [`HitTestResultContext::MEDIA`][crate::HitTestResultContext::MEDIA] flag is present in
    /// #WebKitHitTestResult:context.
    ///
    /// # Returns
    ///
    /// [`true`] if there's a media element in the coordinates of the Hit Test,
    ///    or [`false`] otherwise
    #[doc(alias = "webkit_hit_test_result_context_is_media")]
    pub fn context_is_media(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_hit_test_result_context_is_media(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets whether [`HitTestResultContext::SCROLLBAR`][crate::HitTestResultContext::SCROLLBAR] flag is present in
    /// #WebKitHitTestResult:context.
    ///
    /// # Returns
    ///
    /// [`true`] if there's a scrollbar element at the coordinates of the @self,
    ///    or [`false`] otherwise
    #[doc(alias = "webkit_hit_test_result_context_is_scrollbar")]
    pub fn context_is_scrollbar(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_hit_test_result_context_is_scrollbar(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets whether [`HitTestResultContext::SELECTION`][crate::HitTestResultContext::SELECTION] flag is present in
    /// #WebKitHitTestResult:context.
    ///
    /// # Returns
    ///
    /// [`true`] if there's a selected element at the coordinates of the @self,
    ///    or [`false`] otherwise
    #[doc(alias = "webkit_hit_test_result_context_is_selection")]
    pub fn context_is_selection(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_hit_test_result_context_is_selection(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the value of the #WebKitHitTestResult:context property.
    ///
    /// # Returns
    ///
    /// a bitmask of #WebKitHitTestResultContext flags
    #[doc(alias = "webkit_hit_test_result_get_context")]
    #[doc(alias = "get_context")]
    pub fn context(&self) -> u32 {
        unsafe { ffi::webkit_hit_test_result_get_context(self.to_glib_none().0) }
    }

    /// Gets the value of the #WebKitHitTestResult:image-uri property.
    ///
    /// # Returns
    ///
    /// the URI of the image element in the coordinates of the Hit Test,
    ///    or [`None`] if there isn't an image element in @self context
    #[doc(alias = "webkit_hit_test_result_get_image_uri")]
    #[doc(alias = "get_image_uri")]
    #[doc(alias = "image-uri")]
    pub fn image_uri(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_hit_test_result_get_image_uri(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the value of the #WebKitHitTestResult:link-label property.
    ///
    /// # Returns
    ///
    /// the label of the link element in the coordinates of the Hit Test,
    ///    or [`None`] if there isn't a link element in @self context or the
    ///    link element doesn't have a label
    #[doc(alias = "webkit_hit_test_result_get_link_label")]
    #[doc(alias = "get_link_label")]
    #[doc(alias = "link-label")]
    pub fn link_label(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_hit_test_result_get_link_label(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the value of the #WebKitHitTestResult:link-title property.
    ///
    /// # Returns
    ///
    /// the title of the link element in the coordinates of the Hit Test,
    ///    or [`None`] if there isn't a link element in @self context or the
    ///    link element doesn't have a title
    #[doc(alias = "webkit_hit_test_result_get_link_title")]
    #[doc(alias = "get_link_title")]
    #[doc(alias = "link-title")]
    pub fn link_title(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_hit_test_result_get_link_title(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the value of the #WebKitHitTestResult:link-uri property.
    ///
    /// # Returns
    ///
    /// the URI of the link element in the coordinates of the Hit Test,
    ///    or [`None`] if there isn't a link element in @self context
    #[doc(alias = "webkit_hit_test_result_get_link_uri")]
    #[doc(alias = "get_link_uri")]
    #[doc(alias = "link-uri")]
    pub fn link_uri(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_hit_test_result_get_link_uri(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the value of the #WebKitHitTestResult:media-uri property.
    ///
    /// # Returns
    ///
    /// the URI of the media element in the coordinates of the Hit Test,
    ///    or [`None`] if there isn't a media element in @self context
    #[doc(alias = "webkit_hit_test_result_get_media_uri")]
    #[doc(alias = "get_media_uri")]
    #[doc(alias = "media-uri")]
    pub fn media_uri(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::webkit_hit_test_result_get_media_uri(
                self.to_glib_none().0,
            ))
        }
    }
}