home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / tollmanager3.lha / toolmanager3 / ToolManagerDev.lha / ToolManager / Developer / toolmanager.doc
Encoding:
Text File  |  1997-02-22  |  8.1 KB  |  255 lines
  1. TABLE OF CONTENTS
  2.  
  3. toolmanager.library/AllocTMHandle
  4. toolmanager.library/ChangeTMObjectTagList
  5. toolmanager.library/CreateTMObjectTagList
  6. toolmanager.library/DeleteTMObject
  7. toolmanager.library/FreeTMHandle
  8. toolmanager.library/QuitToolManager
  9.  
  10. toolmanager.library/AllocTMHandle            toolmanager.library/AllocTMHandle
  11.  
  12.    NAME
  13.         AllocTMHandle -- Allocate a ToolManager handle
  14.  
  15.    SYNOPSIS
  16.         handle = AllocTMHandle()
  17.         D0
  18.  
  19.         void *AllocTMHandle(void)
  20.  
  21.    FUNCTION
  22.         Allocates a ToolManager handle, a private data structure. All
  23.         ToolManager objects will be attached to a handle. The library
  24.         function uses the handle to access the objects.
  25.  
  26.    RESULTS
  27.         handle - pointer to the new allocated handle or NULL.
  28.  
  29.    SEE ALSO
  30.         FreeTMHandle()
  31.  
  32. toolmanager.library/ChangeTMObjectTagList toolmanager.library/ChangeTMObjectTagList
  33. toolmanager.library/ChangeTMObjectTags   toolmanager.library/ChangeTMObjectTags
  34.  
  35.    NAME
  36.         ChangeTMObjectTagList -- Change the properties of a ToolManager object
  37.  
  38.    SYNOPSIS
  39.         success = ChangeTMObjectTagList(handle, object, tags)
  40.         D0                              A0      A1      A2
  41.  
  42.         BOOL ChangeTMObjectTagList(void *, char *, struct TagItem *)
  43.  
  44.         success = ChangeTMObjectTags(handle, object, tag1, ...)
  45.  
  46.         BOOL ChangeTMObjectTags(void *, char *, ULONG, ...)
  47.  
  48.    FUNCTION
  49.         Changes the properties of a ToolManager object according to the
  50.         supplied tags. All derived objects will be automagically updated to
  51.         reflect the new properties.
  52.  
  53.    INPUTS
  54.         handle - pointer to a ToolManager handle.
  55.         object - pointer to name of the ToolManager object to change. The
  56.                  object must be attached to the handle.
  57.         tags - list of TagItems, which describe the properties to be changed.
  58.                See CreateTMObjectTagList() for a list of all available tags.
  59.  
  60.    RESULTS
  61.         success - TRUE if properties were changed, otherwise FALSE.
  62.  
  63.    SEE ALSO
  64.         CreateTMObjectTagList()
  65.  
  66. toolmanager.library/CreateTMObjectTagList toolmanager.library/CreateTMObjectTagList
  67. toolmanager.library/CreateTMObjTags         toolmanager.library/CreateTMObjTags
  68.  
  69.    NAME
  70.         CreateTMObjectTagList -- Create a ToolManager object
  71.  
  72.    SYNOPSIS
  73.         success = CreateTMObjectTagList(handle, name, type, tags)
  74.         D0                              A0      A1    D0    A2
  75.  
  76.         BOOL CreateTMObjectTagList(void *, char *, ULONG, struct TagItem *)
  77.  
  78.         success = CreateTMObjectTags(handle, name, type, Tag1, ...)
  79.  
  80.         BOOL CreateTMObjectTags(void *, char *, ULONG, ULONG, ...)
  81.  
  82.    FUNCTION
  83.         Creates a new ToolManager object of the given type. The properties
  84.         will be set according to the supplied tags. The new object will be
  85.         attached to the ToolManager handle.
  86.  
  87.         The following tags are currently supported, see the documentation
  88.         for a detailed description.
  89.  
  90.         NOTE: Every data item referenced by a pointer will NOT BE COPIED! It
  91.               must therefore exist for the lifetime of the object!
  92.  
  93.          Object type: TMOBJTYPE_EXEC
  94.  
  95.            - TMOP_Arguments  (BOOL)
  96.            - TMOP_Command    type depending on TMOP_ExecType
  97.            - TMOP_CurrentDir (char *)
  98.            - TMOP_ExecType   (ULONG)
  99.  
  100.               One of:
  101.  
  102.                - TMET_CLI     TMOP_Command contains a pointer to string
  103.                - TMET_WB                       "
  104.                - TMET_ARexx                    "
  105.                - TMET_Dock                     "
  106.                - TMET_HotKey                   "
  107.                - TMET_Hook    TMOP_Command contains a pointer to a Hook
  108.                               structure (see utility/hooks.h). When the exec
  109.                               object is activated, ToolManager will call
  110.                               h_Entry with a pointer to the Hook structure in
  111.                               A0 (hook), a pointer to an AppMessage in A1
  112.                               (message, this may be NULL) and the value of
  113.                               h_Data in A2 (object). The function must return a
  114.                               BOOL (TRUE for success, FALSE for failure).
  115.  
  116.                               NOTE: The function will be called synchronously
  117.                               and in the task context of the ToolManager
  118.                               handler. So it MUST return AS SOON AS POSSIBLE
  119.                               and MUST NOT MODIFY ANYTHING in the tasks
  120.                               context!!!!!
  121.  
  122.            - TMOP_HotKey     (char *)
  123.            - TMOP_Output     (char *)
  124.            - TMOP_Path       (char *)
  125.            - TMOP_Priority   (LONG)
  126.            - TMOP_PubScreen  (char *)
  127.            - TMOP_Stack      (ULONG)
  128.            - TMOP_ToFront    (BOOL)
  129.  
  130.          Object type: TMOBJTYPE_IMAGE
  131.  
  132.            - TMOP_File       (char *)
  133.  
  134.          Object type: TMOBJTYPE_SOUND
  135.  
  136.            - TMOP_Command    (char *)
  137.            - TMOP_Port       (char *)
  138.  
  139.          Object type: TMOBJTYPE_MENU
  140.  
  141.            - TMOP_Exec       (char *)
  142.            - TMOP_Sound      (char *)
  143.  
  144.          Object type: TMOBJTYPE_ICON
  145.  
  146.            - TMOP_Exec       (char *)
  147.            - TMOP_Image      (char *)
  148.            - TMOP_LeftEdge   (LONG)
  149.            - TMOP_ShowName   (BOOL)
  150.            - TMOP_Sound      (char *)
  151.            - TMOP_TopEdge    (LONG)
  152.  
  153.          Object type: TMOBJTYPE_DOCK
  154.  
  155.            - TMOP_Activated  (BOOL)
  156.            - TMOP_Backdrop   (BOOL)
  157.            - TMOP_Border     (BOOL)
  158.            - TMOP_Centered   (BOOL)
  159.            - TMOP_Columns    (ULONG)
  160.            - TMOP_Font       (struct TextAttr *)
  161.            - TMOP_FrontMost  (BOOL)
  162.            - TMOP_HotKey     (char *)
  163.            - TMOP_Images     (BOOL)
  164.            - TMOP_LeftEdge   (LONG)
  165.            - TMOP_Menu       (BOOL)
  166.            - TMOP_PopUp      (BOOL)
  167.            - TMOP_PubScreen  (char *)
  168.            - TMOP_Sticky     (BOOL)
  169.            - TMOP_Text       (BOOL)
  170.            - TMOP_Tools      (char **) can be specified several times.
  171.            - TMOP_TopEdge    (LONG)
  172.  
  173.    INPUTS
  174.         handle - pointer to a ToolManager handle
  175.         name - pointer to a string which contains the name of the new object.
  176.         type - type of the new object. Must be one of the following:
  177.  
  178.                 TMOBJTYPE_EXEC   (see Object.doc for an detailed explanation
  179.                 TMOBJTYPE_IMAGE   of the object types)
  180.                 TMOBJTYPE_SOUND
  181.                 TMOBJTYPE_MENU
  182.                 TMOBJTYPE_ICON
  183.                 TMOBJTYPE_DOCK
  184.  
  185.         tags - list of TagItems, which describe the properties of the new
  186.                object.
  187.  
  188.    RESULTS
  189.         success - TRUE if object could be created, otherwise FALSE.
  190.  
  191.    SEE ALSO
  192.         DeleteTMObject()
  193.  
  194. toolmanager.library/DeleteTMObject          toolmanager.library/DeleteTMObject
  195.  
  196.    NAME
  197.         DeleteTMObject -- Delete a ToolManager object
  198.  
  199.    SYNOPSIS
  200.         success = DeleteTMObject(handle, object)
  201.         D0                       A0      A1
  202.  
  203.         BOOL DeleteTMObject(void *, char *)
  204.  
  205.    FUNCTION
  206.         Deletes a ToolManager object created with CreateTMObjectTagList().
  207.         All derived objects will be automagically updated.
  208.  
  209.    INPUTS
  210.         handle - pointer to a ToolManager handle.
  211.         object - pointer to the name of the ToolManager object to delete.
  212.                  This object must be attached to the handle.
  213.  
  214.    RESULTS
  215.         success - TRUE if object was deleted, otherwise FALSE.
  216.  
  217.    SEE ALSO
  218.         CreateTMObjectTagList()
  219.  
  220. toolmanager.library/FreeTMHandle              toolmanager.library/FreeTMHandle
  221.  
  222.    NAME
  223.         FreeTMHandle -- Free a ToolManager handle
  224.  
  225.    SYNOPSIS
  226.         FreeTMHandle(handle)
  227.                      A0
  228.  
  229.         void FreeTMHandle(void *)
  230.  
  231.    FUNCTION
  232.         Frees a ToolManager handle and deletes all attached objects.
  233.  
  234.    INPUT
  235.         handle - pointer to the ToolManager handle.
  236.  
  237.    SEE ALSO
  238.         AllocTMHandle()
  239.  
  240. toolmanager.library/QuitToolManager        toolmanager.library/QuitToolManager
  241.  
  242.    NAME
  243.         QuitToolManager -- Send quit signal to ToolManager process
  244.  
  245.    SYNOPSIS
  246.         QuitToolManager()
  247.  
  248.         void QuitToolManager(void)
  249.  
  250.    FUNCTION
  251.         Sends a quit signal to the ToolManager handler process. The process
  252.         will try to exit as soon as possible.
  253.  
  254.  
  255.