NAObjectItem

NAObjectItem — The Object Item Base Class Definition

Synopsis

#include <nautilus-actions/na-object-item.h>

#define             NA_OBJECT_ITEM_TYPE
#define             NA_OBJECT_ITEM                      (object)
#define             NA_IS_OBJECT_ITEM                   (object)
                    NAObjectItem;
enum                NAItemTarget;
gboolean            na_object_item_are_equal            (const NAObjectItem *a,
                                                         const NAObjectItem *b);
NAObjectId *        na_object_item_get_item             (const NAObjectItem *item,
                                                         const gchar *id);
gint                na_object_item_get_position         (const NAObjectItem *item,
                                                         const NAObjectId *child);
void                na_object_item_append_item          (NAObjectItem *item,
                                                         const NAObjectId *child);
void                na_object_item_insert_at            (NAObjectItem *item,
                                                         const NAObjectId *child,
                                                         gint pos);
void                na_object_item_insert_item          (NAObjectItem *item,
                                                         const NAObjectId *child,
                                                         const NAObjectId *before);
void                na_object_item_remove_item          (NAObjectItem *item,
                                                         const NAObjectId *child);
guint               na_object_item_get_items_count      (const NAObjectItem *item);
void                na_object_item_count_items          (GList *items,
                                                         gint *menus,
                                                         gint *actions,
                                                         gint *profiles,
                                                         gboolean recurse);
void                na_object_item_unref_items          (GList *items);
void                na_object_item_unref_items_rec      (GList *items);
void                na_object_item_rebuild_children_slist
                                                        (NAObjectItem *item);
void                na_object_item_deals_with_version   (NAObjectItem *item);

Object Hierarchy

  GObject
   +----NAObject
         +----NAObjectId
               +----NAObjectItem
                     +----NAObjectAction
                     +----NAObjectMenu

Implemented Interfaces

NAObjectItem implements NAIDuplicable.

Description

This is a pure virtual class, i.e. not an instantiatable one, but serves as the base class for NAObjectAction and NAObjectMenu.

Details

NA_OBJECT_ITEM_TYPE

#define NA_OBJECT_ITEM_TYPE                  ( na_object_item_get_type())

NA_OBJECT_ITEM()

#define NA_OBJECT_ITEM( object )             ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_ITEM_TYPE, NAObjectItem ))

NA_IS_OBJECT_ITEM()

#define NA_IS_OBJECT_ITEM( object )          ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_ITEM_TYPE ))

NAObjectItem

typedef struct _NAObjectItem NAObjectItem;

enum NAItemTarget

typedef enum {
	ITEM_TARGET_SELECTION = 1,
	ITEM_TARGET_LOCATION,
	ITEM_TARGET_TOOLBAR,
	ITEM_TARGET_ANY
} NAItemTarget;

The NAItemTarget mode is Nautilus-driven. It determines in which part of the Nautilus UI our actions will be displayed.

ITEM_TARGET_SELECTION

when targeting the selection context menu.

ITEM_TARGET_LOCATION

when targeting the background context menu.

ITEM_TARGET_TOOLBAR

when targeting the toolbar.

ITEM_TARGET_ANY

a wilcard target defined in order to be able to activate an action from a keyboard shortcut, while keeping this same action hidden from the UI.

na_object_item_are_equal ()

gboolean            na_object_item_are_equal            (const NAObjectItem *a,
                                                         const NAObjectItem *b);

na_object_item_get_item ()

NAObjectId *        na_object_item_get_item             (const NAObjectItem *item,
                                                         const gchar *id);

na_object_item_get_position ()

gint                na_object_item_get_position         (const NAObjectItem *item,
                                                         const NAObjectId *child);

na_object_item_append_item ()

void                na_object_item_append_item          (NAObjectItem *item,
                                                         const NAObjectId *child);

na_object_item_insert_at ()

void                na_object_item_insert_at            (NAObjectItem *item,
                                                         const NAObjectId *child,
                                                         gint pos);

na_object_item_insert_item ()

void                na_object_item_insert_item          (NAObjectItem *item,
                                                         const NAObjectId *child,
                                                         const NAObjectId *before);

na_object_item_remove_item ()

void                na_object_item_remove_item          (NAObjectItem *item,
                                                         const NAObjectId *child);

na_object_item_get_items_count ()

guint               na_object_item_get_items_count      (const NAObjectItem *item);

na_object_item_count_items ()

void                na_object_item_count_items          (GList *items,
                                                         gint *menus,
                                                         gint *actions,
                                                         gint *profiles,
                                                         gboolean recurse);

na_object_item_unref_items ()

void                na_object_item_unref_items          (GList *items);

na_object_item_unref_items_rec ()

void                na_object_item_unref_items_rec      (GList *items);

na_object_item_rebuild_children_slist ()

void                na_object_item_rebuild_children_slist
                                                        (NAObjectItem *item);

na_object_item_deals_with_version ()

void                na_object_item_deals_with_version   (NAObjectItem *item);