home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / dev / gui / triton / programmer / doc / triton.doc
Text File  |  1994-07-14  |  36KB  |  1,113 lines
  1. TABLE OF CONTENTS
  2.  
  3. triton.lib/TR_CloseTriton
  4. triton.lib/TR_OpenTriton
  5. triton.library/class_Button
  6. triton.library/class_CheckBox
  7. triton.library/class_Cycle
  8. triton.library/class_DropBox
  9. triton.library/class_FrameBox
  10. triton.library/class_Group
  11. triton.library/class_Image
  12. triton.library/class_Line
  13. triton.library/class_Listview
  14. triton.library/class_Palette
  15. triton.library/class_Progress
  16. triton.library/class_Scroller
  17. triton.library/class_Slider
  18. triton.library/class_Space
  19. triton.library/class_String
  20. triton.library/class_Text
  21. triton.library/TR_AutoRequest
  22. triton.library/TR_CloseProject
  23. triton.library/TR_CloseWindowSafely
  24. triton.library/TR_CreateApp
  25. triton.library/TR_DeleteApp
  26. triton.library/TR_EasyRequest
  27. triton.library/TR_FirstOccurance
  28. triton.library/TR_GetAttribute
  29. triton.library/TR_GetErrorString
  30. triton.library/TR_GetLastError
  31. triton.library/TR_GetMsg
  32. triton.library/TR_LockProject
  33. triton.library/TR_LockScreen
  34. triton.library/TR_NumOccurances
  35. triton.library/TR_OpenProject
  36. triton.library/TR_ReplyMsg
  37. triton.library/TR_SetAttribute
  38. triton.library/TR_UnlockProject
  39. triton.library/TR_UnlockScreen
  40. triton.library/TR_Wait
  41. triton.lib/TR_CloseTriton                           triton.lib/TR_CloseTriton
  42.  
  43.    NAME    
  44.     TR_CloseTriton -- Closes Triton easily.
  45.  
  46.    SYNOPSIS
  47.     TR_CloseTriton()
  48.  
  49.     VOID TR_CloseTriton(VOID);
  50.  
  51.    FUNCTION
  52.     Closes the application created by OpenTriton()
  53.     and closes triton.library.
  54.  
  55.    SEE ALSO
  56.     TR_OpenTriton()
  57.  
  58. triton.lib/TR_OpenTriton                             triton.lib/TR_OpenTriton
  59.  
  60.    NAME    
  61.     TR_OpenTriton -- Opens Triton ready to use.
  62.  
  63.    SYNOPSIS
  64.     success = TR_OpenTriton(version, tag1,...)
  65.     D0
  66.  
  67.     BOOL TR_OpenTriton(ULONG, ULONG,...);
  68.  
  69.    FUNCTION
  70.     Opens triton.library with the specified minimum
  71.     version and creates an application.
  72.     The supplied tags are passed as a taglist to
  73.     TR_CreateApp().
  74.  
  75.    RESULT
  76.     success - Was everything opened successful?
  77.  
  78.    SEE ALSO
  79.     TR_CloseTriton(), TR_CreateApp()
  80.  
  81. triton.library/class_Button                       triton.library/class_Button
  82.  
  83.    NAME    
  84.     class_Button -- A BOOPSI button gadget
  85.  
  86.    SYNOPSIS
  87.     TROB_Button
  88.  
  89.    ATTRIBUTES
  90.     <Default>        : ULONG buttontype
  91.                        - TRBT_TEXT         : Text button (default)
  92.                        - TRBT_GETFILE      : GetFile image button
  93.                        - TRBT_GETDRAWER    : GetDrawer image button
  94.                        - TRBT_GETENTRY     : GetEntry image button
  95.     TRAT_ID          : ULONG objectid
  96.     TRAT_Text        : STRPTR label
  97.     TRAT_Disabled    : BOOL disabled
  98.     TRAT_Flags       : ULONG flags
  99.                        - TRBU_RETURNOK     : Activated by <Return>
  100.                        - TRBU_ESCOK        : Activated by <Esc>
  101.                        - TRBU_SHIFTED      : Shifted shortcut only
  102.                        - TRBU_UNSHIFTED    : Unshifted shortcut only
  103.                        - TRBU_YRESIZE (V2) : When this flag is set, the
  104.                                              button will be vertically
  105.                                              resizeable. This is required
  106.                                              because beginning with
  107.                                              Triton 1.1 the height of
  108.                                              objects which are normally
  109.                                              using the button height can
  110.                                              be modified in the prefs
  111.                                              editor. Set this flags
  112.                                              WHEREVER POSSIBLE in order
  113.                                              to make buttons adopt to
  114.                                              higher objects in the same
  115.                                              horizontal group.
  116.  
  117. triton.library/class_CheckBox                   triton.library/class_CheckBox
  118.  
  119.    NAME    
  120.     class_CheckBox -- A GadTools checkbox gadget
  121.  
  122.    SYNOPSIS
  123.     TROB_CheckBox
  124.  
  125.    ATTRIBUTES
  126.     <Default>        : <unused>
  127.     TRAT_ID          : ULONG objectid
  128.     TRAT_Value       : BOOL checked
  129.     TRAT_Disabled    : BOOL disabled
  130.  
  131. triton.library/class_Cycle                         triton.library/class_Cycle
  132.  
  133.    NAME    
  134.     class_Cycle -- A GadTools cycle gadget
  135.  
  136.    SYNOPSIS
  137.     TROB_Cycle
  138.  
  139.    ATTRIBUTES
  140.     <Default>        : STRPTR *entries    : Gadget etry labels
  141.                                             (create only)
  142.     TRAT_ID          : ULONG objectid
  143.     TRAT_Value       : ULONG number
  144.     TRAT_Disabled    : BOOL disabled      : Requires OS3.0+ when used
  145.                                             together with TRCY_MX.
  146.     TRAT_Flags       : ULONG flags (V2)
  147.                        - TRCY_MX          : "Unfold" the cycle gadget to
  148.                                             a mutually exclusive gadget.
  149.                        - TRCY_RIGHTLABELS : Put the labels to the right
  150.                                             side (TRCY_MX only).
  151.  
  152. triton.library/class_DropBox                     triton.library/class_DropBox
  153.  
  154.    NAME    
  155.     class_DropBox -- An icon drop box
  156.  
  157.    SYNOPSIS
  158.     TROB_DropBox
  159.  
  160.    ATTRIBUTES
  161.     <Default>        : <unused>
  162.     TRAT_ID          : ULONG objectid
  163.  
  164. triton.library/class_FrameBox                   triton.library/class_FrameBox
  165.  
  166.    NAME    
  167.     class_FrameBox -- A framing box
  168.  
  169.    SYNOPSIS
  170.     TROB_FrameBox
  171.  
  172.    ATTRIBUTES
  173.     <Default>        : ULONG boxtype (V2)
  174.                          If no flag is set, unnamed boxes will
  175.                          be grouping and named ones framing.
  176.                        - TRFB_TEXT       : A text container
  177.                        - TRFB_GROUPING   : A grouping box
  178.                        - TRFB_FRAMING    : A framing box.
  179.     TRAT_ID          : ULONG objectid (V2)
  180.     TRAT_Backfill    : ULONG pattern
  181.     TRAT_Text        : STRPTR label (V2)
  182.     <other>          : <Child object>
  183.  
  184. triton.library/class_Group                         triton.library/class_Group
  185.  
  186.    NAME    
  187.     class_Group -- A grouping object
  188.  
  189.    SYNOPSIS
  190.     TRGR_Horiz
  191.     TRGR_Vert
  192.  
  193.    ATTRIBUTES
  194.     <Default>        : ULONG flags
  195.                        - TRGR_PROPSHARE  : Divide objects
  196.                                            proportionally
  197.                        - TRGR_EQUALSHARE : Divide objects equally
  198.                        - TRGR_PROPSPACES : Divide spaces
  199.                                            proportionally
  200.                        - TRGR_ARRAY      : Top group of an array. Lines
  201.                                            or culumns can be built
  202.                                            using TRGR_PROPSHARE groups.
  203.                                            At least one group must
  204.                                            be contained in an array.
  205.                        - TRGR_ALIGN      : Align resizeable objects in
  206.                                            their secondary dimension
  207.                        - TRGR_CENTER     : Center non-resizeable
  208.                                            objects in their secondary
  209.                                            dimension
  210.                        - TRGR_FIXHORIZ   : Don't allow horizontal
  211.                                            resizing
  212.                        - TRGR_FIXVERT    : Don't allow vertical
  213.                                            resizing
  214.                        - TRGR_INDEP (V2) : Group is independant of
  215.                                            surrounding array
  216.     <other>          : <treated as elements of the group>
  217.     TRGR_End         : <unused> : Marks the end of the group
  218.  
  219. triton.library/class_Image                         triton.library/class_Image
  220.  
  221.    NAME    
  222.     class_Image -- An image (V2)
  223.  
  224.    SYNOPSIS
  225.     TROB_Image
  226.  
  227.    ATTRIBUTES
  228.     <Default>        : <Image>
  229.     TRAT_Flags       : ULONG flags
  230.                        - TRIM_BOOPSI : <Default> is a pointer to a
  231.                                        struct IClass BOOPSI image class.
  232.     TRAT_MinWidth    : Minimum image width in pixels. Defaults to
  233.                        the image button height.
  234.     TRAT_MinHeight   : Minimum image height in pixels. Defaults to
  235.                        the image button height.
  236.     TRAT_ID          : ULONG objectid
  237.  
  238. triton.library/class_Line                           triton.library/class_Line
  239.  
  240.    NAME    
  241.     class_Line -- A 3D line
  242.  
  243.    SYNOPSIS
  244.     TROB_Line
  245.  
  246.    ATTRIBUTES
  247.     <Default>        : ULONG flags
  248.                        - TROF_HORIZ        : Horizontal line
  249.                                              (Overrides group dimension)
  250.                        - TROF_VERT         : Vertical line
  251.                                              (Overrides group dimension)
  252.                        - TROF_RAISED       : Raised line
  253.  
  254. triton.library/class_Listview                   triton.library/class_Listview
  255.  
  256.    NAME
  257.     class_Listview -- A GadTools Listview gadget
  258.  
  259.    SYNOPSIS
  260.     TROB_Listview
  261.  
  262.    ATTRIBUTES
  263.     <Default>        : struct List *entries
  264.     TRAT_ID          : ULONG objectid
  265.     TRAT_Disabled    : BOOL disabled
  266.     TRAT_Flags       : ULONG flags
  267.                        - Listview type (mutually exclusive):
  268.                          - TRLV_READONLY     : A read-only list
  269.                          - TRLV_SELECT       : You may select an entry
  270.                          - TRLV_SHOWSELECTED : Show selected entry
  271.                        - TRLV_NOCURSORKEYS   : Don't use arrow keys
  272.                        - TRLV_NONUMPADKEYS   : Don't use keypad keys
  273.                        - TRLV_FWFONT         : Use the fixed-width font
  274.                        - TRLV_NOGAP (V2)     : Leave no gap below the
  275.                                                list but instead at the
  276.                                                end of the group.
  277.     TRAT_Value       : ULONG selected        : Currently selected entry
  278.                                                (TRLV_SHOWSELECTED only)
  279.     TRLV_Top         : ULONG top
  280.     TRAT_MinWidth    : ULONG minwidth        : Minimum width
  281.                                                (Default: 10 characters)
  282.     TRAT_MinHeight   : ULONG minheight       : Minimum height
  283.                                                (Default: 4 lines)
  284.  
  285.    MESSAGES
  286.     Select listviews send TRMS_ACTION messages. ShowSelected lists send
  287.     TRMS_NEWVALUE messages. trm_Data contains the ordinal number of the
  288.     selected entry. trm_Qualifier&IEQUALIFIER_REPEAT is set if the user
  289.     double-clicked the specified listview entry.
  290.  
  291. triton.library/class_Palette                     triton.library/class_Palette
  292.  
  293.    NAME    
  294.     class_Palette -- A GadTools palette gadget
  295.  
  296.    SYNOPSIS
  297.     TROB_Palette
  298.  
  299.    ATTRIBUTES
  300.     <Default>        : <unused>
  301.     TRAT_ID          : ULONG objectid
  302.     TRAT_Value       : BOOL checked
  303.     TRAT_Disabled    : BOOL disabled
  304.  
  305. triton.library/class_Progress                   triton.library/class_Progress
  306.  
  307.    NAME    
  308.     class_Progress -- A progress indicator
  309.  
  310.    SYNOPSIS
  311.     TROB_Progress
  312.  
  313.    ATTRIBUTES
  314.     <Default>        : ULONG maximum
  315.     TRAT_Flags       : ULONG orientation
  316.                        - TROF_HORIZ (default)
  317.                        - TROF_VERT
  318.     TRAT_ID          : ULONG objectid
  319.     TRAT_Value       : ULONG current
  320.  
  321. triton.library/class_Scroller                   triton.library/class_Scroller
  322.  
  323.    NAME    
  324.     class_Scroller -- A GadTools scroller gadget
  325.  
  326.    SYNOPSIS
  327.     TROB_Scroller
  328.  
  329.    ATTRIBUTES
  330.     <Default>        : ULONG flags
  331.                        - TROF_HORIZ        : Horizontal scroller
  332.                        - TROF_VERT         : Vertical scroller
  333.     TRAT_ID          : ULONG objectid
  334.     TRAT_Value       : WORD top
  335.     TRAT_Disabled    : BOOL disabled
  336.     TRSC_Total       : WORD total
  337.     TRSC_Visible     : WORD visible
  338.  
  339. triton.library/class_Slider                       triton.library/class_Slider
  340.  
  341.    NAME    
  342.     class_Slider -- A GadTools slider gadget
  343.  
  344.    SYNOPSIS
  345.     TROB_Slider
  346.  
  347.    ATTRIBUTES
  348.     <Default>        : ULONG flags
  349.                        - TROF_HORIZ (default)
  350.                        - TROF_VERT
  351.     TRAT_ID          : ULONG objectid
  352.     TRAT_Value       : WORD level
  353.     TRAT_Disabled    : BOOL disabled
  354.     TRSL_Min         : WORD min
  355.     TRSL_Max         : WORD max
  356.  
  357. triton.library/class_Space                         triton.library/class_Space
  358.  
  359.    NAME    
  360.     class_Space -- A class of spaces with various sizes
  361.  
  362.    SYNOPSIS
  363.     TROB_Space
  364.  
  365.    ATTRIBUTES
  366.     <Default>        : ULONG spacetype
  367.                        - TRST_NONE         : No space
  368.                        - TRST_SMALL        : Small space
  369.                        - TRST_NORMAL       : Normal space (default)
  370.                        - TRST_BIG          : Big space
  371.  
  372. triton.library/class_String                       triton.library/class_String
  373.  
  374.    NAME    
  375.     class_String -- A GadTools string gadget
  376.  
  377.    SYNOPSIS
  378.     TROB_String
  379.  
  380.    ATTRIBUTES
  381.     <Default>        : STRPTR string
  382.     TRAT_ID          : ULONG objectid
  383.     TRAT_Disabled    : BOOL disabled
  384.     TRAT_Value       : UWORD maxchars (default: 64)
  385.                        [create only]
  386.  
  387. triton.library/class_Text                           triton.library/class_Text
  388.  
  389.    NAME    
  390.     class_Text -- A line of text / A value
  391.  
  392.    SYNOPSIS
  393.     TROB_Text
  394.  
  395.    ATTRIBUTES
  396.     <Default>        : <unused>
  397.     TRAT_ID          : ULONG objectid
  398.     TRAT_Text        : STRPTR text
  399.     TRAT_Value       : ULONG number
  400.     TRAT_MinWidth    : ULONG number_of_average_chars
  401.     TRAT_Flags       : ULONG flags
  402.                        - TRTX_NOUNDERSCORE    : Don't interpret underscores
  403.                        - TRTX_HIGHLIGHT       : Highlight text
  404.                        - TRTX_3D              : Highlight with shadows
  405.                        - TRTX_TITLE           : Use this for titles (e.g.
  406.                                                 of separator bars).
  407.                        - TROF_RIGHTALIGN (V2) : Align text to the right border
  408.                                                 of available space (e.g. in
  409.                                                 text boxes and arrays)
  410.  
  411.    BUGS
  412.     Below V2 of triton.library changing TRAT_Text while the text was
  413.     displayed did only work with text on a TRBF_WINDOWBACK object.
  414.  
  415. triton.library/TR_AutoRequest                   triton.library/TR_AutoRequest
  416.  
  417.    NAME    
  418.     TR_AutoRequest -- A (relatively ;-) low-level requester function.
  419.  
  420.    SYNOPSIS
  421.     selection = TR_AutoRequest(App, Project, TagList)
  422.     D0                         A1   A0       A2
  423.  
  424.     ULONG TR_AutoRequest(struct TR_App *, struct TR_Project *,
  425.                          struct AppItem *);
  426.  
  427.     selection = TR_AutoRequestTags(App, Project, Tag,...)
  428.     D0
  429.  
  430.     ULONG TR_AutoRequestTags(struct TR_App *, struct TR_Project *,
  431.                          struct AppItem *);
  432.  
  433.    FUNCTION
  434.     Pops up a requester which is described by the supplied tag list.
  435.     As soon as a TRMS_ACTION message is sent by one of the objects,
  436.     the requester will close. If a project is supplied, it will be
  437.     locked when opening the requester and unlocked when closing it.
  438.  
  439.    RESULT
  440.     selection - The ID of the object which triggered the action,
  441.                 NULL for an error, (ULONG)(-1) for the close gadget.
  442.  
  443.    NOTES
  444.     Simple requesters with just text and buttons can be done easier
  445.     with TR_EasyRequest(). If you need more complex requesters, you
  446.     have to use your own message polling loop instead of
  447.     TR_AutoRequest(). You may still use the requester macros though.
  448.  
  449.    SEE ALSO
  450.     TR_EasyRequest()
  451.  
  452. triton.library/TR_CloseProject                 triton.library/TR_CloseProject
  453.  
  454.    NAME    
  455.     TR_CloseProject -- Closes a project/window.
  456.  
  457.    SYNOPSIS
  458.     TR_CloseProject(Project)
  459.                     A0
  460.  
  461.     VOID TR_CloseProject(struct TR_Project *);
  462.  
  463.    FUNCTION
  464.     Closes a Triton project.
  465.  
  466.    SEE ALSO
  467.     TR_OpenProject()
  468.  
  469. triton.library/TR_CloseWindowSafely       triton.library/TR_CloseWindowSafely
  470.  
  471.    NAME    
  472.     TR_CloseWindowSafely -- Closes as window with a shared IDCMP port.
  473.  
  474.    SYNOPSIS
  475.     TR_CloseWindowSafely(Window)
  476.                          A0
  477.  
  478.     VOID TR_CloseWindowSafely(struct Window *);
  479.  
  480.    FUNCTION
  481.     Closes a window which shares its IDCMP port with another window.
  482.     All the pending messages (concerning this window) on the port
  483.     will be removed and the window will be closed.
  484.     
  485.     Do *NOT* use this function to close windows which have an IDCMP
  486.     port set up by Intuition. If you do the port will be left in memory!
  487.     
  488.     If you intend to open a lot of windows all sharing the same IDCMP
  489.     port it is easiest if you create a port yourself and open all
  490.     windows with newwin.IDCMPFlags set to 0 (this tells Intuition NOT to
  491.     set up an IDCMP port). After opening the window set win->UserPort
  492.     to your message port and call ModifyIDCMP() to set your IDCMP flags.
  493.     
  494.     When you then receive messages from Intuition check their
  495.     imsg->IDCMPWindow field to find out what window they came from
  496.     and act upon them.
  497.     
  498.     When closing your windows call TR_CloseWindowSafely() for all of
  499.     them and delete your message port.
  500.  
  501.    INPUTS
  502.     Window - pointer to the window to be closed.
  503.  
  504.    NOTE
  505.     This function is for the advanced Triton user.
  506.  
  507.    SEE ALSO
  508.     intuition.library/CloseWindow()
  509.  
  510. triton.library/TR_CreateApp                       triton.library/TR_CreateApp
  511.  
  512.    NAME    
  513.     TR_CreateApp -- Creates a Triton application.
  514.     TR_CreateAppTags -- Varargs stub for TR_CreateApp.
  515.  
  516.    SYNOPSIS
  517.     app = TR_CreateApp(TagList)
  518.     D0                 A1
  519.  
  520.     struct TR_App * TR_CreateApp(struct TagItem *);
  521.  
  522.     app = TR_CreateAppTags(Tag1,...)
  523.  
  524.     struct TR_App * TR_CreateApp(ULONG,...);
  525.  
  526.    FUNCTION
  527.     Creates an application. An application is required
  528.     for opening windows and polling messages. All projects
  529.     of an application will share one IDCMP port and one
  530.     memory pool.
  531.  
  532.    TAGS
  533.     TRCA_Name        - (STRPTR)
  534.                        Unique name for the application. Must not be
  535.                        longer than 20 characters. Case-insensitive.
  536.                        ' ', '/', '.' and ':' are not allowed.
  537.     TRCA_LongName    - (STRPTR)
  538.                        A user-readable name for the application.
  539.                        Up to 60 characters allowed.
  540.     TRCA_Info        - (STRPTR)
  541.                        Information about the application. Should not
  542.                        be more than 2 lines with 60 characters each.
  543.     TRCA_Version     - (STRPTR)
  544.                        Internal version of the application.
  545.     TRCA_Release     - (STRPTR)
  546.                        Release number of the application.
  547.     TRCA_Date        - (STRPTR)
  548.                        Creation/compilation date. Should be given
  549.                        in standard version string format.
  550.     
  551.     Example:
  552.       Name        : DilloCreate
  553.       LongName    : Armadillo Creator
  554.       Info        : Part of the Armadillo Management System.
  555.                     © 1994 by DilloWorks Enterprises.
  556.       Version     : 42.135
  557.       Release     : 2.1bß3
  558.       Date        : 17.6.94
  559.  
  560.    RESULT
  561.     app - A pointer to the created application structure.
  562.           NULL indicates failure.
  563.  
  564.    SEE ALSO
  565.     TR_DeleteApp()
  566.  
  567. triton.library/TR_DeleteApp                       triton.library/TR_DeleteApp
  568.  
  569.    NAME    
  570.     TR_DeleteApp -- Deletes a Triton application.
  571.  
  572.    SYNOPSIS
  573.     TR_DeleteApp(App)
  574.                  A1
  575.  
  576.     VOID TR_DeleteApp(struct TR_App *);
  577.  
  578.    FUNCTION
  579.     Deletes an application created by TR_CreateApp().
  580.  
  581.    NOTES
  582.     All windows have to be closed before deleting the
  583.     corresponding application!
  584.  
  585.    SEE ALSO
  586.     TR_CreateApp()
  587.  
  588. triton.library/TR_EasyRequest                   triton.library/TR_EasyRequest
  589.  
  590.    NAME    
  591.     TR_EasyRequest -- A high-level requester function.
  592.  
  593.    SYNOPSIS
  594.     selection = TR_EasyRequest(App, BodyFmt, GadFmt, TagList)
  595.     D0                         A1   A2       A3      A0
  596.  
  597.     ULONG TR_EasyRequest(struct TR_App *, STRPTR, STRPTR, struct TagItem *);
  598.  
  599.     selection = TR_EasyRequestTags(App, BodyFmt, GadFmt, Tag,...)
  600.     D0
  601.  
  602.     ULONG TR_EasyRequestTags(struct TR_App *, STRPTR, STRPTR, ULONG,...);
  603.  
  604.    FUNCTION
  605.     Pops up a requester and waits for the user to select a gadget.
  606.  
  607.    INPUTS
  608.     App       - A valid Triton application.
  609.     BodyFmt   - A formatted text which will be displayed in the
  610.                 requester body. A <newline> (\n) will start a new line
  611.                 with a small space above it. A <return> (\r) will add
  612.                 a normal space instead. A <tab> (\t) will add a normal
  613.                 space, then a 3D separator line and again a normal
  614.                 space. '%b' will switch to boldface, '%3' to 3D text,
  615.                 '%h' to highlight and '%n' to normal style (at the moment
  616.                 styles may only be changed at the beginning of a line!).
  617.                 Beginning with v2, '%s' ('Shadow') is allowed as an alias
  618.                 for '%3' because CatComp doesn't compile catalogs with
  619.                 '%3' in the description files.
  620.                 (Sigh, why is there no way of telling CatComp not to
  621.                 interpret '%' characters...)
  622.     GadFmt    - The gadget texts, separated by '|'.
  623.     TagList   - Pointer to a TagItem array.
  624.  
  625.    TAGS
  626.     TREZ_ReqPos      - (ULONG)
  627.                        The requester's position (TRWP_...).
  628.                        The default is TRWP_MOUSEPOINTER.
  629.     TREZ_LockProject - (struct TR_Project *)
  630.                        This project will be locked while the
  631.                        requester is displayed. Information about
  632.                        screen and activity state of the requester
  633.                        are taken from this project.
  634.     TREZ_Return      - (ULONG)
  635.                        Number of the default gadget which can be
  636.                        activated by <RETURN>. Defaults to 1 (0 in
  637.                        a single-gadget requester).
  638.     TREZ_Title       - (STRPTR)
  639.                        Requester window title. Default is
  640.                        "System request" (or a localized version under
  641.                        OS2.1 and higher).
  642.     TREZ_Activate    - (BOOL)
  643.                        If this tag is supplied, the activity state
  644.                        of the requester window will be taken from
  645.                        this tag's argument instead of being inherited
  646.                        from the locked project (if applicable).
  647.  
  648.    RESULT
  649.     selection - The number of the selected gadget. The gadgets are
  650.                 numbered from left to right beginning with 1. The
  651.                 rightmost gadget (or the only gadget in a 1-gadget
  652.                 requester) has got number 0. (ULONG)(-1) is returned
  653.                 for indicating an error.
  654.  
  655.    SEE ALSO
  656.     TR_AutoRequest()
  657.  
  658. triton.library/TR_FirstOccurance             triton.library/TR_FirstOccurance
  659.  
  660.    NAME    
  661.     TR_FirstOccurance -- Finds a character in a string.
  662.  
  663.    SYNOPSIS
  664.     Position = TR_FirstOccurance(Character, String)
  665.     D0                           D0         A0
  666.  
  667.     LONG TR_FirstOccurance(UBYTE, STRPTR);
  668.  
  669.    FUNCTION
  670.     Finds the specified character in the string.
  671.  
  672.    RESULT
  673.     Position - The position of the first occurance of the
  674.     character in the string or -1 if the character couldn't
  675.     be found in the string.
  676.  
  677. triton.library/TR_GetAttribute                 triton.library/TR_GetAttribute
  678.  
  679.    NAME    
  680.     TR_GetAttribute -- Gets an attribute of an object.
  681.  
  682.    SYNOPSIS
  683.     value = TR_GetAttribute(Project, ID, Attribute)
  684.     D0                      A0       D0  D1
  685.  
  686.     ULONG TR_GetAttribute(struct TR_Project *, ULONG,
  687.                           ULONG, ULONG);
  688.  
  689.    FUNCTION
  690.     Gets an attribute of a Triton object. Only attributes
  691.     of objects with an ID can be queried.
  692.  
  693.    RESULT
  694.     value - Value of the specified attribute. Depends
  695.             on specific class and attribute.
  696.  
  697.    SEE ALSO
  698.     Class descriptions, TR_SetAttribute()
  699.  
  700. triton.library/TR_GetErrorString             triton.library/TR_GetErrorString
  701.  
  702.    NAME    
  703.     TR_GetErrorString -- Creates an error message
  704.  
  705.    SYNOPSIS
  706.     Message = TR_GetErrorString(Number)
  707.     D0                          D0
  708.  
  709.     STRPTR TR_GetErrorString(UWORD);
  710.  
  711.    FUNCTION
  712.     Creates an error message which matches the supplied
  713.     Triton error code.
  714.  
  715.    INPUTS
  716.     Number - Triton error code. In most cases you will
  717.              get this with TR_GetLastError().
  718.  
  719.    RESULT
  720.     Message - Pointer to a user-readable error message
  721.  
  722.    SEE ALSO
  723.     TR_GetLastError()
  724.  
  725. triton.library/TR_GetLastError                 triton.library/TR_GetLastError
  726.  
  727.    NAME    
  728.     TR_GetLastError -- Gets the last error code
  729.  
  730.    SYNOPSIS
  731.     Number = TR_GetLastError(App)
  732.     D0                       A1
  733.  
  734.     UWORD TR_GetLastError(struct TR_App *);
  735.  
  736.    FUNCTION
  737.     Returns the TRER code of the last error which occured
  738.     in the application and sets the internal tra_LastError
  739.     back to TRER_OK.
  740.  
  741.    INPUTS
  742.     App - Pointer to a Triton Application
  743.  
  744.    RESULT
  745.     Number - TRER error code
  746.  
  747.    SEE ALSO
  748.     TR_GetErrorString()
  749.  
  750. triton.library/TR_GetMsg                             triton.library/TR_GetMsg
  751.  
  752.    NAME    
  753.     TR_GetMsg -- Gets a Triton message.
  754.  
  755.    SYNOPSIS
  756.     message = TR_GetMsg(App)
  757.     D0                  A1
  758.  
  759.     struct TR_Message * TR_GetMsg(struct TR_App *);
  760.  
  761.    FUNCTION
  762.     Gets a message from a Triton application created
  763.     by TR_CreateApp(). You may first wait for a message
  764.     with TR_Wait().
  765.  
  766.    NOTES
  767.     Please reply all messages as quickly as possible
  768.     with TR_ReplyMsg(). This will reduce memory usage.
  769.     All pending messages will be freed automatically when
  770.     you shut down the application with TR_DeleteApp().
  771.     It is *NOT* guaranteed that all reserved resources
  772.     *within* the messages will be freed (like AppMessages)!
  773.  
  774.    SEE ALSO
  775.     TR_ReplyMsg(), TR_Wait()
  776.  
  777. triton.library/TR_LockProject                   triton.library/TR_LockProject
  778.  
  779.    NAME    
  780.     TR_LockProject -- Locks a Triton project.
  781.  
  782.    SYNOPSIS
  783.     TR_LockProject(Project)
  784.                    A0
  785.  
  786.     VOID TR_LockProject(struct TR_Project *);
  787.  
  788.    FUNCTION
  789.     Locks a Triton project. Only window resizing will
  790.     still work in a locked project. All other kinds of
  791.     input (i.e. all input which requires interaction
  792.     by your program and not only by Triton) are not
  793.     possible.
  794.  
  795.    SEE ALSO
  796.     TR_UnlockProject()
  797.  
  798. triton.library/TR_LockScreen                     triton.library/TR_LockScreen
  799.  
  800.    NAME    
  801.     TR_LockScreen -- Get a project's screen
  802.  
  803.    SYNOPSIS
  804.     screen = TR_LockScreen(Project)
  805.     D0                     A0
  806.  
  807.     struct Screen * TR_LockScreen(struct TR_Project *);
  808.  
  809.    FUNCTION
  810.     Lock the screen of a Triton project for use with non-Triton
  811.     windows (e.g. for opening a file requester on the screen of a
  812.     Triton application). The screen must be unlocked later with
  813.     TR_UnlockScreen(). Locking/unlocking calls are nested.
  814.  
  815.    RESULT
  816.     screen - Pointer to the project's screen or NULL to indicate an
  817.              error. In this case the application should *not* abort,
  818.              but *quietly* use another screen (preferably the
  819.              Workbench screen) instead.
  820.  
  821.    SEE ALSO
  822.     TR_UnlockScreen()
  823.  
  824. triton.library/TR_NumOccurances               triton.library/TR_NumOccurances
  825.  
  826.    NAME    
  827.     TR_NumOccurances -- Counts a character in a string.
  828.  
  829.    SYNOPSIS
  830.     Number = TR_NumOccurances(Character, String)
  831.     D0                        D0         A0
  832.  
  833.     LONG TR_NumOccurances(UBYTE, STRPTR);
  834.  
  835.    FUNCTION
  836.     Counts the number of occurances of the character in the string.
  837.  
  838.    RESULT
  839.     Number - The number of occurances found.
  840.  
  841. triton.library/TR_OpenProject                   triton.library/TR_OpenProject
  842.  
  843.    NAME    
  844.     TR_OpenProject -- Opens a project/window.
  845.     TR_OpenProjectTags -- Varargs stub for TR_OpenProject.
  846.  
  847.    SYNOPSIS
  848.     Project = TR_OpenProject(App, TagItems)
  849.     D0                       A1   A0
  850.  
  851.     struct TR_Project *TR_OpenProject(struct TR_App *,
  852.                                       struct TagItem *);
  853.  
  854.     Project = TR_OpenProjectTags(App, Tag1,...)
  855.  
  856.     struct TR_Project *TR_OpenProjectTags(struct TR_App *,
  857.                                           ULONG,...);
  858.  
  859.    FUNCTION
  860.     Opens a Triton project. The supplied taglist may contain
  861.     window tags, menu tags and object tags (in that order).
  862.     Mutually exclusive menus are not yet supported. When creating
  863.     a menu item with an ID, TRAT_ID must be the *last* tag.
  864.     A valid application pointer must be supplied.
  865.  
  866.    INPUTS
  867.     App = Valid application pointer
  868.     TagItems = List of tags describing the project
  869.  
  870.    TAGS
  871.     The taglist may contain window tags, menu tags and object tags
  872.     (in that order!). The following list shows the window and menu
  873.     tags. See the class descriptions for the object tags.
  874.  
  875.     TRWI_Title (STRPTR) - The window title
  876.  
  877.     TRWI_ScreenTitle (STRPTR) - The screen title (V2)
  878.  
  879.     TRWI_Flags (ULONG) - The Triton window flags:
  880.     - TRWF_BACKDROP        : Create a backdrop borderless window
  881.                              in full screen size
  882.     - TRWF_NODRAGBAR       : No dragging bar
  883.     - TRWF_NODEPTHGADGET   : No depth arranging gadget
  884.     - TRWF_NOCLOSEGADGET   : No close gadget
  885.     - TRWF_NOACTIVE        : Don't activate window
  886.     - TRWF_NOESCCLOSE      : Don't send TRMS_CLOSEWINDOW when
  887.                              Esc is pressed
  888.     - TRWF_NOPSCRFALLBACK  : Don't fall back onto default PubScreen
  889.     - TRWF_NOZIPGADGET     : No zip/zoom gadget
  890.     - TRWF_ZIPCENTERTOP    : Center zipped window on screen title bar
  891.     - TRWF_NOMINTEXTWIDTH  : Window title text length doesn't count
  892.                              for window size calculation
  893.     - TRWF_NOSIZEGADGET    : No size gadget
  894.     - TRWF_NOFONTFALLBACK  : Don't fall back to topaz/8
  895.     - TRWF_NODELZIP        : Don't zip the window when Del is pressed
  896.     - TRWF_SIMPLEREFRESH   : Use simple refresh
  897.                              (Default: smart refresh)
  898.     - TRWF_ZIPTOCURRENTPOS : Zip the window without changing its
  899.                              position. Requires OS3.0 or higher.
  900.     - TRWF_APPWINDOW       : Create an AppWindow even if no object
  901.                              reacts on dropped icons
  902.     - TRWF_ACTIVATESTRGAD  : Activate the first string gadget after
  903.                              opening the window
  904.     - TRWF_HELP            : When the user presses <Help> over a menu
  905.                              item or a display object, a TRMS_HELP
  906.                              message will be sent (V2)
  907.  
  908.     TRWI_Underscore (UBYTE *) - The underscore for menu and gadget
  909.         shortcuts
  910.  
  911.     TRWI_Position (ULONG) - The window position:
  912.     - TRWP_DEFAULT         : Let Triton choose a good position for
  913.                              the window
  914.     - TRWP_BELOWTITLEBAR   : Left side of screen; below the title bar
  915.     - TRWP_CENTERTOP       : Top of screen; centered on the title bar
  916.     - TRWP_TOPLEFTSCREEN   : Top left corner of screen
  917.     - TRWP_CENTERSCREEN    : Centered on the screen
  918.     - TRWP_CENTERDISPLAY   : Centered on the currently displayed clip
  919.     - TRWP_MOUSEPOINTER    : Centered under the mouse pointer
  920.  
  921.     TRWI_CustomScreen (struct Screen *) - A custom screen on which
  922.         the window will be opened
  923.  
  924.     TRWI_PubScreen (struct Screen *) - A public screen on which the
  925.         window will be opened. The screen *must* have been locked.
  926.  
  927.     TRWI_PubScreenName (STRPTR) - A public screen on which the window
  928.         will be opened. Triton will try to lock the screen with the
  929.         specified name. It will fall back onto the default public
  930.         screen in case the screen can't be found/locked if you don't
  931.         specify TRWF_NOPSCRFALLBACK.
  932.  
  933.     TRWI_PropFontAttr (struct TextAttr *) - The proportional font. If
  934.         Triton can't open the font or the window would become too big
  935.         for the screen with this font and you didn't specify
  936.         TRWF_NOFONTFALLBACK, Triton will try to use topaz/8 instead.
  937.  
  938.     TRWI_FixedWidthFontAttr (struct TextAttr *) - The fixed-width
  939.         font. If Triton can't open the font or the window would
  940.         become too big for the screen with this font and you didn't
  941.         specify TRWF_NOFONTFALLBACK, Triton will try to use topaz/8
  942.         instead.
  943.  
  944.     TRWI_Backfill (ULONG) - The backfill type:
  945.     - TRBF_WINDOWBACK        : Default window background; Can be
  946.                                changed by the user in the Triton
  947.                                Preferences editor
  948.     - TRBF_REQUESTERBACK     : Default requester background; Can be
  949.                                changed by the user in the Triton
  950.                                Preferences editor
  951.     - TRBF_NONE              : No backfill (i.e. fill with
  952.                                BACKGROUNDPEN)
  953.     - TRBF_SHINE             : Fill with SHINEPEN
  954.     - TRBF_SHADOW            : Fill with SHADOWPEN
  955.     - TRBF_FILL              : Fill with FILLPEN
  956.     - TRBF_SHINE_SHADOW      : Fill with a pattern composed of
  957.                                SHINEPEN and SHADOWPEN
  958.     - TRBF_SHINE_FILL        : ~ SHINEPEN and FILLPEN
  959.     - TRBF_SHINE_BACKGROUND  : ~ SHINEPEN and BACKGROUNDPEN
  960.     - TRBF_SHADOW_FILL       : ~ SHADOWPEN and FILLPEN
  961.     - TRBF_SHADOW_BACKGROUND : ~ SHADOWPEN and BACKGROUNDPEN
  962.     - TRBF_FILL_BACKGROUND   : ~ FILLPEN and BACKGROUNDPEN
  963.  
  964.     TRWI_ID (ULONG) - An ID for the window. Identical windows (e.g.
  965.         several identical data editor windows) should share the same
  966.         ID. The same ID may be used in different applications.
  967.  
  968.     TRWI_Dimensions (struct TR_Dimensions *) - A window dimension
  969.         structure. The user program must supply a structure on its
  970.         own if it wants to use this feature. Triton will *not*
  971.         allocate it. If you use a dimensions structure, Triton will
  972.         copy the window dimensions into it when you close the window.
  973.         If you supply a filled-in dimension structure, Triton will try
  974.         to open the window with these dimensions. Supply an empty
  975.         structure if you want Triton to use the default dimensions (the
  976.         position may then be specified with TRWI_Position) and fill
  977.         in the structure for later use.
  978.  
  979.     TRMN_Title (STRPTR) - A menu label
  980.  
  981.     TRMN_Item (STRPTR) - A menu item label. You may attach a
  982.         keyboard shortcut to a menu by starting the label string
  983.         with the shortcut followed by the project's underscore
  984.         character and then the actual label. You may also use
  985.         extended menu shortcuts composed of more than one character.
  986.         Extended shortcuts can be specified with an underscore at
  987.         the beginning, then the shortcut, again an underscore and
  988.         the label. You may specify TRMN_BARLABEL instead of a string
  989.         to create a separator bar in the menu.
  990.  
  991.     TRMN_Sub (STRPTR) - A sub-menu item label. See TRMN_Item.
  992.  
  993.     TRMN_Flags (ULONG) - Flags for a menu item:
  994.     - TRMF_CHECKIT         : The menu item may be checked.
  995.     - TRMF_CHECKED         : The menu item is checked. You may, but
  996.                              you do not need to specify TRMF_CHECKIT
  997.                              in addition.
  998.     - TRMF_DISABLED        : The menu / (sub) item will be ghosted.
  999.  
  1000.    RESULT
  1001.     Project - The pointer to the TR_Project structure
  1002.  
  1003.    SEE ALSO
  1004.     TR_CloseProject()
  1005.  
  1006. triton.library/TR_ReplyMsg                         triton.library/TR_ReplyMsg
  1007.  
  1008.    NAME    
  1009.     TR_ReplyMsg -- Replies a Triton message.
  1010.  
  1011.    SYNOPSIS
  1012.     TR_ReplyMsg(Message)
  1013.                 A1
  1014.  
  1015.     VOID TR_ReplyMsg(struct TR_Message *);
  1016.  
  1017.    FUNCTION
  1018.     Replies a message allocated by TR_GetMsg().
  1019.  
  1020.    NOTES
  1021.     Please reply all messages as quickly as possible
  1022.     with TR_ReplyMsg(). This will reduce memory usage.
  1023.     All pending messages will be freed automatically when
  1024.     you shut down the application with TR_DeleteApp().
  1025.     It is *NOT* guaranteed that all reserved resources
  1026.     *within* the messages will be freed (like AppMessages)!
  1027.  
  1028.    SEE ALSO
  1029.     TR_GetMsg(), TR_Wait()
  1030.  
  1031. triton.library/TR_SetAttribute                 triton.library/TR_SetAttribute
  1032.  
  1033.    NAME    
  1034.     TR_SetAttribute -- Sets an attribute of an object.
  1035.  
  1036.    SYNOPSIS
  1037.     TR_SetAttribute(Project, ID, Attribute, Value)
  1038.                     A0       D0  D1         D2
  1039.  
  1040.     VOID TR_SetAttribute(struct TR_Project *, ULONG,
  1041.                          ULONG, ULONG, ULONG);
  1042.  
  1043.    FUNCTION
  1044.     Sets an attribute of a Triton object. Only attributes
  1045.     of objects with an ID can be changed. You can change the
  1046.     default attribute of an object by specifying NULL as
  1047.     the attribute to change. By specifying an ID of NULL, you
  1048.     can change certain attributes of a Triton project:
  1049.     - TRWI_Title
  1050.     - TRWI_ScreenTitle
  1051.  
  1052.    SEE ALSO
  1053.     Class descriptions, TR_GetAttribute()
  1054.  
  1055. triton.library/TR_UnlockProject               triton.library/TR_UnlockProject
  1056.  
  1057.    NAME    
  1058.     TR_UnlockProject -- Unlocks a Triton project.
  1059.  
  1060.    SYNOPSIS
  1061.     TR_UnlockProject(Project)
  1062.                      A0
  1063.  
  1064.     VOID TR_UnlockProject(struct TR_Project *);
  1065.  
  1066.    FUNCTION
  1067.     Unlocks a Triton project previously locked by
  1068.     TR_LockProject().
  1069.  
  1070.    SEE ALSO
  1071.     TR_LockProject()
  1072.  
  1073. triton.library/TR_UnlockScreen                 triton.library/TR_UnlockScreen
  1074.  
  1075.    NAME    
  1076.     TR_UnlockScreen -- Release a project's screen
  1077.  
  1078.    SYNOPSIS
  1079.     TR_UnlockScreen(Screen)
  1080.                     A0
  1081.  
  1082.     VOID TR_UnlockScreen(struct Screen *);
  1083.  
  1084.    FUNCTION
  1085.     Unlock a screen which has been locked by TR_LockScreen(). All
  1086.     locked screens must be unlocked! Locking/unlocking calls are
  1087.     nested.
  1088.  
  1089.    SEE ALSO
  1090.     TR_LockScreen()
  1091.  
  1092. triton.library/TR_Wait                                 triton.library/TR_Wait
  1093.  
  1094.    NAME    
  1095.     TR_Wait -- Waits for exec signals.
  1096.  
  1097.    SYNOPSIS
  1098.     Signals = TR_Wait(App, OtherBits)
  1099.             A1   D0
  1100.  
  1101.     ULONG TR_Wait(struct TR_App *, ULONG);
  1102.  
  1103.    FUNCTION
  1104.     Waits until a signal of the specified application
  1105.     or one of the other signal bits is set.
  1106.  
  1107.    RESULT
  1108.     Signals - The mask of set signals
  1109.  
  1110.    SEE ALSO
  1111.     TR_GetMsg(), TR_ReplyMsg()
  1112.  
  1113.