hxcmenu.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:8k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef _HXCMENU_H_
  36. #define _HXCMENU_H_
  37. /*
  38.  * Forward declarations of some interfaces defined or used here-in.
  39.  */
  40. typedef _INTERFACE  IHXContextMenu          IHXContextMenu;
  41. typedef _INTERFACE  IHXContextMenuResponse  IHXContextMenuResponse;
  42. /****************************************************************************
  43.  * 
  44.  *  Interface:
  45.  *
  46.  *  IHXContextMenu
  47.  *
  48.  *  Purpose:
  49.  *
  50.  *  Interface implemented by top level clients and provided to renderers.
  51.  *  Allows the renderer to show a context menu and the top level client
  52.  *  to add client specitic commands unknown to the renderer to that menu.
  53.  *
  54.  *  IID_IHXContextMenu:
  55.  *
  56.  *  {00001f00-0901-11d1-8B06-00A024406D59}
  57.  *
  58.  */
  59. DEFINE_GUID(IID_IHXContextMenu, 0x00001f00, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  60.             0xa0, 0x24, 0x40, 0x6d, 0x59);
  61. #undef  INTERFACE
  62. #define INTERFACE   IHXContextMenu
  63. DECLARE_INTERFACE_(IHXContextMenu, IUnknown)
  64. {
  65.     /*
  66.      * IUnknown methods
  67.      */
  68.     STDMETHOD(QueryInterface)   (THIS_
  69.                 REFIID riid,
  70.                 void** ppvObj) PURE;
  71.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  72.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  73.     /*
  74.      * IHXContextMenu methods
  75.      */
  76.     /************************************************************************
  77.      *  Method:
  78.      *      IHXContextMenu::InitContextMenu
  79.      *  Purpose:
  80.      *      Initializes the context menu to a blank menu, and sets the name
  81.      *      of the "sub menu" for the renderer if appropriate. This will 
  82.      *      clear any previously added menu items and sub menus.
  83.      */
  84.     STDMETHOD(InitContextMenu)  (THIS_
  85.                                  const char* pMenuText
  86.                                  ) PURE;
  87.     
  88.     /************************************************************************
  89.      *  Method:
  90.      *      IHXContextMenu::AddMenuItem
  91.      *  Purpose:
  92.      *      Returns information vital to the instantiation of rendering 
  93.      *      plugins.
  94.      */
  95.     STDMETHOD(AddMenuItem)  (THIS_
  96.                              UINT16      commandID, 
  97.                              const char* pMenuItemText, 
  98.                              BOOL        bChecked,
  99.                              BOOL        bRadioOn, 
  100.                              BOOL        bDisabled
  101.                              ) PURE;
  102.     
  103.     /************************************************************************
  104.      *  Method:
  105.      *      IHXContextMenu::AddMenuItem
  106.      *  Purpose:
  107.      *      Returns information vital to the instantiation of rendering 
  108.      *      plugins.
  109.      */
  110.     STDMETHOD(AddSeparator) (THIS) PURE;
  111.     /************************************************************************
  112.      *  Method:
  113.      *      IHXContextMenu::AddChildMenu
  114.      *  Purpose:
  115.      *      Returns information vital to the instantiation of rendering 
  116.      *      plugins.
  117.      */
  118.     STDMETHOD(AddChildMenu) (THIS_
  119.                              const char* pMenuText
  120.                              ) PURE;
  121.     
  122.     /************************************************************************
  123.      *  Method:
  124.      *      IHXContextMenu::EndChildMenu
  125.      *  Purpose:
  126.      *      Returns information vital to the instantiation of rendering 
  127.      *      plugins.
  128.      */
  129.     STDMETHOD(EndChildMenu) (THIS) PURE;
  130.     /************************************************************************
  131.      *  Method:
  132.      *      IHXContextMenu::ChangeMenuItem
  133.      *  Purpose:
  134.      *      Returns information vital to the instantiation of rendering 
  135.      *      plugins.
  136.      */
  137.     STDMETHOD(ChangeMenuItem)   (THIS_
  138.                                  UINT16      commandID, 
  139.                                  const char* pMenuItemText, 
  140.                                  BOOL        bChecked,
  141.                                  BOOL        bRadioOn, 
  142.                                  BOOL        bDisabled
  143.                                  ) PURE;
  144.     /************************************************************************
  145.      *  Method:
  146.      *      IHXContextMenu::ShowMenu
  147.      *  Purpose:
  148.      *      Shows the setup context menu at the specified point.
  149.      */
  150.     STDMETHOD(ShowMenu)     (THIS_
  151.                              IHXContextMenuResponse* pResonse,
  152.                              HXxPoint ptPopup
  153.                              ) PURE;
  154.     
  155. };
  156. /****************************************************************************
  157.  * 
  158.  *  Interface:
  159.  *
  160.  *  IHXContextMenuResponse
  161.  *
  162.  *  Purpose:
  163.  *
  164.  *  Interface implemented by renderers that use the context menut.
  165.  *  Is called to inform the renderer that a particular menu item was
  166.  *  chosen.
  167.  *
  168.  *  IHXContextMenuResponse:
  169.  *
  170.  *  {00001f01-0901-11d1-8B06-00A024406D59}
  171.  *
  172.  */
  173. DEFINE_GUID(IID_IHXContextMenuResponse, 0x00001f01, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  174.             0xa0, 0x24, 0x40, 0x6d, 0x59);
  175. #undef  INTERFACE
  176. #define INTERFACE   IHXContextMenuResponse
  177. DECLARE_INTERFACE_(IHXContextMenuResponse, IUnknown)
  178. {
  179.     /*
  180.      * IUnknown methods
  181.      */
  182.     STDMETHOD(QueryInterface)   (THIS_
  183.                                  REFIID riid,
  184.                                  void** ppvObj) PURE;
  185.     
  186.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  187.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  188.     /*
  189.      * IHXContextMenuResponse methods
  190.      */
  191.     /************************************************************************
  192.      *  Method:
  193.      *      IHXContextMenuResponse::OnCommand
  194.      *  Purpose:
  195.      *      Called to inform the renderer that a command was chosen from
  196.      *      the context menu.
  197.      */
  198.     STDMETHOD(OnCommand)    (THIS_
  199.                              UINT16 commandID
  200.                              ) PURE;
  201.     
  202.     /************************************************************************
  203.      *  Method:
  204.      *      IHXContextMenuResponse::OnCanceled
  205.      *  Purpose:
  206.      *      Called to inform the renderer that the context menu was closed
  207.      *      without a command being chosen from the renders set of commands.
  208.      */
  209.     STDMETHOD(OnCanceled)   (THIS) PURE;
  210. };
  211. #endif /* _HXCMENU_H_ */