home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD5.iso / workbench / datatypes / switchwindowal.lha / sw.cxclass.c.doc < prev    next >
Encoding:
Text File  |  1996-03-18  |  4.2 KB  |  182 lines
  1. TABLE OF CONTENTS
  2.  
  3. switchwindow/cxbrokerclass
  4. switchwindow/cxclass
  5. switchwindow/cxfilterclass
  6. switchwindow/cxtranslateclass
  7. switchwindow/cxbrokerclass                         switchwindow/cxbrokerclass
  8.  
  9.    NAME
  10.        cxbrokerclass -- A commodities broker object.
  11.  
  12.    FUNCTION
  13.        Class:        cxbrokerclass
  14.        Superclass:   cxclass
  15.  
  16.        Commodities broker object.
  17.  
  18.    TAGS
  19.        CXBROKERA_Name (STRPTR) -- Broker's name.
  20.            Defaults to current projects name.
  21.  
  22.            Applicability is (ISG).
  23.  
  24.        CXBROKERA_Title (STRPTR) -- Broker's title.
  25.            Defaults to NULL.
  26.  
  27.            Applicability is (ISG).
  28.  
  29.        CXBROKERA_Descr (STRPTR) -- Brokers's description.
  30.            Defaults to NULL.
  31.  
  32.            Applicability is (ISG).
  33.  
  34.        CXBROKERA_DoUnique (BOOL) -- Broker's name should be unique in
  35.            commodities brokerlist.
  36.  
  37.            Applicability is (ISG).
  38.  
  39.        CXBROKERA_DoNotify (BOOL) --
  40.  
  41.            Applicability is (ISG).
  42.  
  43.        CXBROKERA_DoShowHide (BOOL) -- Broker's project want to hear
  44.            PROJECTA_SHOWGUI events.
  45.  
  46.            Applicability is (ISG).
  47.  
  48.        ...
  49.  
  50.        CXBROKERA_BrokerError (long) -- BrokerCxObj error code
  51.  
  52.            Applicability is (ISG).
  53.  
  54.        CXBROKERA_ShowGui (BOOL) -- brokerclass object will send this tag
  55.            whenever a CXCMD_APPEAR/CXCMD_DISAPPEAR msg will arrive.
  56.  
  57.            Applicability is (N).
  58.  
  59.        CXBROKERA_Close (BOOL) -- brokerclass object will send this tag
  60.            whenever a CXCMD_KILL msg will arrive.
  61.  
  62.            Applicability is (N).
  63.  
  64.  
  65.    SEE ALSO
  66.        commodities.library/CxBroker()
  67.  
  68. switchwindow/cxclass                                     switchwindow/cxclass
  69.  
  70.    NAME
  71.        cxclass -- Basic commodities object.
  72.  
  73.    FUNCTION
  74.        Class:        cxclass
  75.        Superclass:   icclass
  76.  
  77.        Internal commodities support class.
  78.        This class should only be used with a subclass.
  79.  
  80.    METHODS
  81.        OM_NEW -- Create a new object.
  82.  
  83.        OM_SET -- Set an object's attribute.
  84.  
  85.        OM_GET -- Obtain the value of an attribute.
  86.  
  87.        OM_UPDATE -- Process the arrived CxMsgs.
  88.  
  89.        OM_ADDMEMBER -- Attaches an object to CxObj and add it to the
  90.            internal memberlist (using OM_ADDTAIL).
  91.  
  92.        OM_REMMEMBER -- Removes an object from CxObj and removes it also
  93.            from the internal memberlist (using OM_REMOVE).
  94.  
  95.        OM_DISPOSE -- Dispose object.
  96.  
  97.        ...
  98.  
  99.    TAGS
  100.        CXA_Priority (LONG) -- Commodities object priority.
  101.            Defaults to 0.
  102.  
  103.            Applicability is (ISGU).
  104.  
  105.        CXA_Disabled (BOOL) -- Disabling of CxObj.
  106.            Defaults to FALSE.
  107.  
  108.            Applicability is (ISGU).
  109.  
  110.        ...
  111.  
  112.        CXA_ID (UWORD) -- Object ID like GA_ID
  113.  
  114.            Applicability is (ISGUN).
  115.  
  116.        CXA_UserData (ULONG) -- User data like GA_UserData
  117.  
  118.            Applicability is (ISGU).
  119.  
  120.        CXA_CxObjError (LONG) -- Get the error id from CxObjError().
  121.            Setting/Updating this tag will cause ClearCxObjError().
  122.  
  123.            Applicability is (SGU).
  124.  
  125.    BUGS
  126.        CXA_Priority is not fully supported yet.
  127.  
  128.    SEE ALSO
  129.        commodities.library/CxObjError(),
  130.        commodities.library/ClearCxObjError()
  131.  
  132. switchwindow/cxfilterclass                         switchwindow/cxfilterclass
  133.  
  134.    NAME
  135.        cxfilterclass -- A commodities filter object.
  136.  
  137.    FUNCTION
  138.        Class:        cxfilterclass
  139.        Superclass:   cxclass
  140.  
  141.        Commodities filter object.
  142.  
  143.    METHODS
  144.        ...
  145.  
  146.    TAGS
  147.        CXFILTERA_FilterString (STRPTR) -- A commodities filter string.
  148.  
  149.            Applicability is (ISGU).
  150.  
  151.    BUGS
  152.        ...
  153.  
  154.    SEE ALSO
  155.        amiga.lib/CxFilter(), commodities.library/CreateCxObj(),
  156.        commodities.library/SetFilter()
  157.  
  158. switchwindow/cxtranslateclass                   switchwindow/cxtranslateclass
  159.  
  160.    NAME
  161.        cxtranslateclass -- A commodities translate object.
  162.  
  163.    FUNCTION
  164.        Class:        cxtranslateclass
  165.        Superclass:   cxclass
  166.  
  167.        Commodities translate object.
  168.  
  169.    TAGS
  170.        CXTRANSLATEA_ReplaceString (STRPTR) -- String to insert in the input
  171.            stream.
  172.  
  173.            Applicability is (ISGU).
  174.  
  175.    BUGS
  176.        ...
  177.  
  178.    SEE ALSO
  179.        amiga.lib/CxTranslate(), commodities.library/CreateCxObj(),
  180.        commodities.library/SetTranslate()
  181.  
  182.