include/wx/palmos/prefconf.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/palmos/prefconf.h
   3 // Purpose:     wxPrefConfig interface
   4 // Author:      Wlodzimierz ABX Skiba
   5 // Modified by:
   6 // Created:     28.12.2004
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Wlodzimierz Skiba
   9 // License:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _PREFCONF_H_
  13 #define _PREFCONF_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16 #pragma interface "prefconf.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // wxPrefConfig
  21 // ----------------------------------------------------------------------------
  22
  23 class WXDLLIMPEXP_BASE wxPrefConfig : public wxConfigBase
  24 {
  25 public:
  26   // ctor & dtor
  27   wxPrefConfig(const wxString& appName = wxEmptyString,
  28                const wxString& vendorName = wxEmptyString,
  29                const wxString& localFilename = wxEmptyString,
  30                const wxString& globalFilename = wxEmptyString,
  31                long style = wxCONFIG_USE_GLOBAL_FILE);
  32
  33   // dtor will save unsaved data
  34   virtual ~wxPrefConfig(){}
  35
  36   // implement inherited pure virtual functions
  37   // ------------------------------------------
  38
  39   // path management
  40   virtual void SetPath(const wxString& strPath);
  41   virtual const wxString& GetPath() const { return m_strPath; }
  42
  43   // entry/subgroup info
  44   virtual bool GetFirstGroup(wxString& str, long& lIndex) const;
  45   virtual bool GetNextGroup (wxString& str, long& lIndex) const;
  46   virtual bool GetFirstEntry(wxString& str, long& lIndex) const;
  47   virtual bool GetNextEntry (wxString& str, long& lIndex) const;
  48
  49   // tests for existence
  50   virtual bool HasGroup(const wxString& strName) const;
  51   virtual bool HasEntry(const wxString& strName) const;
  52   virtual EntryType GetEntryType(const wxString& name) const;
  53
  54   // get number of entries/subgroups in the current group, with or without
  55   // it's subgroups
  56   virtual size_t GetNumberOfEntries(bool bRecursive = false) const;
  57   virtual size_t GetNumberOfGroups(bool bRecursive = false) const;
  58
  59   virtual bool Flush(bool WXUNUSED(bCurrentOnly) = false) { return true; }
  60
  61   // rename
  62   virtual bool RenameEntry(const wxString& oldName, const wxString& newName);
  63   virtual bool RenameGroup(const wxString& oldName, const wxString& newName);
  64
  65   // delete
  66   virtual bool DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso = true);
  67   virtual bool DeleteGroup(const wxString& key);
  68   virtual bool DeleteAll();
  69
  70 protected:
  71   // implement read/write methods
  72   virtual bool DoReadString(const wxString& key, wxString *pStr) const;
  73   virtual bool DoReadLong(const wxString& key, long *plResult) const;
  74
  75   virtual bool DoWriteString(const wxString& key, const wxString& szValue);
  76   virtual bool DoWriteLong(const wxString& key, long lValue);
  77
  78 private:
  79   // no copy ctor/assignment operator
  80   wxPrefConfig(const wxPrefConfig&);
  81   wxPrefConfig& operator=(const wxPrefConfig&);
  82
  83   // current path (not '/' terminated)
  84   wxString  m_strPath;
  85
  86   // current path (group) content (cache for read/write)
  87   wxString m_strGroup;
  88
  89   // current group modified ?
  90   bool m_modGroup;
  91 };
  92
  93 #endif // _PREFCONF_H_
  94