Package org.gnome.gio

Class MenuItem

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.MenuItem

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class MenuItem
extends GObject

GMenuItem is an opaque structure type. You must access it using the functions below.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MenuItem.Builder<B extends MenuItem.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
MenuItem(@Nullable String label, @Nullable String detailedAction)	Creates a new GMenuItem.
MenuItem(MemorySegment address)	Create a MenuItem proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected MenuItem	asParent()	Returns this instance as if it were its parent type.
static MenuItem.Builder<? extends MenuItem.Builder>	builder()	A MenuItem.Builder object constructs a MenuItem with the specified properties.
static MenuItem	fromModel(MenuModel model, int itemIndex)	Creates a GMenuItem as an exact copy of an existing menu item in a GMenuModel.
boolean	getAttribute(String attribute, String formatString, Object... varargs)	Queries the named attribute on this MenuItem.
Variant	getAttributeValue(String attribute, @Nullable VariantType expectedType)	Queries the named attribute on this MenuItem.
MenuModel	getLink(String link)	Queries the named link on this MenuItem.
static Type	getType()	Get the GType of the MenuItem class
static MenuItem	section(@Nullable String label, MenuModel section)	Creates a new GMenuItem representing a section.
void	setActionAndTarget(@Nullable String action, @Nullable String formatString, Object... varargs)	Sets or unsets the "action" and "target" attributes of this MenuItem.
void	setActionAndTargetValue(@Nullable String action, @Nullable Variant targetValue)	Sets or unsets the "action" and "target" attributes of this MenuItem.
void	setAttribute(String attribute, @Nullable String formatString, Object... varargs)	Sets or unsets an attribute on this MenuItem.
void	setAttributeValue(String attribute, @Nullable Variant value)	Sets or unsets an attribute on this MenuItem.
void	setDetailedAction(String detailedAction)	Sets the "action" and possibly the "target" attribute of this MenuItem.
void	setIcon(Icon icon)	Sets (or unsets) the icon on this MenuItem.
void	setLabel(@Nullable String label)	Sets or unsets the "label" attribute of this MenuItem.
void	setLink(String link, @Nullable MenuModel model)	Creates a link from this MenuItem to model if non-null, or unsets it.
void	setSection(@Nullable MenuModel section)	Sets or unsets the "section" link of this MenuItem to section.
void	setSubmenu(@Nullable MenuModel submenu)	Sets or unsets the "submenu" link of this MenuItem to submenu.
static MenuItem	submenu(@Nullable String label, MenuModel submenu)	Creates a new GMenuItem representing a submenu.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MenuItem

public MenuItem(MemorySegment address)

Create a MenuItem proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

MenuItem

public MenuItem(@Nullable
 @Nullable String label,
 @Nullable
 @Nullable String detailedAction)

Creates a new GMenuItem.

If label is non-null it is used to set the "label" attribute of the new item.

If detailedAction is non-null it is used to set the "action" and possibly the "target" attribute of the new item. See g_menu_item_set_detailed_action() for more information.

Parameters:

label - the section label, or null

detailedAction - the detailed action string, or null

Method Details

getType

public static Type getType()

Get the GType of the MenuItem class

Returns:

the GType

asParent

protected MenuItem asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

fromModel

public static MenuItem fromModel(MenuModel model,
 int itemIndex)

Creates a GMenuItem as an exact copy of an existing menu item in a GMenuModel.

itemIndex must be valid (ie: be sure to call g_menu_model_get_n_items() first).

Parameters:

model - a GMenuModel

itemIndex - the index of an item in model

Returns:

a new GMenuItem.

section

public static MenuItem section(@Nullable
 @Nullable String label,
 MenuModel section)

Creates a new GMenuItem representing a section.

This is a convenience API around g_menu_item_new() and g_menu_item_set_section().

The effect of having one menu appear as a section of another is exactly as it sounds: the items from section become a direct part of the menu that menuItem is added to.

Visual separation is typically displayed between two non-empty sections. If label is non-null then it will be incorporated into this visual indication. This allows for labeled subsections of a menu.

As a simple example, consider a typical "Edit" menu from a simple program. It probably contains an "Undo" and "Redo" item, followed by a separator, followed by "Cut", "Copy" and "Paste".

This would be accomplished by creating three GMenu instances. The first would be populated with the "Undo" and "Redo" items, and the second with the "Cut", "Copy" and "Paste" items. The first and second menus would then be added as submenus of the third. In XML format, this would look something like the following:

 <menu id='edit-menu'>
   <section>
     <item label='Undo'/>
     <item label='Redo'/>
   </section>
   <section>
     <item label='Cut'/>
     <item label='Copy'/>
     <item label='Paste'/>
   </section>
 </menu>
 

