Blame docs/reference/gio/html/GMenu.html

Packit ae235b
Packit ae235b
<html>
Packit ae235b
<head>
Packit ae235b
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit ae235b
<title>GMenu: GIO Reference Manual</title>
Packit ae235b
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit ae235b
<link rel="home" href="index.html" title="GIO Reference Manual">
Packit ae235b
<link rel="up" href="application.html" title="Application support">
Packit ae235b
<link rel="prev" href="GMenuModel.html" title="GMenuModel">
Packit ae235b
<link rel="next" href="gio-GMenuModel-exporter.html" title="GMenuModel exporter">
Packit ae235b
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit ae235b
<link rel="stylesheet" href="style.css" type="text/css">
Packit ae235b
</head>
Packit ae235b
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit ae235b
Packit ae235b
Packit ae235b
Top  | 
Packit ae235b
                  Description  | 
Packit ae235b
                  Object Hierarchy
Packit ae235b
Packit ae235b
Home
Packit ae235b
Up
Packit ae235b
Prev
Packit ae235b
Next
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

GMenu

Packit ae235b

GMenu — A simple implementation of GMenuModel

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Functions

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GMenu *
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_new ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_freeze ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_insert ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_prepend ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_append ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_insert_item ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_append_item ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_prepend_item ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_insert_section ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_prepend_section ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_append_section ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_append_submenu ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_insert_submenu ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_prepend_submenu ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_remove ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_remove_all ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GMenuItem *
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_new ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GMenuItem *
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_new_section ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GMenuItem *
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_new_submenu ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GMenuItem *
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_new_from_model ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_label ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_icon ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_action_and_target_value ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_action_and_target ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_detailed_action ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_section ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_submenu ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GVariant *
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_get_attribute_value ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_get_attribute ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GMenuModel *
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_get_link ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_attribute_value ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_attribute ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_menu_item_set_link ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Types and Values

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
 
Packit ae235b
GMenu
Packit ae235b
Packit ae235b
Packit ae235b
 
Packit ae235b
GMenuItem
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Object Hierarchy

Packit ae235b
    GObject
Packit ae235b
    ├── GMenuItem
Packit ae235b
    ╰── GMenuModel
Packit ae235b
        ╰── GMenu
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Includes

Packit ae235b
#include <gio/gio.h>
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Description

Packit ae235b

GMenu is a simple implementation of GMenuModel.

Packit ae235b
You populate a GMenu by adding GMenuItem instances to it.

Packit ae235b

There are some convenience functions to allow you to directly

Packit ae235b
add items (avoiding GMenuItem) for the common cases. To add
Packit ae235b
a regular item, use g_menu_insert(). To add a section, use
Packit ae235b
g_menu_insert_section(). To add a submenu, use
Packit ae235b
g_menu_insert_submenu().

Packit ae235b
Packit ae235b
Packit ae235b

Functions

Packit ae235b
Packit ae235b

g_menu_new ()

Packit ae235b
GMenu *
Packit ae235b
g_menu_new (void);
Packit ae235b

Creates a new GMenu.

Packit ae235b

The new menu has no items.

Packit ae235b
Packit ae235b

Returns

Packit ae235b

a new GMenu

Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_freeze ()

Packit ae235b
void
Packit ae235b
g_menu_freeze (GMenu *menu);
Packit ae235b

Marks menu

Packit ae235b
 as frozen.

Packit ae235b

After the menu is frozen, it is an error to attempt to make any

Packit ae235b
changes to it.  In effect this means that the GMenu API must no
Packit ae235b
longer be used.

Packit ae235b

This function causes g_menu_model_is_mutable() to begin returning

Packit ae235b
FALSE, which has some positive performance implications.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_insert ()

Packit ae235b
void
Packit ae235b
g_menu_insert (GMenu *menu,
Packit ae235b
               gint position,
Packit ae235b
               const gchar *label,
Packit ae235b
               const gchar *detailed_action);
Packit ae235b

Convenience function for inserting a normal menu item into menu

