// 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, ContextMenu, ContextMenuAction};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// One item of a #WebKitContextMenu.
    ///
    /// The #WebKitContextMenu is composed of #WebKitContextMenuItem<!--
    /// -->s. These items can be created from a #GtkAction, from a
    /// #WebKitContextMenuAction or from a #WebKitContextMenuAction and a
    /// label. These #WebKitContextMenuAction<!-- -->s denote stock actions
    /// for the items. You can also create separators and submenus.
    #[doc(alias = "WebKitContextMenuItem")]
    pub struct ContextMenuItem(Object<ffi::WebKitContextMenuItem, ffi::WebKitContextMenuItemClass>);

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

impl ContextMenuItem {
    /// Creates a new #WebKitContextMenuItem for the given @action and @label.
    ///
    /// On activation
    /// @target will be passed as parameter to the callback.
    /// ## `action`
    /// a #GAction
    /// ## `label`
    /// the menu item label text
    /// ## `target`
    /// a #GVariant to use as the action target
    ///
    /// # Returns
    ///
    /// the newly created #WebKitContextMenuItem object.
    #[doc(alias = "webkit_context_menu_item_new_from_gaction")]
    #[doc(alias = "new_from_gaction")]
    pub fn from_gaction(
        action: &impl IsA<gio::Action>,
        label: &str,
        target: Option<&glib::Variant>,
    ) -> ContextMenuItem {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(ffi::webkit_context_menu_item_new_from_gaction(
                action.as_ref().to_glib_none().0,
                label.to_glib_none().0,
                target.to_glib_none().0,
            ))
        }
    }

    /// Creates a new #WebKitContextMenuItem for the given stock action.
    ///
    /// Stock actions are handled automatically by WebKit so that, for example,
    /// when a menu item created with a [`ContextMenuAction::Stop`][crate::ContextMenuAction::Stop] is
    /// activated the action associated will be handled by WebKit and the current
    /// load operation will be stopped. You can get the #GAction of a
    /// #WebKitContextMenuItem created with a #WebKitContextMenuAction with
    /// webkit_context_menu_item_get_gaction() and connect to the #GSimpleAction::activate signal
    /// to be notified when the item is activated, but you can't prevent the associated
    /// action from being performed.
    /// ## `action`
    /// a #WebKitContextMenuAction stock action
    ///
    /// # Returns
    ///
    /// the newly created #WebKitContextMenuItem object.
    #[doc(alias = "webkit_context_menu_item_new_from_stock_action")]
    #[doc(alias = "new_from_stock_action")]
    pub fn from_stock_action(action: ContextMenuAction) -> ContextMenuItem {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(ffi::webkit_context_menu_item_new_from_stock_action(
                action.into_glib(),
            ))
        }
    }

    /// Creates a new #WebKitContextMenuItem for the given stock action using the given @label.
    ///
    /// Stock actions have a predefined label, this method can be used to create a
    /// #WebKitContextMenuItem for a #WebKitContextMenuAction but using a custom label.
    /// ## `action`
    /// a #WebKitContextMenuAction stock action
    /// ## `label`
    /// a custom label text to use instead of the predefined one
    ///
    /// # Returns
    ///
    /// the newly created #WebKitContextMenuItem object.
    #[doc(alias = "webkit_context_menu_item_new_from_stock_action_with_label")]
    #[doc(alias = "new_from_stock_action_with_label")]
    pub fn from_stock_action_with_label(action: ContextMenuAction, label: &str) -> ContextMenuItem {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(
                ffi::webkit_context_menu_item_new_from_stock_action_with_label(
                    action.into_glib(),
                    label.to_glib_none().0,
                ),
            )
        }
    }

    /// Creates a new #WebKitContextMenuItem representing a separator.
    ///
    /// # Returns
    ///
    /// the newly created #WebKitContextMenuItem object.
    #[doc(alias = "webkit_context_menu_item_new_separator")]
    pub fn new_separator() -> ContextMenuItem {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::webkit_context_menu_item_new_separator()) }
    }

    /// Creates a new #WebKitContextMenuItem using the given @label with a submenu.
    /// ## `label`
    /// the menu item label text
    /// ## `submenu`
    /// a #WebKitContextMenu to set
    ///
    /// # Returns
    ///
    /// the newly created #WebKitContextMenuItem object.
    #[doc(alias = "webkit_context_menu_item_new_with_submenu")]
    #[doc(alias = "new_with_submenu")]
    pub fn with_submenu(label: &str, submenu: &ContextMenu) -> ContextMenuItem {
        skip_assert_initialized!();
        unsafe {
            from_glib_none(ffi::webkit_context_menu_item_new_with_submenu(
                label.to_glib_none().0,
                submenu.to_glib_none().0,
            ))
        }
    }

    /// Gets the action associated to @self as a #GAction.
    ///
    /// # Returns
    ///
    /// the #GAction associated to the #WebKitContextMenuItem,
    ///    or [`None`] if @self is a separator.
    #[doc(alias = "webkit_context_menu_item_get_gaction")]
    #[doc(alias = "get_gaction")]
    pub fn gaction(&self) -> Option<gio::Action> {
        unsafe {
            from_glib_none(ffi::webkit_context_menu_item_get_gaction(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the #WebKitContextMenuAction of @self.
    ///
    /// If the #WebKitContextMenuItem was not
    /// created for a stock action [`ContextMenuAction::Custom`][crate::ContextMenuAction::Custom] will be
    /// returned. If the #WebKitContextMenuItem is a separator [`ContextMenuAction::NoAction`][crate::ContextMenuAction::NoAction]
    /// will be returned.
    ///
    /// # Returns
    ///
    /// the #WebKitContextMenuAction of @self
    #[doc(alias = "webkit_context_menu_item_get_stock_action")]
    #[doc(alias = "get_stock_action")]
    pub fn stock_action(&self) -> ContextMenuAction {
        unsafe {
            from_glib(ffi::webkit_context_menu_item_get_stock_action(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the submenu of @self.
    ///
    /// # Returns
    ///
    /// the #WebKitContextMenu representing the submenu of
    ///    @self or [`None`] if @self doesn't have a submenu.
    #[doc(alias = "webkit_context_menu_item_get_submenu")]
    #[doc(alias = "get_submenu")]
    pub fn submenu(&self) -> Option<ContextMenu> {
        unsafe {
            from_glib_none(ffi::webkit_context_menu_item_get_submenu(
                self.to_glib_none().0,
            ))
        }
    }

    /// Checks whether @self is a separator.
    ///
    /// # Returns
    ///
    /// [`true`] is @self is a separator or [`false`] otherwise
    #[doc(alias = "webkit_context_menu_item_is_separator")]
    pub fn is_separator(&self) -> bool {
        unsafe {
            from_glib(ffi::webkit_context_menu_item_is_separator(
                self.to_glib_none().0,
            ))
        }
    }

    /// Sets or replaces the @self submenu.
    ///
    /// If @submenu is [`None`] the current
    /// submenu of @self is removed.
    /// ## `submenu`
    /// a #WebKitContextMenu
    #[doc(alias = "webkit_context_menu_item_set_submenu")]
    pub fn set_submenu(&self, submenu: Option<&ContextMenu>) {
        unsafe {
            ffi::webkit_context_menu_item_set_submenu(
                self.to_glib_none().0,
                submenu.to_glib_none().0,
            );
        }
    }
}