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

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 _HXPLGNS_H_
  36. #define _HXPLGNS_H_
  37. /*
  38.  * Forward declarations of some interfaces defined or used here-in.
  39.  */
  40. typedef _INTERFACE  IUnknown     IUnknown;
  41. typedef _INTERFACE  IHXObjectConfiguration     IHXObjectConfiguration;
  42. typedef _INTERFACE  IHXPluginProperties     IHXPluginProperties;
  43. typedef _INTERFACE  IHXBuffer     IHXBuffer;
  44. typedef _INTERFACE  IHXValues     IHXValues;
  45. /****************************************************************************
  46.  * 
  47.  *  Interface:
  48.  *
  49.  * IHXObjectConfiguration
  50.  *
  51.  *  Purpose:
  52.  *
  53.  * Interface for setting context and generic means of plugin 
  54.  * Configuration.
  55.  *
  56.  *  IHXObjectConfiguration:
  57.  *
  58.  * {0x00002900-0901-11d1-8B06-00A024406D59}
  59.  *
  60.  */
  61. DEFINE_GUID(IID_IHXObjectConfiguration,   0x00002900, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  62. #undef  INTERFACE
  63. #define INTERFACE   IHXObjectConfiguration
  64. DECLARE_INTERFACE_(IHXObjectConfiguration, IUnknown)
  65. {
  66.     /*
  67.      * IUnknown methods
  68.      */
  69.     STDMETHOD(QueryInterface) (THIS_
  70. REFIID riid,
  71. void** ppvObj) PURE;
  72.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  73.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  74.     /************************************************************************
  75.      * Method:
  76.      *     IHXObjectConfiguration::SetContext
  77.      * Purpose:
  78.      *     This function is called to set the context for the plugin.
  79.      *     Either IHXPlugin::InitPlugin or this function must be called 
  80.      *     before calling any other function on the plugin.
  81.      *     this is intended to be used as a shortcut for the plugin user.
  82.      *     If one needs to use SetConfiguration they only need to query
  83.      *     IHXObjectConfiguration saving them from also querying for 
  84.      *     IHXPlugin.
  85.      *
  86.      */
  87.     STDMETHOD(SetContext)
  88.     (
  89. THIS_
  90. IUnknown*   pIUnknownContext
  91.     ) PURE;
  92.     /************************************************************************
  93.      * Method:
  94.      *     IHXObjectConfiguration::SetConfiguration
  95.      * Purpose:
  96.      *     This allows the user of a plugin to supply configuration
  97.      *     information.  This is often a set of CString properties
  98.      *     extracted from a list in the config file.  This allows
  99.      *     each plugin within a class (auth plugin, database plugin, etc..) 
  100.      *     to require a different set of parameters.
  101.      *
  102.      */
  103.     STDMETHOD(SetConfiguration)
  104.     (
  105. THIS_
  106. IHXValues* pIHXValuesConfiguration
  107.     ) PURE;
  108. };
  109. /****************************************************************************
  110.  * 
  111.  *  Interface:
  112.  *
  113.  * IHXPluginProperties
  114.  *
  115.  *  Purpose:
  116.  *
  117.  * This allows plugins to return whatever properties they want.
  118.  *
  119.  *  IHXPluginProperties:
  120.  *
  121.  * {0x00002901-0901-11d1-8B06-00A024406D59}
  122.  *
  123.  */
  124. DEFINE_GUID(IID_IHXPluginProperties,   0x00002901, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  125. #undef  INTERFACE
  126. #define INTERFACE   IHXPluginProperties
  127. DECLARE_INTERFACE_(IHXPluginProperties, IUnknown)
  128. {
  129.     /*
  130.      * IUnknown methods
  131.      */
  132.     STDMETHOD(QueryInterface) (THIS_
  133. REFIID riid,
  134. void** ppvObj) PURE;
  135.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  136.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  137.     /************************************************************************
  138.      * Method:
  139.      *     IHXPluginProperties::GetProperties
  140.      * Purpose:
  141.      *     A plugin will implement this in order to return plugin properties
  142.      *     that will allow it to be identified uniquely.  (PluginID, 
  143.      *     AuthenticationProtocol, etc..)
  144.      *
  145.      */
  146.     STDMETHOD(GetProperties)
  147.     (
  148. THIS_
  149. REF(IHXValues*) pIHXValuesProperties
  150.     ) PURE;
  151. };
  152. #endif /* !_HXPLGNS_H_ */