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