Packit ae235b
.
Packit ae235b
Combine g_menu_item_new() and g_menu_insert_item() for a more flexible
Packit ae235b
alternative.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

position

Packit ae235b

the position at which to insert the item

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

detailed_action

Packit ae235b

the detailed action string, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_prepend ()

Packit ae235b
void
Packit ae235b
g_menu_prepend (GMenu *menu,
Packit ae235b
                const gchar *label,
Packit ae235b
                const gchar *detailed_action);
Packit ae235b

Convenience function for prepending a normal menu item to the start

Packit ae235b
of menu
Packit ae235b
.  Combine g_menu_item_new() and g_menu_insert_item() for a more
Packit ae235b
flexible alternative.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

detailed_action

Packit ae235b

the detailed action string, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_append ()

Packit ae235b
void
Packit ae235b
g_menu_append (GMenu *menu,
Packit ae235b
               const gchar *label,
Packit ae235b
               const gchar *detailed_action);
Packit ae235b

Convenience function for appending a normal menu item to the end of

Packit ae235b
menu
Packit ae235b
.  Combine g_menu_item_new() and g_menu_insert_item() for a more
Packit ae235b
flexible alternative.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

detailed_action

Packit ae235b

the detailed action string, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_insert_item ()

Packit ae235b
void
Packit ae235b
g_menu_insert_item (GMenu *menu,
Packit ae235b
                    gint position,
Packit ae235b
                    GMenuItem *item);
Packit ae235b

Inserts item

Packit ae235b
 into menu
Packit ae235b
.

Packit ae235b

The "insertion" is actually done by copying all of the attribute and

Packit ae235b
link values of item
Packit ae235b
 and using them to form a new item within menu
Packit ae235b
.
Packit ae235b
As such, item
Packit ae235b
 itself is not really inserted, but rather, a menu item
Packit ae235b
that is exactly the same as the one presently described by item
Packit ae235b
.

Packit ae235b

This means that item

Packit ae235b
 is essentially useless after the insertion
Packit ae235b
occurs.  Any changes you make to it are ignored unless it is inserted
Packit ae235b
again (at which point its updated values will be copied).

Packit ae235b

You should probably just free item

Packit ae235b
 once you're done.

Packit ae235b

There are many convenience functions to take care of common cases.

Packit ae235b
See g_menu_insert(), g_menu_insert_section() and
Packit ae235b
g_menu_insert_submenu() as well as "prepend" and "append" variants of
Packit ae235b
each of these functions.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

position

Packit ae235b

the position at which to insert the item

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

item

Packit ae235b

the GMenuItem to insert

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_append_item ()

Packit ae235b
void
Packit ae235b
g_menu_append_item (GMenu *menu,
Packit ae235b
                    GMenuItem *item);
Packit ae235b

Appends item

Packit ae235b
 to the end of menu
Packit ae235b
.

Packit ae235b

See g_menu_insert_item() for more information.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

item

Packit ae235b

a GMenuItem to append

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_prepend_item ()

Packit ae235b
void
Packit ae235b
g_menu_prepend_item (GMenu *menu,
Packit ae235b
                     GMenuItem *item);
Packit ae235b

Prepends item

Packit ae235b
 to the start of menu
Packit ae235b
.

Packit ae235b

See g_menu_insert_item() for more information.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

item

Packit ae235b

a GMenuItem to prepend

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_insert_section ()

Packit ae235b
void
Packit ae235b
g_menu_insert_section (GMenu *menu,
Packit ae235b
                       gint position,
Packit ae235b
                       const gchar *label,
Packit ae235b
                       GMenuModel *section);
Packit ae235b

Convenience function for inserting a section menu item into menu

Packit ae235b
.
Packit ae235b
Combine g_menu_item_new_section() and g_menu_insert_item() for a more
Packit ae235b
flexible alternative.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

position

Packit ae235b

the position at which to insert the item

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

section

Packit ae235b

a GMenuModel with the items of the section

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_prepend_section ()

