hxcmenu.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:9k
源码类别:

Symbian

开发平台:

Visual C++

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