From 4e82f60b8a95b16adb4ff37b2d6678ff5e8e6e55 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Fri, 15 Dec 2017 00:39:16 +0100 Subject: [PATCH] Add documentation for wxPersistentDataViewCtrl Documentation is trivial, but better than nothing. --- interface/wx/persist/dataview.h | 42 +++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 interface/wx/persist/dataview.h diff --git a/interface/wx/persist/dataview.h b/interface/wx/persist/dataview.h new file mode 100644 index 0000000000..b98896879b --- /dev/null +++ b/interface/wx/persist/dataview.h @@ -0,0 +1,42 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: wx/persist/dataview.h +// Purpose: interface of wxPersistentDataViewCtrl +// Author: Vadim Zeitlin +// Copyright: (c) 2009 Vadim Zeitlin +// Licence: wxWindows licence +///////////////////////////////////////////////////////////////////////////// + +/** + Persistence adapter for wxDataViewCtrl. + + This adapter handles wxDataViewCtrl column widths and sort order. + + @since 3.1.1 + */ +class wxPersistentDataViewCtrl : public wxPersistentWindow +{ +public: + /** + Constructor. + + @param control The associated control. + */ + wxPersistentDataViewCtrl(wxDataViewCtrl* control); + + /** + Save the current column widths and sort order. + */ + void Save() const override; + + /** + Restore the column widths and sort order. + + The wxDataViewCtrl must be initialized before calling this function, i.e. + all of its columns should be already added to it -- otherwise restoring + their width would have no effect. + */ + bool Restore() override; +}; + +/// Overload allowing persistence adapter creation for wxDataViewCtrl objects. +wxPersistentObject *wxCreatePersistentObject(wxDataViewCtrl *book);