home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / mui / mui_developer / autodocs / mui_family.doc < prev    next >
Text File  |  1997-03-10  |  5KB  |  192 lines
  1. TABLE OF CONTENTS
  2.  
  3. Family.mui/Family.mui
  4. Family.mui/MUIA_Family_Child
  5. Family.mui/MUIA_Family_List
  6. Family.mui/MUIM_Family_AddHead
  7. Family.mui/MUIM_Family_AddTail
  8. Family.mui/MUIM_Family_Insert
  9. Family.mui/MUIM_Family_Remove
  10. Family.mui/MUIM_Family_Sort
  11. Family.mui/MUIM_Family_Transfer
  12. Family.mui/Family.mui
  13.  
  14.     Family class is the base class for objects that are able
  15.     to handle a list of children. This is e.g. the case for
  16.     MUIs Menustrip, Menu and Menuitem objects.
  17.  
  18.     Family class defines methods and attributes to
  19.     add and remove children, sort children, and transfer
  20.     children to other Family objects.
  21.  
  22.     Group class and application class should also be a
  23.     subclass of Family class, but due to BOOPSI system
  24.     limitations, this is currently impossible. If the
  25.     future will allow more logical class trees, things
  26.     might change, but everything will be done in a
  27.     compatible manner.
  28. Family.mui/MUIA_Family_Child
  29.  
  30.     NAME
  31.     MUIA_Family_Child -- (V8 ) [I..], Object *
  32.  
  33.     FUNCTION
  34.     You supply a pointer to a previously created MUI object
  35.     here. This object will be added to family at family
  36.     creation time.
  37.  
  38.     Of course you can specify any number of child objects,
  39.     limited only by available memory.
  40.  
  41.     Normally, the value for a MUIA_Family_Child tag is
  42.     a direct call to another MUI_NewObject(), children
  43.     are generated "on the fly".
  44.  
  45.     When a family is disposed, all of its children will also
  46.     get deleted. If you supply a NULL pointer as child,
  47.     the family object will fail and previously dispose all
  48.     valid children found in the taglist.
  49.  
  50.     This behaviour makes it possible to generate a complete
  51.     family within one single (but long) MUI_NewObject()
  52.     call. Error checking is not necessary since every error,
  53.     even if it occurs in a very deep nesting level, will
  54.     cause the complete call to fail without leaving back
  55.     any previously created object.
  56.  
  57.     NOTES
  58.     As a special case, MUIA_Group_Child is also recognized
  59.     and treated as MUIA_Family_Child.
  60.  
  61.     SEE ALSO
  62.     MUIM_Family_AddTail, MUIM_Family_Insert,
  63.     MUIM_Family_AddHead, MUIA_Family_Remove
  64. Family.mui/MUIA_Family_List
  65.  
  66.     NAME
  67.     MUIA_Family_List -- (V8 ) [..G], struct MinList *
  68.  
  69.     FUNCTION
  70.     Returns a pointer to a struct MinList which contains the children
  71.     of a family object. You must parse this list with 
  72.     intuition.library/NextObject().
  73.  
  74.     SEE ALSO
  75.     MUIA_Family_Child
  76. Family.mui/MUIM_Family_AddHead
  77.  
  78.     NAME
  79.     MUIM_Family_AddHead (V8 )
  80.  
  81.     SYNOPSIS
  82.     DoMethod(obj,MUIM_Family_AddHead,Object *obj);
  83.  
  84.     FUNCTION
  85.     Add an object as first object to the family.
  86.     Subclasses of family class usually define which
  87.     types of objects are possible within their family.
  88.  
  89.     INPUTS
  90.     obj - the object to be added.
  91.  
  92.     SEE ALSO
  93.     MUIM_Family_AddTail, MUIM_Family_Insert,
  94.     MUIM_Family_Remove, MUIA_Family_Child
  95. Family.mui/MUIM_Family_AddTail
  96.  
  97.     NAME
  98.     MUIM_Family_AddTail (V8 )
  99.  
  100.     SYNOPSIS
  101.     DoMethod(obj,MUIM_Family_AddTail,Object *obj);
  102.  
  103.     FUNCTION
  104.     Add an object as last object to the family.
  105.     Subclasses of family class usually define which
  106.     types of objects are possible within their family.
  107.  
  108.     This method does the same as OM_ADDMEMBER.
  109.  
  110.     INPUTS
  111.     obj - the object to be added.
  112.  
  113.     SEE ALSO
  114.     MUIM_Family_AddHead, MUIM_Family_Insert,
  115.     MUIM_Family_Remove, MUIA_Family_Child
  116. Family.mui/MUIM_Family_Insert
  117.  
  118.     NAME
  119.     MUIM_Family_Insert (V8 )
  120.  
  121.     SYNOPSIS
  122.     DoMethod(obj,MUIM_Family_Insert,Object *obj, Object *pred);
  123.  
  124.     FUNCTION
  125.     Add an object after another object to the family.
  126.     Subclasses of family class usually define which
  127.     types of objects are possible within their family.
  128.  
  129.     INPUTS
  130.     obj  - the object to be added.
  131.     pred - the new object is inserted *after* this
  132.            object. pred must of course be a member
  133.            of the family.
  134.  
  135.     SEE ALSO
  136.     MUIM_Family_AddTail, MUIM_Family_AddHead,
  137.     MUIM_Family_Remove, MUIA_Family_Child
  138. Family.mui/MUIM_Family_Remove
  139.  
  140.     NAME
  141.     MUIM_Family_Remove (V8 )
  142.  
  143.     SYNOPSIS
  144.     DoMethod(obj,MUIM_Family_Remove,Object *obj);
  145.  
  146.     FUNCTION
  147.     Remove an object from a family.
  148.  
  149.     This method does the same as OM_REMMEMBER.
  150.  
  151.     INPUTS
  152.     obj - the object to be removed.
  153.  
  154.     SEE ALSO
  155.     MUIM_Family_AddTail, MUIM_Family_Insert,
  156.     MUIM_Family_AddHead, MUIA_Family_Child
  157. Family.mui/MUIM_Family_Sort
  158.  
  159.     NAME
  160.     MUIM_Family_Sort (V8 )
  161.  
  162.     SYNOPSIS
  163.     DoMethod(obj,MUIM_Family_Sort,Object *obj[1]);
  164.  
  165.     FUNCTION
  166.     Sort the children of a family.
  167.  
  168.     INPUTS
  169.     child - array that contains *all* the children of the
  170.             family in the desired order. The array must be
  171.             terminated with a NULL entry.
  172.  
  173.     SEE ALSO
  174.     MUIA_Family_Child
  175. Family.mui/MUIM_Family_Transfer
  176.  
  177.     NAME
  178.     MUIM_Family_Transfer (V8 )
  179.  
  180.     SYNOPSIS
  181.     DoMethod(obj,MUIM_Family_Transfer,Object *family);
  182.  
  183.     FUNCTION
  184.     All the children of the family are removed and
  185.     added to another family in the same order.
  186.  
  187.     INPUTS
  188.     family - the destination family.
  189.  
  190.     SEE ALSO
  191.     MUIA_Family_Child
  192.