The following example is exactly equivalent. It is more illustrative of the exact relationship between the menus and items (keeping in mind that the 'link' element defines a new menu that is linked to the containing one). The style of the second example is more verbose and difficult to read (and therefore not recommended except for the purpose of understanding what is really going on).

 <menu id='edit-menu'>
   <item>
     <link name='section'>
       <item label='Undo'/>
       <item label='Redo'/>
     </link>
   </item>
   <item>
     <link name='section'>
       <item label='Cut'/>
       <item label='Copy'/>
       <item label='Paste'/>
     </link>
   </item>
 </menu>
 

Parameters:

label - the section label, or null

section - a GMenuModel with the items of the section

Returns:

a new GMenuItem

submenu

public static MenuItem submenu(@Nullable
 @Nullable String label,
 MenuModel submenu)

Creates a new GMenuItem representing a submenu.

This is a convenience API around g_menu_item_new() and g_menu_item_set_submenu().

Parameters:

label - the section label, or null

submenu - a GMenuModel with the items of the submenu

Returns:

a new GMenuItem

getAttribute

public boolean getAttribute(String attribute,
 String formatString,
 Object... varargs)

Queries the named attribute on this MenuItem.

If the attribute exists and matches the GVariantType corresponding to formatString then formatString is used to deconstruct the value into the positional parameters and true is returned.

If the attribute does not exist, or it does exist but has the wrong type, then the positional parameters are ignored and false is returned.

Parameters:

attribute - the attribute name to query

formatString - a GVariant format string

varargs - positional parameters, as per formatString

Returns:

true if the named attribute was found with the expected type

getAttributeValue

public Variant getAttributeValue(String attribute,
 @Nullable
 @Nullable VariantType expectedType)

Queries the named attribute on this MenuItem.

If expectedType is specified and the attribute does not have this type, null is returned. null is also returned if the attribute simply does not exist.

Parameters:

attribute - the attribute name to query

expectedType - the expected type of the attribute

Returns:

the attribute value, or null

getLink

public MenuModel getLink(String link)

Queries the named link on this MenuItem.

Parameters:

link - the link name to query

Returns:

the link, or null

setActionAndTarget

public void setActionAndTarget(@Nullable
 @Nullable String action,
 @Nullable
 @Nullable String formatString,
 Object... varargs)

Sets or unsets the "action" and "target" attributes of this MenuItem.

If action is null then both the "action" and "target" attributes are unset (and formatString is ignored along with the positional parameters).

If action is non-null then the "action" attribute is set. formatString is then inspected. If it is non-null then the proper position parameters are collected to create a GVariant instance to use as the target value. If it is null then the positional parameters are ignored and the "target" attribute is unset.

See also g_menu_item_set_action_and_target_value() for an equivalent call that directly accepts a GVariant. See g_menu_item_set_detailed_action() for a more convenient version that works with string-typed targets.

See also g_menu_item_set_action_and_target_value() for a description of the semantics of the action and target attributes.

Parameters:

action - the name of the action for this item

formatString - a GVariant format string

varargs - positional parameters, as per formatString

setActionAndTargetValue

public void setActionAndTargetValue(@Nullable
 @Nullable String action,
 @Nullable
 @Nullable Variant targetValue)

Sets or unsets the "action" and "target" attributes of this MenuItem.

If action is null then both the "action" and "target" attributes are unset (and targetValue is ignored).

If action is non-null then the "action" attribute is set. The "target" attribute is then set to the value of targetValue if it is non-null or unset otherwise.

Normal menu items (ie: not submenu, section or other custom item types) are expected to have the "action" attribute set to identify the action that they are associated with. The state type of the action help to determine the disposition of the menu item. See GAction and GActionGroup for an overview of actions.

In general, clicking on the menu item will result in activation of the named action with the "target" attribute given as the parameter to the action invocation. If the "target" attribute is not set then the action is invoked with no parameter.

If the action has no state then the menu item is usually drawn as a plain menu item (ie: with no additional decoration).

If the action has a boolean state then the menu item is usually drawn as a toggle menu item (ie: with a checkmark or equivalent indication). The item should be marked as 'toggled' or 'checked' when the boolean state is true.

If the action has a string state then the menu item is usually drawn as a radio menu item (ie: with a radio bullet or equivalent indication). The item should be marked as 'selected' when the string state is equal to the value of the target property.

See g_menu_item_set_action_and_target() or g_menu_item_set_detailed_action() for two equivalent calls that are probably more convenient for most uses.

Parameters:

action - the name of the action for this item

targetValue - a GVariant to use as the action target

setAttribute

public void setAttribute(String attribute,
 @Nullable
 @Nullable String formatString,
 Object... varargs)

