home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD5.iso / workbench / datatypes / switchwindowal.lha / sw.frontendclass.c.doc < prev    next >
Encoding:
Text File  |  1996-03-18  |  2.0 KB  |  78 lines
  1. TABLE OF CONTENTS
  2.  
  3. switchwindow/frontendclass
  4. switchwindow/frontendclass                         switchwindow/frontendclass
  5.  
  6.    NAME
  7.        frontendclass -- projectclass support object
  8.  
  9.    FUNCTION
  10.        Special support class for projectclass.
  11.        Contains some useful context stuff for projectclass, including names
  12.        etc.
  13.        Supports automatic locking and adding itself to projectclass via
  14.        OM_ADDMEMBER when OBJA_OBJECTLINK is given.
  15.  
  16.  
  17.        Class:        frontendclass
  18.        Superclass:   rootclass
  19.  
  20.  
  21.    METHODS
  22.        OM_NEW -- Create a new object.
  23.  
  24.        OM_SET -- Set an object's attributes and pass msg to linked object.
  25.  
  26.        OM_GET -- Obtain the value of an attribute. If the given attribute did
  27.            not match any own attributes, the dispatcher routes the msg to the
  28.            linked object.
  29.  
  30.        OM_UPDATE -- Update an object's attributes and pass msg to linked
  31.            object.
  32.  
  33.        OM_ADDMEMBER -- Pass msg to linked object and add the required locks.
  34.  
  35.        OM_REMMEMBER -- Pass msg to linked object and remove the locks.
  36.  
  37.        OM_DISPOSE -- Pass msg to linked object and dispose itself.
  38.  
  39.        ...
  40.    TAGS
  41.        OBJA_NAME (STRPTR) -- Name of the object.
  42.            Defaults to NULL.
  43.  
  44.            Applicability is (ISGU).
  45.  
  46.        OBJA_TITLE (STRPTR) -- Object's title.
  47.            Defaults to NULL.
  48.  
  49.            Applicability is (ISGU).
  50.  
  51.        OBJA_DESCR (STRPTR) -- Short description of object.
  52.            Defaults to NULL.
  53.  
  54.            Applicability is (ISGU).
  55.  
  56.        OBJA_HELPNODE (STRPTR) -- AmigaGuide help node.
  57.            Defaults to NULL.
  58.  
  59.            Applicability is (ISGU).
  60.  
  61.        OBJA_ID (UWORD) -- Object id
  62.            Defaults to 0U.
  63.  
  64.            Applicability is (ISGU).
  65.  
  66.        ...
  67.  
  68.        OBJA_CLASSID (ClassID) -- Objects public class name.
  69.  
  70.            Applicability is (G).
  71.  
  72.        OBJA_PROJECTHELPID (UWORD) -- Will be passed to project as
  73.            PROJECTA_HELPMEMBERID. If this is found in a OM_SET/OM_UPDATE msg,
  74.            the msg won't be passed to the linked object !.
  75.  
  76.            Applicability is (SU).
  77.  
  78.