Applied rowspan patch #15276 (dghart)

[wxWidgets.git] / include / wx / persist.h

diff --git a/include/wx/persist.h b/include/wx/persist.h
index 24cd503142d3278ce910eca0727094367879ce01..18bcdc2d793077e9e9eb02d1afaf14565901108b 100644 (file)
--- a/include/wx/persist.h
+++ b/include/wx/persist.h
@@ -44,9 +44,22 @@ wxPersistentObject *wxCreatePersistentObject(T *obj);
 class WXDLLIMPEXP_CORE wxPersistenceManager
 {
 public:
 class WXDLLIMPEXP_CORE wxPersistenceManager
 {
 public:

+    // Call this method to specify a non-default persistence manager to use.
+    // This function should usually be called very early to affect creation of
+    // all persistent controls and the object passed to it must have a lifetime
+    // long enough to be still alive when the persistent controls are destroyed
+    // and need it to save their state so typically this would be a global or a
+    // wxApp member.
+    static void Set(wxPersistenceManager& manager);
+

     // accessor to the unique persistence manager object
     static wxPersistenceManager& Get();
 
     // accessor to the unique persistence manager object
     static wxPersistenceManager& Get();
 

+    // trivial but virtual dtor
+    //
+    // FIXME-VC6: this only needs to be public because of VC6 bug
+    virtual ~wxPersistenceManager();
+

 
     // globally disable restoring or saving the persistent properties (both are
     // enabled by default)
 
     // globally disable restoring or saving the persistent properties (both are
     // enabled by default)


@@ -77,7 +90,7 @@ public:
     // deletes the associated wxPersistentObject
     void Unregister(void *obj);
 
     // deletes the associated wxPersistentObject
     void Unregister(void *obj);
 

-    
+

     // save/restore the state of an object
     //
     // these methods do nothing if DisableSaving/Restoring() was called
     // save/restore the state of an object
     //
     // these methods do nothing if DisableSaving/Restoring() was called


@@ -128,7 +141,7 @@ public:
 
 #undef wxPERSIST_DECLARE_SAVE_RESTORE_FOR
 
 
 #undef wxPERSIST_DECLARE_SAVE_RESTORE_FOR
 

-private:
+protected:

     // ctor is private, use Get()
     wxPersistenceManager()
     {
     // ctor is private, use Get()
     wxPersistenceManager()
     {


@@ -136,15 +149,19 @@ private:
         m_doRestore = true;
     }
 
         m_doRestore = true;
     }
 

-    // helpers of Save/Restore()
-    //
-    // TODO: make this customizable by allowing
-    //          (a) specifying custom wxConfig object to use
-    //          (b) allowing to use something else entirely
-    wxConfigBase *GetConfig() const { return wxConfigBase::Get(); }
-    wxString GetKey(const wxPersistentObject& who, const wxString& name) const;

 
 

+    // Return the config object to use, by default just the global one but a
+    // different one could be used by the derived class if needed.
+    virtual wxConfigBase *GetConfig() const { return wxConfigBase::Get(); }
+
+    // Return the path to use for saving the setting with the given name for
+    // the specified object (notice that the name is the name of the setting,
+    // not the name of the object itself which can be retrieved with GetName()).
+    virtual wxString GetKey(const wxPersistentObject& who,
+                            const wxString& name) const;

 
 

+
+private:

     // map with the registered objects as keys and associated
     // wxPersistentObjects as values
     wxPersistentObjectsMap m_persistentObjects;
     // map with the registered objects as keys and associated
     // wxPersistentObjects as values
     wxPersistentObjectsMap m_persistentObjects;


@@ -155,7 +172,7 @@ private:
     bool m_doSave,
          m_doRestore;
 
     bool m_doSave,
          m_doRestore;
 

-    DECLARE_NO_COPY_CLASS(wxPersistenceManager)
+    wxDECLARE_NO_COPY_CLASS(wxPersistenceManager);

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -212,7 +229,7 @@ protected:
 private:
     void * const m_obj;
 
 private:
     void * const m_obj;
 

-    DECLARE_NO_COPY_CLASS(wxPersistentObject)
+    wxDECLARE_NO_COPY_CLASS(wxPersistentObject);

 };
 
 // FIXME-VC6: VC6 has troubles with template methods of DLL-exported classes,
 };
 
 // FIXME-VC6: VC6 has troubles with template methods of DLL-exported classes,


@@ -230,7 +247,17 @@ inline bool wxPersistentRegisterAndRestore(T *obj)
     wxPersistentObject * const pers = wxCreatePersistentObject(obj);
 
     return wxPersistenceManager::Get().RegisterAndRestore(obj, pers);
     wxPersistentObject * const pers = wxCreatePersistentObject(obj);
 
     return wxPersistenceManager::Get().RegisterAndRestore(obj, pers);

-                                            
+
+}
+
+// A helper function which also sets the name for the (wxWindow-derived) object
+// before registering and restoring it.
+template <typename T>
+inline bool wxPersistentRegisterAndRestore(T *obj, const wxString& name)
+{
+    obj->SetName(name);
+
+    return wxPersistentRegisterAndRestore(obj);

 }
 
 #endif // _WX_PERSIST_H_
 }
 
 #endif // _WX_PERSIST_H_