home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / options_policy.h < prev    next >
C/C++ Source or Header  |  2008-11-07  |  2KB  |  81 lines
  1. #ifndef K3DSDK_OPTIONS_POLICY_H
  2. #define K3DSDK_OPTIONS_POLICY_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2004, Timothy M. Shead
  6. //
  7. // Contact: tshead@k-3d.com
  8. //
  9. // This program is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. //
  14. // This program is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. // General Public License for more details.
  18. //
  19. // You should have received a copy of the GNU General Public
  20. // License along with this program; if not, write to the Free Software
  21. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  
  23. /** \file
  24.         \brief Declares k3d::istorage, an abstract interface for global user option storage (could be a file, could be gconf, could be the Windoze registry, etc)
  25.         \author Tim Shead (tshead@k-3d.com)
  26. */
  27.  
  28. #include "iunknown.h"
  29.  
  30. namespace k3d
  31. {
  32.  
  33. // Forward declarations
  34. namespace xml { class element; }
  35.  
  36. namespace options
  37. {
  38.  
  39. /// Abstract interface for global user option storage
  40. class istorage :
  41.     public virtual iunknown
  42. {
  43. public:
  44.     /// Returns the stored user option data
  45.     virtual xml::element& tree() = 0;
  46.     /// Commits any modifications to the stored user option data to persistent storage
  47.     virtual void commit() = 0;
  48.  
  49. protected:
  50.     istorage() {}
  51.     istorage(const istorage&) {}
  52.     istorage& operator = (const istorage&) { return *this; }
  53.     virtual ~istorage() {}
  54. };
  55.  
  56. /// Trivial implementation of k3d::istorage that serializes data to an XML file
  57. class file_storage :
  58.     public istorage
  59. {
  60. public:
  61.     file_storage(const filesystem::path& File);
  62.     ~file_storage();
  63.  
  64.     xml::element& tree();
  65.     void commit();
  66.  
  67. private:
  68.     class implementation;
  69.     implementation* const m_implementation;
  70. };
  71.  
  72. /// Sets the istorage implementation to be used for storing user options ... this must be called once at startup before any other sdk calls are made
  73. void set_storage(istorage& OptionStorage);
  74.  
  75. } // namespace options
  76.  
  77. } // namespace k3d
  78.  
  79. #endif // !K3DSDK_OPTIONS_POLICY_H
  80.  
  81.