home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 18 / amigaformatcd18.iso / mui / mui_developer / autodocs / mui_menuitem.doc < prev    next >
Text File  |  1997-03-10  |  4KB  |  138 lines
  1. TABLE OF CONTENTS
  2.  
  3. Menuitem.mui/Menuitem.mui
  4. Menuitem.mui/MUIA_Menuitem_Checked
  5. Menuitem.mui/MUIA_Menuitem_Checkit
  6. Menuitem.mui/MUIA_Menuitem_CommandString
  7. Menuitem.mui/MUIA_Menuitem_Enabled
  8. Menuitem.mui/MUIA_Menuitem_Exclude
  9. Menuitem.mui/MUIA_Menuitem_Shortcut
  10. Menuitem.mui/MUIA_Menuitem_Title
  11. Menuitem.mui/MUIA_Menuitem_Toggle
  12. Menuitem.mui/MUIA_Menuitem_Trigger
  13. Menuitem.mui/Menuitem.mui
  14.  
  15.     Menuitem class describes a single menu item. You can use
  16.     all of the gadtools menus features expect Image menus here.
  17.  
  18.     Since Menuitem class is a subclass of Family class, you can
  19.     add other menu items as children of a menu item to indicate
  20.     sub menus. MUI does not limit the level of sub menus, but
  21.     the operating system currently allows a maximum nesting
  22.     level of one. Because of this, children of menu items
  23.     should not contain other menu items for now, the results
  24.     are unpredictable.
  25.  
  26.     Note: For handling menu items, MUIA_UserData and the methods
  27.     MUIM_SetUData, MUIM_GetUData and MUIM_FindUData can become
  28.     quite useful. See the Menu demo program and the accompanying
  29.         documentation for details.
  30. Menuitem.mui/MUIA_Menuitem_Checked
  31.  
  32.     NAME
  33.     MUIA_Menuitem_Checked -- (V8 ) [ISG], BOOL
  34.  
  35.     FUNCTION
  36.     set/get the checked state of a checkit menu item.
  37.  
  38.     SEE ALSO
  39.     MUIA_Menuitem_Checkit, MUIA_Menuitem_Enabled, 
  40.     MUIA_Menuitem_Exclude
  41. Menuitem.mui/MUIA_Menuitem_Checkit
  42.  
  43.     NAME
  44.     MUIA_Menuitem_Checkit -- (V8 ) [ISG], BOOL
  45.  
  46.     FUNCTION
  47.     Set to TRUE and this item will become a checkmarkable item.
  48.  
  49.     SEE ALSO
  50.     MUIA_Menuitem_Checked, MUIA_Menuitem_Enabled,
  51.     MUIA_Menuitem_Exclude
  52. Menuitem.mui/MUIA_Menuitem_CommandString
  53.  
  54.     NAME
  55.     MUIA_Menuitem_CommandString -- (V16) [ISG], BOOL
  56.  
  57.     FUNCTION
  58.     Set to TRUE if MUIA_Menuitem_Shortcut points to a
  59.     command string (e.g. "shift alt q") instead of a
  60.     simple letter. Note that MUI wont check if these
  61.     keys are pressed (just like intuition), you'll have
  62.     to do this yourself.
  63.  
  64.     SEE ALSO
  65.     MUIA_Menuitem_Shortcut
  66. Menuitem.mui/MUIA_Menuitem_Enabled
  67.  
  68.     NAME
  69.     MUIA_Menuitem_Enabled -- (V8 ) [ISG], BOOL
  70.  
  71.     FUNCTION
  72.     enabled/disalbe the menu item.
  73.  
  74.     SEE ALSO
  75.     MUIA_Menuitem_Checkit, MUIA_Menuitem_Checked,
  76.     MUIA_Menuitem_Exclude
  77. Menuitem.mui/MUIA_Menuitem_Exclude
  78.  
  79.     NAME
  80.     MUIA_Menuitem_Exclude -- (V8 ) [ISG], LONG
  81.  
  82.     FUNCTION
  83.     bitmask of menu item numbers that are to be deselected
  84.     when this one is selected.
  85.  
  86.     SEE ALSO
  87.     MUIA_Menuitem_Checkit, MUIA_Menuitem_Enabled,
  88.     MUIA_Menuitem_Checked
  89. Menuitem.mui/MUIA_Menuitem_Shortcut
  90.  
  91.     NAME
  92.     MUIA_Menuitem_Shortcut -- (V8 ) [ISG], STRPTR
  93.  
  94.     SPECIAL INPUTS
  95.     MUIV_Menuitem_Shortcut_Check
  96.  
  97.     FUNCTION
  98.     Define the shortcut for a menu item.
  99.  
  100.     SEE ALSO
  101.     MUIA_Menuitem_Title
  102. Menuitem.mui/MUIA_Menuitem_Title
  103.  
  104.     NAME
  105.     MUIA_Menuitem_Title -- (V8 ) [ISG], STRPTR
  106.  
  107.     FUNCTION
  108.     Define the items title.
  109.  
  110.     SEE ALSO
  111.     MUIA_Menuitem_Shortcut
  112. Menuitem.mui/MUIA_Menuitem_Toggle
  113.  
  114.     NAME
  115.     MUIA_Menuitem_Toggle -- (V8 ) [ISG], BOOL
  116.  
  117.     FUNCTION
  118.     Define the state of the TOGGLE flag for this item.
  119.  
  120.     SEE ALSO
  121.     MUIA_Menuitem_Checkit, MUIA_Menuitem_Enabled,
  122.     MUIA_Menuitem_Checked
  123. Menuitem.mui/MUIA_Menuitem_Trigger
  124.  
  125.     NAME
  126.     MUIA_Menuitem_Trigger -- (V8 ) [..G], struct MenuItem *
  127.  
  128.     FUNCTION
  129.     This attribute is set to a pointer to the struct MenuItem of
  130.     the item object when the item is selected. By setting up
  131.     notification on this attribute with MUIV_EveryTime, you can
  132.     react on menu actions and query the MenuItems flags
  133.     immediately.
  134.  
  135.     Note that menu reactions are also possible any 
  136.     maybe a bit easier with MUIA_Application_ReturnID,
  137.     MUIA_Application_MenuAction and MUIA_Window_MenuAction.
  138.