home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / opendc12.zip / od124os2.exe / od12otk1.exe / include / MenuBar.idl < prev    next >
Text File  |  1997-04-02  |  11KB  |  406 lines
  1. /* @(#)Z 1.21 com/src/ui/idl/MenuBar.idl, odui, od96os2, odos29712d 97/03/21 17:20:48 (97/03/20 16:07:14) */
  2. //====START_GENERATED_PROLOG======================================
  3. //
  4. //
  5. //   COMPONENT_NAME: odui
  6. //
  7. //   CLASSES: none
  8. //
  9. //   ORIGINS: 82,27
  10. //
  11. //
  12. //   (C) COPYRIGHT International Business Machines Corp. 1995,1996
  13. //   All Rights Reserved
  14. //   Licensed Materials - Property of IBM
  15. //   US Government Users Restricted Rights - Use, duplication or
  16. //   disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  17. //       
  18. //   IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  19. //   ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20. //   PURPOSE. IN NO EVENT SHALL IBM BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  21. //   CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  22. //   USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  23. //   OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
  24. //   OR PERFORMANCE OF THIS SOFTWARE.
  25. //
  26. //====END_GENERATED_PROLOG========================================
  27. //
  28. //     Copyright:      (r) 1993 - 1995 by Apple Computer, Inc., all rights reserved.
  29.  
  30. #ifndef _MENUBAR_
  31. #define _MENUBAR_
  32.  
  33. #ifndef _REFCTOBJ_
  34. #include "RefCtObj.idl"
  35. #endif
  36.  
  37. #if defined(_PLATFORM_OS2_) || defined(_PLATFORM_WIN32_) || defined(_PLATFORM_AIX_)
  38.  
  39. #ifndef _ODTYPESM_
  40. #include "odtypesm.idl"
  41. #endif
  42.  
  43. #endif // PLATFORM_OS2, PLATFORM_WIN32, PLATFORM_AIX
  44.  
  45.  
  46. //=====================================================================================
  47. // Classes defined in this interface
  48. //=====================================================================================
  49.  
  50. interface  ODMenuBar;
  51.  
  52. //=====================================================================================
  53. // Classes used by this interface
  54. //=====================================================================================
  55.  
  56. interface  ODPart;
  57.  
  58.  
  59.  
  60. //=====================================================================================
  61. // Class ODMenuBar
  62. //=====================================================================================
  63.  
  64. interface ODMenuBar :  ODRefCntObject
  65. {
  66.     //-----------------------------------------------------------------------------
  67.     // Public methods for all platforms
  68.     //-----------------------------------------------------------------------------
  69.  
  70.     void Display            ();
  71.  
  72.     ODMenuBar Copy            ();
  73.  
  74.     void AddMenuLast        (in ODMenuID menuID,
  75.                      in ODPlatformMenu menu,
  76.                      in ODPart part);
  77.  
  78.     void AddMenuBefore        (in ODMenuID menuID,
  79.                      in ODPlatformMenu menu,
  80.                      in ODPart part,
  81.                      in ODMenuID beforeID);
  82.  
  83.     void RemoveMenu            (in ODMenuID menu);
  84.  
  85.     ODPlatformMenu GetMenu        (in ODMenuID menu);
  86.  
  87.     ODBoolean IsValid        ();
  88.  
  89. #ifdef _PLATFORM_MACINTOSH_
  90.     //-----------------------------------------------------------------------------
  91.     // Public methods for Macintosh only
  92.     //-----------------------------------------------------------------------------
  93.  
  94.     void AddSubMenu            (in ODMenuID menuID,
  95.                      in ODPlatformMenu menu,
  96.                      in ODPart part);
  97.  
  98.     void RegisterCommand        (in ODCommandID command,
  99.                      in ODMenuID menu,
  100.                      in ODMenuItemID menuItem);
  101.  
  102.     void UnregisterCommand        (in ODCommandID command);
  103.  
  104.     void UnregisterAll        ();
  105.  
  106.     ODBoolean IsCommandRegistered    (in ODCommandID command);
  107.  
  108.     ODBoolean IsCommandSynthetic    (in ODCommandID command);
  109.  
  110.     ODCommandID GetCommand        (in ODMenuID menu,
  111.                      in ODMenuItemID menuItem);
  112.  
  113.     void GetMenuAndItem        (in ODCommandID command,
  114.                      out ODMenuID menu,
  115.                      out ODMenuItemID menuItem);
  116.  
  117.     void EnableCommand        (in ODCommandID cmdNumber,
  118.                      in ODBoolean enable);
  119.  
  120.     void CheckCommand        (in ODCommandID cmdNumber,
  121.                      in ODBoolean check);
  122.  
  123.     void EnableAndCheckCommand    (in ODCommandID cmdNumber,
  124.                      in ODBoolean enable,
  125.                      in ODBoolean check) ;
  126.  
  127.     void SetItemString        (in ODCommandID cmdNumber,
  128.                      in ODIText itemString);
  129.  
  130.     void GetItemString        (in ODCommandID cmdNumber,
  131.                      out ODIText itemString);
  132.  
  133.     void DisableAll            ();
  134.  
  135.     void EnableAll            ();
  136.  
  137.  
  138.  
  139. #endif // _PLATFORM_MACINTOSH_
  140.  
  141. #if defined(_PLATFORM_OS2_) || defined(_PLATFORM_WIN32_) || defined(_PLATFORM_AIX_)
  142.     //-----------------------------------------------------------------------------
  143.     // Public methods for OS/2, Windows, and AIX only
  144.     //-----------------------------------------------------------------------------
  145.  
  146.     ODUShort  GetMenuText        (in ODMenuID menuID,
  147.                      out string menuString);
  148.  
  149.     ODBoolean SetMenuText        (in ODMenuID menuID,
  150.                      in string menuString);
  151.  
  152.     ODUShort  GetMenuItemText    (in ODMenuID menuID,
  153.                      in ODMenuItemID menuItemID,
  154.                      out string menuItemString);
  155.  
  156.     ODBoolean SetMenuItemText    (in ODMenuID menuID,
  157.                      in ODMenuItemID menuItemID,
  158.                      in string menuItemString);
  159.  
  160.     ODBoolean SetHideMenuItem    (in ODMenuID menuID,
  161.                      in ODMenuItemID menuItemID);
  162.  
  163.     ODBoolean SetShowMenuItem    (in ODMenuID menuID,
  164.                      in ODMenuItemID menuItemID);
  165.  
  166.     ODBoolean CheckMenuItem        (in ODMenuID menuID,
  167.                      in ODMenuItemID menuItemID,
  168.                      in ODBoolean check);
  169.  
  170.     ODBoolean EnableMenu        (in ODMenuID menuID,
  171.                      in ODBoolean enable);
  172.  
  173.     ODBoolean EnableMenuItem    (in ODMenuID menuID,
  174.                      in ODMenuItemID menuItemID,
  175.                      in ODBoolean enable);
  176.  
  177.     ODBoolean AddMenuItemBefore    (in ODMenuID menuID,
  178.                      in ODMenuItemID itemID,
  179.                      in ODPlatformMenuItem menuItem,
  180.                      in ODMenuItemID beforeID);
  181.  
  182.     ODBoolean AddMenuItemLast    (in ODMenuID menuID,
  183.                      in ODMenuItemID itemID,
  184.                      in ODPlatformMenuItem menuItem);
  185.  
  186.     ODBoolean AddSubMenuBefore    (in ODMenuID menuID,
  187.                      in ODMenuItemID subMenuItemID,
  188.                      in ODPlatformMenu newSubMenu,
  189.                      in ODMenuItemID beforeID);
  190.  
  191.     ODBoolean AddSubMenuLast    (in ODMenuID menuID,
  192.                      in ODMenuItemID subMenuItemID,
  193.                      in ODPlatformMenu newSubMenu);
  194.  
  195.     // obsolete; remove this before GA
  196.     ODBoolean InsertSubmenu        (in ODMenuID menuID,
  197.                      in ODMenuItemID subMenuID,
  198.                      in ODPlatformMenu newSubmenu);
  199.  
  200.     ODBoolean MenuExists        (in ODMenuID menuID);
  201.  
  202.     ODBoolean IsMenuEnabled        (in ODMenuID menuID);
  203.  
  204.     ODBoolean MenuItemExists    (in ODMenuID menuID,
  205.                      in ODMenuItemID menuItemID);
  206.  
  207.     // obsolete; remove this before GA
  208.     ODBoolean Exists        (in ODMenuID menuID,
  209.                      in ODMenuItemID menuItemID);
  210.  
  211.     ODBoolean IsItemEnabled        (in ODMenuID menuID,
  212.                      in ODMenuItemID menuItemID);
  213.  
  214.     ODBoolean IsItemChecked        (in ODMenuID menuID,
  215.                      in ODMenuItemID menuItemID);
  216.  
  217.     ODBoolean IsItemHidden        (in ODMenuID menuID,
  218.                      in ODMenuItemID menuItemID);
  219.  
  220.     ODBoolean RemoveMenuItem    (in ODMenuID menuID,
  221.                      in ODMenuItemID menuItemID);
  222.  
  223.     ODBoolean GetMenuItem        (in ODMenuID menuID,
  224.                      in ODMenuItemID menuItemID,
  225.                      out ODPlatformMenuItem menuItem);
  226.  
  227.     ODBoolean AddToAccelTable    (in ODULong ulNumberofAccels,
  228.                      in ODACCEL NewAccels);
  229.  
  230.     void RestoreAccelTable        ();
  231.  
  232.     void GetMenuAndItem        (in ODCommandID command,
  233.                      out ODMenuID menu,
  234.                      out ODMenuItemID menuItem);
  235.  
  236.  
  237.  
  238. #endif // _PLATFORM_OS2_ || _PLATFORM_WIN32_ || _PLATFORM_AIX_
  239.  
  240. #ifdef _PLATFORM_WIN32_
  241.     //-----------------------------------------------------------------------------
  242.     // Public methods for Windows only
  243.     //-----------------------------------------------------------------------------
  244.     void AddMenuLastEx        (in ODMenuID menuID,
  245.                      in ODPlatformMenu menu,
  246.                      in ODPart part,
  247.                      in ODUShort      subMenuIDcount,
  248.                      in ODMenuIDInfo *subMenuIDinfo);
  249.  
  250.     void AddMenuBeforeEx        (in ODMenuID menuID,
  251.                      in ODPlatformMenu menu,
  252.                      in ODPart part,
  253.                      in ODMenuID beforeID,
  254.                      in ODUShort      subMenuIDcount,
  255.                      in ODMenuIDInfo *subMenuIDinfo);
  256.  
  257.     ODBoolean AddSubMenuBeforeEx    (in ODMenuID menuID,
  258.                      in ODMenuItemID subMenuItemID,
  259.                      in ODPlatformMenu newSubMenu,
  260.                      in ODMenuID beforeID,
  261.                      in ODUShort      subMenuIDcount,
  262.                      in ODMenuIDInfo *subMenuIDinfo);
  263.  
  264.     ODBoolean AddSubMenuLastEx    (in ODMenuID menuID,
  265.                      in ODMenuItemID subMenuItemID,
  266.                      in ODPlatformMenu newSubMenu,
  267.                      in ODUShort      subMenuIDcount,
  268.                      in ODMenuIDInfo *subMenuIDinfo);
  269.  
  270.  
  271. #endif // PLATFORM_WIN32
  272.  
  273. #ifdef _PLATFORM_AIX_
  274.     //-----------------------------------------------------------------------------
  275.     // Public methods for AIX only
  276.     //-----------------------------------------------------------------------------
  277.     ODPlatformMenu CreateX11PlatformMenu    (in ODMenuID menuID);
  278.  
  279.     void DestroyX11PlatformMenu        (in ODPlatformMenu menu);
  280. #endif // PLATFORM_AIX
  281.  
  282.  
  283.  
  284. #ifdef __SOMIDL__
  285.  
  286.     implementation
  287.     {
  288.  
  289.         majorversion = 1; minorversion = 0;
  290.  
  291.         functionprefix = ODMenuBar;
  292.  
  293.                 override:
  294.  
  295.     #if defined(_PLATFORM_OS2_) || defined(_PLATFORM_WIN32_) || defined(_PLATFORM_AIX_)
  296.             somInit,
  297.     #endif // _PLATFORM_OS2_ || _PLATFORM_WIN32_ || _PLATFORM_AIX_
  298.  
  299.             somUninit,
  300.             Purge,
  301.             Release;
  302.  
  303.         releaseorder:
  304.  
  305.                         Display,
  306.                         Copy,
  307.                         AddMenuLast,
  308.                         AddMenuBefore,
  309.                         RemoveMenu,
  310.                         GetMenu,
  311.                         IsValid,
  312.  
  313.     #ifdef _PLATFORM_MACINTOSH_
  314.                         AddSubMenu,
  315.                         RegisterCommand,
  316.                         UnregisterCommand,
  317.                         UnregisterAll,
  318.                         IsCommandRegistered,
  319.                         IsCommandSynthetic,
  320.                         GetCommand,
  321.                         GetMenuAndItem,
  322.                         EnableCommand,
  323.                         CheckCommand,
  324.                         EnableAndCheckCommand,
  325.                         SetItemString,
  326.                         GetItemString,
  327.                         DisableAll,
  328.                         EnableAll,
  329.                         reserved1,
  330.     #endif // _PLATFORM_MACINTOSH_
  331.  
  332.     #if defined(_PLATFORM_OS2_) || defined(_PLATFORM_WIN32_) || defined(_PLATFORM_AIX_)
  333.             GetMenuText,
  334.             SetMenuText,
  335.             GetMenuItemText,
  336.             SetMenuItemText,
  337.             SetHideMenuItem,
  338.             SetShowMenuItem,
  339.             CheckMenuItem,
  340.             EnableMenu,
  341.             EnableMenuItem,
  342.             AddMenuItemBefore,
  343.             AddMenuItemLast,
  344.             InsertSubmenu,
  345.             AddSubMenuBefore,
  346.             AddSubMenuLast,
  347.             MenuExists,
  348.             IsMenuEnabled,
  349.             MenuItemExists,
  350.             Exists,
  351.             IsItemEnabled,
  352.             IsItemChecked,
  353.             IsItemHidden,
  354.             RemoveMenuItem,
  355.             GetMenuItem,
  356.             AddToAccelTable,
  357.             RestoreAccelTable,
  358.         
  359.             reserved2,
  360.             reserved3,
  361.             reserved4,
  362.             reserved5,
  363.             reserved6,
  364.  
  365.     #endif // _PLATFORM_OS2_ || _PLATFORM_WIN32_ || _PLATFORM_AIX
  366.  
  367.     #ifdef _PLATFORM_WIN32_
  368.  
  369.             AddMenuLastEx,
  370.             AddMenuBeforeEx,
  371.             AddSubMenuBeforeEx,
  372.             AddSubMenuLastEx,
  373.  
  374.             reserved7,
  375.  
  376.     #endif // PLATFORM_WIN32
  377.  
  378.     #ifdef _PLATFORM_AIX_
  379.             CreateX11PlatformMenu,
  380.             DestroyX11PlatformMenu,
  381.     #endif // PLATFORM_AIX
  382.  
  383.             reserved8,
  384.             reserved9,
  385.             reserved10,
  386.  
  387.             GetMenuAndItem;
  388.  
  389.     #ifdef _PLATFORM_MACINTOSH_
  390.     #endif // _PLATFORM_MACINTOSH_
  391.  
  392.     #if defined(_PLATFORM_OS2_) || defined(_PLATFORM_WIN32_) || defined(_PLATFORM_AIX_)
  393.         //---------------------------------------------------------------------
  394.         // OS/2, WIN32, and AIX private instance data
  395.         //---------------------------------------------------------------------
  396.  
  397.     #endif // PLATFORM_OS2, PLATFORM_WIN32, PLATFORM_AIX
  398.  
  399.     };
  400. #endif // __SOMIDL__
  401.  
  402. };
  403.  
  404. #endif // _MENUBAR_
  405.  
  406.