Packit ae235b
void
Packit ae235b
g_menu_prepend_section (GMenu *menu,
Packit ae235b
                        const gchar *label,
Packit ae235b
                        GMenuModel *section);
Packit ae235b

Convenience function for prepending a section menu item to the start

Packit ae235b
of menu
Packit ae235b
.  Combine g_menu_item_new_section() and g_menu_insert_item() for
Packit ae235b
a more flexible alternative.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

section

Packit ae235b

a GMenuModel with the items of the section

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_append_section ()

Packit ae235b
void
Packit ae235b
g_menu_append_section (GMenu *menu,
Packit ae235b
                       const gchar *label,
Packit ae235b
                       GMenuModel *section);
Packit ae235b

Convenience function for appending a section menu item to the end of

Packit ae235b
menu
Packit ae235b
.  Combine g_menu_item_new_section() and g_menu_insert_item() for a
Packit ae235b
more flexible alternative.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

section

Packit ae235b

a GMenuModel with the items of the section

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_append_submenu ()

Packit ae235b
void
Packit ae235b
g_menu_append_submenu (GMenu *menu,
Packit ae235b
                       const gchar *label,
Packit ae235b
                       GMenuModel *submenu);
Packit ae235b

Convenience function for appending a submenu menu item to the end of

Packit ae235b
menu
Packit ae235b
.  Combine g_menu_item_new_submenu() and g_menu_insert_item() for a
Packit ae235b
more flexible alternative.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

submenu

Packit ae235b

a GMenuModel with the items of the submenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_insert_submenu ()

Packit ae235b
void
Packit ae235b
g_menu_insert_submenu (GMenu *menu,
Packit ae235b
                       gint position,
Packit ae235b
                       const gchar *label,
Packit ae235b
                       GMenuModel *submenu);
Packit ae235b

Convenience function for inserting a submenu menu item into menu

Packit ae235b
.
Packit ae235b
Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more
Packit ae235b
flexible alternative.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

position

Packit ae235b

the position at which to insert the item

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

submenu

Packit ae235b

a GMenuModel with the items of the submenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_prepend_submenu ()

Packit ae235b
void
Packit ae235b
g_menu_prepend_submenu (GMenu *menu,
Packit ae235b
                        const gchar *label,
Packit ae235b
                        GMenuModel *submenu);
Packit ae235b

Convenience function for prepending a submenu menu item to the start

Packit ae235b
of menu
Packit ae235b
.  Combine g_menu_item_new_submenu() and g_menu_insert_item() for
Packit ae235b
a more flexible alternative.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

submenu

Packit ae235b

a GMenuModel with the items of the submenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_remove ()

Packit ae235b
void
Packit ae235b
g_menu_remove (GMenu *menu,
Packit ae235b
               gint position);
Packit ae235b

Removes an item from the menu.

Packit ae235b

position

Packit ae235b
 gives the index of the item to remove.

Packit ae235b

It is an error if position is not in range the range from 0 to one

Packit ae235b
less than the number of items in the menu.

Packit ae235b

It is not possible to remove items by identity since items are added

Packit ae235b
to the menu simply by copying their links and attributes (ie:
Packit ae235b
identity of the item itself is not preserved).

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

position

Packit ae235b

the position of the item to remove

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_remove_all ()

Packit ae235b
void
Packit ae235b
g_menu_remove_all (GMenu *menu);
Packit ae235b

Removes all items in the menu.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu

Packit ae235b

a GMenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.38

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_new ()

Packit ae235b
GMenuItem *
Packit ae235b
g_menu_item_new (const gchar *label,
Packit ae235b
                 const gchar *detailed_action);
Packit ae235b

Creates a new GMenuItem.

Packit ae235b

If label

Packit ae235b
 is non-NULL it is used to set the "label" attribute of the
Packit ae235b
new item.

Packit ae235b

If detailed_action

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

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

detailed_action

Packit ae235b

the detailed action string, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

a new GMenuItem

Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_new_section ()

