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_Window.doc < prev    next >
Encoding:
Text File  |  1994-07-04  |  24.0 KB  |  921 lines
  1. TABLE OF CONTENTS
  2.  
  3. Window.mui/Window.mui
  4. Window.mui/MUIM_Window_GetMenuCheck
  5. Window.mui/MUIM_Window_GetMenuState
  6. Window.mui/MUIM_Window_ScreenToBack
  7. Window.mui/MUIM_Window_ScreenToFront
  8. Window.mui/MUIM_Window_SetCycleChain
  9. Window.mui/MUIM_Window_SetMenuCheck
  10. Window.mui/MUIM_Window_SetMenuState
  11. Window.mui/MUIM_Window_ToBack
  12. Window.mui/MUIM_Window_ToFront
  13. Window.mui/MUIA_Window_Activate
  14. Window.mui/MUIA_Window_ActiveObject
  15. Window.mui/MUIA_Window_AltHeight
  16. Window.mui/MUIA_Window_AltLeftEdge
  17. Window.mui/MUIA_Window_AltTopEdge
  18. Window.mui/MUIA_Window_AltWidth
  19. Window.mui/MUIA_Window_AppWindow
  20. Window.mui/MUIA_Window_Backdrop
  21. Window.mui/MUIA_Window_Borderless
  22. Window.mui/MUIA_Window_CloseGadget
  23. Window.mui/MUIA_Window_CloseRequest
  24. Window.mui/MUIA_Window_DefaultObject
  25. Window.mui/MUIA_Window_DepthGadget
  26. Window.mui/MUIA_Window_DragBar
  27. Window.mui/MUIA_Window_FancyDrawing
  28. Window.mui/MUIA_Window_Height
  29. Window.mui/MUIA_Window_ID
  30. Window.mui/MUIA_Window_InputEvent
  31. Window.mui/MUIA_Window_LeftEdge
  32. Window.mui/MUIA_Window_Menu
  33. Window.mui/MUIA_Window_MenuAction
  34. Window.mui/MUIA_Window_Menustrip
  35. Window.mui/MUIA_Window_NoMenus
  36. Window.mui/MUIA_Window_Open
  37. Window.mui/MUIA_Window_PublicScreen
  38. Window.mui/MUIA_Window_RefWindow
  39. Window.mui/MUIA_Window_RootObject
  40. Window.mui/MUIA_Window_Screen
  41. Window.mui/MUIA_Window_ScreenTitle
  42. Window.mui/MUIA_Window_SizeGadget
  43. Window.mui/MUIA_Window_SizeRight
  44. Window.mui/MUIA_Window_Sleep
  45. Window.mui/MUIA_Window_Title
  46. Window.mui/MUIA_Window_TopEdge
  47. Window.mui/MUIA_Window_Width
  48. Window.mui/MUIA_Window_Window
  49. Window.mui/Window.mui
  50.  
  51.     Objects of window class are used to generate windows and
  52.     supply a place where MUI gadgets feel well. It handles
  53.     the complicated task of window resizing fully automatic,
  54.     you don't need to worry about that.
  55.  
  56.     Windows are children of an application, you cannot use
  57.     a window object without having a parent application
  58.     object. On the other side, the gadgets in a window
  59.     are children of the window, you cannot use MUI gadgets
  60.     without having a parent MUI window.
  61.  
  62.     Creating a window object does not mean to open it
  63.     instantly. This is done later by setting the window's
  64.     MUIA_Window_Open attribute. If your application has
  65.     several windows, the usual way is to create them all
  66.     at once at startup time and open/close it later
  67.     just by setting MUIA_Window_Open.
  68.  
  69.     There is no difference in talking to gadgets whether
  70.     their parent window is open or not. If you e.g. set
  71.     the contents of a string gadget in an open window,
  72.     the gadget will refresh immediately. If the window is
  73.     closed, the gadget just remembers its new setting
  74.     and displays it later.
  75. Window.mui/MUIM_Window_GetMenuCheck
  76.  
  77.     NAME
  78.     MUIM_Window_GetMenuCheck (V4) (OBSOLETE)
  79.  
  80.     SYNOPSIS
  81.     DoMethod(obj,MUIM_Window_GetMenuCheck,ULONG MenuID);
  82.  
  83.     FUNCTION
  84.     Ask whether a checkmark menu item has its
  85.     checkmark set or cleared.
  86.  
  87.     INPUTS
  88.     MenuID - the value you wrote into the
  89.                  UserData field of struct NewMenu.
  90.  
  91.     SEE ALSO
  92.     MUIM_Window_SetMenuCheck, MUIA_Window_Menu
  93. Window.mui/MUIM_Window_GetMenuState
  94.  
  95.     NAME
  96.     MUIM_Window_GetMenuState (V4) (OBSOLETE)
  97.  
  98.     SYNOPSIS
  99.     DoMethod(obj,MUIM_Window_GetMenuState,ULONG MenuID);
  100.  
  101.     FUNCTION
  102.     Ask whether a menu item is enabled or disabled.
  103.  
  104.     INPUTS
  105.     MenuID - the value you wrote into the
  106.                  UserData field of struct NewMenu.
  107.  
  108.     SEE ALSO
  109.     MUIM_Window_SetMenuState, MUIA_Window_Menu
  110. Window.mui/MUIM_Window_ScreenToBack
  111.  
  112.     NAME
  113.     MUIM_Window_ScreenToBack (V4)
  114.  
  115.     SYNOPSIS
  116.     DoMethod(obj,MUIM_Window_ScreenToBack,);
  117.  
  118.     FUNCTION
  119.     Put the window's screen to back. This command is
  120.     only valid when the window is opened.
  121.  
  122.     SEE ALSO
  123.     MUIM_Window_ScreenToFront, MUIM_Window_ToFront,
  124.     MUIM_Window_ToBack
  125. Window.mui/MUIM_Window_ScreenToFront
  126.  
  127.     NAME
  128.     MUIM_Window_ScreenToFront (V4)
  129.  
  130.     SYNOPSIS
  131.     DoMethod(obj,MUIM_Window_ScreenToFront,);
  132.  
  133.     FUNCTION
  134.     Put the window's screen to font. This command is
  135.     only valid when the window is opened.
  136.  
  137.     SEE ALSO
  138.     MUIM_Window_ScreenToBack, MUIM_Window_ToFront,
  139.     MUIM_Window_ToBack
  140. Window.mui/MUIM_Window_SetCycleChain
  141.  
  142.     NAME
  143.     MUIM_Window_SetCycleChain (V4)
  144.  
  145.     SYNOPSIS
  146.     DoMethod(obj,MUIM_Window_SetCycleChain,Object *obj[1]);
  147.  
  148.     FUNCTION
  149.     Set the cycle chain for a window. To make MUI's keyboard
  150.     control work, you need to setup a chain of objects that
  151.     should be activatable with the tab key. This can be
  152.     any objects you wish, MUI supports complete keyboard
  153.     handling even for sliders or listviews.
  154.  
  155.     If you forget to set a cycle chain because you
  156.     are a mouse-man, you certainly will annoy some
  157.     users of your application!
  158.  
  159.     INPUTS
  160.     One or more objects, terminated with a NULL.
  161.  
  162.     EXAMPLE
  163.     DoMethod(window,MUIM_Window_SetCycleChain,
  164.        str1,str2,slide1,list,radio,cycle1,cycle2,NULL);
  165.  
  166.     SEE ALSO
  167.     MUIA_Window_ActiveObject
  168. Window.mui/MUIM_Window_SetMenuCheck
  169.  
  170.     NAME
  171.     MUIM_Window_SetMenuCheck (V4) (OBSOLETE)
  172.  
  173.     SYNOPSIS
  174.     DoMethod(obj,MUIM_Window_SetMenuCheck,ULONG MenuID, LONG stat);
  175.  
  176.     FUNCTION
  177.     Set or clear the checkmark of a menu item.
  178.  
  179.     INPUTS
  180.     MenuID - the value you wrote into the
  181.                  UserData field of struct NewMenu.
  182.  
  183.     set    - TRUE to set checkmark, FALSE to clear
  184.  
  185.     SEE ALSO
  186.     MUIM_Window_GetMenuCheck, MUIA_Window_Menu,
  187. Window.mui/MUIM_Window_SetMenuState
  188.  
  189.     NAME
  190.     MUIM_Window_SetMenuState (V4) (OBSOLETE)
  191.  
  192.     SYNOPSIS
  193.     DoMethod(obj,MUIM_Window_SetMenuState,ULONG MenuID, LONG stat);
  194.  
  195.     FUNCTION
  196.     Enable or disable a menu item.
  197.  
  198.     INPUTS
  199.     MenuID - the value you wrote into the
  200.                  UserData field of struct NewMenu.
  201.  
  202.     set    - TRUE to enable item, FALSE to disable.
  203.  
  204.     SEE ALSO
  205.     MUIM_Window_GetMenuState, MUIA_Window_Menu,
  206. Window.mui/MUIM_Window_ToBack
  207.  
  208.     NAME
  209.     MUIM_Window_ToBack (V4)
  210.  
  211.     SYNOPSIS
  212.     DoMethod(obj,MUIM_Window_ToBack,);
  213.  
  214.     FUNCTION
  215.     Put the window to back. When the window is not currently open,
  216.     this command does simply nothing.
  217.  
  218.     SEE ALSO
  219.     MUIM_Window_ToFront, MUIM_Window_ScreenToFront,
  220.     MUIM_Window_ScreenToBack
  221. Window.mui/MUIM_Window_ToFront
  222.  
  223.     NAME
  224.     MUIM_Window_ToFront (V4)
  225.  
  226.     SYNOPSIS
  227.     DoMethod(obj,MUIM_Window_ToFront,);
  228.  
  229.     FUNCTION
  230.     Put the window to front. When the window is not currently open,
  231.     this command does simply nothing.
  232.  
  233.     SEE ALSO
  234.     MUIM_Window_ToBack, MUIM_Window_ScreenToFront,
  235.     MUIM_Window_ScreenToBack
  236. Window.mui/MUIA_Window_Activate
  237.  
  238.     NAME
  239.     MUIA_Window_Activate -- (V4) [ISG], BOOL
  240.  
  241.     FUNCTION
  242.     Setting this to TRUE will activate the window.
  243.     Setting this to FALSE has no effect.
  244.     The attribute will change whenever the user
  245.     activates/deactivates the window.
  246.  
  247.     Specifying FALSE at object creation time will make
  248.     the window open in an inactive state.
  249. Window.mui/MUIA_Window_ActiveObject
  250.  
  251.     NAME
  252.     MUIA_Window_ActiveObject -- (V4) [.SG], Object *
  253.  
  254.     SPECIAL INPUTS
  255.     MUIV_Window_ActiveObject_None
  256.     MUIV_Window_ActiveObject_Next
  257.     MUIV_Window_ActiveObject_Prev
  258.  
  259.     FUNCTION
  260.     Set the active object in a window as if the user
  261.     would have activated it with the tab key. The
  262.     object has to be in the cycle chain for this
  263.     command to work.
  264.  
  265.     EXAMPLE
  266.     set(window,MUIA_Window_ActiveObject,okaybutton);
  267.  
  268.     SEE ALSO
  269.     MUIM_Window_SetCycleChain
  270. Window.mui/MUIA_Window_AltHeight
  271.  
  272.     NAME
  273.     MUIA_Window_AltHeight -- (V4) [I.G], LONG
  274.  
  275.     SPECIAL INPUTS
  276.     MUIV_Window_AltHeight_MinMax(p)
  277.     MUIV_Window_AltHeight_Visible(p)
  278.     MUIV_Window_AltHeight_Screen(p)
  279.     MUIV_Window_AltHeight_Scaled
  280.  
  281.     FUNCTION
  282.     Specify the alternate (zoomed) height of a window.
  283.     If not present, the alternate height will be the
  284.     minimum height.
  285.  
  286.     SEE ALSO
  287.     MUIA_Window_Height, MUIA_Window_AltWidth
  288. Window.mui/MUIA_Window_AltLeftEdge
  289.  
  290.     NAME
  291.     MUIA_Window_AltLeftEdge -- (V4) [I.G], LONG
  292.  
  293.     SPECIAL INPUTS
  294.     MUIV_Window_AltLeftEdge_Centered
  295.     MUIV_Window_AltLeftEdge_Moused
  296.     MUIV_Window_AltLeftEdge_NoChange
  297.  
  298.     FUNCTION
  299.     Specify the alternate (zoomed) left position of
  300.     a window. This defaults to the standard left
  301.     position.
  302.  
  303.     SEE ALSO
  304.     MUIA_Window_LeftEdge, MUIA_Window_AltTopEdge
  305. Window.mui/MUIA_Window_AltTopEdge
  306.  
  307.     NAME
  308.     MUIA_Window_AltTopEdge -- (V4) [I.G], LONG
  309.  
  310.     SPECIAL INPUTS
  311.     MUIV_Window_AltTopEdge_Centered
  312.     MUIV_Window_AltTopEdge_Moused
  313.     MUIV_Window_AltTopEdge_Delta(p)
  314.     MUIV_Window_AltTopEdge_NoChange
  315.  
  316.     FUNCTION
  317.     Specify the alternate (zoomed) top position of
  318.     a window. This defaults to the standard top
  319.     position.
  320.  
  321.     SEE ALSO
  322.     MUIA_Window_TopEdge, MUIA_Window_AltLeftEdge
  323. Window.mui/MUIA_Window_AltWidth
  324.  
  325.     NAME
  326.     MUIA_Window_AltWidth -- (V4) [I.G], LONG
  327.  
  328.     SPECIAL INPUTS
  329.     MUIV_Window_AltWidth_MinMax(p)
  330.     MUIV_Window_AltWidth_Visible(p)
  331.     MUIV_Window_AltWidth_Screen(p)
  332.     MUIV_Window_AltWidth_Scaled
  333.  
  334.     FUNCTION
  335.     Specify the alternate (zoomed) width of a window.
  336.     If not present, the alternate width will be the
  337.     minimum width.
  338.  
  339.     SEE ALSO
  340.     MUIA_Window_Width, MUIA_Window_AltHeight
  341. Window.mui/MUIA_Window_AppWindow
  342.  
  343.     NAME
  344.     MUIA_Window_AppWindow -- (V5) [I..], BOOL
  345.  
  346.     FUNCTION
  347.     Setting this attribute to TRUE will make this window an
  348.     AppWindow, the user will be able to drop icons on it.
  349.     You can hear about these events by listening to the
  350.     MUIA_AppMessage attribute.
  351.  
  352.     SEE ALSO
  353.     MUIA_AppMessage, MUIA_Application_DropObject
  354. Window.mui/MUIA_Window_Backdrop
  355.  
  356.     NAME
  357.     MUIA_Window_Backdrop -- (V4) [I..], BOOL
  358.  
  359.     FUNCTION
  360.     Make the window a backdrop window.
  361. Window.mui/MUIA_Window_Borderless
  362.  
  363.     NAME
  364.     MUIA_Window_Borderless -- (V4) [I..], BOOL
  365.  
  366.     FUNCTION
  367.     Make the window borderless.
  368. Window.mui/MUIA_Window_CloseGadget
  369.  
  370.     NAME
  371.     MUIA_Window_CloseGadget -- (V4) [I..], BOOL
  372.  
  373.     FUNCTION
  374.     Set this to FALSE and your window will not
  375.     have a close gadget.
  376. Window.mui/MUIA_Window_CloseRequest
  377.  
  378.     NAME
  379.     MUIA_Window_CloseRequest -- (V4) [..G], BOOL
  380.  
  381.     FUNCTION
  382.     When the user hits a windows close gadget, the
  383.     window isn't closed immediately. Instead MUI only
  384.     sets this attribute to TRUE to allow your application
  385.     to react.
  386.  
  387.     Usually, you will setup a notification that automatically
  388.     closes the window when a close request appears, but you
  389.     could e.g. pop up a confirmation requester or do some
  390.     other things first.
  391.  
  392.     EXAMPLE
  393.     /* automagically close a window     */
  394.     /* when the close gadget is pressed */
  395.  
  396.     DoMethod(window,MUIM_Notify,
  397.        MUIA_Window_CloseRequest, TRUE,
  398.        window,3,MUIM_Set,MUIA_Window_Open,0);
  399.  
  400.     SEE ALSO
  401.     MUIA_Window_Open
  402. Window.mui/MUIA_Window_DefaultObject
  403.  
  404.     NAME
  405.     MUIA_Window_DefaultObject -- (V4) [ISG], Object *
  406.  
  407.     FUNCTION
  408.     The default object in a window receives keyboard input
  409.     as long as no other object is active. Good candidates
  410.     for default objects are e.g. lonely listviews. Making
  411.     such a listview the default object will allow the user
  412.     to control it immediately without the need of several
  413.     tab strokes for activation.
  414.  
  415.     SEE ALSO
  416.     MUIA_Window_ActiveObject
  417. Window.mui/MUIA_Window_DepthGadget
  418.  
  419.     NAME
  420.     MUIA_Window_DepthGadget -- (V4) [I..], BOOL
  421.  
  422.     FUNCTION
  423.     Enable or disable the depth gadget. Defaults to TRUE.
  424.     There is no good reason to use this tag.
  425. Window.mui/MUIA_Window_DragBar
  426.  
  427.     NAME
  428.     MUIA_Window_DragBar -- (V4) [I..], BOOL
  429.  
  430.     FUNCTION
  431.     Tell MUI to give your window a dragbar.
  432.  
  433.     Defaults to TRUE.
  434.  
  435.     There is no good reason to disable the dragbar!
  436. Window.mui/MUIA_Window_FancyDrawing
  437.  
  438.     NAME
  439.     MUIA_Window_FancyDrawing -- (V8) [ISG], BOOL
  440.  
  441.     FUNCTION
  442.     Usually, the only possible place to do some rendering is
  443.     during a MUIM_Draw method. However, if you have a class
  444.     that really requires very high graphical output speed
  445.     (e.g. a module players scope or a game class), you can
  446.     set MUIA_Window_FancyDrawing to TRUE.
  447.  
  448.     This allows your class to render anywhere between
  449.     MUIM_Show and MUIM_Hide, e.g. directly after an
  450.     attribute change with OM_SET or from a seperate
  451.     task.
  452.  
  453.     Note that your rastport etc. is only valid between
  454.     MUIM_Show and MUIM_Hide. Keep that in mind!
  455.  
  456.     When drawing from a seperate task, you have to clone
  457.     the RastPort and use the copy for your rendering!
  458.  
  459.     NOTES
  460.     Please use this attribute sparingly. It might prevent
  461.     MUI from doing nice things with your window, e.g.
  462.     building an automatic virtual group when the screen
  463.     is too small.
  464.  
  465.     MUIA_Window_FancyDrawing is really only necessary for
  466.     very few types of applications. You should use the
  467.     traditional way (MUIM_Draw and MUI_Redraw()) whenever
  468.     and wherever possible!
  469. Window.mui/MUIA_Window_Height
  470.  
  471.     NAME
  472.     MUIA_Window_Height -- (V4) [I.G], LONG
  473.  
  474.     SPECIAL INPUTS
  475.     MUIV_Window_Height_MinMax(p)
  476.     MUIV_Window_Height_Visible(p)
  477.     MUIV_Window_Height_Screen(p)
  478.     MUIV_Window_Height_Scaled
  479.     MUIV_Window_Height_Default
  480.  
  481.     FUNCTION
  482.     Specify the height of a window. Usually, you won't give
  483.     a pixel value here but instead use one of the following
  484.     magic macros:
  485.  
  486.     MUIV_Window_Height_Default:
  487.        calculated from objects default sizes.
  488.  
  489.     MUIV_Window_Height_MinMax(0..100):
  490.        somewhere between the minimum height (0) and the
  491.        maximum height (100) of your window.
  492.  
  493.     MUIV_Window_Height_Visible(1..100):
  494.        percentage of the screens visible height.
  495.  
  496.     MUIV_Window_Height_Screen(1..100):
  497.        percentage of the screens total height.
  498.  
  499.     MUIV_Window_Height_Scaled:
  500.        height will be adjusted so that
  501.        width : height == minimum width : minimum height.
  502.        Note that a windows width and height may not
  503.        both be scaled.
  504.  
  505.     Default for this tag is MUIV_Window_Height_Default.
  506.  
  507.     As long as your window has a window id (MUIA_Window_ID),
  508.     choosing a size is not that important. MUI will always
  509.     remember a windows last position and size and these
  510.     values will simply override your settings. Positioning
  511.     and sizing should be completely under user control,
  512.     a programmer doesn't need to worry about it.
  513.  
  514.     SEE ALSO
  515.     MUIA_Window_Width, MUIA_Window_ID
  516. Window.mui/MUIA_Window_ID
  517.  
  518.     NAME
  519.     MUIA_Window_ID -- (V4) [ISG], ULONG
  520.  
  521.     FUNCTIONS
  522.     For most of your windows, you should define a longword
  523.     as id value. Only a window with an id is able to
  524.     remember its size and position.
  525.  
  526.     Additionally, when you use an ascii id (e.g. 'MAIN'),
  527.     your window can be controlled from ARexx.
  528.  
  529.     Of course all windows of your application must have
  530.     unique ids.
  531.  
  532.     SEE ALSO
  533.     MUIA_Window_LeftEdge
  534. Window.mui/MUIA_Window_InputEvent
  535.  
  536.     NAME
  537.     MUIA_Window_InputEvent -- (V4) [..G], struct InputEvent *
  538.  
  539.     FUNCTION
  540.     This attribute gets set whenever your window receives
  541.     a rawkey input event. You can react on this by creating
  542.     a notification event containing a standard
  543.     commodities.library input description string.
  544.  
  545.     EXAMPLE
  546.     DoMethod(window, MUIM_Notify,
  547.        MUIA_Window_InputEvent, "control p",
  548.        txobj, 3,
  549.        MUIM_Set, MUIA_Text_Contents, "user pressed ctrl p");
  550. Window.mui/MUIA_Window_LeftEdge
  551.  
  552.     NAME
  553.     MUIA_Window_LeftEdge -- (V4) [I.G], LONG
  554.  
  555.     SPECIAL INPUTS
  556.     MUIV_Window_LeftEdge_Centered
  557.     MUIV_Window_LeftEdge_Moused
  558.  
  559.     FUNCTION
  560.     Specify the left edge of a window. Usually, you shouldn't
  561.     define a pixel value here but instead use one of the
  562.     following macros:
  563.  
  564.     MUIV_Window_LeftEdge_Centered:
  565.        window appears centered on the visible area of screen.
  566.  
  567.     MUIV_Window_LeftEdge_Moused
  568.        window appears centered under the mouse pointer.
  569.  
  570.     Default for this tag is MUIV_Window_LeftEdge_Centered.
  571.  
  572.     As long as your window has a window id (MUIA_Window_ID),
  573.     choosing a position is not that important. MUI will always
  574.     remember a windows last position and size and these
  575.     values will simply override your settings. Positioning
  576.     and sizing should be completely under user control,
  577.     a programmer doesn't need to worry about it.
  578.  
  579.     SEE ALSO
  580.     MUIA_Window_TopEdge, MUIA_Window_ID
  581. Window.mui/MUIA_Window_Menu
  582.  
  583.     NAME
  584.     MUIA_Window_Menu -- (V4) [I..], struct NewMenu * (OBSOLETE)
  585.  
  586.     SPECIAL INPUTS
  587.     MUIV_Window_Menu_NoMenu
  588.  
  589.     FUNCTION
  590.     Obsolete, use MUIA_Window_Menustrip instead.
  591.  
  592.     SEE ALSO
  593.     MUIA_Window_Menustrip
  594. Window.mui/MUIA_Window_MenuAction
  595.  
  596.     NAME
  597.     MUIA_Window_MenuAction -- (V8) [ISG], ULONG
  598.  
  599.     FUNCTION
  600.     Whenever a menu item is selected, this attribute will be
  601.     set to the corresponding UserData field of the gadtools
  602.     NewMenu structure. This allows reacting on menu items
  603.     via broadcasting.
  604.  
  605.     SEE ALSO
  606.     MUIA_Window_Menu
  607. Window.mui/MUIA_Window_Menustrip
  608.  
  609.     NAME
  610.     MUIA_Window_Menustrip -- (V8) [I..], Object *
  611.  
  612.     FUNCTION
  613.     Specify a menu strip object for this window. The object
  614.     is treated as a child of the window and will be disposed
  615.     when the window is disposed.
  616.  
  617.     Menustrip objects defined for a window will override an
  618.     applications Menustrip object.
  619.  
  620.     MUIA_Window_Menustrip replaces the old and obsolete
  621.     MUIA_Window_Menu tag.
  622.  
  623.     Usually, you will create the menu object with MUI's builtin
  624.     object library from a gadtools NewMenu structure, but its
  625.     also OK to define the menu tree "by hand" using the
  626.     Family class.
  627.  
  628.     If you have a global menu for all your applications windows
  629.     but you want some windows to have no menu, use the
  630.     MUIA_Window_NoMenus tag.
  631.  
  632.     SEE ALSO
  633.     MUIA_Window_NoMenus
  634. Window.mui/MUIA_Window_NoMenus
  635.  
  636.     NAME
  637.     MUIA_Window_NoMenus -- (V4) [IS.], BOOL
  638.  
  639.     FUNCTION
  640.     Temporarily disable the menu strip of a window.
  641.  
  642.     SEE ALSO
  643.     MUIA_Window_Menu
  644. Window.mui/MUIA_Window_Open
  645.  
  646.     NAME
  647.     MUIA_Window_Open -- (V4) [.SG], BOOL
  648.  
  649.     FUNCTION
  650.     This little attribute can be used to open and close
  651.     a window. When opening a window, MUI does lots of
  652.     stuff to calculate sizes and positions of all
  653.     gadgets. Minimum and maximum window sizes will be
  654.     adjusted automatically.
  655.  
  656.     When the minimum size of a window is too big to fit
  657.     on the screen, MUI tries to reduce font sizes and
  658.     does a new calculation. You should always design
  659.     your windows to fit on a 640*200 screen with
  660.     all fonts set to topaz/8.
  661.  
  662.     When a window is closed (and you specified a
  663.     MUIA_Window_ID), MUI remembers its position
  664.     and size and uses these values during the next
  665.     opening.
  666.  
  667.     After setting MUIA_Window_Open to TRUE, you should
  668.     test if MUI was able to open the window by getting
  669.     the attribute again. If you don't and if this was
  670.     the only window of your application, the user won't
  671.     be able to do any input and your application will
  672.     seem to hang.
  673.  
  674.     EXAMPLE
  675.     set(window,MUIA_Window_Open,TRUE);
  676.     get(window,MUIA_Window_Open,&open);
  677.     if (!open)
  678.     {
  679.        MUI_Request(app,0,0,0,"Ok","Failed to open window.");
  680.        exit(20);
  681.     }
  682.  
  683.     SEE ALSO
  684.     MUIA_Window_RootObject
  685. Window.mui/MUIA_Window_PublicScreen
  686.  
  687.     NAME
  688.     MUIA_Window_PublicScreen -- (V6) [ISG], STRPTR
  689.  
  690.     FUNCTION
  691.     Force the window to appear on the public screen who's name
  692.     is specified by this attribute. This tag overrides the
  693.     user preferences setting and is overridden by
  694.     MUIA_Window_Screen.
  695.  
  696.     Please use this tag sparely, overriding user prefs is
  697.     not a good idea!
  698.  
  699.     SEE ALSO
  700.     MUIA_Window_Screen
  701. Window.mui/MUIA_Window_RefWindow
  702.  
  703.     NAME
  704.     MUIA_Window_RefWindow -- (V4) [IS.], Object *
  705.  
  706.     FUNCTION
  707.     Setting MUIA_Window_RefWindow to another MUI window
  708.     object will make the left and top position relative
  709.     to this reference window. Using the
  710.     MUIA_Window_Left(Top)Edge_Centered tag, you can easily
  711.     open one window within another.
  712.  
  713.     Note that if your window has an id, the window will
  714.     remember its last position and reopen there. Thus,
  715.     this tag is only useful if you omit MUIA_Window_ID,
  716.     maybe for some small requester windows.
  717.  
  718.     SEE ALSO
  719.     MUIA_Window_ID, MUIA_Window_LeftEdge
  720. Window.mui/MUIA_Window_RootObject
  721.  
  722.     NAME
  723.     MUIA_Window_RootObject -- (V4) [I..], Object *
  724.  
  725.     FUNCTION
  726.     This is a pointer to a MUI object and defines the
  727.     contents of your window. Usually, this root object
  728.     will be of class MUIC_Group since you surely want to
  729.     have more than one gadget.
  730.  
  731.     The root object is treated as child of a window
  732.     and will be disposed when the window is disposed.
  733.     Note that windows can only have one child.
  734.  
  735.     Although you may create a window without root object,
  736.     you have to set one before the window is openend!
  737.  
  738.     EXAMPLE
  739.     win = WindowObject, MUIA_Window_RootObject,
  740.        VGroup,
  741.           Child, ...,
  742.           Child, ...,
  743.           End,
  744.        End;
  745.  
  746.     SEE ALSO
  747.     MUIA_Window_Open
  748. Window.mui/MUIA_Window_Screen
  749.  
  750.     NAME
  751.     MUIA_Window_Screen -- (V4) [ISG], struct Screen *
  752.  
  753.     FUNCTION
  754.     You can get a pointer to the parent screen of a window by 
  755.     getting this attribute. The result will be NULL when the
  756.     window is currently closed.
  757.  
  758.     Specifying MUIA_Window_Screen at object creation time or
  759.     with a SetAttrs() call allows you to explicitly tell MUI
  760.     on which screen the window should be opened. You normally
  761.     won't need this feature and leave the decision about
  762.     screens to the users preferences setting.
  763.  
  764.     SEE ALSO
  765.     MUIA_Window_PublicScreen, MUIA_Window_Window
  766. Window.mui/MUIA_Window_ScreenTitle
  767.  
  768.     NAME
  769.     MUIA_Window_ScreenTitle -- (V5) [ISG], STRPTR
  770.  
  771.     FUNCTION
  772.     This text will appear in the screens title bar
  773.     when the window is active.
  774.  
  775.     SEE ALSO
  776.     MUIA_Window_Title
  777. Window.mui/MUIA_Window_SizeGadget
  778.  
  779.     NAME
  780.     MUIA_Window_SizeGadget -- (V4) [I..], BOOL
  781.  
  782.     FUNCTION
  783.     Tell MUI if you want a sizing gadget for this window.
  784.     Usually you won't need this attribute since MUI
  785.     will automatically disable the sizing gadget when
  786.     your window is not sizeable because of your gadget
  787.     layout.
  788. Window.mui/MUIA_Window_SizeRight
  789.  
  790.     NAME
  791.     MUIA_Window_SizeRight -- (V4) [I..], BOOL
  792.  
  793.     FUNCTION
  794.     When set to TRUE, the size gadget will reside
  795.     in the right window border.
  796. Window.mui/MUIA_Window_Sleep
  797.  
  798.     NAME
  799.     MUIA_Window_Sleep -- (V4) [.SG], BOOL
  800.  
  801.     FUNCTION
  802.     This attribute can be used to put a window to sleep.
  803.     The window gets disabled and a busy pointer appears.
  804.  
  805.     The attribute contains a nesting count, if you tell
  806.     your window to sleep twice, you will have to tell
  807.     it to wake up twice too.
  808.  
  809.     A sleeping window cannot be resized.
  810.  
  811.     SEE ALSO
  812.     MUIA_Application_Sleep
  813. Window.mui/MUIA_Window_Title
  814.  
  815.     NAME
  816.     MUIA_Window_Title -- (V4) [ISG], STRPTR
  817.  
  818.     FUNCTION
  819.     Specify the title of a window.
  820.  
  821.     SEE ALSO
  822.     MUIA_Window_ScreenTitle
  823. Window.mui/MUIA_Window_TopEdge
  824.  
  825.     NAME
  826.     MUIA_Window_TopEdge -- (V4) [I.G], LONG
  827.  
  828.     SPECIAL INPUTS
  829.     MUIV_Window_TopEdge_Centered
  830.     MUIV_Window_TopEdge_Moused
  831.     MUIV_Window_TopEdge_Delta(p)
  832.  
  833.     FUNCTION
  834.     Specify the top edge of a window. Usually, you shouldn't
  835.     define a pixel value here but instead use one of the
  836.     following macros:
  837.  
  838.     MUIV_Window_TopEdge_Centered:
  839.        window appears centered on the visible area of screen.
  840.  
  841.     MUIV_Window_TopEdge_Moused
  842.        window appears centered under the mouse pointer.
  843.  
  844.     MUIV_Window_TopEdge_Delta(p)
  845.        window appears p pixels below the screens title bar.
  846.  
  847.     Default for this tag is MUIV_Window_TopEdge_Centered.
  848.  
  849.     As long as your window has a window id (MUIA_Window_ID),
  850.     choosing a position is not that important. MUI will always
  851.     remember a windows last position and size and these
  852.     values will simply override your settings. Positioning
  853.     and sizing should be completely under user control,
  854.     a programmer doesn't need to worry about it.
  855.  
  856.     SEE ALSO
  857.     MUIA_Window_LeftEdge, MUIA_Window_ID
  858. Window.mui/MUIA_Window_Width
  859.  
  860.     NAME
  861.     MUIA_Window_Width -- (V4) [I.G], LONG
  862.  
  863.     SPECIAL INPUTS
  864.     MUIV_Window_Width_MinMax(p)
  865.     MUIV_Window_Width_Visible(p)
  866.     MUIV_Window_Width_Screen(p)
  867.     MUIV_Window_Width_Scaled
  868.     MUIV_Window_Width_Default
  869.  
  870.     FUNCTION
  871.     Specify the width of a window. Usually, you won't give
  872.     a pixel value here but instead use one of the following
  873.     magic macros:
  874.  
  875.     MUIV_Window_Width_Default:
  876.        calculated from objects default sizes.
  877.  
  878.     MUIV_Window_Width_MinMax(0..100):
  879.        somewhere between the minimum width (0) and the
  880.        maximum width (100) of your window.
  881.  
  882.     MUIV_Window_Width_Visible(1..100):
  883.        percentage of the screens visible width.
  884.  
  885.     MUIV_Window_Width_Screen(1..100):
  886.        percentage of the screens total width.
  887.  
  888.     MUIV_Window_Width_Scaled:
  889.        width will be adjusted so that
  890.        width : height == minimum width : minimum height.
  891.        Note that a windows width and height may not
  892.        both be scaled.
  893.  
  894.     Default for this tag is MUIV_Window_Width_Default.
  895.  
  896.     As long as your window has a window id (MUIA_Window_ID),
  897.     choosing a size is not that important. MUI will always
  898.     remember a windows last position and size and these
  899.     values will simply override your settings. Positioning
  900.     and sizing should be completely under user control,
  901.     a programmer doesn't need to worry about it.
  902.  
  903.     SEE ALSO
  904.     MUIA_Window_Height, MUIA_Window_ID
  905. Window.mui/MUIA_Window_Window
  906.  
  907.     NAME
  908.     MUIA_Window_Window -- (V4) [..G], struct Window *
  909.  
  910.     FUNCTION
  911.     When your window is open, you can obtain a pointer
  912.     to the intuition Window structure with this tag
  913.     and use it e.g. in an asl.library requester call.
  914.  
  915.     Since the user can close your window any time
  916.     (e.g. iconification), you must be prepared to
  917.     receive a NULL pointer as result.
  918.  
  919.     SEE ALSO
  920.     MUIA_Window_Screen
  921.