CajaMenuItem

CajaMenuItem — Menu item descriptor object

Functions

Properties

char * icon Read / Write
char * label Read / Write
CajaMenu * menu Read / Write
char * name Read / Write / Construct Only
gboolean priority Read / Write
gboolean sensitive Read / Write
char * tip Read / Write

Signals

void activate Run Last

Types and Values

struct CajaMenuItem

Object Hierarchy

    GObject
    ╰── CajaMenuItem

Includes

#include <libcaja-extension/caja-menu-item.h>

Description

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

Functions

caja_menu_item_get_type ()

GType
caja_menu_item_get_type (void);

caja_menu_item_new ()

CajaMenuItem *
caja_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.

Parameters

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 CajaMenuItem


caja_menu_item_activate ()

void
caja_menu_item_activate (CajaMenuItem *item);

emits the activate signal.

Parameters

item

pointer to a CajaMenuItem

 

caja_menu_item_set_submenu ()

void
caja_menu_item_set_submenu (CajaMenuItem *item,
                            CajaMenu *menu);

Attachs a menu to the given CajaMenuItem.

Parameters

item

pointer to a CajaMenuItem

 

menu

pointer to a CajaMenu to attach to the button

 

Types and Values

struct CajaMenuItem

struct CajaMenuItem;

Property Details

The “icon” property

  “icon”                     char *

Name of the icon to display in the menu item.

Owner: CajaMenuItem

Flags: Read / Write

Default value: NULL


The “label” property

  “label”                    char *

Label to display to the user.

Owner: CajaMenuItem

Flags: Read / Write

Default value: NULL


The “menu” property

  “menu”                     CajaMenu *

The menu belonging to this item. May be null.

Owner: CajaMenuItem

Flags: Read / Write


The “name” property

  “name”                     char *

Name of the item.

Owner: CajaMenuItem

Flags: Read / Write / Construct Only

Default value: NULL


The “priority” property

  “priority”                 gboolean

Show priority text in toolbars.

Owner: CajaMenuItem

Flags: Read / Write

Default value: TRUE


The “sensitive” property

  “sensitive”                gboolean

Whether the menu item is sensitive.

Owner: CajaMenuItem

Flags: Read / Write

Default value: TRUE


The “tip” property

  “tip”                      char *

Tooltip for the menu item.

Owner: CajaMenuItem

Flags: Read / Write

Default value: NULL

Signal Details

The “activate” signal

void
user_function (CajaMenuItem *cajamenuitem,
               gpointer      user_data)

Flags: Run Last