Dream 41

home *** CD-ROM | disk | FTP | other *** search

/ Dream 41 / Amiga_Dream_41.iso / Amiga / Programmation / gui / tri20b1dev.lha / Triton / Developer / Autodocs / triton.doc

Wrap

Text File | 1996-10-14 | 47.8 KB | 1,594 lines

TABLE OF CONTENTS triton.lib/TR_CloseTriton triton.lib/TR_OpenTriton triton.library/class_Button triton.library/class_CheckBox triton.library/class_Cycle triton.library/class_DisplayObject triton.library/class_DropBox triton.library/class_FrameBox triton.library/class_Group triton.library/class_Image triton.library/class_Line triton.library/class_Listview triton.library/class_Object triton.library/class_Palette triton.library/class_Progress triton.library/class_Scroller triton.library/class_Slider triton.library/class_Space triton.library/class_String triton.library/class_Text triton.library/TR_AutoRequest triton.library/TR_CloseProject triton.library/TR_CloseWindowSafely triton.library/TR_CreateApp triton.library/TR_DeleteApp triton.library/TR_DoMethod triton.library/TR_DoMethodClass triton.library/TR_DrawFrame triton.library/TR_EasyRequest triton.library/TR_FirstOccurance triton.library/TR_FrameBorderHeight triton.library/TR_FrameBorderWidth triton.library/TR_GetAttribute triton.library/TR_GetErrorString triton.library/TR_GetLastError triton.library/TR_GetMsg triton.library/TR_GetPen triton.library/TR_LockProject triton.library/TR_LockScreen triton.library/TR_NumOccurances triton.library/TR_ObtainWindow triton.library/TR_OpenProject triton.library/TR_PrintText triton.library/TR_ReleaseWindow triton.library/TR_ReplyMsg triton.library/TR_SendMessage triton.library/TR_SetAttribute triton.library/TR_TextHeight triton.library/TR_TextWidth triton.library/TR_UnlockProject triton.library/TR_UnlockScreen triton.library/TR_Wait triton.lib/TR_CloseTriton triton.lib/TR_CloseTriton NAME TR_CloseTriton -- Closes Triton easily. SYNOPSIS TR_CloseTriton() VOID TR_CloseTriton(VOID); FUNCTION Closes the application created by OpenTriton() and closes triton.library. SEE ALSO TR_OpenTriton() triton.lib/TR_OpenTriton triton.lib/TR_OpenTriton NAME TR_OpenTriton -- Opens Triton ready to use. SYNOPSIS success = TR_OpenTriton(version, tag1,...) D0 BOOL TR_OpenTriton(ULONG, ULONG,...); FUNCTION Opens triton.library with the specified minimum version and creates an application. The supplied tags are passed as a taglist to TR_CreateApp(). RESULT success - Was everything opened successful? SEE ALSO TR_CloseTriton(), TR_CreateApp() triton.library/class_Button triton.library/class_Button NAME class_Button -- A BOOPSI button gadget SUPERCLASS class_DisplayObject SYNOPSIS TROB_Button ATTRIBUTES <Default> : ULONG buttontype - TRBT_TEXT : Text button (default) - TRBT_GETFILE : GetFile image button - TRBT_GETDRAWER : GetDrawer image button - TRBT_GETENTRY : GetEntry image button [create] TRAT_Text : STRPTR label [create] TRAT_Flags : ULONG flags - TRBU_RETURNOK : Activated by <Return> - TRBU_ESCOK : Activated by <Esc> - TRBU_SHIFTED : Shifted shortcut only - TRBU_UNSHIFTED : Unshifted shortcut only - TRBU_YRESIZE (V2) : When this flag is set, the button will be vertically resizeable. This is required because beginning with V2 the height of objects which are normally using the button height can be modified in the prefs editor. Set this flags WHEREVER POSSIBLE in order to make buttons adopt to taller objects in the same horizontal group. [create] APPLICATION MESSAGES TRMS_ACTION is sent when a pressed down button is released. NOTES Although image buttons don't display a text string you can still set one using the TRAT_Text attribute in order to create a shortcut for the button. triton.library/class_CheckBox triton.library/class_CheckBox NAME class_CheckBox -- A GadTools checkbox gadget SUPERCLASS class_DisplayObject SYNOPSIS TROB_CheckBox ATTRIBUTES <Default> : <unused> TRAT_Value : BOOL checked [create, set, get] APPLICATION MESSAGES TRMS_NEWVALUE is sent when the checkbox has been toggled. trm_Data contains 0 for an unselected checkbox and any other value for a selected checkbox. triton.library/class_Cycle triton.library/class_Cycle NAME class_Cycle -- A GadTools cycle gadget SUPERCLASS class_DisplayObject SYNOPSIS TROB_Cycle ATTRIBUTES <Default> : STRPTR *entries : Gadget etry labels [create] TRAT_Value : ULONG number [create, set, get] TRAT_Flags : ULONG flags (V2) - TRCY_MX : "Unfold" the cycle gadget to a mutually exclusive gadget. - TRCY_RIGHTLABELS : Put the labels to the right side (TRCY_MX only). [create] NOTES Disabling TRCY_MX-style gadgets requires OS3.0 or better. APPLICATION MESSAGES TRMS_NEWVALUE is sent when the selected entry has changed. trm_Data contains the ordinal number of the new entry. triton.library/class_DisplayObject triton.library/class_DisplayObject NAME class_DisplayObject -- An abstract display object SUPERCLASS class_Object SYNOPSIS (TROB_DisplayObject) ATTRIBUTES <Default> : <unused> TRAT_ID : ULONG objectid [create, get] TRAT_Disabled : BOOL disabled [create, set, get] TRDO_QuickHelpString : STRPTR string [create, set, get] OBJECT MESSAGES TROM_INSTALL : Install an object at its place in a rastport TROM_REMOVE : Remove an installed object TROM_SETATTRIBUTE : Modify an attribute TROM_GETATTRIBUTE : Query an attribute TROM_HIT : Find an object from a pair of coordinates (TROM_REFRESH) : Refresh/redraw an object's on-screen representation (TROM_EVENT) : An IDCMP event has arrived (TROM_DISABLED) : Disable/ghost an object (TROM_ENABLED) : Enable an object again (TROM_KEYDOWN) : A key has been pressed down (TROM_REPEATEDKEYDOWN) : A key is still pressed down (TROM_KEYUP) : A key has been released (TROM_CANCELLED) : A key press has been cancelled (TROM_CREATECLASS) : Create class-specific data (TROM_DISPOSECLASS) : Dispose of class-specific data triton.library/class_DropBox triton.library/class_DropBox NAME class_DropBox -- An icon drop box SUPERCLASS class_DisplayObject SYNOPSIS TROB_DropBox ATTRIBUTES <Default> : <unused> triton.library/class_FrameBox triton.library/class_FrameBox NAME class_FrameBox -- A framing box SUPERCLASS class_DisplayObject (no attributes inherited) SYNOPSIS TROB_FrameBox ATTRIBUTES <Default> : ULONG boxtype (V2) If no flag is set, unnamed boxes will be grouping and named ones framing. - TRFB_TEXT : A text container - TRFB_GROUPING : A grouping box - TRFB_FRAMING : A framing box. [create] TRAT_ID : ULONG objectid (V2) [create] TRAT_Backfill : ULONG pattern [create, set] TRAT_Text : STRPTR label (V2) [create] <other> : <Child object> [create] triton.library/class_Group triton.library/class_Group NAME class_Group -- A grouping object SUPERCLASS class_DisplayObject SYNOPSIS TRGR_Horiz TRGR_Vert ATTRIBUTES <Default> : ULONG flags - TRGR_PROPSHARE : Divide objects proportionally - TRGR_EQUALSHARE : Divide objects equally - TRGR_PROPSPACES : Divide spaces proportionally - TRGR_ARRAY : Top group of an array. Lines or culumns can be built using TRGR_PROPSHARE groups. At least one group must be contained in an array. - TRGR_ALIGN : Align resizable objects in their secondary dimension - TRGR_CENTER : Center non-resizable objects in their secondary dimension - TRGR_FIXHORIZ : Don't allow horizontal resizing - TRGR_FIXVERT : Don't allow vertical resizing - TRGR_INDEP (V2) : Group is independent of surrounding array [create] TRAT_ID : ULONG objectid (V4) [create] <other> : Treated as elements of the group [create] TRGR_End : <unused> : Marks the end of the group [create] NOTES An array group must contain at least one non-space object. triton.library/class_Image triton.library/class_Image NAME class_Image -- An image (V2) SUPERCLASS class_DisplayObject SYNOPSIS TROB_Image ATTRIBUTES <Default> : <Image> [create] TRAT_Flags : ULONG flags - TRIM_BOOPSI : <Default> is a pointer to a struct IClass BOOPSI image class. [create] TRAT_MinWidth : Minimum image width in pixels. Defaults to the image button height. [create, set] TRAT_MinHeight : Minimum image height in pixels. Defaults to the image button height. [create, set] triton.library/class_Line triton.library/class_Line NAME class_Line -- A 3D line SUPERCLASS class_DisplayObject SYNOPSIS TROB_Line ATTRIBUTES <Default> : ULONG flags - TROF_HORIZ : Horizontal line (Overrides group dimension) - TROF_VERT : Vertical line (Overrides group dimension) - TROF_RAISED : Raised line [create] triton.library/class_Listview triton.library/class_Listview NAME class_Listview -- A GadTools Listview gadget SUPERCLASS class_DisplayObject SYNOPSIS TROB_Listview ATTRIBUTES <Default> : struct List *entries [create, set] TRAT_Flags : ULONG flags - Listview type (mutually exclusive): - TRLV_READONLY : A read-only list - TRLV_SELECT : You may select an entry - TRLV_SHOWSELECTED : Show selected entry - TRLV_NOCURSORKEYS : Don't use arrow keys - TRLV_NONUMPADKEYS : Don't use keypad keys - TRLV_FWFONT : Use the fixed-width font - TRLV_NOGAP (V2) : Leave no gap below the list but instead at the end of the group. [create, set] TRAT_Value : ULONG selected : Currently selected entry (TRLV_SHOWSELECTED only) [create, set, get] TRLV_Top : ULONG top [create, set] TRAT_MinWidth : ULONG minwidth : Minimum width (Default: 10 characters) [create, set] TRAT_MinHeight : ULONG minheight : Minimum height (Default: 4 lines) [create, set] APPLICATION MESSAGES 'Select' listviews send TRMS_ACTION messages. 'ShowSelected' lists send TRMS_NEWVALUE messages. trm_Data contains the ordinal number of the selected entry. trm_Qualifier&IEQUALIFIER_REPEAT is set if the user has double-clicked the specified listview entry. triton.library/class_Object triton.library/class_Object NAME class_Object -- The abstract root class SUPERCLASS <none> SYNOPSIS (TROB_Object) ATTRIBUTES <Default> : <unused> OBJECT MESSAGES TROM_NEW : Create an instance TROM_DISPOSE : Dispose of an instance triton.library/class_Palette triton.library/class_Palette NAME class_Palette -- A GadTools palette gadget SUPERCLASS class_DisplayObject SYNOPSIS TROB_Palette ATTRIBUTES <Default> : <unused> TRAT_Value : BOOL checked [create, set, get] APPLICATION MESSAGES TRMS_NEWVALUE is sent when a new color has been selected. trm_Data contains the pen number of the selected color. triton.library/class_Progress triton.library/class_Progress NAME class_Progress -- A progress indicator SUPERCLASS class_DisplayObject SYNOPSIS TROB_Progress ATTRIBUTES <Default> : ULONG maximum [create, set] TRAT_Flags : ULONG orientation - TROF_HORIZ (default) - TROF_VERT [create, set] TRAT_Value : ULONG current [create, set, get] triton.library/class_Scroller triton.library/class_Scroller NAME class_Scroller -- A GadTools scroller gadget SUPERCLASS class_DisplayObject SYNOPSIS TROB_Scroller ATTRIBUTES <Default> : ULONG flags - TROF_HORIZ (default) - TROF_VERT [create] TRAT_Value : WORD top [create, set, get] TRSC_Total : WORD total [create, set, get] TRSC_Visible : WORD visible [create, set, get] APPLICATION MESSAGES TRMS_NEWVALUE is sent when TRAT_Value changes. trm_Data contains the new value. triton.library/class_Slider triton.library/class_Slider NAME class_Slider -- A GadTools slider gadget SUPERCLASS class_DisplayObject SYNOPSIS TROB_Slider ATTRIBUTES <Default> : ULONG flags - TROF_HORIZ (default) - TROF_VERT [create] TRAT_Value : WORD level [create, set, get] TRSL_Min : WORD min [create] TRSL_Max : WORD max [create] APPLICATION MESSAGES TRMS_NEWVALUE is sent when TRAT_Value changes. trm_Data contains the new value. triton.library/class_Space triton.library/class_Space NAME class_Space -- A class of spaces with various sizes SUPERCLASS class_DisplayObject SYNOPSIS TROB_Space ATTRIBUTES <Default> : ULONG spacetype - TRST_NONE : No space - TRST_SMALL : Small space - TRST_NORMAL : Normal space (default) - TRST_BIG : Big space [create] triton.library/class_String triton.library/class_String NAME class_String -- A GadTools string gadget SUPERCLASS class_DisplayObject SYNOPSIS TROB_String ATTRIBUTES <Default> : STRPTR string [create, set, get] TRAT_Value : UWORD maxchars (default: 64) [create] TRST_Filter : STRPTR filter: Only characters in this string will be accepted if present, otherwise all characters are allowed. [create] TRAT_Flags : ULONG flags - TRST_INVISIBLE : Invisible typing - TRST_NORETURNBROADCAST : Don't broadcast <Return> key presses to the window. - TRST_FLOAT : Only one "." or "," symbol is accepted. [create] APPLICATION MESSAGES TRMS_NEWVALUE is sent when <Return> has been pressed in an activated string gadget. trm_Data contains a pointer to the new string and is only valid as long as the object exists. It is advised that you do not check for TRMS_NEWVALUE messages but instead read the current string using TR_GetAttribute() when you need it. OBJECT MESSAGES TROM_ACTIVATE : Activate the string gadget. triton.library/class_Text triton.library/class_Text NAME class_Text -- A line of text / A value SUPERCLASS class_DisplayObject SYNOPSIS TROB_Text ATTRIBUTES <Default> : <unused> TRAT_Text : STRPTR text [create, set] TRAT_Value : ULONG number [create, set] TRAT_MinWidth : ULONG number_of_average_chars [create] TRAT_Flags : ULONG flags - TRTX_NOUNDERSCORE : Don't interpret underscores - TRTX_HIGHLIGHT : Highlight text - TRTX_3D : Highlight with shadows - TRTX_BOLD : Bold text - TRTX_TITLE : Use this for titles (e.g. of separator bars). - TRTX_RIGHTALIGN (V6) : Align text to the right border - TRTX_CENTER (V6) : Center text - TRTX_CLIPPED (V4) : Text is resizable in X direction. Text which exceeds the available space will be truncated. - TRTX_MULTILINE (V6) : See TR_PrintText() autodoc clip for details [create] NOTES TRTX_CLIPPED is mutually exclusive with TRTX_MULTILINE and TRTX_RIGHTALIGN. Non-clipped texts (and especially multi-line texts) should not be changed. Clipping is not possible when TRAT_MinWidth is specified. SEE ALSO TR_PrintText() triton.library/TR_AutoRequest triton.library/TR_AutoRequest NAME TR_AutoRequest -- A (relatively ;-) low-level requester function. SYNOPSIS selection = TR_AutoRequest(App, Project, TagList) D0 A1 A0 A2 ULONG TR_AutoRequest(struct TR_App *, struct TR_Project *, struct AppItem *); selection = TR_AutoRequestTags(App, Project, Tag,...) D0 ULONG TR_AutoRequestTags(struct TR_App *, struct TR_Project *, struct AppItem *); FUNCTION Pops up a requester which is described by the supplied tag list. As soon as a TRMS_ACTION message is sent by one of the objects, the requester will close. If a project is supplied, it will be locked when opening the requester and unlocked when closing it. RESULT selection - The ID of the object which triggered the action, 0 for an error, (ULONG)(-1) for the close gadget. NOTES Simple requesters with just text and buttons can be done easier with TR_EasyRequest(). If you need more complex requesters, you have to use your own message polling loop instead of TR_AutoRequest(). You may still use the requester macros though. SEE ALSO TR_EasyRequest() triton.library/TR_CloseProject triton.library/TR_CloseProject NAME TR_CloseProject -- Closes a project/window. SYNOPSIS TR_CloseProject(Project) A0 VOID TR_CloseProject(struct TR_Project *); FUNCTION Closes a Triton project. SEE ALSO TR_OpenProject() triton.library/TR_CloseWindowSafely triton.library/TR_CloseWindowSafely NAME TR_CloseWindowSafely -- Closes as window with a shared IDCMP port. SYNOPSIS TR_CloseWindowSafely(Window) A0 VOID TR_CloseWindowSafely(struct Window *); FUNCTION Closes a window which shares its IDCMP port with another window. All the pending messages (concerning this window) on the port will be removed and the window will be closed. Do *NOT* use this function to close windows which have an IDCMP port set up by Intuition. If you do the port will be left in memory! If you intend to open a lot of windows all sharing the same IDCMP port it is easiest if you create a port yourself and open all windows with newwin.IDCMPFlags set to 0 (this tells Intuition NOT to set up an IDCMP port). After opening the window set win->UserPort to your message port and call ModifyIDCMP() to set your IDCMP flags. When you then receive messages from Intuition check their imsg->IDCMPWindow field to find out what window they came from and act upon them. When closing your windows call TR_CloseWindowSafely() for all of them and delete your message port. INPUTS Window - pointer to the window to be closed. NOTE This function is for the advanced Triton user. SEE ALSO intuition.library/CloseWindow() triton.library/TR_CreateApp triton.library/TR_CreateApp NAME TR_CreateApp -- Creates a Triton application. TR_CreateAppTags -- Varargs stub for TR_CreateApp. SYNOPSIS app = TR_CreateApp(TagList) D0 A1 struct TR_App * TR_CreateApp(struct TagItem *); app = TR_CreateAppTags(Tag1,...) struct TR_App * TR_CreateApp(ULONG,...); FUNCTION Creates an application. An application is required for opening windows and polling messages. All projects of an application will share one IDCMP port and one memory pool. TAGS TRCA_Name - (STRPTR) Unique name for the application. Must not be longer than 20 characters. Case-insensitive. ' ', '/', '.' and ':' are not allowed. TRCA_LongName - (STRPTR) A user-readable name for the application. Up to 60 characters allowed. TRCA_Info - (STRPTR) Information about the application. Should not be more than 2 lines with 60 characters each. TRCA_Version - (STRPTR) Internal version of the application. TRCA_Release - (STRPTR) Release number of the application. TRCA_Date - (STRPTR) Creation/compilation date. Should be given in standard version string format. Example: Name : DilloCreate LongName : Armadillo Creator Info : Part of the Armadillo Management System. ⌐ 1994 by DilloWorks Enterprises. Version : 42.135 Release : 2.1b▀3 Date : 17.6.94 RESULT app - A pointer to the created application structure. NULL indicates failure. SEE ALSO TR_DeleteApp() triton.library/TR_DeleteApp triton.library/TR_DeleteApp NAME TR_DeleteApp -- Deletes a Triton application. SYNOPSIS TR_DeleteApp(App) A1 VOID TR_DeleteApp(struct TR_App *); FUNCTION Deletes an application created by TR_CreateApp(). NOTES All windows have to be closed before deleting the corresponding application! SEE ALSO TR_CreateApp() triton.library/TR_DoMethod triton.library/TR_DoMethod NAME TR_DoMethod -- Dispatch a method. (V6) SYNOPSIS Result = TR_DoMethod(Object, MessageID, Data) A0 D0 A1 ULONG TR_DoMethod(struct TROD_Object *, ULONG, APTR); FUNCTION Dispatch a method to an object. RESULT Depends on the class and method being called. SEE ALSO TR_DoMethodClass() triton.library/TR_DoMethodClass triton.library/TR_DoMethodClass NAME TR_DoMethodClass -- Dispatch a method through a meta-class. (V6) SYNOPSIS Result = TR_DoMethodClass(Object, MessageID, Data, Class) A0 D0 A1 A2 ULONG TR_DoMethodClass(struct TROD_Object *, ULONG, APTR, struct TR_Class *); FUNCTION Dispatch a method to an object as if the object was of the specified class. RESULT Depends on the class and method being called. SEE ALSO TR_DoMethod() triton.library/TR_DrawFrame triton.library/TR_DrawFrame NAME TR_DrawFrame -- Draws a frame/BevelBox. (V6) SYNOPSIS TR_DrawFrame(Project, RastPort, Left, Top, Width, A0 A1 D1 D2 D3 Height, Type, Inverted) D4 D0 D5 VOID TR_DrawFrame(struct TR_Project *, struct RastPort *, UWORD, UWORD, UWORD, UWORD, UWORD, BOOL); FUNCTION Draws a frame into the specified RastPort (or into the project's default RastPort if the supplied RastPort is NULL. Set Inverted to TRUE for a recessed (basic) or inverted (abstract) frame. SEE ALSO TR_FrameBorderWidth(), TR_FrameBorderHeight() triton.library/TR_EasyRequest triton.library/TR_EasyRequest NAME TR_EasyRequest -- A high-level requester function. SYNOPSIS selection = TR_EasyRequest(App, BodyFmt, GadFmt, TagList) D0 A1 A2 A3 A0 ULONG TR_EasyRequest(struct TR_App *, STRPTR, STRPTR, struct TagItem *); selection = TR_EasyRequestTags(App, BodyFmt, GadFmt, Tag,...) D0 ULONG TR_EasyRequestTags(struct TR_App *, STRPTR, STRPTR, ULONG,...); FUNCTION Pops up a requester and waits for the user to select a gadget. INPUTS App - A valid Triton application. BodyFmt - A multi-line text which will be displayed in the requester body. See TR_PrintText() autodoc clip for details about the formatting sequences. GadFmt - The gadget texts, separated by '|'. TagList - Pointer to a TagItem array. TAGS TREZ_ReqPos (ULONG) - The requester's position (TRWP_...). The default is TRWP_MOUSEPOINTER. TREZ_LockProject (struct TR_Project *) - This project will be locked while the requester is displayed. Information about screen and activity state of the requester are taken from this project. TREZ_Return (ULONG) - Number of the default gadget which can be activated by <RETURN>. Defaults to 1 (0 in a single-gadget requester). TREZ_Title (STRPTR) - Requester window title. Default is "System request" (or a localized version under OS2.1 and higher). TREZ_Activate (BOOL) - If this tag is supplied, the activity state of the requester window will be taken from this tag's argument instead of being inherited from the locked project (if applicable). TRWI_PubScreen (struct Screen *) - A public screen on which the window will be opened. The screen *must* have been locked. TRWI_PubScreenName (STRPTR) - A public screen on which the window will be opened. Triton will try to lock the screen with the specified name. It will fall back onto the default public screen in case the screen can't be found/locked. RESULT selection - The number of the selected gadget. The gadgets are numbered from left to right beginning with 1. The rightmost gadget (or the only gadget in a 1-gadget requester) has got number 0. (ULONG)(-1) is returned for indicating an error. SEE ALSO TR_AutoRequest(), TR_PrintText() triton.library/TR_FirstOccurance triton.library/TR_FirstOccurance NAME TR_FirstOccurance -- Finds a character in a string. SYNOPSIS Position = TR_FirstOccurance(Character, String) D0 D0 A0 LONG TR_FirstOccurance(UBYTE, STRPTR); FUNCTION Finds the specified character in the string. RESULT Position - The position of the first occurance of the character in the string or -1 if the character couldn't be found in the string. triton.library/TR_FrameBorderHeight triton.library/TR_FrameBorderHeight NAME TR_FrameBorderHeight -- Returns frame border height. (V6) SYNOPSIS Height = TR_FrameBorderHeight(Project, Type) A0 D0 ULONG TR_FrameBorderHeight(struct TR_Project *, UWORD); FUNCTION Returns the thickness of the top/bottom borders of the specified frame type (TRFT_#?) in a specific project taking into account the user's preferences settings. RESULT Height - The height of the borders in pixels SEE ALSO TR_FrameBorderWidth(), TR_DrawFrame() triton.library/TR_FrameBorderWidth triton.library/TR_FrameBorderWidth NAME TR_FrameBorderWidth -- Returns frame border width. (V6) SYNOPSIS Width = TR_FrameBorderWidth(Project, Type) A0 D0 ULONG TR_FrameBorderWidth(struct TR_Project *, UWORD); FUNCTION Returns the thickness of the left/right borders of the specified frame type (TRFT_#?) in a specific project taking into account the user's preferences settings. RESULT Width - The width of the borders in pixels SEE ALSO TR_FrameBorderHeight(), TR_DrawFrame() triton.library/TR_GetAttribute triton.library/TR_GetAttribute NAME TR_GetAttribute -- Gets an attribute of an object. SYNOPSIS value = TR_GetAttribute(Project, ID, Attribute) D0 A0 D0 D1 ULONG TR_GetAttribute(struct TR_Project *, ULONG, ULONG); FUNCTION Gets an attribute of a Triton object. Only attributes of objects with an ID can be queried. RESULT value - Value of the specified attribute. Depends on specific class and attribute. SEE ALSO Class descriptions, TR_SetAttribute() triton.library/TR_GetErrorString triton.library/TR_GetErrorString NAME TR_GetErrorString -- Creates an error message SYNOPSIS Message = TR_GetErrorString(Number) D0 D0 STRPTR TR_GetErrorString(UWORD); FUNCTION Creates an error message which matches the supplied Triton error code. INPUTS Number - Triton error code. In most cases you will get this with TR_GetLastError(). RESULT Message - Pointer to a user-readable error message or an empty string ("") if none available. BUGS In older Triton versions, TR_GetErrorString() did return NULL instead of an empty string. This is fixed in V4. SEE ALSO TR_GetLastError() triton.library/TR_GetLastError triton.library/TR_GetLastError NAME TR_GetLastError -- Gets the last error code SYNOPSIS Number = TR_GetLastError(App) D0 A1 UWORD TR_GetLastError(struct TR_App *); FUNCTION Returns the TRER code of the last error which occured in the application and sets the internal tra_LastError back to TRER_OK. INPUTS App - Pointer to a Triton Application RESULT Number - TRER error code SEE ALSO TR_GetErrorString() triton.library/TR_GetMsg triton.library/TR_GetMsg NAME TR_GetMsg -- Gets a Triton message. SYNOPSIS message = TR_GetMsg(App) D0 A1 struct TR_Message * TR_GetMsg(struct TR_App *); FUNCTION Gets a message from a Triton application created by TR_CreateApp(). You may first want to wait for a message with TR_Wait(). NOTES Please reply all messages as quickly as possible with TR_ReplyMsg(). Shutting down an application does not free unreplied messages and resources which are attached to them (like AppMessages). SEE ALSO TR_ReplyMsg(), TR_Wait(), TR_CreateMsg() triton.library/TR_GetPen triton.library/TR_GetPen NAME TR_GetPen -- Returns a pen number. (V6) SYNOPSIS Pen = TR_GetPen(Project, PenType, PenData) A0 D0 D1 ULONG TR_GetPen(struct TR_Project *, ULONG, ULONG); FUNCTION Returns the pen specified by PenType and PenData. RESULT Pen - The number of the requested pen triton.library/TR_LockProject triton.library/TR_LockProject NAME TR_LockProject -- Locks a Triton project. SYNOPSIS TR_LockProject(Project) A0 VOID TR_LockProject(struct TR_Project *); FUNCTION Locks a Triton project. Only window resizing will still work in a locked project. All other kinds of input (i.e. all input which requires interaction by your program and not only by Triton) are not possible. SEE ALSO TR_UnlockProject() triton.library/TR_LockScreen triton.library/TR_LockScreen NAME TR_LockScreen -- Get a project's screen SYNOPSIS screen = TR_LockScreen(Project) D0 A0 struct Screen * TR_LockScreen(struct TR_Project *); FUNCTION Lock the screen of a Triton project for use with non-Triton windows (e.g. for opening a file requester on the screen of a Triton application). The screen must be unlocked later with TR_UnlockScreen(). Locking/unlocking calls are nested. RESULT screen - Pointer to the project's screen or NULL to indicate an error. In this case the application should *not* abort, but *quietly* use another screen (preferably the Workbench screen) instead. SEE ALSO TR_UnlockScreen() triton.library/TR_NumOccurances triton.library/TR_NumOccurances NAME TR_NumOccurances -- Counts a character in a string. SYNOPSIS Number = TR_NumOccurances(Character, String) D0 D0 A0 LONG TR_NumOccurances(UBYTE, STRPTR); FUNCTION Counts the number of occurances of the character in the string. RESULT Number - The number of matching characters found. triton.library/TR_ObtainWindow triton.library/TR_ObtainWindow NAME TR_ObtainWindow -- Get a project's window. (V3) SYNOPSIS window = TR_ObtainWindow(Project) D0 A0 struct Window * TR_ObtainWindow(struct TR_Project *); FUNCTION Lock the window of a Triton project for non-Triton window operations (e.g. activating a window or bringing it to the front). Do not manipulate the contents of Triton windows! Locked windows must be freed again with TR_UnlockWindow(). Locking/unlocking calls are nested. RESULT window - Pointer to the project's Window. A value of NULL should be quietly ignored. NULL simply indicates that there is currently no window available. SEE ALSO TR_UnlockWindow() triton.library/TR_OpenProject triton.library/TR_OpenProject NAME TR_OpenProject -- Opens a project/window. TR_OpenProjectTags -- Varargs stub for TR_OpenProject. SYNOPSIS Project = TR_OpenProject(App, TagItems) D0 A1 A0 struct TR_Project *TR_OpenProject(struct TR_App *, struct TagItem *); Project = TR_OpenProjectTags(App, Tag1,...) struct TR_Project *TR_OpenProjectTags(struct TR_App *, ULONG,...); FUNCTION Opens a Triton project. The supplied taglist may contain window tags, menu tags and object tags (in that order). Mutually exclusive menus are not yet supported. When creating a menu item with an ID, TRAT_ID must be the *last* tag. A valid application pointer must be supplied. INPUTS App = Valid application pointer TagItems = List of tags describing the project TAGS The taglist may contain window tags, menu tags and object tags (in that order!). The following list shows the window and menu tags. See the class descriptions for the object tags. TRWI_Title (STRPTR) - The window title (changeable) TRWI_ScreenTitle (STRPTR) - The screen title (changeable) (V2) TRWI_Flags (ULONG) - The Triton window flags: - TRWF_BACKDROP : Create a backdrop borderless window in full screen size - TRWF_NODRAGBAR : No dragging bar - TRWF_NODEPTHGADGET : No depth arranging gadget - TRWF_NOCLOSEGADGET : No close gadget - TRWF_NOACTIVATE : Don't activate window - TRWF_NOESCCLOSE : Don't send TRMS_CLOSEWINDOW when Esc is pressed - TRWF_NOPSCRFALLBACK : Don't fall back onto default PubScreen - TRWF_NOZIPGADGET : No zip/zoom gadget - TRWF_ZIPCENTERTOP : Center zipped window on screen title bar - TRWF_NOMINTEXTWIDTH : Window title text length doesn't count for window size calculation - TRWF_NOSIZEGADGET : No size gadget - TRWF_NOFONTFALLBACK : Don't fall back to topaz/8 - TRWF_NODELZIP : Don't zip the window when Del is pressed - TRWF_SIMPLEREFRESH : Use simple instead of smart refresh. (V1) This flag is *obsolete* in V3+! The refresh type is now set by the user. - TRWF_ZIPTOCURRENTPOS : Zip the window without changing its position. Requires OS3.0 or higher. - TRWF_APPWINDOW : Create an AppWindow even if no object reacts on dropped icons - TRWF_ACTIVATESTRGAD : Activate the first string gadget after opening the window - TRWF_HELP : When the user presses <Help> over a menu item or a display object, a TRMS_HELP message will be sent (V2) - TRWF_SYSTEMACTION : When a system action IDCMP message arrives, a corresponding Triton message will be generated. These are currently TRMS_DISKINSERTED and TRMS_DISKREMOVED. (V4) TRWI_Underscore (UBYTE *) - The underscore for menu and gadget shortcuts. The default is "_". TRWI_Position (ULONG) - The window position: - TRWP_DEFAULT : Let Triton choose a good position for the window (default; preferred) - TRWP_BELOWTITLEBAR : Left side of screen; below the title bar - TRWP_CENTERTOP : Top of screen; centered on the title bar - TRWP_TOPLEFTSCREEN : Top left corner of screen - TRWP_CENTERSCREEN : Centered on the screen - TRWP_CENTERDISPLAY : Centered on the currently displayed clip - TRWP_MOUSEPOINTER : Centered under the mouse pointer TRWI_CustomScreen (struct Screen *) - A custom screen on which the window will be opened TRWI_PubScreen (struct Screen *) - A public screen on which the window will be opened. The screen *must* have been locked. TRWI_PubScreenName (STRPTR) - A public screen on which the window will be opened. Triton will try to lock the screen with the specified name. It will fall back onto the default public screen in case the screen can't be found/locked if you don't specify TRWF_NOPSCRFALLBACK. TRWI_PropFontAttr (struct TextAttr *) - The proportional font. If Triton can't open the font or the window would become too big for the screen with this font and you didn't specify TRWF_NOFONTFALLBACK, Triton will try to use topaz/8 instead. TRWI_FixedWidthFontAttr (struct TextAttr *) - The fixed-width font. If Triton can't open the font or the window would become too big for the screen with this font and you didn't specify TRWF_NOFONTFALLBACK, Triton will try to use topaz/8 instead. TRWI_Backfill (ULONG) - The backfill type: - TRBF_WINDOWBACK : Default window background; Can be changed by the user in the Triton Preferences editor - TRBF_REQUESTERBACK : Default requester background; Can be changed by the user in the Triton Preferences editor - TRBF_NONE : No backfill (i.e. fill with BACKGROUNDPEN) - TRBF_SHINE : Fill with SHINEPEN - TRBF_SHADOW : Fill with SHADOWPEN - TRBF_FILL : Fill with FILLPEN - TRBF_SHINE_SHADOW : Fill with a pattern composed of SHINEPEN and SHADOWPEN - TRBF_SHINE_FILL : ~ SHINEPEN and FILLPEN - TRBF_SHINE_BACKGROUND : ~ SHINEPEN and BACKGROUNDPEN - TRBF_SHADOW_FILL : ~ SHADOWPEN and FILLPEN - TRBF_SHADOW_BACKGROUND : ~ SHADOWPEN and BACKGROUNDPEN - TRBF_FILL_BACKGROUND : ~ FILLPEN and BACKGROUNDPEN TRWI_ID (ULONG) - An ID for the window. Identical windows (e.g. several identical data editor windows) should share the same ID, otherwise application-wide unique IDs should be used. TRWI_Dimensions (struct TR_Dimensions *) - A window dimension structure. The user program must supply a structure on its own if it wants to use this feature. Triton will *not* allocate it. If you use a dimensions structure, Triton will copy the window dimensions into it when you close the window. If you supply a filled-in dimension structure, Triton will try to open the window with these dimensions. Supply a cleared structure if you want Triton to use the default dimensions (the position may then be specified with TRWI_Position) and fill in the structure for later use. TRWI_QuickHelp (BOOL) - When this flag is set, QuickHelp windows will pop up for those objects which have QuickHelp strings assigned to them. (changeable) (V4) TRMN_Title (STRPTR) - A menu label TRMN_Item (STRPTR) - A menu item label. You may attach a keyboard shortcut to a menu by starting the label string with the shortcut followed by the project's underscore character and then the actual label. You may also use extended menu shortcuts composed of more than one character. Extended shortcuts can be specified with an underscore at the beginning, then the shortcut, again an underscore and the label. You may specify TRMN_BARLABEL instead of a string to create a separator bar in the menu. TRMN_Sub (STRPTR) - A sub-menu item label. See TRMN_Item. TRMN_Flags (ULONG) - Flags for a menu item: - TRMF_CHECKIT : The menu item may be checked. - TRMF_CHECKED : The menu item is checked. You may, but you do not need to specify TRMF_CHECKIT in addition. - TRMF_DISABLED : The menu / (sub) item will be ghosted. RESULT Project - The pointer to the TR_Project structure SEE ALSO TR_CloseProject() triton.library/TR_PrintText triton.library/TR_PrintText NAME TR_PrintText -- Prints a line of text. (V6) SYNOPSIS TR_PrintText(Project, RastPort, Text, X, Y, Width, Flags) A0 A1 A2 D1 D2 D3 D0 VOID TR_PrintText(struct TR_Project *, struct RastPort *, STRPTR, ULONG, ULONG, ULONG, ULONG); FUNCTION Prints a text into the specified RastPort (or into the project's default RastPort if the supplied RastPort is NULL. If you specify TRTX_MULTILINE some formatting sequences may appear in the text: - A <newline> (\n) will start a new line with a small space above it. - A <return> (\r) will add a normal space instead. - A <tab> (\t) will add a normal space, then a 3D separator line and again a normal space. The following sequences are allowed at the beginning of a line only: - '%b' switches to boldface, - '%3' and '%s' (V2+) to 3D text, - '%h' to highlight - and '%n' to normal style. - '%%' inserts a '%' character. SEE ALSO TR_TextWidth() triton.library/TR_ReleaseWindow triton.library/TR_ReleaseWindow NAME TR_ReleaseWindow -- Release a project's window. (V3) SYNOPSIS TR_ReleaseWindow(Window) A0 VOID TR_ReleaseWindow(struct Window *); FUNCTION Unlock a window which has been locked by TR_ObtainWindow(). All locked windows must be unlocked! Locking/unlocking calls are nested. SEE ALSO TR_ObtainWindow() triton.library/TR_ReplyMsg triton.library/TR_ReplyMsg NAME TR_ReplyMsg -- Replies a Triton message. SYNOPSIS TR_ReplyMsg(Message) A1 VOID TR_ReplyMsg(struct TR_Message *); FUNCTION Replies a message received by TR_GetMsg(). SEE ALSO TR_GetMsg(), TR_Wait() triton.library/TR_SendMessage triton.library/TR_SendMessage NAME TR_SendMessage -- Send a message to one or more objects. (V4) SYNOPSIS TR_SendMessage(Project, ID, MessageID, MessageData) A0 D0 D1 A1 ULONG TR_SendMessage(struct TR_Project *, ULONG, ULONG, void *); FUNCTION Sends an object message, specified by its ID (TROM_...) and the message data to one or more objects of a project which share the specified ID. By specifying an ID of NULL, you can send a message to the project itself. SEE ALSO Class descriptions, TR_SetAttribute, TR_GetAttribute() triton.library/TR_SetAttribute triton.library/TR_SetAttribute NAME TR_SetAttribute -- Sets an attribute of an object. SYNOPSIS TR_SetAttribute(Project, ID, Attribute, Value) A0 D0 D1 D2 VOID TR_SetAttribute(struct TR_Project *, ULONG, ULONG, ULONG); FUNCTION Sets an attribute of a Triton object. Only attributes of objects with an ID can be changed. You can change the default attribute of an object by specifying 0 as the attribute to change. By specifying an ID of 0, you can change those attributes of a Triton project which are marked with '(changeable)' in the TR_OpenProject docs. SEE ALSO Class descriptions, TR_GetAttribute(), TR_OpenProject() triton.library/TR_TextHeight triton.library/TR_TextHeight NAME TR_TextWidth -- Returns text height. (V6) SYNOPSIS Height = TR_TextHeight(Project, Text, Flags) A0 A2 D0 ULONG TR_TextHeight(struct TR_Project *, STRPTR, ULONG); FUNCTION Returns the height of a text string with the specified TRTX_* flags in the given project. RESULT Height - The height of the text in pixels SEE ALSO TR_TextWidth(), TR_PrintText() triton.library/TR_TextWidth triton.library/TR_TextWidth NAME TR_TextWidth -- Returns text width. (V6) SYNOPSIS Width = TR_TextWidth(Project, Text, Flags) A0 A2 D0 ULONG TR_TextWidth(struct TR_Project *, STRPTR, ULONG); FUNCTION Returns the width of a text string with the specified TRTX_* flags in the given project. RESULT Width - The width of the text in pixels SEE ALSO TR_TextHeight(), TR_PrintText() triton.library/TR_UnlockProject triton.library/TR_UnlockProject NAME TR_UnlockProject -- Unlocks a Triton project. SYNOPSIS TR_UnlockProject(Project) A0 VOID TR_UnlockProject(struct TR_Project *); FUNCTION Unlocks a Triton project previously locked by TR_LockProject(). SEE ALSO TR_LockProject() triton.library/TR_UnlockScreen triton.library/TR_UnlockScreen NAME TR_UnlockScreen -- Release a project's screen SYNOPSIS TR_UnlockScreen(Screen) A0 VOID TR_UnlockScreen(struct Screen *); FUNCTION Unlock a screen which has been locked by TR_LockScreen(). All locked screens must be unlocked! Locking/unlocking calls are nested. SEE ALSO TR_LockScreen() triton.library/TR_Wait triton.library/TR_Wait NAME TR_Wait -- Waits for exec signals. SYNOPSIS Signals = TR_Wait(App, OtherBits) A1 D0 ULONG TR_Wait(struct TR_App *, ULONG); FUNCTION Waits until a signal of the specified application or one of the other signal bits is set. RESULT Signals - The mask of set signals SEE ALSO TR_GetMsg(), TR_ReplyMsg()