GtkMenuItem as GtkBuildable

The GtkMenuItem implementation of the GtkBuildable interface supports adding a submenu by specifying "submenu" as the "type" attribute of a <child> element.

1
2
3
4
5

<object class="GtkMenuItem">
  <child type="submenu">
    <object class="GtkMenu"/>
  </child>
</object>

struct GtkMenuItem

struct GtkMenuItem;

gtk_menu_item_new ()

GtkWidget *         gtk_menu_item_new                   (void);

Creates a new GtkMenuItem.

gtk_menu_item_new_with_label ()

GtkWidget *         gtk_menu_item_new_with_label        (const gchar *label);

Creates a new GtkMenuItem whose child is a GtkLabel.

gtk_menu_item_new_with_mnemonic ()

GtkWidget *         gtk_menu_item_new_with_mnemonic     (const gchar *label);

Creates a new GtkMenuItem containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the menu item.

gtk_menu_item_set_right_justified ()

void                gtk_menu_item_set_right_justified   (GtkMenuItem *menu_item,
                                                         gboolean right_justified);

Sets whether the menu item appears justified at the right side of a menu bar. This was traditionally done for "Help" menu items, but is now considered a bad idea. (If the widget layout is reversed for a right-to-left language like Hebrew or Arabic, right-justified-menu-items appear at the left.)

gtk_menu_item_get_right_justified ()

gboolean            gtk_menu_item_get_right_justified   (GtkMenuItem *menu_item);

Gets whether the menu item appears justified at the right side of the menu bar.

gtk_menu_item_get_label ()

const gchar *       gtk_menu_item_get_label             (GtkMenuItem *menu_item);

Sets text on the menu_item label

Since 2.16

gtk_menu_item_set_label ()

void                gtk_menu_item_set_label             (GtkMenuItem *menu_item,
                                                         const gchar *label);

Sets text on the menu_item label

Since 2.16

gtk_menu_item_get_use_underline ()

gboolean            gtk_menu_item_get_use_underline     (GtkMenuItem *menu_item);

Checks if an underline in the text indicates the next character should be used for the mnemonic accelerator key.

Since 2.16

gtk_menu_item_set_use_underline ()

void                gtk_menu_item_set_use_underline     (GtkMenuItem *menu_item,
                                                         gboolean setting);

If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key.

Since 2.16

gtk_menu_item_set_submenu ()

void                gtk_menu_item_set_submenu           (GtkMenuItem *menu_item,
                                                         GtkWidget *submenu);

Sets or replaces the menu item's submenu, or removes it when a NULL submenu is passed.

gtk_menu_item_get_submenu ()

GtkWidget *         gtk_menu_item_get_submenu           (GtkMenuItem *menu_item);

Gets the submenu underneath this menu item, if any. See gtk_menu_item_set_submenu().

gtk_menu_item_remove_submenu ()

void                gtk_menu_item_remove_submenu        (GtkMenuItem *menu_item);

Removes the widget's submenu.

gtk_menu_item_set_accel_path ()

void                gtk_menu_item_set_accel_path        (GtkMenuItem *menu_item,
                                                         const gchar *accel_path);

Set the accelerator path on menu_item, through which runtime changes of the menu item's accelerator caused by the user can be identified and saved to persistant storage (see gtk_accel_map_save() on this). To setup a default accelerator for this menu item, call gtk_accel_map_add_entry() with the same accel_path. See also gtk_accel_map_add_entry() on the specifics of accelerator paths, and gtk_menu_set_accel_path() for a more convenient variant of this function.

This function is basically a convenience wrapper that handles calling gtk_widget_set_accel_path() with the appropriate accelerator group for the menu item.

Note that you do need to set an accelerator on the parent menu with gtk_menu_set_accel_group() for this to work.

Note that accel_path string will be stored in a GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string().

gtk_menu_item_get_accel_path ()

const gchar *       gtk_menu_item_get_accel_path        (GtkMenuItem *menu_item);

