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

Symbian

开发平台:

Visual C++

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