Packit ae235b
GMenuItem *
Packit ae235b
g_menu_item_new_section (const gchar *label,
Packit ae235b
                         GMenuModel *section);
Packit ae235b

Creates a new GMenuItem representing a section.

Packit ae235b

This is a convenience API around g_menu_item_new() and

Packit ae235b
g_menu_item_set_section().

Packit ae235b

The effect of having one menu appear as a section of another is

Packit ae235b
exactly as it sounds: the items from section
Packit ae235b
 become a direct part of
Packit ae235b
the menu that menu_item
Packit ae235b
 is added to.

Packit ae235b

Visual separation is typically displayed between two non-empty

Packit ae235b
sections.  If label
Packit ae235b
 is non-NULL then it will be encorporated into
Packit ae235b
this visual indication.  This allows for labeled subsections of a
Packit ae235b
menu.

Packit ae235b

As a simple example, consider a typical "Edit" menu from a simple

Packit ae235b
program.  It probably contains an "Undo" and "Redo" item, followed by
Packit ae235b
a separator, followed by "Cut", "Copy" and "Paste".

Packit ae235b

This would be accomplished by creating three GMenu instances. The

Packit ae235b
first would be populated with the "Undo" and "Redo" items, and the
Packit ae235b
second with the "Cut", "Copy" and "Paste" items.  The first and
Packit ae235b
second menus would then be added as submenus of the third.  In XML
Packit ae235b
format, this would look something like the following:

Packit ae235b
Packit ae235b
  
Packit ae235b
    
Packit ae235b
      
Packit ae235b
        
1
Packit ae235b
2
Packit ae235b
3
Packit ae235b
4
Packit ae235b
5
Packit ae235b
6
Packit ae235b
7
Packit ae235b
8
Packit ae235b
9
Packit ae235b
10
Packit ae235b
11
Packit ae235b
        
<menu id='edit-menu'>
Packit ae235b
  <section>
Packit ae235b
    <item label='Undo'/>
Packit ae235b
    <item label='Redo'/>
Packit ae235b
  </section>
Packit ae235b
  <section>
Packit ae235b
    <item label='Cut'/>
Packit ae235b
    <item label='Copy'/>
Packit ae235b
    <item label='Paste'/>
Packit ae235b
  </section>
Packit ae235b
</menu>
Packit ae235b
      
Packit ae235b
    
Packit ae235b
  
Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b

The following example is exactly equivalent. It is more illustrative

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

Packit ae235b
Packit ae235b
  
Packit ae235b
    
Packit ae235b
      
Packit ae235b
        
1
Packit ae235b
2
Packit ae235b
3
Packit ae235b
4
Packit ae235b
5
Packit ae235b
6
Packit ae235b
7
Packit ae235b
8
Packit ae235b
9
Packit ae235b
10
Packit ae235b
11
Packit ae235b
12
Packit ae235b
13
Packit ae235b
14
Packit ae235b
15
Packit ae235b
        
<menu id='edit-menu'>
Packit ae235b
  <item>
Packit ae235b
    <link name='section'>
Packit ae235b
      <item label='Undo'/>
Packit ae235b
      <item label='Redo'/>
Packit ae235b
    </link>
Packit ae235b
  </item>
Packit ae235b
  <item>
Packit ae235b
    <link name='section'>
Packit ae235b
      <item label='Cut'/>
Packit ae235b
      <item label='Copy'/>
Packit ae235b
      <item label='Paste'/>
Packit ae235b
    </link>
Packit ae235b
  </item>
Packit ae235b
</menu>
Packit ae235b
      
Packit ae235b
    
Packit ae235b
  
Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

section

Packit ae235b

a GMenuModel with the items of the section

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

a new GMenuItem

Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_new_submenu ()

Packit ae235b
GMenuItem *
Packit ae235b
g_menu_item_new_submenu (const gchar *label,
Packit ae235b
                         GMenuModel *submenu);
Packit ae235b

Creates a new GMenuItem representing a submenu.

Packit ae235b

This is a convenience API around g_menu_item_new() and

