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

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: pref.h,v 1.3.32.3 2004/07/09 01:48:00 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. #ifdef _MACINTOSH
  50. #pragma once
  51. #endif
  52. #ifndef _PREF
  53. #define  _PREF
  54. #include "hxtypes.h"
  55. #include "hxresult.h"
  56. #include "hxassert.h"
  57. struct IHXBuffer;
  58. typedef struct _HXxRect     HXxRect;
  59. typedef struct _HXxSize     HXxSize;
  60. typedef struct _HXxPoint    HXxPoint;
  61. typedef ULONG32     HXxColor;
  62. class CHXBuffer;
  63. class CPref;
  64. typedef _INTERFACE IHXPreferences IHXPreferences;
  65. #define MAX_PREF_NAME       256
  66. #define MAX_PREF_SIZE       1024
  67. #define MAX_INT_BUFFER       20
  68. #define MAX_RECT_BUFFER       60
  69. #define MAX_SIZE_BUFFER       30
  70. #define MAX_POINT_BUFFER      30
  71. #define HX_PRODUCTNAME_SHARED "HelixShared"    // Special shared product name. 
  72. typedef struct _PrefTableEntry
  73. {
  74.     char*   szPrefName;
  75.     char*   pDefaultValue;
  76. } PrefTableEntry;
  77. // Helper class used by CPref, but can also be used outside of CPref if a pref table is being used
  78. class CPrefTable
  79. {
  80. public:
  81.     CPrefTable(PrefTableEntry* pPrefTable,INT32 nTableEntries,CPref* pPrefs);
  82.     CPrefTable(PrefTableEntry* pPrefTable,INT32 nTableEntries,IHXPreferences* pPrefs);
  83.     virtual ~CPrefTable();
  84.    BOOL IsPrefSet(INT32 nPrefKey,INT32 nIndex=0);
  85.    HX_RESULT ReadPrefInt(INT32 nPrefKey,INT32& nValue,INT32 nIndex=0);
  86.    HX_RESULT ReadPrefColor(INT32 nPrefKey,HXxColor& color,INT32 nIndex=0);
  87.    HX_RESULT ReadPrefRect(INT32 nPrefKey,HXxRect& rect,INT32 nIndex=0);
  88.    HX_RESULT ReadPrefSize(INT32 nPrefKey,HXxSize& size,INT32 nIndex=0);
  89.    HX_RESULT ReadPrefPoint(INT32 nPrefKey,HXxPoint& pt,INT32 nIndex=0);
  90.    HX_RESULT ReadPrefString(INT32 nPrefKey,char* szString,INT32 nStrLen,INT32 nIndex=0);
  91.    HX_RESULT ReadPrefBuffer(INT32 nPrefKey,IHXBuffer*& pBuffer,INT32 nIndex=0);
  92.     
  93.    HX_RESULT WritePrefInt(INT32 nPrefKey,INT32 nValue,INT32 nIndex=0);
  94.    HX_RESULT WritePrefColor(INT32 nPrefKey,const HXxColor& color,INT32 nIndex=0);
  95.    HX_RESULT WritePrefRect(INT32 nPrefKey,const HXxRect& rect,INT32 nIndex=0);
  96.    HX_RESULT WritePrefSize(INT32 nPrefKey,const HXxSize& size,INT32 nIndex=0);
  97.    HX_RESULT WritePrefPoint(INT32 nPrefKey,const HXxPoint& pt,INT32 nIndex=0);
  98.    HX_RESULT WritePrefString(INT32 nPrefKey,const char* szString,INT32 nIndex=0);
  99.    HX_RESULT WritePrefBuffer(INT32 nPrefKey,IHXBuffer* pBuffer,INT32 nIndex=0);
  100.    HX_RESULT RemoveIndexedPref(INT32 nPrefKey);
  101.    HX_RESULT RemovePref(INT32 nPrefKey);
  102.    HX_RESULT BeginSubPref(INT32 nPrefKey);
  103. protected:
  104.    HX_RESULT ReadPref(INT32 nPrefKey,INT32 nIndex,IHXBuffer*& pBuffer);
  105.    BOOL ReadPoints(const char* pBuffer,HXxPoint* pt,int nNumPoints);
  106.    HX_RESULT WritePref(INT32 nPrefKey,INT32 nIndex,IHXBuffer* pBuffer);
  107.    IHXBuffer* CreateIHXBuffer(const char* szString);
  108.    INT32     m_nTableEntries;
  109.    PrefTableEntry*  m_pPrefTable;   
  110.    CPref*     m_pCPref;
  111.    IHXPreferences* m_pIHXPrefs;
  112. };
  113. class CPref 
  114. {
  115. public:
  116. /*    last_error() returns the last platform specific error that occurred */
  117.    HX_RESULT last_error(void)   
  118.    {
  119.        return mLastError;
  120.    };
  121. /*    class destructor */  
  122.    virtual              ~CPref         (void);
  123. /*  read_pref reads the preference specified by Key to the Buffer. */
  124.    virtual HX_RESULT read_pref(const char* pPrefKey, IHXBuffer*& pBuffer) = 0;
  125.    /* To use these methods you need to call UsePrefTable() and setup up a product specific pref table */
  126.    inline BOOL IsPrefSet(INT32 nPrefKey,INT32 nIndex=0)
  127.    {
  128.        return (m_pPrefTable ? m_pPrefTable->IsPrefSet(nPrefKey,nIndex) : FALSE);
  129.    }
  130.    inline HX_RESULT ReadPrefInt(INT32 nPrefKey,INT32& nValue,INT32 nIndex=0)
  131.    {
  132.        return (m_pPrefTable ? m_pPrefTable->ReadPrefInt(nPrefKey,nValue,nIndex) : HXR_FAIL);
  133.    }
  134.    inline HX_RESULT ReadPrefColor(INT32 nPrefKey,HXxColor& color,INT32 nIndex=0)
  135.    {
  136.        return (m_pPrefTable ? m_pPrefTable->ReadPrefColor(nPrefKey,color,nIndex) : HXR_FAIL);
  137.    }
  138.    inline HX_RESULT ReadPrefRect(INT32 nPrefKey,HXxRect& rect,INT32 nIndex=0)
  139.    {
  140.        return (m_pPrefTable ? m_pPrefTable->ReadPrefRect(nPrefKey,rect,nIndex) : HXR_FAIL);
  141.    }
  142.    inline HX_RESULT ReadPrefSize(INT32 nPrefKey,HXxSize& size,INT32 nIndex=0)
  143.    {
  144.        return (m_pPrefTable ? m_pPrefTable->ReadPrefSize(nPrefKey,size,nIndex) : HXR_FAIL);
  145.    }
  146.    inline HX_RESULT ReadPrefPoint(INT32 nPrefKey,HXxPoint& pt,INT32 nIndex=0)
  147.    {
  148.        return (m_pPrefTable ? m_pPrefTable->ReadPrefPoint(nPrefKey,pt,nIndex) : HXR_FAIL);
  149.    }
  150.    inline HX_RESULT ReadPrefString(INT32 nPrefKey,char* szString,INT32 nStrLen,INT32 nIndex=0)
  151.    {
  152.        return (m_pPrefTable ? m_pPrefTable->ReadPrefString(nPrefKey,szString,nStrLen,nIndex) : HXR_FAIL);
  153.    }
  154.    inline HX_RESULT ReadPrefBuffer(INT32 nPrefKey,IHXBuffer*& pBuffer,INT32 nIndex=0)
  155.    {
  156.        return (m_pPrefTable ? m_pPrefTable->ReadPrefBuffer(nPrefKey,pBuffer,nIndex) : HXR_FAIL);
  157.    }
  158. /*  write_pref writes (saves) the preference specified by Key from the Buffer. */       
  159.    virtual HX_RESULT write_pref(const char* pPrefKey, IHXBuffer* pBuffer) = 0; 
  160. /*  write_pref deletes the preference specified by Key from the Buffer. */       
  161.    virtual HX_RESULT delete_pref(const char* pPrefKey) = 0; 
  162.    /* commit_prefs saves all changes to the prefs to disk (e.g. on Unix) */ 
  163.    virtual HX_RESULT commit_prefs() {return HXR_OK;};
  164.    
  165.    /* To use these methods you need to call UsePrefTable() and setup up a product specific pref table */
  166.    inline HX_RESULT WritePrefInt(INT32 nPrefKey,INT32 nValue,INT32 nIndex=0)
  167.    {
  168.        return (m_pPrefTable ? m_pPrefTable->WritePrefInt(nPrefKey,nValue,nIndex) : HXR_FAIL);
  169.    }
  170.    inline HX_RESULT WritePrefColor(INT32 nPrefKey,const HXxColor& color,INT32 nIndex=0)
  171.    {
  172.        return (m_pPrefTable ? m_pPrefTable->WritePrefColor(nPrefKey,color,nIndex) : HXR_FAIL);
  173.    }
  174.    inline HX_RESULT WritePrefRect(INT32 nPrefKey,const HXxRect& rect,INT32 nIndex=0)
  175.    {
  176.        return (m_pPrefTable ? m_pPrefTable->WritePrefRect(nPrefKey,rect,nIndex) : HXR_FAIL);
  177.    }
  178.    inline HX_RESULT WritePrefSize(INT32 nPrefKey,const HXxSize& size,INT32 nIndex=0)
  179.    {
  180.        return (m_pPrefTable ? m_pPrefTable->WritePrefSize(nPrefKey,size,nIndex) : HXR_FAIL);
  181.    }
  182.    inline HX_RESULT WritePrefPoint(INT32 nPrefKey,const HXxPoint& pt,INT32 nIndex=0)
  183.    {
  184.        return (m_pPrefTable ? m_pPrefTable->WritePrefPoint(nPrefKey,pt,nIndex) : HXR_FAIL);
  185.    }
  186.    inline HX_RESULT WritePrefString(INT32 nPrefKey,const char* szString,INT32 nIndex=0)
  187.    {
  188.        return (m_pPrefTable ? m_pPrefTable->WritePrefString(nPrefKey,szString,nIndex) : HXR_FAIL);
  189.    }
  190.    inline HX_RESULT WritePrefBuffer(INT32 nPrefKey,IHXBuffer* pBuffer,INT32 nIndex=0)
  191.    {
  192.        return (m_pPrefTable ? m_pPrefTable->WritePrefBuffer(nPrefKey,pBuffer,nIndex) : HXR_FAIL);
  193.    }
  194.    inline HX_RESULT RemoveIndexedPref(INT32 nPrefKey)
  195.    {
  196.        return (m_pPrefTable ? m_pPrefTable->RemoveIndexedPref(nPrefKey) : HXR_FAIL);
  197.    }
  198.    inline HX_RESULT RemovePref(INT32 nPrefKey)
  199.    {
  200.        return (m_pPrefTable ? m_pPrefTable->RemovePref(nPrefKey) : HXR_FAIL);
  201.    }
  202. /*  call open_pref() to automatically create the correct platform specific preference 
  203.     object. If open_pref() returns NULL, an error occurred and the CPref object was 
  204.     not created. Call last_error to get the error */
  205. #if defined(_CARBON) || defined(_MAC_UNIX)
  206.    // for the Mac, we default to bCommon=FALSE since we want non-admin users to be able to run a new install, so by default
  207.    // prefs get written per-user
  208.    static CPref* open_pref(const char* pCompanyName, const char* pProductName, int nProdMajorVer, int nProdMinorVer, BOOL bCommon = FALSE);
  209. #else
  210.    static CPref* open_pref(const char* pCompanyName, const char* pProductName, int nProdMajorVer, int nProdMinorVer, BOOL bCommon = TRUE);
  211. #endif
  212.    static CPref* open_shared_pref(const char* pCompanyName);
  213.    static CPref* open_shared_user_pref(const char* pCompanyName);
  214.    void SetupPrefTable(PrefTableEntry* pPrefTable,INT32 nTableEntries);
  215. /*  remove_indexed_pref removes indexed preference specified by Key */       
  216.    virtual HX_RESULT remove_indexed_pref(const char* pPrefKey) = 0; 
  217.    /* Sub-Preference Support */
  218.    /* 
  219.     * After calling BeginSubPref all calls to Read/Write preferences will write the preferences under the Sub-Prefernece
  220.     * passed into BeginSubPref.  When done writing Sub-Preferences call EndSubPref.  Each call to BeginSubPref must
  221.     * be matched with a call to EndSubPref otherwise preferences may be written to the incorrect place.  You can call
  222.     * BeginSubPref multiple times to traverse deeper into sub-preferences, but each call must be matched with an EndSubPref
  223.     * on the way out.
  224.     */
  225.    virtual HX_RESULT BeginSubPref(const char* szSubPref) = 0;
  226.    inline  HX_RESULT BeginSubPref(INT32 nPrefKey)
  227.    {
  228.        return (m_pPrefTable ? m_pPrefTable->BeginSubPref(nPrefKey) : HXR_FAIL);
  229.    }
  230.    virtual HX_RESULT EndSubPref() = 0;
  231.    /* Preference Enumeration Support */
  232.    /*
  233.     * Gets a specified pref key for the specified index.  Use 0 to get the first pref key and then just keep incrementing
  234.     * until GetPrefKey returns HXR_FAIL.  pBuffer will contain the pref key
  235.     */
  236.    virtual HX_RESULT GetPrefKey(UINT32 nIndex,IHXBuffer*& pBuffer) = 0;
  237.    // remove the preference specified
  238.    virtual HX_RESULT remove_pref(const char* pPrefKey)
  239.    { HX_ASSERT(FALSE); return(HXR_FAIL); }
  240.    
  241.    virtual BOOL IsCommonPref() { return m_bIsCommonPref; }
  242. protected:
  243. /*  Constructor NOTE: use open_pref() to create an instance of this class */
  244.    CPref();
  245.    HX_RESULT       mLastError;       // last error to occur 
  246.    CPrefTable*    m_pPrefTable;     // The pref table information
  247.    BOOL    m_bIsCommonPref;  // pref was created bCommon (machine-wide)
  248. };              
  249. #endif // _PREF