Bonobo API Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# BonoboItemContainer

## Name

BonoboItemContainer -- this implements a simple container interface for compound document containers

## Synopsis

    typedef     BonoboClientSiteList;
    typedef     BonoboItemContainer;
    typedef     BonoboItemContainerClass;
    BonoboItemContainer* bonobo_item_container_new
                                                (void);
    void        bonobo_item_container_add       (BonoboItemContainer *container,
                                                 const char *name,
                                                 BonoboObject *object);
    void        bonobo_item_container_remove_by_name
                                                (BonoboItemContainer *container,
                                                 const char *name);

## Object Hierarchy

      GtkObject
       +----BonoboObject
             +----BonoboXObject
                   +----BonoboItemContainer

## Signal Prototypes

    "get-object"
                gpointer    user_function      (BonoboItemContainer *bonoboitemcontainer,
                                                gpointer arg1,
                                                gboolean arg2,
                                                gpointer arg3,
                                                gpointer user_data);

## Description

This implementation is mostly deprecated, see BonoboItemHandler

## Details

### BonoboClientSiteList

    typedef GList BonoboClientSiteList;

### BonoboItemContainer

    typedef struct {
    	BonoboXObject base;

    	BonoboItemContainerPrivate *priv;
    } BonoboItemContainer;

### BonoboItemContainerClass

    typedef struct {
    	BonoboXObjectClass parent_class;

    	POA_Bonobo_ItemContainer__epv epv;

    	Bonobo_Unknown (*get_object) (BonoboItemContainer *item_container,
    				      CORBA_char          *item_name,
    				      CORBA_boolean        only_if_exists,
    				      CORBA_Environment   *ev);
    } BonoboItemContainerClass;

### bonobo_item_container_new ()

    BonoboItemContainer* bonobo_item_container_new
                                                (void);

Creates a new BonoboItemContainer object. These are used to hold client sites.

Returns : | The newly created BonoboItemContainer object

### bonobo_item_container_add ()

    void        bonobo_item_container_add       (BonoboItemContainer *container,
                                                 const char *name,
                                                 BonoboObject *object);

Adds the `object` to the list of objects managed by this container

`container` : | The object to operate on.
`name` : | The name of the object
`object` : | The object to add to the container

### bonobo_item_container_remove_by_name ()

    void        bonobo_item_container_remove_by_name
                                                (BonoboItemContainer *container,
                                                 const char *name);

Removes the named object from the `container`

`container` : | The object to operate on.
`name` : | The name of the object to remove from the container

## Signals

### The "get-object" signal

    gpointer    user_function                  (BonoboItemContainer *bonoboitemcontainer,
                                                gpointer arg1,
                                                gboolean arg2,
                                                gpointer arg3,
                                                gpointer user_data);

`bonoboitemcontainer` : | the object which received the signal.
`arg1` : |
`arg2` : |
`arg3` : |
`user_data` : | user data set when the signal handler was connected.
Returns : |

## See Also

BonoboItemHandler

<<< Previous Page | Home | Up | Next Page >>>
BonoboEmbeddable | View interfaces