@database BST_ApplicationClass.guide @rem Source: BST_ApplicationClass.s @rem Generated with RoboDoc v3.0h (Apr 07 1996) @rem RoboDoc is copyright 1994--1996 by Maverick Software Development @node Main BST_ApplicationClass.guide @{jcenter} @{fg highlight}@{b}TABLE OF CONTENTS@{ub}@{fg text} @{"BST_ApplicationClass/BST_ApplicationInstance " Link "BST_ApplicationInstance"} @{"BST_ApplicationClass/mth_AddEvent_BST_Application " Link "mth_AddEvent_BST_Application"} @{"BST_ApplicationClass/mth_Dispose_BST_Application " Link "mth_Dispose_BST_Application"} @{"BST_ApplicationClass/mth_EventLoop_BST_Application" Link "mth_EventLoop_BST_Application"} @{"BST_ApplicationClass/mth_GetAttr_BST_Application " Link "mth_GetAttr_BST_Application"} @{"BST_ApplicationClass/mth_Init_BST_Application " Link "mth_Init_BST_Application"} @{"BST_ApplicationClass/mth_RemEvent_BST_Application " Link "mth_RemEvent_BST_Application"} @{"BST_ApplicationClass/mth_SetAttr_BST_Application " Link "mth_SetAttr_BST_Application"} @{"Beast/BST_ApplicationClass " Link "BST_ApplicationClass"} @{jleft} @endnode @Node "BST_ApplicationInstance" "BST_ApplicationClass/BST_ApplicationInstance" @{fg shine}BST_ApplicationClass/BST_ApplicationInstance@{fg text} @{b}NAME@{ub} @{b} @{b}BST_ApplicationInstance@{ub} - (under construction) @{ub} @endnode @Node "mth_AddEvent_BST_Application" "BST_ApplicationClass/mth_AddEvent_BST_Application" @{fg shine}BST_ApplicationClass/mth_AddEvent_BST_Application@{fg text} @{b}NAME@{ub} @{b} mth_AddEvent - Add an event. (V1 Bravo) @{ub} @{b}FUNCTION@{ub} Add an event to the list. See @{"OBM_ADDEVENT" Link "Methods.guide/OBM_ADDEVENT"}. @{b}INPUTS@{ub} See @{"OBM_ADDEVENT" Link "Methods.guide/OBM_ADDEVENT"}. TagList - @{"BTA_Signals" Link "TagLists.guide/BTA_Signals"} - af[T( @{"BTA_type_Flags" Link "TagLists.guide/BTA_type_Flags"} )] The signal flag on which the event will react. @{"BTA_MsgPort" Link "TagLists.guide/BTA_MsgPort"} - af[] The Messageport of the event, if available. Intuition GetMsg is used to retrieve the message. @{"BTA_Method" Link "TagLists.guide/BTA_Method"} - af[D( OBM_IDMCPOUTPUT )] The method which is triggered when a event occures. @endnode @Node "mth_Dispose_BST_Application" "BST_ApplicationClass/mth_Dispose_BST_Application" @{fg shine}BST_ApplicationClass/mth_Dispose_BST_Application@{fg text} @{b}NAME@{ub} @{b} mth_Dispose - Dispose the object. (V1 Bravo) @{ub} @endnode @Node "mth_EventLoop_BST_Application" "BST_ApplicationClass/mth_EventLoop_BST_Application" @{fg shine}BST_ApplicationClass/mth_EventLoop_BST_Application@{fg text} @{b}NAME@{ub} @{b} mth_EventLoop - Enter the eventloop. (V1 Bravo) @{ub} @{b}FUNCTION@{ub} The eventloop is entered. See @{"OBM_EVENTLOOP" Link "Methods.guide/OBM_EVENTLOOP"}. The method returns when a BREAK_CTRL_C signal is received, or the object will be destroyed. The triggered method are supplied with an TagList containing the following tags. @{"BTA_Message" Link "TagLists.guide/BTA_Message"} - af[A] Pointer to a Intuition Message structure. @{"BTA_MainObject" Link "TagLists.guide/BTA_MainObject"} - af[A] Pointer to this Application object. @{b}INPUTS@{ub} See @{"OBM_EVENTLOOP" Link "Methods.guide/OBM_EVENTLOOP"}. @endnode @Node "mth_GetAttr_BST_Application" "BST_ApplicationClass/mth_GetAttr_BST_Application" @{fg shine}BST_ApplicationClass/mth_GetAttr_BST_Application@{fg text} @{b}NAME@{ub} @{b} mth_GetAttr - Get attributes. (V1 Bravo) @{ub} @{b}FUNCTION@{ub} Get the application attributes. See @{"OBM_GETATTR" Link "Methods.guide/OBM_GETATTR"} @{b}INPUTS@{ub} See @{"mth_GetAttr_BST_BaseClass" Link "BST_BaseClass.guide/mth_GetAttr_BST_BaseClass"}. TagList - @{"BTA_Signals" Link "TagLists.guide/BTA_Signals"} - af[IFT( @{"BTA_type_Flags" Link "TagLists.guide/BTA_type_Flags"} )] The current application wait signals. @endnode @Node "mth_Init_BST_Application" "BST_ApplicationClass/mth_Init_BST_Application" @{fg shine}BST_ApplicationClass/mth_Init_BST_Application@{fg text} @{b}NAME@{ub} @{b} mth_Init - Init object. (V1 Bravo) @{ub} @{b}FUNCTION@{ub} Init the object. Function equal to the @{"OBM_SETATTR" Link "Methods.guide/OBM_SETATTR"} method. @{b}SEE ALSO@{ub} mth_SetAttr_BST_ApplicationClass @endnode @Node "mth_RemEvent_BST_Application" "BST_ApplicationClass/mth_RemEvent_BST_Application" @{fg shine}BST_ApplicationClass/mth_RemEvent_BST_Application@{fg text} @{b}NAME@{ub} @{b} mth_RemEvent - Remove event. (V1 Bravo) @{ub} @{b}FUNCTION@{ub} Remove an event from the list. See @{"OBM_REMEVENT" Link "Methods.guide/OBM_REMEVENT"}. @{b}INPUTS@{ub} See @{"OBM_REMEVENT" Link "Methods.guide/OBM_REMEVENT"}. TagList - @{"BTA_Signals" Link "TagLists.guide/BTA_Signals"} - af[T( @{"BTA_type_Flags" Link "TagLists.guide/BTA_type_Flags"} )] The event with this signal is removed. If the tag is not supplied (or is 0) all events of the @{"BTA_MainObject" Link "TagLists.guide/BTA_MainObject"} are removed. @endnode @Node "mth_SetAttr_BST_Application" "BST_ApplicationClass/mth_SetAttr_BST_Application" @{fg shine}BST_ApplicationClass/mth_SetAttr_BST_Application@{fg text} @{b}NAME@{ub} @{b} mth_SetAttr - Set Attributes(V1 Bravo) @{ub} @{b}FUNCTION@{ub} Set the application class attributes. See @{"OBM_SETATTR" Link "Methods.guide/OBM_SETATTR"}. @{b}INPUTS@{ub} See @{"mth_SetAttr_BST_BaseClass" Link "BST_BaseClass.guide/mth_SetAttr_BST_BaseClass"}. TagList - @{"BTA_Signals" Link "TagLists.guide/BTA_Signals"} - af[IFT( @{"BTA_type_Flags" Link "TagLists.guide/BTA_type_Flags"} )] Set the current application wait signals. @{"BTA_Signals_AND" Link "TagLists.guide/BTA_Signals_AND"} - af[IFT( @{"BTA_type_Flags" Link "TagLists.guide/BTA_type_Flags"} )] And the value with the current application wait signals. @{"BTA_Signals_OR" Link "TagLists.guide/BTA_Signals_OR"} - af[IFT( @{"BTA_type_Flags" Link "TagLists.guide/BTA_type_Flags"} )] Or the value with the current application wait signals. @{"BTA_Signals_XOR" Link "TagLists.guide/BTA_Signals_XOR"} - af[IFT( @{"BTA_type_Flags" Link "TagLists.guide/BTA_type_Flags"} )] Xor the value with the current application wait signals. @endnode @Node "BST_ApplicationClass" "Beast/BST_ApplicationClass" @{fg shine}Beast/BST_ApplicationClass@{fg text} @{b}NAME@{ub} @{b} @{b}BST_ApplicationClass@{ub} -- (V1 Bravo) @{ub} @{b}COPYRIGHT@{ub} Maverick Software Development SUPERCLASS @{"BST_BaseClass" Link "BST_BaseClass.guide/BST_BaseClass"} @{b}FUNCTION@{ub} The general Application classes, does the event handling. The method names are defined as follows; mth_[method name]_[class name] The following tokens are used to explain the methods. af[..] = Attribute flags; R = Required, must be supplied. P = When not available, the method will try retrieve it from it's parents. S = This tag is used/filled in by a superclass of this class. E = When supplied the object will act more efficient. D(n) = Default value when it's not supplied and it cannot be retrieved from something else. A = Always supplied by the method. F = This tag is filled in by the method. I = @{"BTF_Ignore" Link "TagLists.guide/BTF_Ignore"} flag is set when processed. T(n) = Extra information about the typeof the tag. @{b}AUTHOR@{ub} @{i} Jacco van Weert @{ui} @{b}CREATION DATE@{ub} 4-Apr-96 @{b}MODIFICATION HISTORY@{ub} @{b}NOTES@{ub} @endnode