Objects of window class are used to generate windows and supply a place where MUI gadgets feel well.
Source position: mui.pas line 1098
const MUIC_Window: PChar = 'Window.mui'; |
Objects of window class are used to generate windows and supply a place where MUI gadgets feel well. It handles the complicated task of window resizing fully automatic, you don't need to worry about that.
Windows are children of an application, you cannot use a window object without having a parent application object. On the other side, the gadgets in a window are children of the window, you cannot use MUI gadgets without having a parent MUI window.
Creating a window object does not mean to open it instantly. This is done later by setting the window's MUIA_Window_Open attribute. If your application has several windows, the usual way is to create them all at once at startup time and open/close it later just by setting MUIA_Window_Open.
There is no difference in talking to gadgets whether their parent window is open or not. If you e.g. set the contents of a string gadget in an open window, the gadget will refresh immediately. If the window is closed, the gadget just remembers its new setting and displays it later.
| rootclass | --> | Notify | --> | Window |
| _______________ Field _______________ | ___ Access ___ | _____ Type _____ | Short description |
|---|---|---|---|
| MUIA_Window_Activate | ISG | BOOL (0/1) | Set to True to active the Window. |
| MUIA_Window_ActiveObject | _SG | PObject_ | Set or get the active object. |
| MUIA_Window_AltHeight | I_G | LongInt | Specify the alternate (zoomed) height of a window. |
| MUIA_Window_AltLeftEdge | I_G | LongInt | Specify the alternate (zoomed) left position of a window. |
| MUIA_Window_AltTopEdge | I_G | LongInt | Specify the alternate (zoomed) top position of a window. |
| MUIA_Window_AltWidth | I_G | LongInt | Specify the alternate (zoomed) width of a window. |
| MUIA_Window_AppWindow | I__ | BOOL (0/1) | Set Window as AppWindow. |
| MUIA_Window_Backdrop | I__ | BOOL (0/1) | Make the window a backdrop window. |
| MUIA_Window_Borderless | I__ | BOOL (0/1) | Make the window borderless. |
| MUIA_Window_CloseGadget | I__ | BOOL (0/1) | Set this to False and your window will not have a close gadget. |
| MUIA_Window_CloseRequest | __G | BOOL (0/1) | Set to True if the user tries to close the window. |
| MUIA_Window_DefaultObject | ISG | PObject_ | The default object in a window receives keyboard input. |
| MUIA_Window_DepthGadget | I__ | BOOL (0/1) | Enable or disable the depth gadget. |
| MUIA_Window_DisableKeys | ISG | LongWord | Undocumented |
| MUIA_Window_DragBar | I__ | BOOL (0/1) | Tell MUI to give your window a dragbar. |
| MUIA_Window_FancyDrawing | ISG | BOOL (0/1) | Obsolete relaxed way of custom class drawing. |
| MUIA_Window_Height | I_G | LongInt | Specify the height of a window. |
| MUIA_Window_ID | ISG | LongWord | Define an ID for the window. |
| MUIA_Window_InputEvent | __G | PInputEvent | Define an ID for the window. |
| MUIA_Window_IsSubWindow | ISG | BOOL (0/1) | Windows with this flag set to True dont get disposed when the application object is disposed. |
| MUIA_Window_LeftEdge | I_G | LongInt | Specify the left edge of a window. |
| MUIA_Window_MenuAction | ISG | LongWord | UserData field of selected Menu item. |
| MUIA_Window_Menustrip | I_G | PObject_ | Specify a menu strip object for this window. |
| MUIA_Window_MouseObject | __G | PObject_ | Identify mouse position. |
| MUIA_Window_NeedsMouseObject | I__ | BOOL (0/1) | Enable notification of changes of mouse position. |
| MUIA_Window_NoMenus | IS_ | BOOL (0/1) | Temporarily disable the menu strip of a window. |
| MUIA_Window_Open | _SG | BOOL (0/1) | Open or close the window. |
| MUIA_Window_PublicScreen | ISG | PChar | Force the window to appear on the public screen who's name is specified by this attribute. |
| MUIA_Window_RefWindow | IS_ | PObject_ | Calculate position relative to this window. |
| MUIA_Window_RootObject | ISG | PObject_ | This is a pointer to a MUI object and defines the contents of your window. |
| MUIA_Window_Screen | ISG | PScreen | You can get a pointer to the parent screen of a window by getting this attribute. |
| MUIA_Window_ScreenTitle | ISG | PChar | This text will appear in the screens title bar when the window is active. |
| MUIA_Window_SizeGadget | I__ | BOOL (0/1) | Tell MUI if you want a sizing gadget for this window. |
| MUIA_Window_SizeRight | I__ | BOOL (0/1) | When set to True, the size gadget will reside in the right window border. |
| MUIA_Window_Sleep | _SG | BOOL (0/1) | This attribute can be used to put a window to sleep. |
| MUIA_Window_Title | ISG | PChar | Specify the title of a window. |
| MUIA_Window_TopEdge | I_G | LongInt | Specify the top edge of a window. |
| MUIA_Window_UseBottomBorderScroller | ISG | BOOL (0/1) | If set to True, the window will feature a scrollbar in its bottom border. |
| MUIA_Window_UseLeftBorderScroller | ISG | BOOL (0/1) | If set to True, the window will feature a scrollbar in its left border. |
| MUIA_Window_UseRightBorderScroller | ISG | BOOL (0/1) | If set to True, the window will feature a scrollbar in its right border. |
| MUIA_Window_Width | I_G | LongInt | Specify the width of a window. |
| MUIA_Window_Window | __G | PWindow | Obtain a pointer to the intuition Window structure. |
| _______________ Field _______________ | ___ Access ___ | _____ Type _____ | Short description |
|---|---|---|---|
| MUIA_ApplicationObject | __G | PObject_ | Obtain a pointer to the application object that some gadget belongs |
| MUIA_AppMessage | __G | PAppMessage | Listen to this field to get AppMessages (Icon dropped on the App window) |
| MUIA_HelpLine | ISG | LongInt | Define a line in a help file specified with MUIA_Application_HelpFile |
| MUIA_HelpNode | ISG | PChar | Define a node in a help file specified with MUIA_Application_HelpFile |
| MUIA_NoNotify | _S_ | BOOL (0/1) | Prevent notification from being triggered on attribute set |
| MUIA_ObjectID | ISG | LongWord | Identification for object on save/load |
| MUIA_Parent | __G | PObject_ | Get a pointer to the parent object of the current object |
| MUIA_Revision | __G | LongInt | Get the revision number of an objects class |
| MUIA_UserData | ISG | LongWord | A general purpose value to fill in any kind of information |
| MUIA_Version | __G | LongInt | Get the version number of an objects class |
| _______________ Method _______________ | Short description |
|---|---|
| MUIM_Window_AddEventHandler | Add an Event Handler for custom class. |
| MUIM_Window_Cleanup | undocumented. |
| MUIM_Window_RemEventHandler | Remove an Event Handler for custom class. |
| MUIM_Window_ScreenToBack | Put the window's screen to back. |
| MUIM_Window_ScreenToFront | Put the window's screen to front. |
| MUIM_Window_Setup | undocumented. |
| MUIM_Window_Snapshot | Remember Windows current position and size. |
| MUIM_Window_ToBack | Put the window to back. |
| MUIM_Window_ToFront | Put the window to front. |
| _______________ Method _______________ | Short description |
|---|---|
| MUIM_CallHook | Call a standard amiga callback hook |
| MUIM_Export | Called on export object to dataspace |
| MUIM_FindUData | Find a userdata in objects and childrens list and return the object |
| MUIM_GetConfigItem | |
| MUIM_GetUData | Find a userdata in objects and childrens list and return an attribute of the object |
| MUIM_Import | Called on import object from dataspace |
| MUIM_KillNotify | Kills previously given notifications on specific attributes |
| MUIM_KillNotifyObj | |
| MUIM_MultiSet | Set an attribute for multiple objects. |
| MUIM_NoNotifySet | Acts like MUIM_Notify but doesn't trigger any notification |
| MUIM_Notify | Add a notification event handler to an object |
| MUIM_Set | Set an attribute to a value |
| MUIM_SetAsString | Set a (text kind) attribute to a string. |
| MUIM_SetUData | Find a userdata in objects and childrens list and set an attribute of the object |
| MUIM_SetUDataOnce | This method performs like MUIM_SetUData, but stop at first found object. |
| MUIM_WriteLong | This method simply writes a longword somewhere to memory. |
| MUIM_WriteString | This method simply copies a string somewhere to memory. |
| MUIM_ConnectParent | (AROS only) |
| MUIM_DisconnectParent | (AROS only) |