Retrieve the accelerator path that was previously set on menu_item.

See gtk_menu_item_set_accel_path() for details.

Since 2.14

gtk_menu_item_select ()

void                gtk_menu_item_select                (GtkMenuItem *menu_item);

Emits the "select" signal on the given item. Behaves exactly like gtk_item_select.

gtk_menu_item_deselect ()

void                gtk_menu_item_deselect              (GtkMenuItem *menu_item);

Emits the "deselect" signal on the given item. Behaves exactly like gtk_item_deselect.

gtk_menu_item_activate ()

void                gtk_menu_item_activate              (GtkMenuItem *menu_item);

Emits the "activate" signal on the given item

gtk_menu_item_toggle_size_request ()

void                gtk_menu_item_toggle_size_request   (GtkMenuItem *menu_item,
                                                         gint *requisition);

Emits the "toggle_size_request" signal on the given item.

gtk_menu_item_toggle_size_allocate ()

void                gtk_menu_item_toggle_size_allocate  (GtkMenuItem *menu_item,
                                                         gint allocation);

Emits the "toggle_size_allocate" signal on the given item.

gtk_menu_item_right_justify()

#define gtk_menu_item_right_justify(menu_item) gtk_menu_item_set_right_justified ((menu_item), TRUE)

Sets the menu item to be right-justified. Only useful for menu bars.

The "accel-path" property

  "accel-path"               gchar*                : Read / Write

Sets the accelerator path of the menu item, through which runtime changes of the menu item's accelerator caused by the user can be identified and saved to persistant storage.

Default value: NULL

Since 2.14

The "label" property

  "label"                    gchar*                : Read / Write

The text for the child label.

Default value: ""

Since 2.16

The "right-justified" property

  "right-justified"          gboolean              : Read / Write

Sets whether the menu item appears justified at the right side of a menu bar.

Default value: FALSE

Since 2.14

The "submenu" property

  "submenu"                  GtkMenu*              : Read / Write

The submenu attached to the menu item, or NULL if it has none.

Since 2.12

The "use-underline" property

  "use-underline"            gboolean              : Read / Write

TRUE if underlines in the text indicate mnemonics

Default value: FALSE

Since 2.16

The "arrow-scaling" style property

  "arrow-scaling"            gfloat                : Read

Amount of space used up by arrow, relative to the menu item's font size.

Allowed values: [0,2]

Default value: 0.8

The "arrow-spacing" style property

  "arrow-spacing"            gint                  : Read

Space between label and arrow.

Allowed values: >= 0

Default value: 10

The "horizontal-padding" style property

  "horizontal-padding"       gint                  : Read

Padding to left and right of the menu item.

Allowed values: >= 0

Default value: 3

The "selected-shadow-type" style property

  "selected-shadow-type"     GtkShadowType         : Read

Shadow type when item is selected.

Default value: GTK_SHADOW_NONE

The "toggle-spacing" style property

  "toggle-spacing"           gint                  : Read

Space between icon and label.

Allowed values: >= 0

Default value: 5

The "width-chars" style property

  "width-chars"              gint                  : Read

The minimum desired width of the menu item in characters.

Allowed values: >= 0

Default value: 12

Since 2.14

The "activate" signal

void                user_function                      (GtkMenuItem *menuitem,
                                                        gpointer     user_data)      : Action

Emitted when the item is activated.

The "activate-item" signal

void                user_function                      (GtkMenuItem *menuitem,
                                                        gpointer     user_data)      : Run First

Emitted when the item is activated, but also if the menu item has a submenu. For normal applications, the relevant signal is "activate".

The "toggle-size-allocate" signal

void                user_function                      (GtkMenuItem *menuitem,
                                                        gint         arg1,
                                                        gpointer     user_data)      : Run First

The "toggle-size-request" signal

void                user_function                      (GtkMenuItem *menuitem,
                                                        gpointer     arg1,
                                                        gpointer     user_data)      : Run First