Sets or unsets an attribute on this MenuItem.

The attribute to set or unset is specified by attribute. This can be one of the standard attribute names G_MENU_ATTRIBUTE_LABEL, G_MENU_ATTRIBUTE_ACTION, G_MENU_ATTRIBUTE_TARGET, or a custom attribute name. Attribute names are restricted to lowercase characters, numbers and '-'. Furthermore, the names must begin with a lowercase character, must not end with a '-', and must not contain consecutive dashes.

If formatString is non-null then the proper position parameters are collected to create a GVariant instance to use as the attribute value. If it is null then the positional parameterrs are ignored and the named attribute is unset.

See also g_menu_item_set_attribute_value() for an equivalent call that directly accepts a GVariant.

Parameters:

attribute - the attribute to set

formatString - a GVariant format string, or null

varargs - positional parameters, as per formatString

setAttributeValue

public void setAttributeValue(String attribute,
 @Nullable
 @Nullable Variant value)

Sets or unsets an attribute on this MenuItem.

The attribute to set or unset is specified by attribute. This can be one of the standard attribute names G_MENU_ATTRIBUTE_LABEL, G_MENU_ATTRIBUTE_ACTION, G_MENU_ATTRIBUTE_TARGET, or a custom attribute name. Attribute names are restricted to lowercase characters, numbers and '-'. Furthermore, the names must begin with a lowercase character, must not end with a '-', and must not contain consecutive dashes.

must consist only of lowercase ASCII characters, digits and '-'.

If value is non-null then it is used as the new value for the attribute. If value is null then the attribute is unset. If the value GVariant is floating, it is consumed.

See also g_menu_item_set_attribute() for a more convenient way to do the same.

Parameters:

attribute - the attribute to set

value - a GVariant to use as the value, or null

setDetailedAction

public void setDetailedAction(String detailedAction)

Sets the "action" and possibly the "target" attribute of this MenuItem.

The format of detailedAction is the same format parsed by g_action_parse_detailed_name().

See g_menu_item_set_action_and_target() or g_menu_item_set_action_and_target_value() for more flexible (but slightly less convenient) alternatives.

See also g_menu_item_set_action_and_target_value() for a description of the semantics of the action and target attributes.

Parameters:

detailedAction - the "detailed" action string

setIcon

public void setIcon(Icon icon)

Sets (or unsets) the icon on this MenuItem.

This call is the same as calling g_icon_serialize() and using the result as the value to g_menu_item_set_attribute_value() for G_MENU_ATTRIBUTE_ICON.

This API is only intended for use with "noun" menu items; things like bookmarks or applications in an "Open With" menu. Don't use it on menu items corresponding to verbs (eg: stock icons for 'Save' or 'Quit').

If icon is null then the icon is unset.

Parameters:

icon - a GIcon, or null

setLabel

public void setLabel(@Nullable
 @Nullable String label)

Sets or unsets the "label" attribute of this MenuItem.

If label is non-null it is used as the label for the menu item. If it is null then the label attribute is unset.

Parameters:

label - the label to set, or null to unset

setLink

public void setLink(String link,
 @Nullable
 @Nullable MenuModel model)

Creates a link from this MenuItem to model if non-null, or unsets it.

Links are used to establish a relationship between a particular menu item and another menu. For example, G_MENU_LINK_SUBMENU is used to associate a submenu with a particular menu item, and G_MENU_LINK_SECTION is used to create a section. Other types of link can be used, but there is no guarantee that clients will be able to make sense of them. Link types are restricted to lowercase characters, numbers and '-'. Furthermore, the names must begin with a lowercase character, must not end with a '-', and must not contain consecutive dashes.

Parameters:

link - type of link to establish or unset

model - the GMenuModel to link to (or null to unset)

setSection

public void setSection(@Nullable
 @Nullable MenuModel section)

Sets or unsets the "section" link of this MenuItem to section.

The effect of having one menu appear as a section of another is exactly as it sounds: the items from section become a direct part of the menu that this MenuItem is added to. See g_menu_item_new_section() for more information about what it means for a menu item to be a section.

Parameters:

section - a GMenuModel, or null

setSubmenu

public void setSubmenu(@Nullable
 @Nullable MenuModel submenu)

Sets or unsets the "submenu" link of this MenuItem to submenu.

If submenu is non-null, it is linked to. If it is null then the link is unset.

The effect of having one menu appear as a submenu of another is exactly as it sounds.

Parameters:

submenu - a GMenuModel, or null

builder

public static MenuItem.Builder<? extends MenuItem.Builder> builder()

A MenuItem.Builder object constructs a MenuItem with the specified properties. Use the various set...() methods to set properties, and finish construction with MenuItem.Builder.build().