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

Symbian

开发平台:

Visual C++

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