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