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