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

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 _HXUPGRD_H
  36. #define _HXUPGRD_H
  37. #include "ihxpckts.h"
  38. typedef _INTERFACE IHXBuffer IHXBuffer;
  39. typedef _INTERFACE IHXValues IHXValues;
  40. /* Enumeration for the upgrade types */
  41. typedef enum _HXUpgradeType
  42. {
  43.     eUT_Required,
  44.     eUT_Recommended,
  45.     eUT_Optional,
  46.     eUT_FileTypeNotSupported
  47. } HXUpgradeType;
  48. /****************************************************************************
  49.  * 
  50.  *  Interface:
  51.  *
  52.  *   IHXUpgradeCollection
  53.  *
  54.  *  Purpose:
  55.  *
  56.  * Interface provided by the Context. This interface allows collection 
  57.  * of upgrade components by the client core and it's delegates 
  58.  * (i.e. renderer plugins etc.)
  59.  *
  60.  *  IID_IHXUpgradeCollection
  61.  *
  62.  * {00002500-0901-11d1-8B06-00A024406D59}
  63.  *
  64.  */
  65.  
  66. DEFINE_GUID(IID_IHXUpgradeCollection, 
  67.     0x00002500, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  68. #undef  INTERFACE
  69. #define INTERFACE   IHXUpgradeCollection
  70. DECLARE_INTERFACE_(IHXUpgradeCollection, IUnknown)
  71. {
  72.     /*
  73.      * IHXUpgradeCollection methods
  74.      */
  75.     /************************************************************************
  76.      * Method:
  77.      * IHXUpgradeCollection::Add
  78.      * Purpose:
  79.      * Adds the specified upgrade information to the collection
  80.      *
  81.      */
  82.     STDMETHOD_(UINT32, Add) (THIS_ 
  83.      HXUpgradeType upgradeType,
  84. IHXBuffer* pPluginId,
  85. UINT32 majorVersion,
  86. UINT32 minorVersion) PURE;
  87.     /************************************************************************
  88.      * Method:
  89.      * IHXUpgradeCollection::Remove
  90.      * Purpose:
  91.      * Remove the specified item from the collection
  92.      *
  93.      */
  94.     STDMETHOD(Remove) (THIS_ 
  95.      UINT32 index) PURE;
  96.     /************************************************************************
  97.      * Method:
  98.      * IHXUpgradeCollection::RemoveAll
  99.      * Purpose:
  100.      * Remove all items from the collection
  101.      *
  102.      */
  103.     STDMETHOD(RemoveAll)     (THIS) PURE;
  104.     /************************************************************************
  105.      * Method:
  106.      * IHXUpgradeCollection::GetCount
  107.      * Purpose:
  108.      * get the count of the collection
  109.      *
  110.      */
  111.     STDMETHOD_(UINT32, GetCount)(THIS) PURE;
  112.     /************************************************************************
  113.      * Method:
  114.      * IHXUpgradeCollection::GetAt
  115.      * Purpose:
  116.      * get the specified items upgrade information
  117.      *
  118.      */
  119.     STDMETHOD(GetAt) (THIS_ 
  120.      UINT32 index,
  121. REF(HXUpgradeType) upgradeType,
  122. IHXBuffer* pPluginId,
  123. REF(UINT32) majorVersion, 
  124. REF(UINT32) minorVersion) PURE;
  125. };
  126. /****************************************************************************
  127.  * 
  128.  *  Interface:
  129.  *
  130.  *   IHXUpgradeHandler
  131.  *
  132.  *  Purpose:
  133.  *
  134.  * Interface provided by the top-level client application.  This
  135.  * interface allows the client core to request an upgrade.
  136.  *
  137.  *  IID_IHXUpgradeHandler:
  138.  *
  139.  * {00002501-0901-11d1-8B06-00A024406D59}
  140.  *
  141.  */
  142.  
  143. DEFINE_GUID(IID_IHXUpgradeHandler, 
  144.                         0x00002501, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  145. #undef  INTERFACE
  146. #define INTERFACE   IHXUpgradeHandler
  147. DECLARE_INTERFACE_(IHXUpgradeHandler, IUnknown)
  148. {
  149.     /*
  150.      * IHXUpgradeHandler methods
  151.      */
  152.     /************************************************************************
  153.      * Method:     IHXUpgradeHandler::RequestUpgrade
  154.      * Purpose:    Send a request for an upgrade of particular set of components.
  155.      *     If new components are available ask user and start upgrade.
  156.      *  Arguments:
  157.      *     pUpgradeCollection - interface that determines what components
  158.      *  to upgrade.
  159.      *      bBlocking          - flag of not returning from this call until
  160.      *  upgrade is done.
  161.      *  Return Value:
  162.      *     HXR_OK             - upgrade request was sent;
  163.      *  if bBlocking == TRUE new components received
  164.      *  and sucesfully installed.
  165.      *     HXR_FAILED        - upgrade failed.
  166.      *     HXR_NO_DATA        - user cancelled the upgrade or
  167.      *  no new data available at this time.
  168.      */
  169.     STDMETHOD(RequestUpgrade) (THIS_ IHXUpgradeCollection* pComponents,
  170.      BOOL bBlocking) PURE;
  171.     /************************************************************************
  172.      * Method:
  173.      * IHXUpgradeHandler::HasComponents
  174.      * Purpose:
  175.      * Check if required components are present on the system.
  176.      *  Returns:
  177.      * HXR_OK - components are here, no upgrade required;
  178.      *  all components are removed from pComponents.
  179.      *          HXR_FAIL - some components are missing;
  180.      *                   pComponents contains only those components 
  181.      *  that need upgrade.
  182.      *
  183.      */       
  184.     STDMETHOD(HasComponents)  (THIS_ IHXUpgradeCollection* pComponents) PURE;
  185. };
  186. // $Private:
  187. /****************************************************************************
  188.  * 
  189.  *  Interface:
  190.  *
  191.  *   IHXSystemRequired
  192.  *
  193.  *  Purpose:
  194.  *
  195.  * Interface provided by the client core. It can be replaced by the top 
  196.  * level client. 
  197.  *
  198.  *  IID_IHXSystemRequired:
  199.  *
  200.  * {00002502-0901-11d1-8B06-00A024406D59}
  201.  *
  202.  */
  203.  
  204. DEFINE_GUID(IID_IHXSystemRequired, 
  205. 0x00002502, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  206. #undef  INTERFACE
  207. #define INTERFACE   IHXSystemRequired
  208. DECLARE_INTERFACE_(IHXSystemRequired, IUnknown)
  209. {
  210.     /*
  211.      * IHXSystemRequired methods
  212.      */
  213.     /************************************************************************
  214.      * Method:
  215.      * IHXSystemRequired::HasFeatures
  216.      * Purpose:
  217.      * Check if required features are present on the system.
  218.      *  Returns:
  219.      * HXR_OK -    features are here, no upgrade required;
  220.      *     all features are removed from pFeatures.
  221.      * HXR_FAIL -  some features are missing;
  222.      *     pFeatures contains only those features 
  223.      *     that need upgrade.
  224.      *
  225.      */       
  226.     STDMETHOD(HasFeatures)  (THIS_ 
  227.     IHXUpgradeCollection* pFeatures) PURE;
  228. };
  229. // $EndPrivate.
  230. /****************************************************************************
  231.  * 
  232.  *  Interface:
  233.  *
  234.  *   IHXUpgradeCollection2
  235.  *
  236.  *  Purpose:
  237.  *
  238.  * Interface provided by the Context. Allows to add additional information
  239.  * to be passed to upgrade server for a given component
  240.  *
  241.  *  IID_IHXUpgradeCollection2
  242.  *
  243.  * {00002503-0901-11d1-8B06-00A024406D59}
  244.  *
  245.  */
  246.  
  247. DEFINE_GUID(IID_IHXUpgradeCollection2, 
  248.     0x00002503, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  249. #undef  INTERFACE
  250. #define INTERFACE   IHXUpgradeCollection2
  251. DECLARE_INTERFACE_(IHXUpgradeCollection2, IUnknown)
  252. {
  253.     /*
  254.      * IHXUpgradeCollection2 methods
  255.      */
  256.     /************************************************************************
  257.      * Method:
  258.      * IHXUpgradeCollection::AddURLParseElement
  259.      * Purpose:
  260.      * Adds name-value pair for RUP URL parsing:
  261.      * URL-encoded values substitute names.
  262.      *
  263.      */
  264.     STDMETHOD(AddURLParseElement) (THIS_ const char* pName,
  265.  const char* Value) PURE;
  266.     /************************************************************************
  267.      * Method:
  268.      * IHXUpgradeCollection::GetURLParseElements
  269.      * Purpose:
  270.      * Gets name-value pair for RUP URL parsing.
  271.      *
  272.      */
  273.     STDMETHOD(GetURLParseElements) (THIS_ REF(IHXValues*) pURLParseElements) PURE;
  274. };
  275. #endif /* _HXUPGRD_H */
  276.