Packit ae235b
g_menu_item_set_submenu().

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the section label, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

submenu

Packit ae235b

a GMenuModel with the items of the submenu

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

a new GMenuItem

Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_new_from_model ()

Packit ae235b
GMenuItem *
Packit ae235b
g_menu_item_new_from_model (GMenuModel *model,
Packit ae235b
                            gint item_index);
Packit ae235b

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

Packit ae235b
GMenuModel.

Packit ae235b

item_index

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

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

model

Packit ae235b

a GMenuModel

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

item_index

Packit ae235b

the index of an item in model

Packit ae235b

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

a new GMenuItem.

Packit ae235b
Packit ae235b

Since: 2.34

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_label ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_label (GMenuItem *menu_item,
Packit ae235b
                       const gchar *label);
Packit ae235b

Sets or unsets the "label" attribute of menu_item

Packit ae235b
.

Packit ae235b

If label

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

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

label

Packit ae235b

the label to set, or NULL to unset.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_icon ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_icon (GMenuItem *menu_item,
Packit ae235b
                      GIcon *icon);
Packit ae235b

Sets (or unsets) the icon on menu_item

Packit ae235b
.

Packit ae235b

This call is the same as calling g_icon_serialize() and using the

Packit ae235b
result as the value to g_menu_item_set_attribute_value() for
Packit ae235b
G_MENU_ATTRIBUTE_ICON.

Packit ae235b

This API is only intended for use with "noun" menu items; things like

Packit ae235b
bookmarks or applications in an "Open With" menu.  Don't use it on
Packit ae235b
menu items corresponding to verbs (eg: stock icons for 'Save' or
Packit ae235b
'Quit').

Packit ae235b

If icon

Packit ae235b
 is NULL then the icon is unset.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

icon

Packit ae235b

a GIcon, or NULL

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.38

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_action_and_target_value ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_action_and_target_value
Packit ae235b
                               (GMenuItem *menu_item,
Packit ae235b
                                const gchar *action,
Packit ae235b
                                GVariant *target_value);
Packit ae235b

Sets or unsets the "action" and "target" attributes of menu_item

Packit ae235b
.

Packit ae235b

If action

Packit ae235b
 is NULL then both the "action" and "target" attributes
Packit ae235b
are unset (and target_value
Packit ae235b
 is ignored).

Packit ae235b

If action

Packit ae235b
 is non-NULL then the "action" attribute is set.  The
Packit ae235b
"target" attribute is then set to the value of target_value
Packit ae235b
 if it is
Packit ae235b
non-NULL or unset otherwise.

Packit ae235b

Normal menu items (ie: not submenu, section or other custom item

Packit ae235b
types) are expected to have the "action" attribute set to identify
Packit ae235b
the action that they are associated with.  The state type of the
Packit ae235b
action help to determine the disposition of the menu item.  See
Packit ae235b
GAction and GActionGroup for an overview of actions.

Packit ae235b

In general, clicking on the menu item will result in activation of

Packit ae235b
the named action with the "target" attribute given as the parameter
Packit ae235b
to the action invocation.  If the "target" attribute is not set then
Packit ae235b
the action is invoked with no parameter.

Packit ae235b

If the action has no state then the menu item is usually drawn as a

Packit ae235b
plain menu item (ie: with no additional decoration).

Packit ae235b

If the action has a boolean state then the menu item is usually drawn

Packit ae235b
as a toggle menu item (ie: with a checkmark or equivalent
Packit ae235b
indication).  The item should be marked as 'toggled' or 'checked'
Packit ae235b
when the boolean state is TRUE.

Packit ae235b

If the action has a string state then the menu item is usually drawn

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

Packit ae235b

See g_menu_item_set_action_and_target() or

Packit ae235b
g_menu_item_set_detailed_action() for two equivalent calls that are
Packit ae235b
probably more convenient for most uses.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action

Packit ae235b

the name of the action for this item.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

target_value

Packit ae235b

