home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / dev / mui-2.1.lha / MUI-2.1 / Developer / Autodocs / MUI_Area.doc < prev    next >
Encoding:
Text File  |  1994-07-04  |  22.1 KB  |  905 lines
  1. TABLE OF CONTENTS
  2.  
  3. Area.mui/Area.mui
  4. Area.mui/MUIM_AskMinMax
  5. Area.mui/MUIM_Cleanup
  6. Area.mui/MUIM_Draw
  7. Area.mui/MUIM_HandleInput
  8. Area.mui/MUIM_Hide
  9. Area.mui/MUIM_Setup
  10. Area.mui/MUIM_Show
  11. Area.mui/MUIA_ApplicationObject
  12. Area.mui/MUIA_Background
  13. Area.mui/MUIA_BottomEdge
  14. Area.mui/MUIA_ControlChar
  15. Area.mui/MUIA_Disabled
  16. Area.mui/MUIA_ExportID
  17. Area.mui/MUIA_FixHeight
  18. Area.mui/MUIA_FixHeightTxt
  19. Area.mui/MUIA_FixWidth
  20. Area.mui/MUIA_FixWidthTxt
  21. Area.mui/MUIA_Font
  22. Area.mui/MUIA_Frame
  23. Area.mui/MUIA_FramePhantomHoriz
  24. Area.mui/MUIA_FrameTitle
  25. Area.mui/MUIA_Height
  26. Area.mui/MUIA_HorizWeight
  27. Area.mui/MUIA_InnerBottom
  28. Area.mui/MUIA_InnerLeft
  29. Area.mui/MUIA_InnerRight
  30. Area.mui/MUIA_InnerTop
  31. Area.mui/MUIA_InputMode
  32. Area.mui/MUIA_LeftEdge
  33. Area.mui/MUIA_Pressed
  34. Area.mui/MUIA_RightEdge
  35. Area.mui/MUIA_Selected
  36. Area.mui/MUIA_ShowMe
  37. Area.mui/MUIA_ShowSelState
  38. Area.mui/MUIA_Timer
  39. Area.mui/MUIA_TopEdge
  40. Area.mui/MUIA_VertWeight
  41. Area.mui/MUIA_Weight
  42. Area.mui/MUIA_Width
  43. Area.mui/MUIA_Window
  44. Area.mui/MUIA_WindowObject
  45. Area.mui/Area.mui
  46.  
  47.     Area class is a super class for every other MUI class
  48.     except windows and applications. It holds information
  49.     about an objects current position, size and weight
  50.     and manages frames, fonts and backgrounds.
  51.  
  52.     Additionally, area class handles the user input. By
  53.     setting an objects MUIA_InputMode, you can make it
  54.     behave like a button or like a toggle gadget. That's
  55.     why MUI doesn't offer an extra button class. A button
  56.     is simply a text object with a raised frame and a relverify
  57.     input mode. Since especially group class is a subclass
  58.     of area, you can create rather complex buttons consisting
  59.     of many other display elements.
  60. Area.mui/MUIM_AskMinMax
  61.  
  62.     NAME
  63.     MUIM_AskMinMax (V4)
  64.     [For use within custom classes only]
  65.  
  66.     SYNOPSIS
  67.     DoMethod(obj,MUIM_AskMinMax,struct MUI_MinMax *MinMaxInfo);
  68.  
  69.     FUNCTION
  70.     see developer documentation.
  71. Area.mui/MUIM_Cleanup
  72.  
  73.     NAME
  74.     MUIM_Cleanup (V4)
  75.     [For use within custom classes only]
  76.  
  77.     SYNOPSIS
  78.     DoMethod(obj,MUIM_Cleanup,);
  79.  
  80.     FUNCTION
  81.     see developer documentation.
  82. Area.mui/MUIM_Draw
  83.  
  84.     NAME
  85.     MUIM_Draw (V4)
  86.     [For use within custom classes only]
  87.  
  88.     SYNOPSIS
  89.     DoMethod(obj,MUIM_Draw,ULONG flags);
  90.  
  91.     FUNCTION
  92.     see developer documentation.
  93. Area.mui/MUIM_HandleInput
  94.  
  95.     NAME
  96.     MUIM_HandleInput (V4)
  97.     [For use within custom classes only]
  98.  
  99.     SYNOPSIS
  100.     DoMethod(obj,MUIM_HandleInput,struct IntuiMessage *imsg, LONG muikey);
  101.  
  102.     FUNCTION
  103.     see developer documentation.
  104. Area.mui/MUIM_Hide
  105.  
  106.     NAME
  107.     MUIM_Hide (V4)
  108.     [For use within custom classes only]
  109.  
  110.     SYNOPSIS
  111.     DoMethod(obj,MUIM_Hide,);
  112.  
  113.     FUNCTION
  114.     see developer documentation.
  115. Area.mui/MUIM_Setup
  116.  
  117.     NAME
  118.     MUIM_Setup (V4)
  119.     [For use within custom classes only]
  120.  
  121.     SYNOPSIS
  122.     DoMethod(obj,MUIM_Setup,struct MUI_RenderInfo *RenderInfo);
  123.  
  124.     FUNCTION
  125.     see developer documentation.
  126. Area.mui/MUIM_Show
  127.  
  128.     NAME
  129.     MUIM_Show (V4)
  130.     [For use within custom classes only]
  131.  
  132.     SYNOPSIS
  133.     DoMethod(obj,MUIM_Show,);
  134.  
  135.     FUNCTION
  136.     see developer documentation.
  137. Area.mui/MUIA_ApplicationObject
  138.  
  139.     NAME
  140.     MUIA_ApplicationObject -- (V4) [..G], Object *
  141.  
  142.     FUNCTION
  143.     You can obtain a pointer to the application object
  144.     that some gadget belongs to by using this attribute.
  145.     Useful mainly within callback hooks if you do not want
  146.     to deal with global variables.
  147.  
  148.     SEE ALSO
  149.     MUIA_WindowObject
  150. Area.mui/MUIA_Background
  151.  
  152.     NAME
  153.     MUIA_Background -- (V4) [IS.], LONG
  154.  
  155.     FUNCTION
  156.     Adjust the background for an object.
  157.  
  158.     Every MUI object has its own background setting.
  159.     The background is displayed "behind" the actual
  160.     object contents, e.g. behind a the text of a
  161.     text object or behind the image of an image object.
  162.  
  163.     This attribute takes the same values as MUIA_Image_Spec,
  164.     please refer to autodocs of image class for a complete
  165.     description.
  166.  
  167.     An object without a specific background setting will
  168.     inherit the pattern from its parent group. The default
  169.     background for a window and many other background
  170.     patterns are adjustable with the preferences program.
  171.  
  172.     Only a few MUII_xxxxxxx tags make sense as background.
  173.     Important are:
  174.  
  175.     MUII_ButtonBack:
  176.        You have to set this when you create a button gadget.
  177.        Thus, your button will be displayed in the users
  178.        preferred style.
  179.  
  180.     MUII_TextBack:
  181.        Set this when you create a text object with a TextFrame,
  182.        e.g. some kind of status line. Do *not* use MUII_TextBack
  183.        for simple text without frame (e.g. gadget labels).
  184.  
  185.     MUII_BACKGROUND
  186.     MUII_SHADOW
  187.     MUII_SHINE
  188.     MUII_FILL
  189.     MUII_SHADOWBACK
  190.     MUII_SHADOWFILL
  191.     MUII_SHADOWSHINE
  192.     MUII_FILLBACK
  193.     MUII_FILLSHINE
  194.     MUII_SHINEBACK
  195.     MUII_SHINEBACK2:
  196.        One of MUI's predefined pattern. These are not
  197.        configurable by the user and will always look the
  198.        same.
  199.  
  200.     Note: It is *important* that you test your programs with
  201.           a fancy pattern configuration. With the default
  202.           setting you won't notice any errors in your backgrounds.
  203. Area.mui/MUIA_BottomEdge
  204.  
  205.     NAME
  206.     MUIA_BottomEdge -- (V4) [..G], LONG
  207.  
  208.     FUNCTION
  209.     You can use this to read the current position and
  210.     dimension of an object, if you e.g. need it to pop
  211.     up some requester below.
  212.  
  213.     Of course, this attribute is only valid when the
  214.     parent window of the object is currently open.
  215.  
  216.     SEE ALSO
  217.     MUIA_TopEdge, MUIA_Width, MUIA_Height,
  218.     MUIA_RightEdge, MUIA_LeftEdge
  219. Area.mui/MUIA_ControlChar
  220.  
  221.     NAME
  222.     MUIA_ControlChar -- (V4) [I..], char
  223.  
  224.     FUNCTION
  225.     Pressing the control char will have the same effect
  226.     as pressing return if the object was active.
  227.     
  228.     This can be used to create old style key shortcuts.
  229.  
  230.     Note: Using an uppercase control char will force
  231.           the user to press shift.
  232.  
  233.     SEE ALSO
  234.     mui.h / KeyButton() macro
  235. Area.mui/MUIA_Disabled
  236.  
  237.     NAME
  238.     MUIA_Disabled -- (V4) [ISG], BOOL
  239.  
  240.     FUNCTION
  241.     Disable or enable a gadget. Setting this attribute
  242.     causes a gadget to become disabled, it gets a ghost
  243.     pattern and doesn't respond to user input any longer.
  244.  
  245.     Disabled gadgets cannot be activated with the TAB key.
  246.  
  247.     Using MUIA_Disable on a group of objects will disable
  248.     all objects within that group.
  249.  
  250.     EXAMPLE
  251.     /* we have a radio button gadget with three         */
  252.     /* entries, the third should enable a string gadget */
  253.     /* with additional parameters                       */
  254.  
  255.     DoMethod(radio, MUIM_Notify, MUIA_Radio_Active, 0,
  256.        string, 3, MUIM_Set, MUIA_Disabled, TRUE);
  257.  
  258.     DoMethod(radio, MUIM_Notify, MUIA_Radio_Active, 1,
  259.        string, 3, MUIM_Set, MUIA_Disabled, TRUE);
  260.  
  261.     DoMethod(radio, MUIM_Notify, MUIA_Radio_Active, 2,
  262.        string, 3, MUIM_Set, MUIA_Disabled, FALSE);
  263. Area.mui/MUIA_ExportID
  264.  
  265.     NAME
  266.     MUIA_ExportID -- (V4) [ISG], LONG
  267.  
  268.     FUNCTION
  269.     Objects with a non NULL MUIA_ExportID export their
  270.     contents during MUIM_Application_Save and import
  271.     them during MUIM_Application_Load.
  272.  
  273.     You have to use different ExportIDs for your objects!
  274.  
  275.     SEE ALSO
  276.     MUIM_Application_Save, MUIM_Application_Load
  277. Area.mui/MUIA_FixHeight
  278.  
  279.     NAME
  280.     MUIA_FixHeight -- (V4) [I..], LONG
  281.  
  282.     FUNCTION
  283.     Give your object a fixed pixel height. This tag is
  284.     absolutely not needed in a general MUI application
  285.     and only present for emergency situations. Please
  286.     think twice before using it!
  287.  
  288.     EXAMPLE
  289.     /* create an 8x8 pixel rectangle with FILLPEN */
  290.  
  291.     RectangleObject,
  292.        MUIA_FixWidth  , 8,
  293.        MUIA_FixHeight , 8,
  294.        MUIA_Background, MUII_FILL,
  295.        End;
  296.  
  297.     SEE ALSO
  298.     MUIA_FixWidth, MUIA_FixWidthTxt, MUIA_FixHeightTxt
  299. Area.mui/MUIA_FixHeightTxt
  300.  
  301.     NAME
  302.     MUIA_FixHeightTxt -- (V4) [I..], LONG
  303.  
  304.     FUNCTION
  305.     Give your object a fixed pixel height. The height
  306.     will match the height of the given string. This tag is
  307.     absolutely not needed in a general MUI application
  308.     and only present for emergency situations. Please
  309.     think twice before using it!
  310.  
  311.     EXAMPLE
  312.     /* create a fixed size rectangle with FILLPEN */
  313.  
  314.     RectangleObject,
  315.        MUIA_FixWidthTxt , "00:00:00",
  316.        MUIA_FixHeightTxt, "\n\n",
  317.        MUIA_Background  , MUII_FILL,
  318.        End;
  319.  
  320.     SEE ALSO
  321.     MUIA_FixHeight, MUIA_FixWidth, MUIA_FixWidthTxt
  322. Area.mui/MUIA_FixWidth
  323.  
  324.     NAME
  325.     MUIA_FixWidth -- (V4) [I..], LONG
  326.  
  327.     FUNCTION
  328.     Give your object a fixed pixel width. This tag is
  329.     absolutely not needed in a general MUI application
  330.     and only present for emergency situations. Please
  331.     think twice before using it!
  332.  
  333.     EXAMPLE
  334.     /* create an 8x8 pixel rectangle with FILLPEN */
  335.  
  336.     RectangleObject,
  337.        MUIA_FixWidth  , 8,
  338.        MUIA_FixHeight , 8,
  339.        MUIA_Background, MUII_FILL,
  340.        End;
  341.  
  342.     SEE ALSO
  343.     MUIA_FixHeight, MUIA_FixWidthTxt, MUIA_FixHeightTxt
  344. Area.mui/MUIA_FixWidthTxt
  345.  
  346.     NAME
  347.     MUIA_FixWidthTxt -- (V4) [I..], STRPTR
  348.  
  349.     FUNCTION
  350.     Give your object a fixed pixel width. The width
  351.     will match the width of the given string. This tag is
  352.     absolutely not needed in a general MUI application
  353.     and only present for emergency situations. Please
  354.     think twice before using it!
  355.  
  356.     EXAMPLE
  357.     /* create a fixed size rectangle with FILLPEN */
  358.  
  359.     RectangleObject,
  360.        MUIA_FixWidthTxt , "00:00:00",
  361.        MUIA_FixHeightTxt, "\n\n",
  362.        MUIA_Background  , MUII_FILL,
  363.        End;
  364.  
  365.     SEE ALSO
  366.     MUIA_FixHeight, MUIA_FixWidth, MUIA_FixHeightTxt
  367. Area.mui/MUIA_Font
  368.  
  369.     NAME
  370.     MUIA_Font -- (V4) [I.G], struct TextFont *
  371.  
  372.     SPECIAL INPUTS
  373.     MUIV_Font_Inherit
  374.     MUIV_Font_Normal
  375.     MUIV_Font_List
  376.     MUIV_Font_Tiny
  377.     MUIV_Font_Fixed
  378.     MUIV_Font_Title
  379.     MUIV_Font_Big
  380.  
  381.     FUNCTION
  382.     Every MUI object can have its own font, just set it with
  383.     this tag. Objects without an explicit font setting will
  384.     inherit it from their parent group.
  385.  
  386.     You normally won't need to open a font yourself, just
  387.     use one of the predefined values to get a font from
  388.     the users preferences.
  389.  
  390.     EXAMPLE
  391.     /* since the text contains tabs,           */
  392.     /* use the fixed width font for displaying */
  393.  
  394.     msgread = FloattextObject,
  395.        MUIA_Font, MUIV_Font_Fixed,
  396.        ...,
  397.        End;
  398. Area.mui/MUIA_Frame
  399.  
  400.     NAME
  401.     MUIA_Frame -- (V4) [I..], LONG
  402.  
  403.     SPECIAL INPUTS
  404.     MUIV_Frame_None
  405.     MUIV_Frame_Button
  406.     MUIV_Frame_ImageButton
  407.     MUIV_Frame_Text
  408.     MUIV_Frame_String
  409.     MUIV_Frame_ReadList
  410.     MUIV_Frame_InputList
  411.     MUIV_Frame_Prop
  412.     MUIV_Frame_Gauge
  413.     MUIV_Frame_Group
  414.     MUIV_Frame_PopUp
  415.     MUIV_Frame_Virtual
  416.     MUIV_Frame_Slider
  417.     MUIV_Frame_Count
  418.  
  419.     FUNCTION
  420.     Define a frame for the current object. Since area class
  421.     is a superclass for all elements in a window, you can
  422.     assign frames to every object you wish.
  423.  
  424.     You don't adjust the style of your frame directly,
  425.     instead you only specify a type:
  426.  
  427.     MUIV_Frame_Button
  428.        for standard buttons with text in it.
  429.  
  430.     MUIV_Frame_ImageButton
  431.        for small buttons with images, e.g. the arrows
  432.        of a scrollbar.
  433.  
  434.     MUIV_Frame_Text
  435.        for a text field, e.g. a status line display.
  436.  
  437.     MUIV_Frame_String
  438.        for a string gadget.
  439.  
  440.     MUIV_Frame_ReadList
  441.        for a read only list.
  442.  
  443.     MUIV_Frame_InputList
  444.        for a list that handles input (has a cursor).
  445.  
  446.     MUIV_Frame_Prop
  447.        for proportional gadgets.
  448.  
  449.     MUIV_Frame_Group
  450.        for groups.
  451.  
  452.     How the frame is going to look is adjustable via the
  453.     preferences program.
  454.  
  455.     Four spacing values belong to each frame that tell
  456.     MUI how many pixels should be left free between the
  457.     frame and its contents. These spacing values are also
  458.     user adjustable as long as you don't override them
  459.     with one of the MUIA_InnerXXXX tags.
  460.  
  461.     Note: The first object in a window (MUIA_Window_RootObject)
  462.           may *not* have a frame. If you need this you will have
  463.           to create a dummy group with just one child.
  464.  
  465.     EXAMPLE
  466.     strobj = StringObject,
  467.        MUIA_Frame, MUIV_Frame_String,
  468.        End;
  469.  
  470.     SEE ALSO
  471.     MUIA_InnerLeft, MUIA_InnerRight, MUIA_InnerTop,
  472.     MUIA_InnerBottom
  473. Area.mui/MUIA_FramePhantomHoriz
  474.  
  475.     NAME
  476.     MUIA_FramePhantomHoriz -- (V4) [I..], BOOL
  477.  
  478.     FUNCTION
  479.     Setting this to TRUE causes the specified frame to be
  480.     a horizontal phantom frame. The frame will not appear
  481.     but its vertical components (frame height, inner
  482.     top and inner bottom spacing) will be used to calculate
  483.     positions and dimensions (horizontal components are
  484.     treated as 0).
  485.  
  486.     This is extremely useful for a correct labeling of objects.
  487.     You would e.g. label a string gadget by using a text object
  488.     with a phantom string frame. Thus, the label text will
  489.     be always on the same vertical position as the string
  490.     gadget text, no matter what spacing values the user
  491.     configured.
  492.  
  493.     SEE ALSO
  494.     Label() macros in "mui.h".
  495. Area.mui/MUIA_FrameTitle
  496.  
  497.     NAME
  498.     MUIA_FrameTitle -- (V4) [I..], STRPTR
  499.  
  500.     FUNCTION
  501.     This tag identifies a text string that will be displayed
  502.     centered in the top line of a frame. This can become
  503.     handy if you want to name groups of objects.
  504.  
  505.     You may not use MUIA_FrameTitle without defining
  506.     a MUIA_Frame.
  507.  
  508.     EXAMPLE
  509.     VGroup,
  510.        MUIA_Frame     , MUIV_Frame_Group,
  511.        MUIA_FrameTitle, "Spacing",
  512.        ...
  513.  
  514.     SEE ALSO
  515.     MUIA_Frame
  516. Area.mui/MUIA_Height
  517.  
  518.     NAME
  519.     MUIA_Height -- (V4) [..G], LONG
  520.  
  521.     FUNCTION
  522.     You can use this to read the current position and
  523.     dimension of an object, if you e.g. need it to pop
  524.     up some requester below.
  525.  
  526.     Of course, this attribute is only valid when the
  527.     parent window of the object is currently open.
  528.  
  529.     SEE ALSO
  530.     MUIA_TopEdge, MUIA_Width, MUIA_LeftEdge,
  531.     MUIA_RightEdge, MUIA_BottomEdge
  532. Area.mui/MUIA_HorizWeight
  533.  
  534.     NAME
  535.     MUIA_HorizWeight -- (V4) [I..], LONG
  536.  
  537.     FUNCTION
  538.     Adjust the horizontal weight of an object. Usually
  539.     you can simply use MUIA_Weight instead of this tag
  540.     but in some two-dimensional groups it may become
  541.     handy to have different horizontal and vertical 
  542.     weights.
  543.  
  544.     SEE ALSO
  545.     MUIA_Weight
  546. Area.mui/MUIA_InnerBottom
  547.  
  548.     NAME
  549.     MUIA_InnerBottom -- (V4) [I..], LONG
  550.  
  551.     FUNCTION
  552.     Adjust the space between an object and its frame.
  553.     Usually you shouldn't use this tag since you will
  554.     override the users preferred default setting.
  555.  
  556.     SEE ALSO
  557.     MUIA_Frame
  558. Area.mui/MUIA_InnerLeft
  559.  
  560.     NAME
  561.     MUIA_InnerLeft -- (V4) [I..], LONG
  562.  
  563.     FUNCTION
  564.     Adjust the space between an object and its frame.
  565.     Usually you shouldn't use this tag since you will
  566.     override the users preferred default setting.
  567.  
  568.     SEE ALSO
  569.     MUIA_Frame
  570. Area.mui/MUIA_InnerRight
  571.  
  572.     NAME
  573.     MUIA_InnerRight -- (V4) [I..], LONG
  574.  
  575.     FUNCTION
  576.     Adjust the space between an object and its frame.
  577.     Usually you shouldn't use this tag since you will
  578.     override the users preferred default setting.
  579.  
  580.     SEE ALSO
  581.     MUIA_Frame
  582. Area.mui/MUIA_InnerTop
  583.  
  584.     NAME
  585.     MUIA_InnerTop -- (V4) [I..], LONG
  586.  
  587.     FUNCTION
  588.     Adjust the space between an object and its frame.
  589.     Usually you shouldn't use this tag since you will
  590.     override the users preferred default setting.
  591.  
  592.     SEE ALSO
  593.     MUIA_Frame
  594. Area.mui/MUIA_InputMode
  595.  
  596.     NAME
  597.     MUIA_InputMode -- (V4) [I..], LONG
  598.  
  599.     SPECIAL INPUTS
  600.     MUIV_InputMode_None
  601.     MUIV_InputMode_RelVerify
  602.     MUIV_InputMode_Immediate
  603.     MUIV_InputMode_Toggle
  604.  
  605.     FUNCTION
  606.     Adjust the input mode for an object.
  607.  
  608.     MUI has no distinct button class. Instead you can make
  609.     every object (even groups) behave like a button by
  610.     setting an input mode for them. Several input modes
  611.     area available:
  612.  
  613.     MUIV_InputMode_None:
  614.        No input, this is not a gadget.
  615.  
  616.     MUIV_InputMode_RelVerify:
  617.        For buttons and similar stuff.
  618.  
  619.     MUIV_InputMode_Immediate:
  620.        Used e.g. in a radio button object.
  621.  
  622.     MUIV_InputMode_ToggleSelect:
  623.        For things like checkmark gadgets.
  624.  
  625.     The input mode setting determines how a user action
  626.     will trigger the attributes MUIA_Selected, MUIA_Pressed
  627.     and MUIA_Timer. See their documentation for details.
  628.  
  629.     EXAMPLE
  630.     /* A traditional button, just a text object with */
  631.     /* a button frame and a relverify input mode:    */
  632.  
  633.     okbutton = TextObject,
  634.        MUIA_Frame        , MUIV_Frame_Button,
  635.        MUIA_InputMode    , MUIV_InputMode_RelVerify,
  636.        MUIA_Text_Contents, "OK",
  637.        ...
  638.  
  639.     SEE ALSO
  640.     MUIA_Selected, MUIA_Timer, MUIA_Pressed
  641. Area.mui/MUIA_LeftEdge
  642.  
  643.     NAME
  644.     MUIA_LeftEdge -- (V4) [..G], LONG
  645.  
  646.     FUNCTION
  647.     You can use this to read the current position and
  648.     dimension of an object, if you e.g. need it to pop
  649.     up some requester below.
  650.  
  651.     Of course, this attribute is only valid when the
  652.     parent window of the object is currently open.
  653.  
  654.     SEE ALSO
  655.     MUIA_TopEdge, MUIA_Width, MUIA_Height,
  656.     MUIA_RightEdge, MUIA_BottomEdge
  657. Area.mui/MUIA_Pressed
  658.  
  659.     NAME
  660.     MUIA_Pressed -- (V4) [..G], BOOL
  661.  
  662.     FUNCTION
  663.     Learn if a button is pressed (or released).
  664.     The MUIA_Pressed attribute of a gadget is triggered
  665.     by some user action, depending on the input mode:
  666.  
  667.     MUIV_InputMode_RelVerify:
  668.        - set when lmb is pressed.
  669.        - cleared when lmb is released and the mouse
  670.          is still over the gadget (otherwise it will
  671.          be cleared too, but without triggering a
  672.          notification event).
  673.  
  674.     MUIV_InputMode_Immediate:
  675.        - undefined, use MUIA_Selected for this.
  676.  
  677.     MUIV_InputMode_Toggle:
  678.        - undefined, use MUIA_Selected for this.
  679.  
  680.     Waiting for MUIA_Pressed getting FALSE is the usual
  681.     way to react on button gadgets.
  682.  
  683.     EXAMPLE
  684.     DoMethod(btcancel,MUIM_Notify,MUIA_Pressed,FALSE,
  685.        app,2,MUIM_Application_ReturnID,ID_CANCEL);
  686.  
  687.     SEE ALSO
  688.     MUIA_Selected, MUIA_Timer, MUIA_ShowSelState, MUIA_InputMode
  689. Area.mui/MUIA_RightEdge
  690.  
  691.     NAME
  692.     MUIA_RightEdge -- (V4) [..G], LONG
  693.  
  694.     FUNCTION
  695.     You can use this to read the current position and
  696.     dimension of an object, if you e.g. need it to pop
  697.     up some requester below.
  698.  
  699.     Of course, this attribute is only valid when the
  700.     parent window of the object is currently open.
  701.  
  702.     SEE ALSO
  703.     MUIA_TopEdge, MUIA_Width, MUIA_Height,
  704.     MUIA_LeftEdge, MUIA_BottomEdge
  705. Area.mui/MUIA_Selected
  706.  
  707.     NAME
  708.     MUIA_Selected -- (V4) [ISG], BOOL
  709.  
  710.     FUNCTION
  711.     Get and set the selected state of a gadget.
  712.     This attribute can be triggered by the user
  713.     clicking on the gadget (or using the keyboard),
  714.     depending on the input mode:
  715.  
  716.     MUIV_InputMode_RelVerify:
  717.        - set when lmb is pressed.
  718.        - cleared when lmb is released.
  719.        - cleared when the gadget is selected and the
  720.          mouse leaves the gadget box.
  721.        - set when the mouse reenters the gadget box.
  722.  
  723.     MUIV_InputMode_Immediate:
  724.        - set when lmb is pressed.
  725.  
  726.     MUIV_InputMode_Toggle:
  727.        - toggled when lmb is pressed.
  728.  
  729.     Of course you may set this attribute yourself, e.g.
  730.     to adjust the state of a checkmark gadget.
  731.  
  732.     A selected gadget will display its border reverse
  733.     and get the configured MUII_SelectedBack background.
  734.     This can be avoided using the MUIA_ShowSelState tag.
  735.  
  736.     SEE ALSO
  737.     MUIA_Pressed, MUIA_Timer, MUIA_ShowSelState, MUIA_InputMode
  738. Area.mui/MUIA_ShowMe
  739.  
  740.     NAME
  741.     MUIA_ShowMe -- (V4) [ISG], BOOL
  742.  
  743.     FUNCTION
  744.     Objects with this attribute set are not displayed. You can
  745.     set MUIA_ShowMe at any time, causing objects to appear and
  746.     to disappear immediately. A new layout is calculated whenever
  747.     some objects are shown or hidden. When necessary, MUI will
  748.     resize the parent window to make place for the new objects.
  749.  
  750.     NOTE
  751.     Currently, MUI does a complete window refresh after
  752.     showing/hiding objects. This behaviour might get improved
  753.     in the future.
  754. Area.mui/MUIA_ShowSelState
  755.  
  756.     NAME
  757.     MUIA_ShowSelState -- (V4) [I..], BOOL
  758.  
  759.     FUNCTION
  760.     Normally a gadget will reverse its frame and
  761.     display the configured MUII_SelectetBack background
  762.     pattern in its selected state. For some objects
  763.     (e.g. checkmarks) this is not recommended and
  764.     can be supressed by setting MUIA_ShowSelState
  765.     to FALSE.
  766.  
  767.     SEE ALSO
  768.     MUIA_Selected
  769. Area.mui/MUIA_Timer
  770.  
  771.     NAME
  772.     MUIA_Timer -- (V4) [..G], LONG
  773.  
  774.     FUNCTION
  775.     MUIA_Timer gets triggered when a relverify button is 
  776.     pressed and (after a little delay) increases every 
  777.     INTUITICK as long as the mouse remains over the gadget.
  778.  
  779.     This makes it possible to have buttons repeatedly
  780.     cause some actions, just like the arrow gadgets of
  781.     a scrollbar.
  782.  
  783.     EXAMPLE
  784.     DoMethod(btmore,MUIM_Notify,MUIA_Timer,MUIV_EveryTime,
  785.        app,2,MUIM_Application_ReturnID,ID_MORE);
  786.  
  787.     DoMethod(btless,MUIM_Notify,MUIA_Timer,MUIV_EveryTime,
  788.        app,2,MUIM_Application_ReturnID,ID_LESS);
  789.  
  790.     SEE ALSO
  791.     MUIA_Pressed, MUIA_Selected
  792. Area.mui/MUIA_TopEdge
  793.  
  794.     NAME
  795.     MUIA_TopEdge -- (V4) [..G], LONG
  796.  
  797.     FUNCTION
  798.     You can use this to read the current position and
  799.     dimension of an object, if you e.g. need it to pop
  800.     up some requester below.
  801.  
  802.     Of course, this attribute is only valid when the
  803.     parent window of the object is currently open.
  804.  
  805.     SEE ALSO
  806.     MUIA_LeftEdge, MUIA_Width, MUIA_Height,
  807.     MUIA_RightEdge, MUIA_BottomEdge
  808. Area.mui/MUIA_VertWeight
  809.  
  810.     NAME
  811.     MUIA_VertWeight -- (V4) [I..], LONG
  812.  
  813.     FUNCTION
  814.     Adjust the vertical weight of an object. Usually
  815.     you can simply use MUIA_Weight instead of this tag
  816.     but in some two-dimensional groups it may become
  817.     handy to have different horizontal and vertical
  818.     weights.
  819.  
  820.     SEE ALSO
  821.     MUIA_Weight
  822. Area.mui/MUIA_Weight
  823.  
  824.     NAME
  825.     MUIA_Weight -- (V4) [I..], LONG
  826.  
  827.     FUNCTION
  828.     This tag is a shorthand for MUIA_HorizWeight and
  829.     MUIA_VertHeight, it sets both weights at once.
  830.  
  831.     The weight of an object determines how much room it
  832.     will get during the layout process. Imagine you have
  833.     a 100 pixel wide horizontal group with two string
  834.     gadgets. Usually, each gadget will get half of the
  835.     room and be 50 pixels wide. If you feel the left
  836.     gadget is more important and should be bigger,
  837.     you can give it a weight of 200 (and 100 for
  838.     the right gadget). Because the left gadget is
  839.     twice as "heavy" as the right gadget, it will
  840.     become twice as big (about 66 pixel) as the
  841.     right one (34 pixel).
  842.  
  843.     Of course giving weights only makes sense if the
  844.     object is resizable. A MUIA_VertWeight for a
  845.     (always fixed height) string gadget is useless.
  846.  
  847.     An object with a weight of 0 will always stay
  848.     at its minimum size.
  849.  
  850.     By default, all objects have a weight of 100.
  851.  
  852.     EXAMPLE
  853.     HGroup,
  854.        StringGadget, MUIA_Weight,  50, End,
  855.        StringGadget, MUIA_Weight, 100, End,
  856.        StringGadget, MUIA_Weight, 200, End,
  857.        End;
  858.  
  859.     SEE ALSO
  860.     MUIA_HorizWeight, MUIA_VertWeight
  861. Area.mui/MUIA_Width
  862.  
  863.     NAME
  864.     MUIA_Width -- (V4) [..G], LONG
  865.  
  866.     FUNCTION
  867.     You can use this to read the current position and
  868.     dimension of an object, if you e.g. need it to pop
  869.     up some requester below.
  870.  
  871.     Of course, this attribute is only valid when the
  872.     parent window of the object is currently open.
  873.  
  874.     SEE ALSO
  875.     MUIA_TopEdge, MUIA_LeftEdge, MUIA_Height,
  876.     MUIA_RightEdge, MUIA_BottomEdge
  877. Area.mui/MUIA_Window
  878.  
  879.     NAME
  880.     MUIA_Window -- (V4) [..G], struct Window *
  881.  
  882.     FUNCTION
  883.     This attribute can be used to get a pointer to the
  884.     intuition window structure of the parent window 
  885.     ot the object. This pointer could e.g. be used
  886.     in calls to asl.library.
  887.  
  888.     The result is only valid when the window is opened.
  889.  
  890.     SEE ALSO
  891.     MUIA_Window_Window
  892. Area.mui/MUIA_WindowObject
  893.  
  894.     NAME
  895.     MUIA_WindowObject -- (V4) [..G], Object *
  896.  
  897.     FUNCTION
  898.     You can obtain a pointer to the window object
  899.     that some gadget belongs to by using this attribute.
  900.     Useful mainly within callback hooks if you do not want
  901.     to deal with global variables.
  902.  
  903.     SEE ALSO
  904.     MUIA_ApplicationObject
  905.