MateComponentItemContainer

MateComponentItemContainer — this implements a simple container interface for compound document containers

Synopsis

                    MateComponentItemContainer;
                    MateComponentItemContainerClass;
MateComponentItemContainer * matecomponent_item_container_new         (void);
void                matecomponent_item_container_add           (MateComponentItemContainer *container,
                                                         const char *name,
                                                         MateComponentObject *object);
void                matecomponent_item_container_remove_by_name
                                                        (MateComponentItemContainer *container,
                                                         const char *name);

Object Hierarchy

  GObject
   +----MateComponentObject
         +----MateComponentItemContainer

Signals

  "get-object"                                     : Run Last

Description

This implementation is mostly deprecated, see MateComponentItemHandler

Details

MateComponentItemContainer

typedef struct _MateComponentItemContainer MateComponentItemContainer;

Object that implements MateComponent::ItemHandler


MateComponentItemContainerClass

typedef struct {
	MateComponentObjectClass parent_class;

	POA_MateComponent_ItemContainer__epv epv;

	MateComponent_Unknown (*get_object) (MateComponentItemContainer *item_container,
				      CORBA_char          *item_name,
				      CORBA_boolean        only_if_exists,
				      CORBA_Environment   *ev);
} MateComponentItemContainerClass;

MateComponentItemContainer's class


matecomponent_item_container_new ()

MateComponentItemContainer * matecomponent_item_container_new         (void);

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

Returns :

The newly created MateComponentItemContainer object

matecomponent_item_container_add ()

void                matecomponent_item_container_add           (MateComponentItemContainer *container,
                                                         const char *name,
                                                         MateComponentObject *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

matecomponent_item_container_remove_by_name ()

void                matecomponent_item_container_remove_by_name
                                                        (MateComponentItemContainer *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

Signal Details

The "get-object" signal

MateComponentUnknown*      user_function                      (MateComponentItemContainer  *matecomponentitemcontainer,
                                                        gchar                *arg1,
                                                        gboolean              arg2,
                                                        MateComponentCorbaException *arg3,
                                                        gpointer              user_data)                : Run Last

Signal emitted when a sub-object is requested from the item container.

matecomponentitemcontainer :

the object which received the signal.

arg1 :

the item name, i.e. the string after the '!' character, usually a semicolon separated list of key=value options

arg2 :

the "only_if_exists" flag; if TRUE, client requests that subobject be returned if it exists, but that it should not be created on demand if it doesn't

arg3 :

environment, in case the signal wishes to raise an exception

user_data :

user data set when the signal handler was connected.

Returns :

an object contained by the item container, or CORBA_OBJECT_NIL.

See Also

MateComponentItemHandler