Struct ContextMenuItem 

pub struct ContextMenuItem { /* private fields */ }

One item of a ContextMenu.

The ContextMenu is composed of ContextMenuItems. These items can be created from a GtkAction, from a ContextMenuAction or from a ContextMenuAction and a label. These ContextMenuActions denote stock actions for the items. You can also create separators and submenus.

GLib type: GObject with reference counted clone semantics.

Implementations

impl ContextMenuItem

pub fn from_gaction( action: &impl IsA<Action>, label: &str, target: Option<&Variant>, ) -> ContextMenuItem

Creates a new ContextMenuItem for the given action and label.

On activation target will be passed as parameter to the callback.

action

a gio::Action

label

the menu item label text

target

a glib::Variant to use as the action target

Returns

the newly created ContextMenuItem object.

pub fn from_stock_action(action: ContextMenuAction) -> ContextMenuItem

Creates a new ContextMenuItem 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 is activated the action associated will be handled by WebKit and the current load operation will be stopped. You can get the gio::Action of a ContextMenuItem created with a ContextMenuAction with 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 ContextMenuAction stock action

Returns

the newly created ContextMenuItem object.

pub fn from_stock_action_with_label( action: ContextMenuAction, label: &str, ) -> ContextMenuItem

Creates a new ContextMenuItem for the given stock action using the given label.

Stock actions have a predefined label, this method can be used to create a ContextMenuItem for a ContextMenuAction but using a custom label.

action

a ContextMenuAction stock action

label

a custom label text to use instead of the predefined one

Returns

the newly created ContextMenuItem object.

pub fn new_separator() -> ContextMenuItem

Creates a new ContextMenuItem representing a separator.

Returns

the newly created ContextMenuItem object.

pub fn with_submenu(label: &str, submenu: &ContextMenu) -> ContextMenuItem

Creates a new ContextMenuItem using the given label with a submenu.

label

the menu item label text

submenu

a ContextMenu to set

Returns

the newly created ContextMenuItem object.

pub fn gaction(&self) -> Option<Action>

Gets the action associated to self as a gio::Action.

Returns

the gio::Action associated to the ContextMenuItem, or None if self is a separator.

pub fn gaction_target(&self) -> Option<Variant>

Available on crate feature v2_52 only.

Gets the target glib::Variant associated with self.

Returns

the target glib::Variant of the ContextMenuItem, or None if self was not created with from_gaction() or if no target was specified.

pub fn stock_action(&self) -> ContextMenuAction

Gets the ContextMenuAction of self.

If the ContextMenuItem was not created for a stock action ContextMenuAction::Custom will be returned. If the ContextMenuItem is a separator ContextMenuAction::NoAction will be returned.

Returns

the ContextMenuAction of self

pub fn submenu(&self) -> Option<ContextMenu>

Gets the submenu of self.

Returns

the ContextMenu representing the submenu of self or None if self doesn’t have a submenu.

pub fn title(&self) -> Option<GString>

Available on crate feature v2_52 only.

Gets the title of self.

Returns

the title of self, or None if self is a separator.

pub fn is_separator(&self) -> bool

Checks whether self is a separator.

Returns

true is self is a separator or false otherwise

pub fn set_submenu(&self, submenu: Option<&ContextMenu>)

Sets or replaces the self submenu.

If submenu is None the current submenu of self is removed.

submenu

a ContextMenu

Trait Implementations

impl Clone for ContextMenuItem

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContextMenuItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for ContextMenuItem

type ParamSpec = ParamSpecObject

type SetValue = ContextMenuItem

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, ContextMenuItem>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ContextMenuItem

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ContextMenuItem

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for ContextMenuItem

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for ContextMenuItem

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ContextMenuItem

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ContextMenuItem

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ContextMenuItem