Virtualize StartEditor and add implementations for the ports that can do it.

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

diff --git a/interface/wx/persist.h b/interface/wx/persist.h
index bb0dc58c3197c9f42259494ee265c66b2cc240e2..8b0ef8f57df4a941b2112956b6ad7f3b2c79273e 100644 (file)
--- a/interface/wx/persist.h
+++ b/interface/wx/persist.h
@@ -4,7 +4,7 @@
 // Author:      Vadim Zeitlin
 // RCS-ID:      $Id$
 // Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
 // Author:      Vadim Zeitlin
 // RCS-ID:      $Id$
 // Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -17,6 +17,8 @@
     This is a singleton class and its unique instance can be retrieved using
     Get() method.
 
     This is a singleton class and its unique instance can be retrieved using
     Get() method.
 

+    @since 2.9.0
+

     @library{wxcore}
  */
 class wxPersistenceManager
     @library{wxcore}
  */
 class wxPersistenceManager


@@ -270,12 +272,23 @@ wxPersistentObject *wxCreatePersistentObject(T *obj);
 
     This function simply calls wxPersistenceManager::RegisterAndRestore() but
     using it results in slightly shorter code as it calls
 
     This function simply calls wxPersistenceManager::RegisterAndRestore() but
     using it results in slightly shorter code as it calls

-    wxPersistenceManager::Get() internally.
+    wxPersistenceManager::Get() internally. As an additional convenience, this
+    function can also set the window name.

 
 

-    For the implementation reasons, this function @em mucst be used instead of
+    For the implementation reasons, this function @em must be used instead of

     the template method when using Microsoft Visual C++ 6 compiler.
 
     the template method when using Microsoft Visual C++ 6 compiler.
 

+    @param obj wxWindow-derived object to register with persistence manager and
+        to try to restore the settings for.
+    @param name If not empty, @a obj name is changed to the provided value
+        before registering it.
+    @return true if the settings were restored or false otherwise (this will
+        always be the case when the program runs for the first time, for
+        example).
+
+    @since 2.9.0, @a name is new in 2.9.1.
+

     @header{wx/persist.h}
  */
 template <class T>
     @header{wx/persist.h}
  */
 template <class T>

-bool wxPersistentRegisterAndRestore(T *obj);
+bool wxPersistentRegisterAndRestore(T *obj, const wxString& name = wxString());