a GVariant to use as the action target.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_action_and_target ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_action_and_target (GMenuItem *menu_item,
Packit ae235b
                                   const gchar *action,
Packit ae235b
                                   const gchar *format_string,
Packit ae235b
                                   ...);
Packit ae235b

Sets or unsets the "action" and "target" attributes of menu_item

Packit ae235b
.

Packit ae235b

If action

Packit ae235b
 is NULL then both the "action" and "target" attributes
Packit ae235b
are unset (and format_string
Packit ae235b
 is ignored along with the positional
Packit ae235b
parameters).

Packit ae235b

If action

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

Packit ae235b

See also g_menu_item_set_action_and_target_value() for an equivalent

Packit ae235b
call that directly accepts a GVariant.  See
Packit ae235b
g_menu_item_set_detailed_action() for a more convenient version that
Packit ae235b
works with string-typed targets.

Packit ae235b

See also g_menu_item_set_action_and_target_value() for a

Packit ae235b
description of the semantics of the action and target attributes.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action

Packit ae235b

the name of the action for this item.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

format_string

Packit ae235b

a GVariant format string.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

...

Packit ae235b

positional parameters, as per format_string

Packit ae235b

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_detailed_action ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_detailed_action (GMenuItem *menu_item,
Packit ae235b
                                 const gchar *detailed_action);
Packit ae235b

Sets the "action" and possibly the "target" attribute of menu_item

Packit ae235b
.

Packit ae235b

The format of detailed_action

Packit ae235b
 is the same format parsed by
Packit ae235b
g_action_parse_detailed_name().

Packit ae235b

See g_menu_item_set_action_and_target() or

Packit ae235b
g_menu_item_set_action_and_target_value() for more flexible (but
Packit ae235b
slightly less convenient) alternatives.

Packit ae235b

See also g_menu_item_set_action_and_target_value() for a description of

Packit ae235b
the semantics of the action and target attributes.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

detailed_action

Packit ae235b

the "detailed" action string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_section ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_section (GMenuItem *menu_item,
Packit ae235b
                         GMenuModel *section);
Packit ae235b

Sets or unsets the "section" link of menu_item

Packit ae235b
 to section
Packit ae235b
.

Packit ae235b

The effect of having one menu appear as a section of another is

Packit ae235b
exactly as it sounds: the items from section
Packit ae235b
 become a direct part of
Packit ae235b
the menu that menu_item
Packit ae235b
 is added to.  See g_menu_item_new_section()
Packit ae235b
for more information about what it means for a menu item to be a
Packit ae235b
section.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

section

Packit ae235b

a GMenuModel, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_submenu ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_submenu (GMenuItem *menu_item,
Packit ae235b
                         GMenuModel *submenu);
Packit ae235b

Sets or unsets the "submenu" link of menu_item

Packit ae235b
 to submenu
Packit ae235b
.

Packit ae235b

If submenu

Packit ae235b
 is non-NULL, it is linked to.  If it is NULL then the
Packit ae235b
link is unset.

Packit ae235b

The effect of having one menu appear as a submenu of another is

Packit ae235b
exactly as it sounds.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

submenu

Packit ae235b

a GMenuModel, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_get_attribute_value ()

Packit ae235b
GVariant *
Packit ae235b
g_menu_item_get_attribute_value (GMenuItem *menu_item,
Packit ae235b
                                 const gchar *attribute,
Packit ae235b
                                 const GVariantType *expected_type);
Packit ae235b

Queries the named attribute

Packit ae235b
 on menu_item
Packit ae235b
.

Packit ae235b

If expected_type

Packit ae235b
 is specified and the attribute does not have this
Packit ae235b
type, NULL is returned.  NULL is also returned if the attribute
Packit ae235b
simply does not exist.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

attribute

Packit ae235b

the attribute name to query

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

expected_type

Packit ae235b

the expected type of the attribute.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

the attribute value, or NULL.

Packit ae235b

[transfer full]

Packit ae235b
Packit ae235b

Since: 2.34

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_get_attribute ()

