#5537: DeclarationSelector is now able to persist the sash position o…

…f the splitter window.

Provided it's registered by the owning dialog to the WindowState handler.

libs/wxutil/EntityClassChooser.cpp

@@ -32,8 +32,6 @@ namespace
     constexpr const char* const TITLE_ADD_ENTITY = N_("Create Entity");
     constexpr const char* const TITLE_CONVERT_TO_ENTITY = N_("Convert to Entity");
     constexpr const char* const TITLE_SELECT_ENTITY = N_("Select Entity Class");
-    constexpr const char* const RKEY_SPLIT_POS = "user/ui/entityClassChooser/splitPos";
-    constexpr const char* const RKEY_WINDOW_STATE = "user/ui/entityClassChooser/window";
     constexpr const char* const RKEY_LAST_SELECTED_ECLASS = "user/ui/entityClassChooser/lastSelectedEclass";
 
     constexpr const char* const FOLDER_ICON = "folder16.png";
@@ -275,6 +273,9 @@ EntityClassChooser::EntityClassChooser(Purpose purpose) :
     mainSizer->Add(buttonSizer, 0, wxALIGN_RIGHT, 12);
 
     loadEntityClasses();
+
+    // Save the state of the selector widget on dialog close
+    RegisterPersistableObject(_selector);
 }
 
 EntityClassChooser::~EntityClassChooser()
@@ -340,8 +341,6 @@ int EntityClassChooser::ShowModal()
 
     int returnCode = DialogBase::ShowModal();
 
-    _panedPosition.saveToPath(RKEY_SPLIT_POS);
-
     return returnCode;
 }
 

libs/wxutil/EntityClassChooser.h

@@ -1,8 +1,6 @@
 #pragma once
 
 #include "dialog/DialogBase.h"
-#include "PanedPosition.h"
-#include "WindowPosition.h"
 
 #include <sigc++/connection.h>
 #include <wx/dataview.h>
@@ -32,8 +30,6 @@ class EntityClassChooser final :
 private:
     EntityClassSelector* _selector;
 
-    PanedPosition _panedPosition;
-
     sigc::connection _defsReloaded;
 
     wxButton* _affirmativeButton;

libs/wxutil/PanedPosition.cpp

@@ -6,7 +6,7 @@
 
 namespace
 {
-    const int DEFAULT_POSITION = 200;
+    constexpr int DEFAULT_POSITION = 200;
 }
 
 namespace wxutil
@@ -27,16 +27,14 @@ void PanedPosition::connect(wxSplitterWindow* paned)
 
     _paned = paned;
 
-    _paned->Bind(wxEVT_SPLITTER_SASH_POS_CHANGED,
-                 &PanedPosition::onPositionChange, this);
+    _paned->Bind(wxEVT_SPLITTER_SASH_POS_CHANGED, &PanedPosition::onPositionChange, this);
 }
 
 void PanedPosition::disconnect()
 {
     if (_paned)
     {
-        _paned->Unbind(wxEVT_SPLITTER_SASH_POS_CHANGED,
-                       &PanedPosition::onPositionChange, this);
+        _paned->Unbind(wxEVT_SPLITTER_SASH_POS_CHANGED, &PanedPosition::onPositionChange, this);
 
         _paned.Release();
     }

libs/wxutil/PanedPosition.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include "ui/iwindowstate.h"
 #include <wx/event.h>
 #include <wx/weakref.h>
 
@@ -15,14 +16,15 @@ namespace wxutil
  *
  * Use the connect() method to connect a wxSplitterWindow to this object.
  *
- * Use the loadFromNode() and saveToNode() methods to save the internal
- * size info into the given xml::Node
+ * Register this instance to a wxutil::WindowState helper to let the
+ * divider position be saved to the registry on dialog close.
  *
  * This is used in various places (mainframe, entity inspector) to store 
  * the size/position of the paned views on shutdown.
  */
 class PanedPosition :
-	public wxEvtHandler
+	public wxEvtHandler,
+    public ui::IPersistableObject
 {
 private:
 	// The position of this object
@@ -42,8 +44,8 @@ class PanedPosition :
 
 	void setPosition(int position);
 
-	void saveToPath(const std::string& path);
-	void loadFromPath(const std::string& path);
+	void saveToPath(const std::string& path) override;
+	void loadFromPath(const std::string& path) override;
 
 private:
 	// The callback that gets invoked on position change

libs/wxutil/decl/DeclarationSelector.cpp

@@ -65,6 +65,9 @@ void DeclarationSelector::AddPreviewToRightPane(ui::IDeclarationPreview* preview
     splitter->SetMinimumPaneSize(200); // no unsplitting
     splitter->SplitVertically(_leftPanel, _rightPanel, 350);
 
+    _panedPosition = std::make_unique<PanedPosition>();
+    _panedPosition->connect(splitter);
+
     auto widget = preview->GetPreviewWidget();
 
     widget->Reparent(_rightPanel);
@@ -104,6 +107,22 @@ void DeclarationSelector::FocusTreeView()
     _treeView->SetFocus();
 }
 
+void DeclarationSelector::loadFromPath(const std::string& registryKey)
+{
+    if (_panedPosition)
+    {
+        _panedPosition->loadFromPath(registryKey);
+    }
+}
+
+void DeclarationSelector::saveToPath(const std::string& registryKey)
+{
+    if (_panedPosition)
+    {
+        _panedPosition->saveToPath(registryKey);
+    }
+}
+
 DeclarationTreeView* DeclarationSelector::GetTreeView() const
 {
     return _treeView;

libs/wxutil/decl/DeclarationSelector.h

@@ -2,11 +2,13 @@
 
 #include <vector>
 #include "idecltypes.h"
+#include "ui/iwindowstate.h"
 #include <wx/panel.h>
 #include <wx/sizer.h>
 
 #include "ui/ideclpreview.h"
 #include "../dataview/DeclarationTreeView.h"
+#include "wxutil/PanedPosition.h"
 
 namespace wxutil
 {
@@ -19,7 +21,8 @@ class DeclFileInfo;
  * Preview widgets can optionally be appended to the right or the bottom of the tree view.
  */
 class DeclarationSelector :
-    public wxPanel
+    public wxPanel,
+    public ui::IPersistableObject
 {
 private:
     decl::Type _declType;
@@ -37,6 +40,8 @@ class DeclarationSelector :
 
     DeclFileInfo* _declFileInfo;
 
+    std::unique_ptr<PanedPosition> _panedPosition;
+
 public:
     // Construct a selector widget with the default set of tree view columns
     DeclarationSelector(wxWindow* parent, decl::Type declType);
@@ -63,6 +68,9 @@ class DeclarationSelector :
     // Set the focus on the treeview widget
     void FocusTreeView();
 
+    void loadFromPath(const std::string& registryKey) override;
+    void saveToPath(const std::string& registryKey) override;
+
 protected:
     DeclarationTreeView* GetTreeView() const;