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

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 _HXPREFERENCES_
  36. #define _HXPREFERENCES_
  37. struct IHXScheduler;
  38. class CPref;
  39. #ifdef _UNIX
  40. class HXPreferencesCallback;
  41. #endif
  42. #include "unkimp.h"
  43. #include "hxprefs.h"
  44. #include "hxstring.h"
  45. #include "hxprefutil.h"
  46. class HXPreferences : public CUnknownIMP,
  47. public IHXPreferences,
  48. public IHXPreferences2,
  49. public IHXPreferences3
  50. {
  51. protected:
  52.     CHXString m_CompanyName;
  53.     CHXString m_ProductName;
  54.     ULONG32 m_nProdMajorVer;
  55.     ULONG32 m_nProdMinorVer;
  56.     BOOL m_bCommon;
  57. public:
  58.     HXPreferences();
  59.     ~HXPreferences();
  60.     DECLARE_UNKNOWN( HXPreferences )
  61.     /************************************************************************
  62.      * Method:
  63.      * HXPreferences::Open
  64.      * Purpose:
  65.      * TBD
  66.      */
  67.     STDMETHOD(Open) (THIS_
  68.     const char* pCompanyName, const char* pProductName, 
  69.     ULONG32 nProdMajorVer, ULONG32 nProdMinorVer);
  70.     /************************************************************************
  71.      * Method:
  72.      * HXPreferences::OpenShared
  73.      * Purpose:
  74.      * Have this preference object read/write from the company wide shared
  75.      * location for all products
  76.      */
  77.     STDMETHOD(OpenShared) (THIS_
  78. const char* pCompanyName);
  79.     /************************************************************************
  80.      * Method:
  81.      * HXPreferences::OpenUserPref
  82.      * Purpose:
  83.      * Opens user-specific preferences on multi-user system.
  84.      */
  85.     STDMETHOD(OpenUserPref) (THIS_
  86.     const char* pCompanyName, const char* pProductName, 
  87.     ULONG32 nProdMajorVer, ULONG32 nProdMinorVer);
  88.     void      Close(void);
  89.     /*
  90.      * IHXPreferences methods
  91.      */
  92.     /************************************************************************
  93.      * Method:
  94.      * IHXPreferences::ReadPref
  95.      * Purpose:
  96.      * TBD
  97.      */
  98.     STDMETHOD(ReadPref) (THIS_
  99.     const char* pPrefKey, IHXBuffer*& pBuffer);
  100.     /************************************************************************
  101.      * Method:
  102.      * IHXPreferences::WritePref
  103.      * Purpose:
  104.      * TBD
  105.      */
  106.     STDMETHOD(WritePref) (THIS_
  107.     const char* pPrefKey, IHXBuffer* pBuffer);
  108.     /************************************************************************
  109.      * Method:
  110.      * IHXPreferences::GetPreferenceEnumerator
  111.      * Purpose:
  112.      * TBD
  113.      */
  114.     STDMETHOD(GetPreferenceEnumerator)(THIS_ 
  115. REF(IHXPreferenceEnumerator*) /*OUT*/ pEnum);
  116.     /************************************************************************
  117.      * Method:
  118.      * IHXPreferences2::SetRoot
  119.      * Purpose:
  120.      * Reset the root of the preferences
  121.      */
  122.     STDMETHOD(ResetRoot)(THIS_ const char* pCompanyName, const char* pProductName, 
  123.     int nProdMajorVer, int nProdMinorVer);
  124.     /************************************************************************
  125.      * Method:
  126.      * IHXPreferences::DeletePref
  127.      * Purpose:
  128.      * TBD
  129.      */
  130.     STDMETHOD(DeletePref) (THIS_ const char* pPrefKey);
  131.     /************************************************************************
  132.      * Method:
  133.      * HXPreferences::OpenSharedUser
  134.      * Purpose:
  135.      * Have this preference object read/write from the company wide shared
  136.      * location for all products on a multi-user system
  137.      */
  138.     STDMETHOD(OpenSharedUser)(THIS_ const char* pCompanyName);
  139. #if defined(_UNIX) || defined(_CARBON)
  140.     HX_RESULT CommitPrefs();
  141. #endif
  142.    HX_RESULT        SetContext(IUnknown* pContext);
  143. protected:
  144.     CPref*     m_pPref;
  145.     IUnknown*     m_pContext;
  146. #ifdef _UNIX
  147.     HXPreferencesCallback* m_pCallback;
  148. #endif
  149. };
  150. class HXPreferenceEnumerator : public IHXPreferenceEnumerator
  151. {
  152. protected:
  153.     LONG32 m_lRefCount;
  154. public:
  155.     HXPreferenceEnumerator(const char* pCompanyName, 
  156.     const char* pProductName, 
  157.     ULONG32 nProdMajorVer, 
  158.     ULONG32 nProdMinorVer,
  159.     BOOL bCommon);
  160.     ~HXPreferenceEnumerator();
  161.     /*
  162.      * IUnknown methods
  163.      */
  164.     STDMETHOD(QueryInterface) (THIS_
  165. REFIID riid,
  166. void** ppvObj);
  167.     STDMETHOD_(ULONG32,AddRef) (THIS);
  168.     STDMETHOD_(ULONG32,Release) (THIS);
  169.     /*
  170.      * IHXPreferenceEnumerator methods
  171.      */
  172.     /************************************************************************
  173.      * Method:
  174.      * IHXPreferenceEnumerator::EndSubPref
  175.      * Purpose:
  176.      * TBD
  177.      */
  178.     STDMETHOD(BeginSubPref) (THIS_ const char* szSubPref);
  179.     /************************************************************************
  180.      * Method:
  181.      * IHXPreferenceEnumerator::EndSubPref
  182.      * Purpose:
  183.      * TBD
  184.      */
  185.    STDMETHOD(EndSubPref) (THIS);
  186.     /************************************************************************
  187.      * Method:
  188.      * IHXPreferenceEnumerator::GetPrefKey
  189.      * Purpose:
  190.      * TBD
  191.      */
  192.    STDMETHOD(GetPrefKey) (THIS_ UINT32 nIndex, REF(IHXBuffer*) pBuffer);
  193.     /************************************************************************
  194.      * Method:
  195.      * IHXPreferenceEnumerator::ReadPref
  196.      * Purpose:
  197.      * TBD
  198.      */
  199.     STDMETHOD(ReadPref) (THIS_
  200.     const char* pPrefKey, IHXBuffer*& pBuffer);
  201. protected:
  202.     CPref*     m_pPref;
  203. };
  204. #endif /* _HXPREFERENCES_ */