Source position: mui.pas line 2193
const MUIC_Menuitem: PChar = 'Menuitem.mui'; |
Menuitem class describes a single menu item. You can use all of the gadtools menus features expect Image menus here.
Since Menuitem class is a subclass of Family class, you can add other menu items as children of a menu item to indicate sub menus. MUI does not limit the level of sub menus, but the operating system currently allows a maximum nesting level of one. Because of this, children of menu items should not contain other menu items for now, the results are unpredictable.
Note: For handling menu items, MUIA_UserData and the methods MUIM_SetUData, MUIM_GetUData and MUIM_FindUData can become quite useful. See the Menu demo program and the accompanying documentation for details.
| rootclass | --> | Notify | --> | Family | --> | MenuItem |
| _______________ Field _______________ | ___ Access ___ | _____ Type _____ | Short description |
|---|---|---|---|
| MUIA_MenuItem_Checked | ISG | BOOL (0/1) | Set/Get the checked state of a checkit menu item. |
| MUIA_Menuitem_Checkit | ISG | BOOL (0/1) | Set to True and this item will become a checkmarkable item. |
| MUIA_Menuitem_Enabled | ISG | BOOL (0/1) | Enabled/Disable the menu item. |
| MUIA_Menuitem_Exclude | ISG | LongInt | bitmask of menu item numbers that are to be deselected when this one is selected. |
| MUIA_Menuitem_Shortcut | ISG | PChar | Define the shortcut for a menu item. |
| MUIA_Menuitem_Title | ISG | PChar | Define the items title. |
| MUIA_Menuitem_Toggle | ISG | PChar | Define the state of the toggle flag for this item. |
| MUIA_Menuitem_Trigger | __G | PMenuItem | Trigger when menu item is selected. |
| _______________ Field _______________ | ___ Access ___ | _____ Type _____ | Short description |
|---|---|---|---|
| MUIA_Family_Child | I__ | PObject_ | Add a child to family child list on creation |
| MUIA_Family_List | I__ | PMinList | Returns a pointer to a struct MinList which contains the children of a family object. |
| _______________ 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_Family_AddHead | Add an object as first object to the family. |
| MUIM_Family_AddTail | Add an object as last object to the family. |
| MUIM_Family_Insert | Add an object after another object to the family. |
| MUIM_Family_Remove | Remove an object from a family. |
| MUIM_Family_Sort | Sort the children of a family. |
| _______________ 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. |