GtkMenu: GtkMenu

In RGtk2: R Bindings for Gtk 2.8.0 and Above

Description

A menu widget

Methods and Functions

gtkMenuNew(show = TRUE)
gtkMenuSetScreen(object, screen = NULL)
gtkMenuReorderChild(object, child, position)
gtkMenuAttach(object, child, left.attach, right.attach, top.attach, bottom.attach)
gtkMenuPopup(object, parent.menu.shell = NULL, parent.menu.item = NULL, func = NULL, data = NULL, button, activate.time)
gtkMenuSetAccelGroup(object, accel.group)
gtkMenuGetAccelGroup(object)
gtkMenuSetAccelPath(object, accel.path)
gtkMenuGetAccelPath(object)
gtkMenuSetTitle(object, title)
gtkMenuGetTitle(object)
gtkMenuSetMonitor(object, monitor.num)
gtkMenuGetMonitor(object)
gtkMenuGetTearoffState(object)
gtkMenuSetReserveToggleSize(object, reserve.toggle.size)
gtkMenuGetReserveToggleSize(object)
gtkMenuPopdown(object)
gtkMenuReposition(object)
gtkMenuGetActive(object)
gtkMenuSetActive(object, index)
gtkMenuSetTearoffState(object, torn.off)
gtkMenuAttachToWidget(object, attach.widget)
gtkMenuDetach(object)
gtkMenuGetAttachWidget(object)
gtkMenuGetForAttachWidget(object)
gtkMenu(show = TRUE)

Hierarchy

GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkMenuShell
                                 +----GtkMenu
                                       +----GtkRecentChooserMenu

Interfaces

GtkMenu implements AtkImplementorIface and GtkBuildable.

Detailed Description

A GtkMenu is a GtkMenuShell that implements a drop down menu consisting of a list of GtkMenuItem objects which can be navigated and activated by the user to perform application functions.

A GtkMenu is most commonly dropped down by activating a GtkMenuItem in a GtkMenuBar or popped up by activating a GtkMenuItem in another GtkMenu.

A GtkMenu can also be popped up by activating a GtkOptionMenu. Other composite widgets such as the GtkNotebook can pop up a GtkMenu as well.

Applications can display a GtkMenu as a popup menu by calling the gtkMenuPopup function. The example below shows how an application can pop up a menu when the 3rd mouse button is pressed.

Connecting the popup signal handler.

## connect our handler which will popup the menu 
gSignalConnect(window, "button_press_event", my_popup_handler, menu,
               user.data.first=TRUE)

Signal handler which displays a popup menu.

# The popup handler
my_popup_handler <- function(widget, event)
{
  stopifnot(widget != NULL)
  checkPtrType(widget, "GtkMenu")
  stopifnot(event != NULL)

  ## The "widget" is the menu that was supplied when 
  ## gSignalConnect() was called.
  menu <- widget

  if (event[["type"]] == "button-press") {
    if (event[["button"]] == 3) {
      menu$popup(button=event[["button"]], activate.time=event[["time"]])
      return(TRUE)
    }
  }

  return(FALSE)
}

Structures

GtkMenu

The GtkMenu struct contains private data only, and should be accessed using the functions below.

Convenient Construction

gtkMenu is the equivalent of gtkMenuNew.

User Functions

GtkMenuPositionFunc(menu, x, y, push.in, user.data)

A user function supplied when calling gtkMenuPopup which controls the positioning of the menu when it is displayed. The function sets the x and y parameters to the coordinates where the menu is to be drawn. To make the menu appear on a different monitor than the mouse pointer, gtkMenuSetMonitor must be called.

menu

a GtkMenu.

x

the integer representing the horizontal position where the menu shall be drawn. This is an output parameter.

y

the integer representing the vertical position where the menu shall be drawn. This is an output parameter.

push.in

This parameter controls how menus placed outside the monitor are handled. If this is set to TRUE and part of the menu is outside the monitor then GTK+ pushes the window into the visible area, effectively modifying the popup position. Note that moving and possibly resizing the menu around will alter the scroll position to keep the menu items "in place", i.e. at the same monitor position they would have been without resizing. In practice, this behavior is only useful for combobox popups or option menus and cannot be used to simply confine a menu to monitor boundaries. In that case, changing the scroll offset is not desirable.

user.data

the data supplied by the user in the gtkMenuPopup data parameter.

GtkMenuDetachFunc(attach.widget, menu)

A user function supplied when calling gtkMenuAttachToWidget which will be called when the menu is later detached from the widget.

attach.widget

the GtkWidget that the menu is being detached from.

menu

the GtkMenu being detached.

Signals

move-scroll(menu, user.data)

undocumented

menu

the object which received the signal.

user.data

user data set when the signal handler was connected.

Properties

accel-group [GtkAccelGroup : * : Read / Write]

The accel group holding accelerators for the menu. Since 2.14

accel-path [character : * : Read / Write]

An accel path used to conveniently construct accel paths of child items. Default value: NULL Since 2.14

active [integer : Read / Write]

The index of the currently selected menu item, or -1 if no menu item is selected. Allowed values: >= -1 Default value: -1 Since 2.14

attach-widget [GtkWidget : * : Read / Write]

The widget the menu is attached to. Setting this property attaches the menu without a GtkMenuDetachFunc. If you need to use a detacher, use gtkMenuAttachToWidget directly. Since 2.14

monitor [integer : Read / Write]

The monitor the menu will be popped up on. Allowed values: >= -1 Default value: -1 Since 2.14

reserve-toggle-size [logical : Read / Write]

A boolean that indicates whether the menu reserves space for toggles and icons, regardless of their actual presence.

This property should only be changed from its default value for special-purposes such as tabular menus. Regular menus that are connected to a menu bar or context menus should reserve toggle space for consistency. Default value: TRUE Since 2.18

tearoff-state [logical : Read / Write]

A boolean that indicates whether the menu is torn-off. Default value: FALSE Since 2.6

tearoff-title [character : * : Read / Write]

A title that may be displayed by the window manager when this menu is torn-off. Default value: NULL

Style Properties

arrow-placement [GtkArrowPlacement : Read]

Indicates where scroll arrows should be placed. Default value: GTK_ARROWS_BOTH Since 2.16

arrow-scaling [numeric : Read]

Arbitrary constant to scale down the size of the scroll arrow. Allowed values: [0,1] Default value: 0.7

double-arrows [logical : Read]

When scrolling, always show both arrows. Default value: TRUE

horizontal-offset [integer : Read]

When the menu is a submenu, position it this number of pixels offset horizontally. Default value: -2

horizontal-padding [integer : Read]

Extra space at the left and right edges of the menu. Allowed values: >= 0 Default value: 0

vertical-offset [integer : Read]

When the menu is a submenu, position it this number of pixels offset vertically. Default value: 0

vertical-padding [integer : Read]

Extra space at the top and bottom of the menu. Allowed values: >= 0 Default value: 1

Author(s)

Derived by RGtkGen from GTK+ documentation

References

https://developer.gnome.org/gtk2/stable/GtkMenu.html

RGtk2 documentation built on Oct. 14, 2021, 5:08 p.m.