home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / mui / mui_developer / autodocs / muimaster.doc < prev   
Text File  |  1997-03-10  |  20KB  |  688 lines
  1. TABLE OF CONTENTS
  2.  
  3. muimaster.library/--background--
  4. muimaster.library/MUI_AllocAslRequest
  5. muimaster.library/MUI_AslRequest
  6. muimaster.library/MUI_CreateCustomClass
  7. muimaster.library/MUI_DeleteCustomClass
  8. muimaster.library/MUI_DisposeObject
  9. muimaster.library/MUI_Error
  10. muimaster.library/MUI_FreeAslRequest
  11. muimaster.library/MUI_FreeClass
  12. muimaster.library/MUI_GetClass
  13. muimaster.library/MUI_MakeObjectA
  14. muimaster.library/MUI_NewObjectA
  15. muimaster.library/MUI_ObtainPen
  16. muimaster.library/MUI_Redraw
  17. muimaster.library/MUI_ReleasePen
  18. muimaster.library/MUI_RequestA
  19. muimaster.library/MUI_RejectIDCMP
  20. muimaster.library/MUI_RequestIDCMP
  21. muimaster.library/MUI_SetError
  22.  
  23.  
  24. muimaster.library/--background--             muimaster.library/--background--
  25.  
  26.     PURPOSE
  27.     muimaster.library contains functions for creating and diposing
  28.     objects, for requester handling and for controlling custom
  29.     classes. Additionally, several of the standard MUI classes are
  30.     built into muimaster.library. For you as a programmer, there
  31.     is no difference between using a builtin class or an external
  32.     class coming as "mui:libs/mui/<foobar>.mui". The MUI object
  33.     generation call takes care of this situation and loads
  34.     external classes automatically when they are needed.
  35.  
  36.  
  37. muimaster.library/MUI_AllocAslRequest   muimaster.library/MUI_AllocAslRequest
  38.  
  39.     NAME
  40.     MUI_AllocAslRequest
  41.  
  42.     FUNCTION
  43.     Provide an interface to asl.library. Using this ensures
  44.     your application will benefit from future expansions
  45.         to MUI's window and iconification handling.
  46.  
  47.     SEE ALSO
  48.     asl.library/AllocAslRequest
  49.  
  50.  
  51. muimaster.library/MUI_AslRequest
  52.  
  53.     NAME
  54.     MUI_AslRequest
  55.  
  56.     FUNCTION
  57.     Provide an interface to asl.library. Using this ensures
  58.     your application will benefit from future expansions
  59.         to MUI's window and iconification handling.
  60.  
  61.     SEE ALSO
  62.     asl.library/AslRequest
  63.  
  64.  
  65. muimaster.library/MUI_CreateCustomClass                 MUI_CreateCustomClass
  66.  
  67.     NAME
  68.     MUI_CreateCustomClass -- create a public/private custom class.
  69.  
  70.     SYNOPSIS
  71.     MUI_CreateCustomClass (base, supername, supermcc, datasize, dispfunc)
  72.                             A0    A1        A2        D0        A3
  73.  
  74.     struct MUI_CustomClass * MUI_CreateCustomClass(
  75.        struct Library *, char *, int, APTR );
  76.  
  77.     FUNCTION
  78.     This function creates a public or private MUI custom class.
  79.     Public custom classes are shared libraries and can be found
  80.     in "libs:mui/<foobar>.mcc". Private classes simply consist
  81.     of a dispatcher and are built into applications.
  82.  
  83.     MUI_CreateCustomClass() returns a pointer to a struct
  84.     MUI_CustomClass which in turn contains a pointer to a
  85.     struct IClass. For private classes, this struct IClass
  86.     pointer needs to be fed to a intuition.library/NewObject()
  87.     call to create new objects.
  88.  
  89.     MUI creates the dispatcher hook for you, you may *not*
  90.     use the IClass->cl_Dispatcher.h_Data field! If you need
  91.     custom data for your dispatcher, use the cl_UserData
  92.     of the IClass structure or the mcc_UserData of the
  93.     MUI_CustomClass structure.
  94.  
  95.     For public classes, MUI makes sure that a6 contains
  96.     a pointer to your library base when your dispatcher
  97.     is called. For private classes, you will need to keep
  98.     track of A4 or similiar things the compiler may need yourself.
  99.  
  100.     INPUTS
  101.     base =      if you create a public class, you have to call
  102.                 MUI_CreateCustomClass() from your libraries
  103.                 init function. In this case, place your library
  104.                 base pointer here. For private classes, you must
  105.                 supply NULL.
  106.  
  107.     supername = super class of your class. This can either
  108.                 be a builtin MUI class ("xyz.mui") or a external
  109.                 custom class ("xyz.mcc").
  110.  
  111.     supermcc =  if (and only if) the super class is a private
  112.                 custom class and hence has no name, you are allowed
  113.                 to pass a NULL supername and a pointer to the
  114.                 MUI_CustomClass structure of the super class here.
  115.  
  116.     datasize =  size of your classes data structure.
  117.  
  118.     dispfunc =  your classes dispatcher function (no hook!).
  119.                 The dispatcher will be called with a struct IClass
  120.                 in a0, with your object in a2 and the message in a1.
  121.  
  122.     RESULT
  123.     A pointer to a struct MUI_CustomClass or NULL to indicate
  124.     an error.
  125.  
  126.     SEE ALSO
  127.     MUI_DeleteCustomClass()
  128.  
  129.  
  130. muimaster.library/MUI_DeleteCustomClass                 MUI_DeleteCustomClass
  131.  
  132.     NAME
  133.     MUI_DeleteCustomClass -- delete a public/private custom class.
  134.  
  135.     SYNOPSIS
  136.     MUI_DeleteCustomClass ( mcc )
  137.                             A0
  138.  
  139.     BOOL MUI_DeleteCustomClass(struct MUI_CustomClass *);
  140.  
  141.     FUNCTION
  142.     Delete a public or private custom class. Note that you
  143.     must not delete classes with outstanding objects or sub
  144.     classes.
  145.  
  146.     INPUTS
  147.     mcc = pointer obtained from MUI_CreateCustomClass().
  148.  
  149.     RESULT
  150.     TRUE if all went well, FALSE if some objects or
  151.     sub classes were still hanging around. Nothing
  152.     will be freed in this case.
  153.  
  154.     SEE ALSO
  155.     MUI_CreateCustomClass()
  156.  
  157.  
  158. muimaster.library/MUI_DisposeObject       muimaster.library/MUI_DisposeObject
  159.  
  160.     NAME
  161.     MUI_DisposeObject -- Delete a MUI object.
  162.  
  163.     SYNOPSIS
  164.     MUI_DisposeObject( object )
  165.                        A0
  166.  
  167.     VOID MUI_DisposeObject( APTR );
  168.  
  169.     FUNCTION
  170.     Deletes a MUI object and all of it's auxiliary data.
  171.     These objects are all created by MUI_NewObject() or NewObject().
  172.     Objects of certain classes "own" other objects, which will also
  173.     be deleted when the object is passed to MUI_DisposeObject().
  174.     Read the per-class documentation carefully to be aware
  175.     of these instances.
  176.  
  177.     INPUTS
  178.     object = abstract pointer to a MUI object returned by
  179.              MUI_NewObject(). The pointer may be NULL, in which case
  180.              this function has no effect.
  181.  
  182.     RESULT
  183.     None.
  184.  
  185.     SEE ALSO
  186.     MUI_NewObjectA(), SetAttrs(), GetAttr().
  187.  
  188.  
  189. muimaster.library/MUI_Error                       muimaster.library/MUI_Error
  190.  
  191.     NAME
  192.     MUI_Error -- Return extra information from the MUI system.
  193.  
  194.     SYNOPSIS
  195.     LONG MUI_Error(VOID);
  196.  
  197.     FUNCTION
  198.     Obsolete. Better use SetIoErr()/IoErr().
  199.  
  200.     SEE ALSO
  201.     MUI_SetError()
  202.  
  203.  
  204. muimaster.library/MUI_FreeAslRequest     muimaster.library/MUI_FreeAslRequest
  205.  
  206.     NAME
  207.     MUI_FreeAslRequest
  208.  
  209.     FUNCTION
  210.     Provide an interface to asl.library. Using this ensures
  211.     your application will benefit from future expansions
  212.         to MUI's window and iconification handling.
  213.  
  214.     SEE ALSO
  215.     asl.library/FreeAslRequest
  216.  
  217.  
  218. muimaster.library/MUI_FreeClass               muimaster.library/MUI_FreeClass
  219.  
  220.     NAME
  221.      MUI_FreeClass -- Free class.
  222.  
  223.     SYNOPSIS
  224.     MUI_FreeClass( classptr )
  225.                    A0
  226.  
  227.     VOID MUI_FreeClass(struct IClass *classptr);
  228.  
  229.     FUNCTION
  230.     This function is obsolete since MUI V8.
  231.     Use MUI_DeleteCustomClass() instead.
  232.  
  233.     SEE ALSO
  234.     MUI_CreateCustomClass(), MUI_DeleteCustomClass()
  235.  
  236.  
  237. muimaster.library/MUI_GetClass                 muimaster.library/MUI_GetClass
  238.  
  239.     NAME
  240.      MUI_GetClass -- Get a pointer to a MUI class.
  241.  
  242.     SYNOPSIS
  243.     class = MUI_GetClass( classid )
  244.     D0                    A0
  245.  
  246.     struct IClass * MUI_GetClass(char *classid);
  247.  
  248.     FUNCTION
  249.     This function is obsolete since MUI V8.
  250.     Use MUI_CreateCustomClass instead.
  251.  
  252.     SEE ALSO
  253.     MUI_CreateCustomClass(), MUI_DeleteCustomClass()
  254.  
  255.  
  256. muimaster.library/MUI_MakeObjectA           muimaster.library/MUI_MakeObjectA
  257.  
  258.     NAME
  259.      MUI_MakeObjectA -- create an object from the builtin object collection.
  260.      MUI_MakeObject -- Varargs stub for MUI_MakeObjectA
  261.  
  262.     SYNOPSIS
  263.     object = MUI_MakeObjectA( objtype, params )
  264.     D0                        D0       A0
  265.  
  266.     Object * MUI_MakeObjectA(ULONG type, ULONG *params);
  267.  
  268.     Object * MUI_MakeObject(ULONG type, ...);
  269.  
  270.     FUNCTION
  271.     Prior to muimaster.library V8, MUI was distributed with several macros
  272.     to help creating often used objects. This practice was easy, but using
  273.     lots of these macros often resulted in big programs. Now, muimaster
  274.     library contains an object library with several often used objects
  275.     already built in.
  276.  
  277.     MUI_MakeObject() takes the type of the object as first parameter and
  278.     a list of additional (type specific) parameters. Note that these
  279.     additional values are *not* a taglist!
  280.  
  281.     See the header file mui.h for documentation on object types and the
  282.     required parameters.
  283.  
  284.     SEE ALSO
  285.     MUI_CreateCustomClass(), MUI_DeleteCustomClass()
  286.  
  287.  
  288. muimaster.library/MUI_NewObjectA             muimaster.library/MUI_NewObjectA
  289.  
  290.    NAME
  291.     MUI_NewObjectA -- Create an object from a class.
  292.     MUI_NewObject -- Varargs stub for MUI_NewObjectA().
  293.  
  294.    SYNOPSIS
  295.     object = MUI_NewObjectA( class, tags )
  296.     D0                       A0     A1
  297.  
  298.     APTR MUI_NewObjectA( char *, struct TagItem * );
  299.  
  300.     object = MUI_NewObject( classID, Tag1, ... )
  301.  
  302.     APTR MUI_NewObject( classID, ULONG, ... );
  303.  
  304.    FUNCTION
  305.     This is the general method of creating objects from MUI classes.
  306.     You specify a class by its ID string. If the class is not
  307.     already in memory or built into muimaster.library, it will be
  308.     loaded using OpenLibrary("mui/%s",0).
  309.  
  310.     You further specify initial "create-time" attributes for the
  311.     object via a TagItem list, and they are applied to the resulting
  312.     generic data object that is returned. The attributes, their meanings,
  313.     attributes applied only at create-time, and required attributes
  314.     are all defined and documented on a class-by-class basis.
  315.  
  316.    INPUTS
  317.     classID = the name/ID string of a MUI class, e.g. "Image.mui".
  318.               Class names are case sensitive!
  319.  
  320.     tagList = pointer to array of TagItems containing attribute/value
  321.               pairs to be applied to the object being created.
  322.  
  323.    RESULT
  324.     A MUI object, which may be used in different contexts such
  325.     as an application, window or gadget, and may be manipulated
  326.     by generic functions. You eventually free the object using
  327.     MUI_DisposeObject().
  328.     NULL indicates failure, more information on the error can be
  329.     obtained with MUI_Error().
  330.  
  331.    BUGS
  332.  
  333.    SEE ALSO
  334.     MUI_DisposeObject(), MUI_Error(), SetAttrs(), GetAttr().
  335.  
  336.  
  337. muimaster.library/MUI_ObtainPen               muimaster.library/MUI_ObtainPen
  338.  
  339.    NAME
  340.     MUI_ObtainPen -- Obtain a drawing pen.
  341.  
  342.    SYNOPSIS
  343.     MUI_ObtainPen ( mri , spec , flags )
  344.                     A0    A1     D0
  345.  
  346.     LONG MUI_ObtainPen
  347.     (
  348.         struct MUI_RenderInfo *mri,
  349.         struct MUI_PenSpec *spec,
  350.         ULONG flags
  351.     );
  352.  
  353.    FUNCTION
  354.     Whenever your application needs custom drawing pens, you should allow
  355.     your user to adjust them with a Poppen class. The result from this
  356.     Poppen class is a struct MUI_PenSpec which you can save somewhere in
  357.     your preferences and use together with MUI_ObtainPen(),
  358.     MUI_ReleasePen() and the MUIPEN() macro to transform the spec into a
  359.     pen number useful for SetAPen().
  360.  
  361.    NOTE
  362.     This function will work under 2.x but will generally perform better
  363.     under 3.x and above.
  364.  
  365.    EXAMPLE
  366.     See demo program Class2.c
  367.  
  368.    SEE ALSO
  369.     MUI_ReleasePen(), Poppen.mui
  370.  
  371. 
  372. muimaster.library/MUI_Redraw                     muimaster.library/MUI_Redraw
  373.  
  374.    NAME
  375.     MUI_Redraw -- Redraw yourself.
  376.  
  377.    SYNOPSIS
  378.     MUI_Redraw( obj, flag )
  379.                 A0   D0
  380.  
  381.     VOID MUI_Redraw( Object *obj, ULONG flag );
  382.  
  383.    FUNCTION
  384.     With MUI_Redraw(), an object tells itself to refresh, e.g. when
  385.     some internal attributes were changed. Calling MUI_Redraw() is
  386.     only legal within a custom class dispatcher, using this function
  387.     within an applications main part is invalid!
  388.  
  389.     Most objects graphical representation in a window depends on some
  390.     attributes. A fuel gauge for example would depend on its
  391.     MUIA_Gauge_Current attribute, an animation object would
  392.     depend on MUIA_Animation_CurrentFrame.
  393.  
  394.     Whenever someone changes such an attribute with a SetAttrs() call,
  395.     the corresponding object receives an OM_SET method with the new
  396.     value. Usually, it could just render itself with some
  397.     graphics.library calls. However, if the object is placed
  398.     in a virtual group or if some other clipping or coordinate
  399.     translation is required, this simple rendering will lead
  400.     into problems.
  401.  
  402.     That's why MUI offers the MUI_Redraw() function call. Instead
  403.     of drawing directly during OM_SET, you should simply call
  404.     MUI_Redraw(). MUI calculates all necessary coordinates
  405.     and clip regions (in case of virtual groups) and then sends
  406.     a MUIM_Draw method to your object.
  407.  
  408.     To emphasize this point again: The only time your object is
  409.     allowed to render something is when you receive a MUIM_Draw
  410.     method. Drawing during other methods is illegal.
  411.  
  412.     Note: As long as no special cases (e.g. virtual groups) are
  413.           present, MUI_Redraw is very quick and calls your MUIM_Draw
  414.           method immediately. No coordinate translations or clip
  415.           regions need to be calculated.
  416.  
  417.    INPUTS
  418.     obj  - pointer to yourself.
  419.     flag - MADF_DRAWOBJECT or MADF_DRAWUPDATE.
  420.            The flag given here affects the objects flags when
  421.            MUI calls the MUIM_Draw method. There are several
  422.            caveats when implementing MUIM_DRAW, see the
  423.            developer documentation for details.
  424.  
  425.    EXAMPLE
  426.  
  427.     /* Note: This example was broken up to version 2.1 of muimaster.doc */
  428.  
  429.     LONG mSet(struct IClass *cl,Object *obj,sruct opSet *msg)
  430.     {
  431.        struct Data *data = INST_DATA(cl,obj);
  432.        struct TagItem *tags,*tag;
  433.  
  434.        for (tags=msg->ops_AttrList;tag=NextTagItem(&tags);)
  435.        {
  436.           switch (tag->ti_Tag)
  437.           {
  438.              case MYATTR_PEN_1:
  439.                 data->pen1 = tag->ti_Data;       /* set the new value  */
  440.                 data->mark = 1;                  /* set internal marker*/
  441.                 MUI_Redraw(obj,MADF_DRAWUPDATE); /* update ourselves   */
  442.                 break;
  443.  
  444.              case MYATTR_PEN_1:
  445.                 data->pen2 = tag->ti_Data;       /* set the new value  */
  446.                 data->mark = 2;                  /* set internal marker*/
  447.                 MUI_Redraw(obj,MADF_DRAWUPDATE); /* update ourselves   */
  448.                 break;
  449.           }
  450.        }
  451.  
  452.        return(DoSuperMethodA(cl,obj,msg));
  453.     }
  454.  
  455.     LONG mDraw(struct IClass *cl,Object *obj,struct MUIP_Draw *msg)
  456.     {
  457.        struct Data *data = INST_DATA(cl,obj);
  458.  
  459.        // ** Note: You *must* call the super method prior to do
  460.        // ** anything else, otherwise msg->flags will not be set
  461.        // ** properly !!!
  462.  
  463.        DoSuperMethodA(cl,obj,msg); // ALWAYS REQUIRED!
  464.  
  465.        if (msg->flags & MADF_DRAWUPDATE)
  466.        {
  467.           /* called as a result of our MUI_Redraw() during
  468.              MUIM_Set method. Depending on our internal
  469.              marker, we render different things. */
  470.  
  471.           switch (data->mark)
  472.           {
  473.              case 1: RenderChangesFromPen1(cl,obj); break;
  474.              case 2: RenderChangesFromPen2(cl,obj); break;
  475.           }
  476.        }
  477.        else if (msg->flags & MADF_DRAWOBJECT)
  478.        {
  479.           /* complete redraw, maybe the window was just opened. */
  480.           DrawObjectCompletely(cl,obj);
  481.        }
  482.  
  483.        /* if MADF_DRAWOBJECT wasn't set, MUI just wanted to update
  484.           the frame or some other part of our object. In this case
  485.           we just do nothing. */
  486.  
  487.         return(0);
  488.     }
  489.  
  490.    SEE ALSO
  491.     area.mui/MUIM_Draw
  492.  
  493.  
  494. muimaster.library/MUI_ReleasePen             muimaster.library/MUI_ReleasePen
  495.  
  496.    NAME
  497.     MUI_ReleasePen -- Release a drawing pen.
  498.  
  499.    SYNOPSIS
  500.     MUI_ReleasePen ( mri , pen )
  501.                      A0    D0
  502.  
  503.     LONG MUI_ReleasePen
  504.     (
  505.         struct MUI_RenderInfo *mri,
  506.         ULONG pen
  507.     );
  508.  
  509.    FUNCTION
  510.     Release a pen obtained with MUI_ObtainPen(). Usually placed
  511.     in the Cleanup method of custom classes.
  512.  
  513.    NOTE
  514.     Do *not* use the MUIPEN() maros when releasing pens!
  515.  
  516.    EXAMPLE
  517.     See demo program Class2.c
  518.  
  519.    SEE ALSO
  520.     MUI_ObtainPen(), Poppen.mui
  521.  
  522. 
  523. muimaster.library/MUI_RequestA                 muimaster.library/MUI_RequestA
  524.  
  525.    NAME
  526.     MUI_RequestA  -- Pop up a MUI requester.
  527.  
  528.    SYNOPSIS
  529.     MUI_RequestA(app,win,flags,title,gadgets,format,params)
  530.                  D0   D1  D2    A0     A1      A2     A3
  531.  
  532.     LONG MUI_RequestA ( APTR app, APTR win, LONGBITS flags,
  533.          char *title, char *gadgets, char *format, APTR params );
  534.  
  535.     LONG MUI_Request ( APTR app, APTR win, LONGBITS flags,
  536.          char *title, char *gadgets, char *format, ...);
  537.  
  538.    FUNCTION
  539.     Pop up a MUI requester. Using a MUI requester instead
  540.     of a standard system requester offers you the possibility
  541.     to include text containing all the text engine format codes.
  542.  
  543.    INPUTS
  544.     app     - The application object. If you leave this
  545.               NULL, MUI_RequestA() will fall back to a
  546.               standard system requester.
  547.  
  548.     win     - Pointer to a window of the application. If
  549.               this is used, the requester will appear centered
  550.               relative to this window.
  551.  
  552.     flags   - For future expansion, must be 0 for now.
  553.  
  554.     title   - Title for the requester window. Defaults to the
  555.               name of the application when NULL (and app!=NULL).
  556.  
  557.     gadgets - Pointer to a string containing the possible answers.
  558.               The format looks like "_Save|_Use|_Test|_Cancel".
  559.               If you precede an entry with a '*', this answer will
  560.               become the active object. Pressing <Return> will
  561.               terminate the requester with this response. A '_'
  562.               character indicates the keyboard shortcut for this
  563.               response.
  564.  
  565.     format  - A printf-style formatting string.
  566.  
  567.     params  - Pointer to an array of ULONG containing the parameter
  568.               values for format.
  569.  
  570.    RESULT
  571.     0, 1, ..., N = Successive id values, for the gadgets
  572.     you specify for the requester.  NOTE: The numbering
  573.     from left to right is actually: 1, 2, ..., N, 0.
  574.     In case of a problem (e.g. out of memory), the
  575.     function returns FALSE.
  576.  
  577.    SEE ALSO
  578.     MUIA_Text_Contents
  579.  
  580.  
  581. muimaster.library/MUI_RejectIDCMP           muimaster.library/MUI_RejectIDCMP
  582.  
  583.    NAME
  584.      MUI_RejectIDCMP -- Reject previously requested input events.
  585.  
  586.    SYNOPSIS
  587.     MUI_RejectIDCMP( obj, flags )
  588.                       A0   D0
  589.  
  590.     VOID MUI_RejectIDCMP( Object *obj, ULONG flags );
  591.  
  592.    FUNCTION
  593.     Reject previously requested input events. You should
  594.     ensure that you reject all input events you requested
  595.     for an object before it gets disposed. Rejecting
  596.     flags that you never requested has no effect.
  597.  
  598.     Critical flags such as IDCMP_MOUSEMOVE and IDCMP_INTUITICKS
  599.     should be rejected as soon as possible. See MUI_RequestIDCMP()
  600.     for details.
  601.  
  602.    INPUTS
  603.     obj   - pointer to yourself as an object.
  604.     flags - one or more IDCMP_XXXX flags.
  605.  
  606.    EXAMPLE
  607.     LONG CleanupMethod(struct IClass *cl, Object *obj, Msg msg)
  608.     {
  609.        MUI_RejectIDCMP( obj, IDCMP_MOUSEBUTTONS|IDCMP_RAWKEY );
  610.        return(DoSuperMethodA(cl,obj,msg));
  611.     }
  612.  
  613.    SEE ALSO
  614.     MUI_RequestIDMCP()
  615.  
  616.  
  617. muimaster.library/MUI_RequestIDCMP         muimaster.library/MUI_RequestIDCMP
  618.  
  619.    NAME
  620.      MUI_RequestIDCMP -- Request input events for your custom class.
  621.  
  622.    SYNOPSIS
  623.     MUI_RequestIDCMP( obj, flags )
  624.                       A0   D0
  625.  
  626.     VOID MUI_RequestIDCMP( Object *obj, ULONG flags );
  627.  
  628.    FUNCTION
  629.     If your custom class needs to do some input handling, you must
  630.     explicitly request the events you want to receive. You can
  631.     request (and reject) events at any time.
  632.  
  633.     Whenever an input event you requested arrives at your parent
  634.     windows message port, your object will receive a
  635.     MUIM_HandleInput method.
  636.  
  637.     Note: Time consuming IDCMP flags such as IDCMP_INTUITICKS and
  638.           IDCMP_MOUSEMOVE should be handled with care. Too many
  639.           objects receiving them will degrade performance With
  640.           the following paragraph in mind, this isn't really
  641.           a problem:
  642.  
  643.           You should try to request critical events only when you
  644.           really need them and reject them with MUI_RejectIDCMP()
  645.           as soon as possible. Usually, mouse controlled objects
  646.           only need MOUSEMOVES and INTUITICKS when a button
  647.           is pressed. You should request these flags only
  648.           on demand, i.e. after receiving a mouse down event
  649.           and reject them immediately after the button has been
  650.           released.
  651.  
  652.    INPUTS
  653.     obj   - pointer to yourself as an object.
  654.     flags - one or more IDCMP_XXXX flags.
  655.  
  656.    EXAMPLE
  657.     LONG SetupMethod(struct IClass *cl, Object *obj, Msg msg)
  658.     {
  659.        if (!DoSuperMethodA(cl,obj,msg))
  660.           return(FALSE);
  661.  
  662.        /* do some setup here... */
  663.        ...;
  664.  
  665.        /* i need mousebutton events and keyboard */
  666.        MUI_RequestIDCMP( obj, IDCMP_MOUSEBUTTONS|IDCMP_RAWKEY );
  667.  
  668.        return(TRUE);
  669.     }
  670.  
  671.    SEE ALSO
  672.     MUI_RejectIDMCP()
  673.  
  674.  
  675. muimaster.library/MUI_SetError                 muimaster.library/MUI_SetError
  676.  
  677.    NAME
  678.      MUI_SetError -- Set an error value.
  679.  
  680.    SYNOPSIS
  681.     VOID MUI_SetError(LONG);
  682.  
  683.    FUNCTION
  684.     Obsolete. Better use SetIoErr()/IoErr().
  685.  
  686.    SEE ALSO
  687.     MUI_Error()
  688.