Packit ae235b
gboolean
Packit ae235b
g_menu_item_get_attribute (GMenuItem *menu_item,
Packit ae235b
                           const gchar *attribute,
Packit ae235b
                           const gchar *format_string,
Packit ae235b
                           ...);
Packit ae235b

Queries the named attribute

Packit ae235b
 on menu_item
Packit ae235b
.

Packit ae235b

If the attribute exists and matches the GVariantType corresponding

Packit ae235b
to format_string
Packit ae235b
 then format_string
Packit ae235b
 is used to deconstruct the
Packit ae235b
value into the positional parameters and TRUE is returned.

Packit ae235b

If the attribute does not exist, or it does exist but has the wrong

Packit ae235b
type, then the positional parameters are ignored and FALSE is
Packit ae235b
returned.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

attribute

Packit ae235b

the attribute name to query

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

format_string

Packit ae235b

a GVariant format string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

...

Packit ae235b

positional parameters, as per format_string

Packit ae235b

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

TRUE if the named attribute was found with the expected

Packit ae235b
type

Packit ae235b
Packit ae235b

Since: 2.34

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_get_link ()

Packit ae235b
GMenuModel *
Packit ae235b
g_menu_item_get_link (GMenuItem *menu_item,
Packit ae235b
                      const gchar *link);
Packit ae235b

Queries the named link

Packit ae235b
 on menu_item
Packit ae235b
.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

link

Packit ae235b

the link name to query

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

the link, or NULL.

Packit ae235b

[transfer full]

Packit ae235b
Packit ae235b

Since: 2.34

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_attribute_value ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_attribute_value (GMenuItem *menu_item,
Packit ae235b
                                 const gchar *attribute,
Packit ae235b
                                 GVariant *value);
Packit ae235b

Sets or unsets an attribute on menu_item

Packit ae235b
.

Packit ae235b

The attribute to set or unset is specified by attribute

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

Packit ae235b

must consist only of lowercase

Packit ae235b
ASCII characters, digits and '-'.

Packit ae235b

If value

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

Packit ae235b

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

Packit ae235b
the same.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

attribute

Packit ae235b

the attribute to set

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

value

Packit ae235b

a GVariant to use as the value, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_attribute ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_attribute (GMenuItem *menu_item,
Packit ae235b
                           const gchar *attribute,
Packit ae235b
                           const gchar *format_string,
Packit ae235b
                           ...);
Packit ae235b

Sets or unsets an attribute on menu_item

Packit ae235b
.

Packit ae235b

The attribute to set or unset is specified by attribute

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

Packit ae235b

If format_string

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

Packit ae235b

See also g_menu_item_set_attribute_value() for an equivalent call

Packit ae235b
that directly accepts a GVariant.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

attribute

Packit ae235b

the attribute to set

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

format_string

Packit ae235b

a GVariant format string, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

...

Packit ae235b

positional parameters, as per format_string

Packit ae235b

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_menu_item_set_link ()

Packit ae235b
void
Packit ae235b
g_menu_item_set_link (GMenuItem *menu_item,
Packit ae235b
                      const gchar *link,
Packit ae235b
                      GMenuModel *model);
Packit ae235b

Creates a link from menu_item

Packit ae235b
 to model
Packit ae235b
 if non-NULL, or unsets it.

Packit ae235b

Links are used to establish a relationship between a particular menu

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

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

menu_item

Packit ae235b

a GMenuItem

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

link

Packit ae235b

type of link to establish or unset

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

model

Packit ae235b

the GMenuModel to link to (or NULL to unset).

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Types and Values

Packit ae235b
Packit ae235b

GMenu

Packit ae235b
typedef struct _GMenu GMenu;
Packit ae235b

GMenu is an opaque structure type. You must access it using the

Packit ae235b
functions below.

Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

GMenuItem

Packit ae235b
typedef struct _GMenuItem GMenuItem;
Packit ae235b

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

Packit ae235b
functions below.

Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Generated by GTK-Doc V1.27
Packit ae235b
</body>
Packit ae235b
</html>