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