Struct libpanel::MenuManager

pub struct MenuManager { /* private fields */ }

The goal of MenuManager is to simplify the process of merging multiple GtkBuilder .ui files containing menus into a single representation of the application menus. Additionally, it provides the ability to “unmerge” previously merged menus.

This allows for an application to have plugins which seemlessly extends the core application menus.

Implementation notes:

To make this work, we don’t use the GMenu instances created by a GtkBuilder instance. Instead, we create the menus ourself and recreate section and submenu links. This allows the MenuManager to be in full control of the generated menus.

menu_by_id() will always return a gio::Menu, however that menu may contain no children until something has extended it later on during the application process.

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl MenuManager

pub fn new() -> MenuManager

pub fn find_item_by_id(&self, id: &str) -> (Option<Menu>, u32)

Locates a menu item that matches id and sets the position within the resulting gio::Menu to position.

If no match is found, None is returned.

id

the identifier of the menu item

Returns

a gio::Menu if successful; otherwise None and position is unset.

position

the position within the resulting menu

pub fn menu_by_id(&self, menu_id: &str) -> Menu

Returns

A gio::Menu.

pub fn menu_ids(&self) -> Vec<GString>

Gets the known menu ids as a string array.

pub fn merge(&self, menu_id: &str, menu_model: &impl IsA<MenuModel>) -> u32

Note that menu_model is not retained, a copy of it is made.

menu_id

the identifier of the menu

menu_model

the menu model to merge

Returns

the merge-id which can be used with remove()

pub fn remove(&self, merge_id: u32)

This removes items from menus that were added as part of a previous menu merge. Use the value returned from merge() as the merge_id.

merge_id

A previously registered merge id

pub fn set_attribute_string( &self, menu: &Menu, position: u32, attribute: &str, value: &str, )

Overwrites an attribute for a menu that was created by MenuManager.

This can be useful when you want to update an attribute such as “accel” when an accelerator has changed due to user mappings.

menu

the menu that was retreived with menu_by_id()

position

the index of the item in the menu

attribute

the attribute to change

value

the new value for the attribute

impl MenuManager

pub fn add_filename(&self, filename: impl AsRef<Path>) -> Result<u32, Error>

pub fn add_resource(&self, resource: &str) -> Result<u32, Error>

Returns

the merge id

Trait Implementations

impl Clone for MenuManager

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 MenuManager

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

Formats the value using the given formatter.

impl Default for MenuManager

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for MenuManager

type ParamSpec = ParamSpecObject

type SetValue = MenuManager

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MenuManager

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 MenuManager

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 MenuManager

type Parent = Object

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

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 MenuManager

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 MenuManager

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MenuManager