Family.mui Class Reference

BOOPSI custom class Family.mui (MUI 3.8 dev). Each ### sub-section below documents one of the class's attributes or methods. Sub-classes of Family.mui are listed at the end under Sub-classes; the class hierarchy itself is documented in the MUI classes index.

Function index

Class definition

Attributes

Methods

Family.mui

MUIA_Family_Child

**MUIA_Family_Child -- (V8 ) [I..], Object ***

Function

You supply a pointer to a previously created MUI object here. This object will be added to family at family creation time. Of course you can specify any number of child objects, limited only by available memory. Normally, the value for a MUIA_Family_Child tag is a direct call to another MUI_NewObject(), children are generated "on the fly". When a family is disposed, all of its children will also get deleted. If you supply a NULL pointer as child, the family object will fail and previously dispose all valid children found in the taglist. This behaviour makes it possible to generate a complete family within one single (but long) MUI_NewObject() call. Error checking is not necessary since every error, even if it occurs in a very deep nesting level, will cause the complete call to fail without leaving back any previously created object.

Notes

As a special case, MUIA_Group_Child is also recognized and treated as MUIA_Family_Child.

See also

MUIM_Family_AddTail, MUIM_Family_Insert, MUIM_Family_AddHead, MUIA_Family_Remove

MUIA_Family_List

**MUIA_Family_List -- (V8 ) [..G], struct MinList ***

Function

Returns a pointer to a struct MinList which contains the children of a family object. You must parse this list with intuition.library/NextObject().

See also

MUIA_Family_Child

MUIM_Family_AddHead

MUIM_Family_AddHead (V8 ) — SYNOPSIS — DoMethod(obj,MUIM_Family_AddHead,Object *obj);

Function

Add an object as first object to the family. Subclasses of family class usually define which types of objects are possible within their family.

Inputs

obj - the object to be added.

See also

MUIM_Family_AddTail, MUIM_Family_Insert, MUIM_Family_Remove, MUIA_Family_Child

MUIM_Family_AddTail

MUIM_Family_AddTail (V8 ) — SYNOPSIS — DoMethod(obj,MUIM_Family_AddTail,Object *obj);

Function

Add an object as last object to the family. Subclasses of family class usually define which types of objects are possible within their family. This method does the same as OM_ADDMEMBER.

Inputs

obj - the object to be added.

See also

MUIM_Family_AddHead, MUIM_Family_Insert, MUIM_Family_Remove, MUIA_Family_Child

MUIM_Family_Insert

MUIM_Family_Insert (V8 ) — SYNOPSIS — DoMethod(obj,MUIM_Family_Insert,Object obj, Object pred);

Function

Add an object after another object to the family. Subclasses of family class usually define which types of objects are possible within their family.

Inputs

obj - the object to be added. pred - the new object is inserted after this object. pred must of course be a member of the family.

See also

MUIM_Family_AddTail, MUIM_Family_AddHead, MUIM_Family_Remove, MUIA_Family_Child

MUIM_Family_Remove

MUIM_Family_Remove (V8 ) — SYNOPSIS — DoMethod(obj,MUIM_Family_Remove,Object *obj);

Function

Remove an object from a family. This method does the same as OM_REMMEMBER.

Inputs

obj - the object to be removed.

See also

MUIM_Family_AddTail, MUIM_Family_Insert, MUIM_Family_AddHead, MUIA_Family_Child

MUIM_Family_Sort

MUIM_Family_Sort (V8 ) — SYNOPSIS — DoMethod(obj,MUIM_Family_Sort,Object *obj[1]);

Function

Sort the children of a family.

Inputs

child - array that contains all the children of the family in the desired order. The array must be terminated with a NULL entry.

See also

MUIA_Family_Child

MUIM_Family_Transfer

MUIM_Family_Transfer (V8 ) — SYNOPSIS — DoMethod(obj,MUIM_Family_Transfer,Object *family);

Function

All the children of the family are removed and added to another family in the same order.

Inputs

family - the destination family.

See also

MUIA_Family_Child