NautilusMenuItem

NautilusMenuItem — Menu item descriptor object

Synopsis

#include <libnautilus-extension/nautilus-menu-item.h>

struct              NautilusMenuItem;
void                nautilus_menu_item_list_free        (GList *item_list);
GType               nautilus_menu_item_get_type         (void);
NautilusMenuItem *  nautilus_menu_item_new              (const char *name,
                                                         const char *label,
                                                         const char *tip,
                                                         const char *icon);
void                nautilus_menu_item_activate         (NautilusMenuItem *item);
void                nautilus_menu_item_set_submenu      (NautilusMenuItem *item,
                                                         NautilusMenu *menu);

Object Hierarchy

  GObject
   +----NautilusMenuItem

Properties

  "icon"                     gchar*                : Read / Write
  "label"                    gchar*                : Read / Write
  "menu"                     NautilusMenu*         : Read / Write
  "name"                     gchar*                : Read / Write / Construct Only
  "priority"                 gboolean              : Read / Write
  "sensitive"                gboolean              : Read / Write
  "tip"                      gchar*                : Read / Write

Signals

  "activate"                                       : Run Last

Description

NautilusMenuItem is an object that describes an item in a file manager menu. Extensions can provide NautilusMenuItem objects by registering a NautilusMenuProvider and returning them from nautilus_menu_provider_get_file_items(), or nautilus_menu_provider_get_background_items(), which will be called by the main application when creating menus.

Details

struct NautilusMenuItem

struct NautilusMenuItem;

nautilus_menu_item_list_free ()

void                nautilus_menu_item_list_free        (GList *item_list);

item_list :

a list of NautilusMenuItem. [element-type NautilusMenuItem]

nautilus_menu_item_get_type ()

GType               nautilus_menu_item_get_type         (void);

nautilus_menu_item_new ()

NautilusMenuItem *  nautilus_menu_item_new              (const char *name,
                                                         const char *label,
                                                         const char *tip,
                                                         const char *icon);

Creates a new menu item that can be added to the toolbar or to a contextual menu.

name :

the identifier for the menu item

label :

the user-visible label of the menu item

tip :

the tooltip of the menu item

icon :

the name of the icon to display in the menu item

Returns :

a newly create NautilusMenuItem

nautilus_menu_item_activate ()

void                nautilus_menu_item_activate         (NautilusMenuItem *item);

emits the activate signal.

item :

pointer to a NautilusMenuItem

nautilus_menu_item_set_submenu ()

void                nautilus_menu_item_set_submenu      (NautilusMenuItem *item,
                                                         NautilusMenu *menu);

Attachs a menu to the given NautilusMenuItem.

item :

pointer to a NautilusMenuItem

menu :

pointer to a NautilusMenu to attach to the button

Property Details

The "icon" property

  "icon"                     gchar*                : Read / Write

Name of the icon to display in the menu item.

Default value: NULL


The "label" property

  "label"                    gchar*                : Read / Write

Label to display to the user.

Default value: NULL


The "menu" property

  "menu"                     NautilusMenu*         : Read / Write

The menu belonging to this item. May be null.


The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

Name of the item.

Default value: NULL


The "priority" property

  "priority"                 gboolean              : Read / Write

Show priority text in toolbars.

Default value: TRUE


The "sensitive" property

  "sensitive"                gboolean              : Read / Write

Whether the menu item is sensitive.

Default value: TRUE


The "tip" property

  "tip"                      gchar*                : Read / Write

Tooltip for the menu item.

Default value: NULL

Signal Details

The "activate" signal

void                user_function                      (NautilusMenuItem *nautilusmenuitem,
                                                        gpointer          user_data)             : Run Last