Optionally set the window name in wxPersistentRegisterAndRestore().

In practice names are not often used so typically whenever you want to make a
window settings persistent you also need to set its name and the it's
convenient to let a single function do both tasks, so add an overload taking
the name string (this is a separate function instead of optional parameter to
avoid compilation errors if this is ever used with non-wxWindow-derived
objects which don't have SetName() method).

Also expand the documentation slightly and add @since tags.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64887 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2010-07-11 10:44:23 +00:00
parent ac63bc407e
commit 679ab0b315
3 changed files with 27 additions and 5 deletions

View File

@@ -239,5 +239,15 @@ inline bool wxPersistentRegisterAndRestore(T *obj)
}
// 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_