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

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: hxvalue.h,v 1.1.1.1.50.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 _HXVALUE_H_
  50. #define _HXVALUE_H_
  51. #include "hxcom.h"
  52. /*
  53.  * Forward declarations of some interfaces defined or used here-in.
  54.  */
  55. typedef _INTERFACE  IUnknown     IUnknown;
  56. typedef _INTERFACE  IHXBuffer     IHXBuffer;
  57. typedef _INTERFACE  IHXKeyValueList     IHXKeyValueList;
  58. typedef _INTERFACE  IHXKeyValueListIter            IHXKeyValueListIter;
  59. typedef _INTERFACE  IHXKeyValueListIterOneKey      IHXKeyValueListIterOneKey;
  60. typedef _INTERFACE  IHXValues     IHXValues;
  61. typedef _INTERFACE  IHXOptions     IHXOptions;
  62. /* Note : GUIDS 3101 - 3107 are deprecated. */
  63. /****************************************************************************
  64.  * 
  65.  *  Interface:
  66.  *
  67.  * IHXKeyValueList
  68.  *
  69.  *  Purpose:
  70.  *
  71.  * Stores a list of strings, where strings are keyed by not necessarily
  72.  *      unique keys.
  73.  *
  74.  *
  75.  *  IHXKeyValueList:
  76.  *
  77.  * {0x00003108-0901-11d1-8B06-00A024406D59}
  78.  *
  79.  */
  80. DEFINE_GUID(IID_IHXKeyValueList, 0x00003108, 0x901, 0x11d1, 
  81.     0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  82. #define CLSID_IHXKeyValueList IID_IHXKeyValueList
  83. #undef  INTERFACE
  84. #define INTERFACE   IHXKeyValueList
  85. DECLARE_INTERFACE_(IHXKeyValueList, IUnknown)
  86. {
  87.     /*
  88.      * IUnknown methods
  89.      */
  90.     STDMETHOD(QueryInterface) (THIS_
  91. REFIID riid,
  92. void** ppvObj) PURE;
  93.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  94.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  95.     /*
  96.      * Regular methods
  97.      */
  98.      /************************************************************************
  99.      * Method:
  100.      *     IHXKeyValueList::AddKeyValue
  101.      * Purpose:
  102.      *      Add a new key/value tuple to our list of strings.  You can have
  103.      *      multiple strings for the same key.
  104.      */
  105.     STDMETHOD(AddKeyValue) (THIS_
  106. const char* pKey,
  107. IHXBuffer* pStr) PURE;
  108.      /************************************************************************
  109.      * Method:
  110.      *     IHXKeyValueList::GetIter
  111.      * Purpose:
  112.      *      Return an iterator that allows you to iterate through all the 
  113.      *      key/value tuples in our list of strings.
  114.      */
  115.     STDMETHOD(GetIter) (THIS_
  116. REF(IHXKeyValueListIter*) pIter) PURE;
  117.      /************************************************************************
  118.      * Method:
  119.      *     IHXKeyValueList::GetIterOneKey
  120.      * Purpose:
  121.      *      Return an iterator that allows you to iterate through all the 
  122.      *      strings for a particular key.
  123.      */
  124.     STDMETHOD(GetIterOneKey) (THIS_
  125. const char* pKey,
  126. REF(IHXKeyValueListIterOneKey*) pIter) PURE;
  127.      /************************************************************************
  128.      * Method:
  129.      *     IHXKeyValueList::AppendAllListItems
  130.      * Purpose:
  131.      *      Append all the key/string tuples from another list to this list.
  132.      *      (You can have duplicate keys.)
  133.      */
  134.     STDMETHOD(AppendAllListItems)   (THIS_
  135.     IHXKeyValueList* pList) PURE;
  136.      /************************************************************************
  137.      * Method:
  138.      *     IHXKeyValueList::KeyExists
  139.      * Purpose:
  140.      *      See whether any strings exist for a particular key.
  141.      */
  142.     STDMETHOD_(BOOL,KeyExists)  (THIS_
  143. const char* pKey) PURE;
  144.      /************************************************************************
  145.      * Method:
  146.      *     IHXKeyValueList::CreateObject
  147.      * Purpose:
  148.      *      Create an empty object that is the same class as the current object.
  149.      */
  150.     STDMETHOD(CreateObject) (THIS_
  151. REF(IHXKeyValueList*) pNewList) PURE;
  152.      /************************************************************************
  153.      * Method:
  154.      *     IHXKeyValueList::ImportValues.
  155.      * Purpose:
  156.      *      Import all the strings from an IHXValues object into this object.
  157.      *      If this object also supports IHXValues, it should also import the 
  158.      *      ULONGs and Buffers.  You can have duplicate keys, and old data is 
  159.      *      left untouched.
  160.      */
  161.     STDMETHOD(ImportValues) (THIS_
  162. IHXValues* pValues) PURE;
  163. };
  164. /****************************************************************************
  165.  * 
  166.  *  Interface:
  167.  *
  168.  * IHXKeyValueListIter
  169.  *
  170.  *  Purpose:
  171.  *
  172.  * Iterate over all the items in a CKeyValueList.
  173.  *      Call IHXKeyValueList::GetIter to create an iterator.
  174.  *
  175.  *
  176.  *  IHXKeyValueListIter:
  177.  *
  178.  * {0x00003109-0901-11d1-8B06-00A024406D59}
  179.  *
  180.  */
  181. DEFINE_GUID(IID_IHXKeyValueListIter,   0x00003109, 0x901, 0x11d1, 
  182.     0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  183. #define CLSID_IHXKeyValueListIter IID_IHXKeyValueListIter
  184. #undef  INTERFACE
  185. #define INTERFACE   IHXKeyValueListIter
  186. DECLARE_INTERFACE_(IHXKeyValueListIter, IUnknown)
  187. {
  188.     /*
  189.      * IUnknown methods
  190.      */
  191.     STDMETHOD(QueryInterface) (THIS_
  192. REFIID riid,
  193. void** ppvObj) PURE;
  194.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  195.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  196.     /*
  197.      * Regular methods
  198.      */
  199.      /************************************************************************
  200.      * Method:
  201.      *     IHXKeyValueListIter::GetNextPair
  202.      * Purpose:
  203.      *      Each call to this method returns one key/value tuple from your
  204.      *      list of strings.  Strings are returned in same order that they
  205.      *      were inserted.
  206.      */
  207.     STDMETHOD(GetNextPair) (THIS_
  208. REF(const char*) pKey,
  209. REF(IHXBuffer*) pStr) PURE;
  210.      /************************************************************************
  211.      * Method:
  212.      *     IHXKeyValueListIter::ReplaceCurr
  213.      * Purpose:
  214.      *      Replaces the value in the key/value tuple that was returned 
  215.      *      in the last call to GetNextPair with a new string.
  216.      */
  217.     STDMETHOD(ReplaceCurr) (THIS_
  218. IHXBuffer* pStr) PURE;
  219. };
  220. /****************************************************************************
  221.  * 
  222.  *  Interface:
  223.  *
  224.  * IHXKeyValueListIterOneKey
  225.  *
  226.  *  Purpose:
  227.  *
  228.  * Iterate over all the items in a CKeyValueList that match a particular key.
  229.  *      Call IHXKeyValueList::GetIterOneKey to create an iterator.
  230.  *
  231.  *
  232.  *  IHXKeyValueListIterOneKey:
  233.  *
  234.  * {0x00003110-0901-11d1-8B06-00A024406D59}
  235.  *
  236.  */
  237. DEFINE_GUID(IID_IHXKeyValueListIterOneKey,   0x00003110, 0x901, 0x11d1, 
  238.     0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  239. #define CLSID_IHXKeyValueListIterOneKey IID_IHXKeyValueListIterOneKey
  240. #undef  INTERFACE
  241. #define INTERFACE   IHXKeyValueListIterOneKey
  242. DECLARE_INTERFACE_(IHXKeyValueListIterOneKey, IUnknown)
  243. {
  244.     /*
  245.      * IUnknown methods
  246.      */
  247.     STDMETHOD(QueryInterface) (THIS_
  248. REFIID riid,
  249. void** ppvObj) PURE;
  250.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  251.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  252.     /*
  253.      * Regular methods
  254.      */
  255.      /************************************************************************
  256.      * Method:
  257.      *     IHXKeyValueListIterOneKey::GetNextString
  258.      * Purpose:
  259.      *      Each call to this method returns one string that matches the 
  260.      *      key for this iterator.  Strings are returned in same order that they
  261.      *      were inserted.
  262.      *      
  263.      */
  264.     STDMETHOD(GetNextString) (THIS_
  265. REF(IHXBuffer*) pStr) PURE;
  266.      /************************************************************************
  267.      * Method:
  268.      *     IHXKeyValueListIterOneKey::ReplaceCurr
  269.      * Purpose:
  270.      *      Replaces the value in the key/value tuple that was referenced
  271.      *      in the last call to GetNextString with a new string.
  272.      *      
  273.      */
  274.     STDMETHOD(ReplaceCurr) (THIS_
  275. IHXBuffer* pStr) PURE;
  276. };
  277. /****************************************************************************
  278.  * 
  279.  *  Interface:
  280.  *
  281.  * IHXOptions
  282.  *
  283.  *  Purpose:
  284.  *
  285.  * This is a generic options interface, implemented by any object to
  286.  * allow its options to be read and set by another component of the
  287.  * system.
  288.  *
  289.  *
  290.  *  IHXOptions:
  291.  *
  292.  * {0x00003111-0901-11d1-8B06-00A024406D59}
  293.  *
  294.  */
  295. DEFINE_GUID(IID_IHXOptions,   0x00003111, 0x901, 0x11d1, 
  296.     0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  297. #define CLSID_IHXOptions IID_IHXOptions
  298. #undef  INTERFACE
  299. #define INTERFACE   IHXOptions
  300. DECLARE_INTERFACE_(IHXOptions, IUnknown)
  301. {
  302.     /*
  303.      * IUnknown methods
  304.      */
  305.     STDMETHOD(QueryInterface) (THIS_
  306. REFIID riid,
  307. void** ppvObj) PURE;
  308.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  309.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  310.     /*
  311.      * Regular methods
  312.      */
  313.      /************************************************************************
  314.      * Method:
  315.      *     IHXOptions::GetOptions
  316.      * Purpose:
  317.      *      This method returns a list of the options supported by this
  318.      *     particular object, along with the value currently set for each
  319.      *     option. Enumerate the members of the returned IHXValues object
  320.      *     to discover what options a component supports and the type of
  321.      *     each of those options. The value for each name-value pair is
  322.      *     the current setting for that option.
  323.      *      
  324.      */
  325.     STDMETHOD(GetOptions) (THIS_
  326. REF(IHXValues*) pOptions) PURE;
  327.      /************************************************************************
  328.      * Method:
  329.      *     IHXOptions::SetOptionULONG32
  330.      * Purpose:
  331.      *      Sets the value of a ULONG32 option. The return value indicates
  332.      *     whether or not the SetOptionULONG32 call succeeded.
  333.      *      
  334.      */
  335.     STDMETHOD(SetOptionULONG32) (THIS_
  336. const char* pName,
  337. ULONG32 ulValue) PURE;
  338.      /************************************************************************
  339.      * Method:
  340.      *     IHXOptions::SetOptionCString
  341.      * Purpose:
  342.      *      Sets the value of a CString option. The return value indicates
  343.      *     whether or not the SetOptionCString call succeeded.
  344.      *      
  345.      */
  346.     STDMETHOD(SetOptionCString) (THIS_
  347. const char* pName,
  348. IHXBuffer* pValue) PURE;
  349.      /************************************************************************
  350.      * Method:
  351.      *     IHXOptions::SetOptionBuffer
  352.      * Purpose:
  353.      *      Sets the value of a Buffer option. The return value indicates
  354.      *     whether or not the SetOptionBuffer call succeeded.
  355.      *      
  356.      */
  357.     STDMETHOD(SetOptionBuffer) (THIS_
  358. const char* pName,
  359. IHXBuffer* pValue) PURE;
  360. };
  361. #endif /* !_HXVALUE_H_ */