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

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 _HXVPORT_H_
  36. #define _HXVPORT_H_
  37. /*
  38.  * Forward declarations of some interfaces defined or used here-in.
  39.  */
  40. typedef _INTERFACE IHXValues IHXValues;
  41. typedef _INTERFACE IHXViewPortManager IHXViewPortManager;
  42. typedef _INTERFACE IHXViewPort IHXViewPort;
  43. typedef _INTERFACE IHXViewPortSink IHXViewPortSink;
  44. typedef _INTERFACE IHXSiteUser IHXSiteUser;
  45. /****************************************************************************
  46.  * 
  47.  *  Interface:
  48.  *
  49.  * IHXViewPortManager
  50.  *
  51.  *  Purpose:
  52.  *
  53.  * Interface to manage IHXViewPort
  54.  *
  55.  *  IID_IHXViewPortManager:
  56.  *
  57.  * {00004000-0901-11d1-8B06-00A024406D59}
  58.  *
  59.  */
  60. DEFINE_GUID(IID_IHXViewPortManager, 0x00004000, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  61.      0xa0, 0x24, 0x40, 0x6d, 0x59);
  62. DECLARE_INTERFACE_(IHXViewPortManager, IUnknown)
  63. {
  64.     /*
  65.      * IUnknown methods
  66.      */
  67.     STDMETHOD(QueryInterface) (THIS_
  68. REFIID riid,
  69. void** ppvObj) PURE;
  70.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  71.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  72.     /*
  73.      * IHXViewPortManager methods
  74.      */
  75.     /************************************************************************
  76.      * Method:
  77.      *     IHXViewPortManager::OpenViewPort
  78.      * Purpose:
  79.      *     create viewport
  80.      */
  81.     STDMETHOD(OpenViewPort) (THIS_
  82.  IHXValues* pValues,
  83.  IHXSiteUser* pSiteUser) PURE;
  84.     /************************************************************************
  85.      * Method:
  86.      *     IHXViewPortManager::GetViewPort
  87.      * Purpose:
  88.      *     get viewport
  89.      */
  90.     STDMETHOD(GetViewPort) (THIS_
  91.  const char* pszViewPort,
  92.  REF(IHXViewPort*) pViewPort) PURE;
  93.     /************************************************************************
  94.      * Method:
  95.      *     IHXViewPortManager::CloseViewPort
  96.      * Purpose:
  97.      *     remove viewport
  98.      */
  99.     STDMETHOD(CloseViewPort) (THIS_
  100.  const char* pszViewPort) PURE;
  101.     /************************************************************************
  102.      * Method:
  103.      *     IHXViewPortManager::AddViewPortSink
  104.      * Purpose:
  105.      *     add viewport sinker
  106.      */
  107.     STDMETHOD(AddViewPortSink) (THIS_
  108.  IHXViewPortSink*  pViewPortSink) PURE;
  109.     /************************************************************************
  110.      * Method:
  111.      *     IHXViewPortManager::RemoveViewPortSink
  112.      * Purpose:
  113.      *     remove viewport sinker
  114.      */
  115.     STDMETHOD(RemoveViewPortSink)   (THIS_
  116.      IHXViewPortSink*  pViewPortSink) PURE;
  117. };
  118. /****************************************************************************
  119.  * 
  120.  *  Interface:
  121.  *
  122.  * IHXViewPort
  123.  *
  124.  *  Purpose:
  125.  *
  126.  * Interface to IHXViewPort
  127.  *
  128.  *  IID_IHXViewPort
  129.  *
  130.  * {00004001-0901-11d1-8B06-00A024406D59}
  131.  */
  132. DEFINE_GUID(IID_IHXViewPort, 0x00004001, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  133.     0xa0, 0x24, 0x40, 0x6d, 0x59);
  134. DECLARE_INTERFACE_(IHXViewPort, IUnknown)
  135. {
  136.     /*
  137.      * IUnknown methods
  138.      */
  139.     STDMETHOD(QueryInterface) (THIS_
  140. REFIID riid,
  141. void** ppvObj) PURE;
  142.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  143.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  144.     /*
  145.      * IHXViewPort methods
  146.      */
  147.     /************************************************************************
  148.      * Method:
  149.      *     IHXViewPort::GetName
  150.      * Purpose:
  151.      *     get name of the viewport
  152.      */
  153.     STDMETHOD_(const char*, GetName) (THIS) PURE;
  154.     /************************************************************************
  155.      * Method:
  156.      *     IHXViewPort::GetProperties
  157.      * Purpose:
  158.      *     get properties of the viewport
  159.      */
  160.     STDMETHOD(GetProperties) (THIS_
  161.  REF(IHXValues*)   pValues) PURE;
  162.     /************************************************************************
  163.      * Method:
  164.      *     IHXViewPort::Show
  165.      * Purpose:
  166.      *     show viewport
  167.      */
  168.     STDMETHOD(Show) (THIS) PURE;
  169.     /************************************************************************
  170.      * Method:
  171.      *     IHXViewPort::Hide
  172.      * Purpose:
  173.      *     hide viewport
  174.      */
  175.     STDMETHOD(Hide) (THIS) PURE;
  176.     /************************************************************************
  177.      * Method:
  178.      *     IHXViewPort::SetFocus
  179.      * Purpose:
  180.      *     set focus on viewport
  181.      */
  182.     STDMETHOD(SetFocus) (THIS) PURE;
  183.     /************************************************************************
  184.      * Method:
  185.      *     IHXViewPort::SetZOrder
  186.      * Purpose:
  187.      *     set Z order on viewport
  188.      */
  189.     STDMETHOD(SetZOrder) (THIS_
  190.  UINT32 ulZOrder) PURE;
  191. };
  192. /****************************************************************************
  193.  * 
  194.  *  Interface:
  195.  *
  196.  * IHXViewPortSink
  197.  *
  198.  *  Purpose:
  199.  *
  200.  * Interface sinker to IHXViewPort
  201.  *
  202.  *  IID_IHXViewPortSink
  203.  *
  204.  * {00004002-0901-11d1-8B06-00A024406D59}
  205.  */
  206. DEFINE_GUID(IID_IHXViewPortSink, 0x00004002, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  207.     0xa0, 0x24, 0x40, 0x6d, 0x59);
  208. DECLARE_INTERFACE_(IHXViewPortSink, IUnknown)
  209. {
  210.     /*
  211.      * IUnknown methods
  212.      */
  213.     STDMETHOD(QueryInterface) (THIS_
  214. REFIID riid,
  215. void** ppvObj) PURE;
  216.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  217.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  218.     /*
  219.      * IHXViewPortSink methods
  220.      */
  221.     /************************************************************************
  222.      * Method:
  223.      *     IHXViewPortSink::ViewPortOpened
  224.      * Purpose:
  225.      *     notification of the addition of viewport
  226.      */
  227.     STDMETHOD(ViewPortOpened) (THIS_
  228.  const char* pszViewPort) PURE;
  229.     /************************************************************************
  230.      * Method:
  231.      *     IHXViewPortSink::ViewPortClosed
  232.      * Purpose:
  233.      *     notification of the removal of viewport
  234.      */
  235.     STDMETHOD(ViewPortClosed) (THIS_
  236.  const char* pszViewPort) PURE;
  237.     /************************************************************************
  238.      * Method:
  239.      *     IHXViewPortSink::ViewPortShown
  240.      * Purpose:
  241.      *     notification of the shown of viewport
  242.      */
  243.     STDMETHOD(ViewPortShown) (THIS_
  244.  const char* pszViewPort) PURE;
  245.     /************************************************************************
  246.      * Method:
  247.      *     IHXViewPortSink::ViewPortHidden
  248.      * Purpose:
  249.      *     notification of the hide of viewport
  250.      */
  251.     STDMETHOD(ViewPortHidden) (THIS_
  252.  const char* pszViewPort) PURE;
  253.     /************************************************************************
  254.      * Method:
  255.      *     IHXViewPortSink::ViewPortFocusSet
  256.      * Purpose:
  257.      *     notification of the active focus of viewport
  258.      */
  259.     STDMETHOD(ViewPortFocusSet) (THIS_
  260.  const char* pszViewPort) PURE;
  261.     /************************************************************************
  262.      * Method:
  263.      *     IHXViewPortSink::ViewPortZOrderSet
  264.      * Purpose:
  265.      *     notification of the Z order of viewport
  266.      */
  267.     STDMETHOD(ViewPortZOrderSet)(THIS_
  268.  const char* pszViewPort,
  269.  UINT32 ulZOrder) PURE;
  270. };
  271. /****************************************************************************
  272.  * 
  273.  *  Interface:
  274.  *
  275.  * IHXViewPortSupplier
  276.  *
  277.  *  Purpose:
  278.  *
  279.  * Interface IHXViewPortSupplier
  280.  *
  281.  *  IID_IHXViewPortSupplier
  282.  *
  283.  * {00004003-0901-11d1-8B06-00A024406D59}
  284.  */
  285. DEFINE_GUID(IID_IHXViewPortSupplier, 0x00004003, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  286.     0xa0, 0x24, 0x40, 0x6d, 0x59);
  287. DECLARE_INTERFACE_(IHXViewPortSupplier, IUnknown)
  288. {
  289.     /*
  290.      * IUnknown methods
  291.      */
  292.     STDMETHOD(QueryInterface) (THIS_
  293. REFIID riid,
  294. void** ppvObj) PURE;
  295.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  296.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  297.     /*
  298.      * IHXViewPortSupplier methods
  299.      */
  300.     /************************************************************************
  301.      * Method:
  302.      *     IHXViewPortSupplier::OnViewPortOpen
  303.      * Purpose:
  304.      *     notification of the addition of viewport
  305.      */
  306.     STDMETHOD(OnViewPortOpen) (THIS_
  307.  IHXValues* pValues,
  308.  IHXSiteUser* pSiteUser) PURE;
  309.     /************************************************************************
  310.      * Method:
  311.      *     IHXViewPortSupplier::OnViewPortClose
  312.      * Purpose:
  313.      *     notification of the removal of viewport
  314.      */
  315.     STDMETHOD(OnViewPortClose) (THIS_
  316.  const char* pszViewPort) PURE;
  317.     /************************************************************************
  318.      * Method:
  319.      *     IHXViewPortSupplier::OnViewPortShow
  320.      * Purpose:
  321.      *     notification of the shown of viewport
  322.      */
  323.     STDMETHOD(OnViewPortShow) (THIS_
  324.  const char* pszViewPort) PURE;
  325.     /************************************************************************
  326.      * Method:
  327.      *     IHXViewPortSupplier::OnViewPortHide
  328.      * Purpose:
  329.      *     notification of the hide of viewport
  330.      */
  331.     STDMETHOD(OnViewPortHide) (THIS_
  332.  const char* pszViewPort) PURE;
  333.     /************************************************************************
  334.      * Method:
  335.      *     IHXViewPortSupplier::OnViewPortFocus
  336.      * Purpose:
  337.      *     notification of the active focus of viewport
  338.      */
  339.     STDMETHOD(OnViewPortFocus) (THIS_
  340.  const char* pszViewPort) PURE;
  341.     /************************************************************************
  342.      * Method:
  343.      *     IHXViewPortSupplier::OnViewPortZOrder
  344.      * Purpose:
  345.      *     notification of the Z order of viewport
  346.      */
  347.     STDMETHOD(OnViewPortZOrder) (THIS_
  348.  const char* pszViewPort,
  349.  UINT32 ulZOrder) PURE;
  350. };
  351. #endif /* _HXVPORT_H_ */