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

glib::wrapper! {
    /// Represents the context menu in a #WebKitWebView.
    ///
    /// #WebKitContextMenu represents a context menu containing
    /// #WebKitContextMenuItem<!-- -->s in a #WebKitWebView.
    ///
    /// When a #WebKitWebView is about to display the context menu, it
    /// emits the #WebKitWebView::context-menu signal, which has the
    /// #WebKitContextMenu as an argument. You can modify it, adding new
    /// submenus that you can create with webkit_context_menu_new(), adding
    /// new #WebKitContextMenuItem<!-- -->s with
    /// webkit_context_menu_prepend(), webkit_context_menu_append() or
    /// webkit_context_menu_insert(), maybe after having removed the
    /// existing ones with webkit_context_menu_remove_all().
    #[doc(alias = "WebKitContextMenu")]
    pub struct ContextMenu(Object<ffi::WebKitContextMenu, ffi::WebKitContextMenuClass>);

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

impl ContextMenu {
    /// Creates a new #WebKitContextMenu object.
    ///
    /// Creates a new #WebKitContextMenu object to be used as a submenu of an existing
    /// #WebKitContextMenu. The context menu of a #WebKitWebView is created by the view
    /// and passed as an argument of #WebKitWebView::context-menu signal.
    /// To add items to the menu use webkit_context_menu_prepend(),
    /// webkit_context_menu_append() or webkit_context_menu_insert().
    /// See also webkit_context_menu_new_with_items() to create a #WebKitContextMenu with
    /// a list of initial items.
    ///
    /// # Returns
    ///
    /// The newly created #WebKitContextMenu object
    #[doc(alias = "webkit_context_menu_new")]
    pub fn new() -> ContextMenu {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::webkit_context_menu_new()) }
    }

    /// Creates a new #WebKitContextMenu object with the given items.
    ///
    /// Creates a new #WebKitContextMenu object to be used as a submenu of an existing
    /// #WebKitContextMenu with the given initial items.
    /// See also webkit_context_menu_new()
    /// ## `items`
    /// a #GList of #WebKitContextMenuItem
    ///
    /// # Returns
    ///
    /// The newly created #WebKitContextMenu object
    #[doc(alias = "webkit_context_menu_new_with_items")]
    #[doc(alias = "new_with_items")]
    pub fn with_items(items: &[ContextMenuItem]) -> ContextMenu {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::webkit_context_menu_new_with_items(
                items.to_glib_none().0,
            ))
        }
    }

    /// Adds @item at the end of the @self.
    /// ## `item`
    /// the #WebKitContextMenuItem to add
    #[doc(alias = "webkit_context_menu_append")]
    pub fn append(&self, item: &ContextMenuItem) {
        unsafe {
            ffi::webkit_context_menu_append(self.to_glib_none().0, item.to_glib_none().0);
        }
    }

    /// Gets the first item in the @self.
    ///
    /// # Returns
    ///
    /// the first #WebKitContextMenuItem of @self,
    ///    or [`None`] if the #WebKitContextMenu is empty.
    #[doc(alias = "webkit_context_menu_first")]
    pub fn first(&self) -> Option<ContextMenuItem> {
        unsafe { from_glib_none(ffi::webkit_context_menu_first(self.to_glib_none().0)) }
    }

    /// Gets the #GdkEvent that triggered the context menu. This function only returns a valid
    /// #GdkEvent when called for a #WebKitContextMenu passed to #WebKitWebView::context-menu
    /// signal; in all other cases, [`None`] is returned.
    ///
    /// The returned #GdkEvent is expected to be one of the following types:
    /// <itemizedlist>
    /// <listitem><para>
    /// a #GdkEventButton of type `GDK_BUTTON_PRESS` when the context menu was triggered with mouse.
    /// </para></listitem>
    /// <listitem><para>
    /// a #GdkEventKey of type `GDK_KEY_PRESS` if the keyboard was used to show the menu.
    /// </para></listitem>
    /// <listitem><para>
    /// a generic #GdkEvent of type `GDK_NOTHING` when the #GtkWidget::popup-menu signal was used to show the context menu.
    /// </para></listitem>
    /// </itemizedlist>
    ///
    /// # Returns
    ///
    /// the menu event or [`None`].
    #[doc(alias = "webkit_context_menu_get_event")]
    #[doc(alias = "get_event")]
    pub fn event(&self) -> Option<gdk::Event> {
        unsafe { from_glib_none(ffi::webkit_context_menu_get_event(self.to_glib_none().0)) }
    }

    /// Gets the item at the given position in the @self.
    /// ## `position`
    /// the position of the item, counting from 0
    ///
    /// # Returns
    ///
    /// the #WebKitContextMenuItem at position @position in @self,
    ///    or [`None`] if the position is off the end of the @self.
    #[doc(alias = "webkit_context_menu_get_item_at_position")]
    #[doc(alias = "get_item_at_position")]
    pub fn item_at_position(&self, position: u32) -> Option<ContextMenuItem> {
        unsafe {
            from_glib_none(ffi::webkit_context_menu_get_item_at_position(
                self.to_glib_none().0,
                position,
            ))
        }
    }

    /// Returns the item list of @self.
    ///
    /// # Returns
    ///
    /// a #GList of
    ///    #WebKitContextMenuItem<!-- -->s
    #[doc(alias = "webkit_context_menu_get_items")]
    #[doc(alias = "get_items")]
    pub fn items(&self) -> Vec<ContextMenuItem> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::webkit_context_menu_get_items(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the length of the @self.
    ///
    /// # Returns
    ///
    /// the number of #WebKitContextMenuItem<!-- -->s in @self
    #[doc(alias = "webkit_context_menu_get_n_items")]
    #[doc(alias = "get_n_items")]
    pub fn n_items(&self) -> u32 {
        unsafe { ffi::webkit_context_menu_get_n_items(self.to_glib_none().0) }
    }

    /// Gets the user data of @self.
    ///
    /// This function can be used from the UI Process to get user data previously set
    /// from the Web Process with webkit_context_menu_set_user_data().
    ///
    /// # Returns
    ///
    /// the user data of @self, or [`None`] if @self doesn't have user data
    #[doc(alias = "webkit_context_menu_get_user_data")]
    #[doc(alias = "get_user_data")]
    pub fn user_data(&self) -> Option<glib::Variant> {
        unsafe {
            from_glib_none(ffi::webkit_context_menu_get_user_data(
                self.to_glib_none().0,
            ))
        }
    }

    /// Inserts @item into the @self at the given position.
    ///
    /// If @position is negative, or is larger than the number of items
    /// in the #WebKitContextMenu, the item is added on to the end of
    /// the @self. The first position is 0.
    /// ## `item`
    /// the #WebKitContextMenuItem to add
    /// ## `position`
    /// the position to insert the item
    #[doc(alias = "webkit_context_menu_insert")]
    pub fn insert(&self, item: &ContextMenuItem, position: i32) {
        unsafe {
            ffi::webkit_context_menu_insert(self.to_glib_none().0, item.to_glib_none().0, position);
        }
    }

    /// Gets the last item in the @self.
    ///
    /// # Returns
    ///
    /// the last #WebKitContextMenuItem of @self,
    ///    or [`None`] if the #WebKitContextMenu is empty.
    #[doc(alias = "webkit_context_menu_last")]
    pub fn last(&self) -> Option<ContextMenuItem> {
        unsafe { from_glib_none(ffi::webkit_context_menu_last(self.to_glib_none().0)) }
    }

    /// Moves @item to the given position in the @self.
    ///
    /// If @position is negative, or is larger than the number of items
    /// in the #WebKitContextMenu, the item is added on to the end of
    /// the @self.
    /// The first position is 0.
    /// ## `item`
    /// the #WebKitContextMenuItem to add
    /// ## `position`
    /// the new position to move the item
    #[doc(alias = "webkit_context_menu_move_item")]
    pub fn move_item(&self, item: &ContextMenuItem, position: i32) {
        unsafe {
            ffi::webkit_context_menu_move_item(
                self.to_glib_none().0,
                item.to_glib_none().0,
                position,
            );
        }
    }

    /// Adds @item at the beginning of the @self.
    /// ## `item`
    /// the #WebKitContextMenuItem to add
    #[doc(alias = "webkit_context_menu_prepend")]
    pub fn prepend(&self, item: &ContextMenuItem) {
        unsafe {
            ffi::webkit_context_menu_prepend(self.to_glib_none().0, item.to_glib_none().0);
        }
    }

    /// Removes @item from the @self.
    ///
    /// See also webkit_context_menu_remove_all() to remove all items.
    /// ## `item`
    /// the #WebKitContextMenuItem to remove
    #[doc(alias = "webkit_context_menu_remove")]
    pub fn remove(&self, item: &ContextMenuItem) {
        unsafe {
            ffi::webkit_context_menu_remove(self.to_glib_none().0, item.to_glib_none().0);
        }
    }

    /// Removes all items of the @self.
    #[doc(alias = "webkit_context_menu_remove_all")]
    pub fn remove_all(&self) {
        unsafe {
            ffi::webkit_context_menu_remove_all(self.to_glib_none().0);
        }
    }

    /// Sets user data to @self.
    ///
    /// This function can be used from a Web Process extension to set user data
    /// that can be retrieved from the UI Process using webkit_context_menu_get_user_data().
    /// If the @user_data #GVariant is floating, it is consumed.
    #[doc(alias = "webkit_context_menu_set_user_data")]
    pub fn set_user_data(&self, user_data: &glib::Variant) {
        unsafe {
            ffi::webkit_context_menu_set_user_data(
                self.to_glib_none().0,
                user_data.to_glib_none().0,
            );
        }
    }
}

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