Struct webkit6::OptionMenu

pub struct OptionMenu { /* private fields */ }

Represents the dropdown menu of a select element in a #WebKitWebView.

When a select element in a #WebKitWebView needs to display a dropdown menu, the signal #WebKitWebView::show-option-menu is emitted, providing a WebKitOptionMenu with the #WebKitOptionMenuItems that should be displayed.

Signals

close

Emitted when closing a #WebKitOptionMenu is requested. This can happen when the user explicitly calls webkit_option_menu_close() or when the element is detached from the current page.

GLib type: GObject with reference counted clone semantics.

Implementations

impl OptionMenu

pub fn activate_item(&self, index: u32)

Activates the #WebKitOptionMenuItem at @index in @self.

Activating an item changes the value of the element making the item the active one. You are expected to close the menu with webkit_option_menu_close() after activating an item, calling this function again will have no effect.

index

the index of the item

pub fn close(&self)

Request to close a #WebKitOptionMenu.

This emits WebKitOptionMenu::close signal. This function should always be called to notify WebKit that the associated menu has been closed. If the menu is closed and neither webkit_option_menu_select_item() nor webkit_option_menu_activate_item() have been called, the element value remains unchanged.

pub fn event(&self) -> Option<Event>

Gets the #GdkEvent that triggered the dropdown menu. If @self was not triggered by a user interaction, like a mouse click, None is returned.

Returns

the menu event or None.

pub fn item(&self, index: u32) -> Option<OptionMenuItem>

Returns the #WebKitOptionMenuItem at @index in @self.

index

the index of the item

Returns

a #WebKitOptionMenuItem of @self.

pub fn n_items(&self) -> u32

Gets the length of the @self.

Returns

the number of #WebKitOptionMenuItems in @self

pub fn select_item(&self, index: u32)

Selects the #WebKitOptionMenuItem at @index in @self.

Selecting an item changes the text shown by the combo button, but it doesn’t change the value of the element. You need to explicitly activate the item with webkit_option_menu_select_item() or close the menu with webkit_option_menu_close() in which case the currently selected item will be activated.

index

the index of the item

pub fn connect_close<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when closing a #WebKitOptionMenu is requested. This can happen when the user explicitly calls webkit_option_menu_close() or when the element is detached from the current page.

Trait Implementations

impl Clone for OptionMenu

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 OptionMenu

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

Formats the value using the given formatter.

impl HasParamSpec for OptionMenu

type ParamSpec = ParamSpecObject

type SetValue = OptionMenu

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for OptionMenu

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 OptionMenu

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 + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for OptionMenu

type Parent = Object

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

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for OptionMenu

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for OptionMenu