Discontinue perspective caption manipulation
Some checks failed
Doxygen Action / build (push) Has been cancelled

Reference: https://github.com/wxWidgets/wxWidgets/issues/12528
Signed-off-by: Simon Rozman <simon@rozman.si>
This commit is contained in:
Simon Rozman
2025-11-04 15:51:13 +01:00
parent fd16ef2909
commit dea6a38d30
7 changed files with 107 additions and 283 deletions

View File

@@ -1,33 +0,0 @@
/*
SPDX-License-Identifier: GPL-3.0-or-later
Copyright © 2015-2022 Amebis
Copyright © 2016 GÉANT
*/
#pragma once
#include "../common.h"
#include <codeanalysis\warnings.h>
#pragma warning(push)
#pragma warning(disable: WXWIDGETS_CODE_ANALYSIS_WARNINGS)
#include <wx/aui/framemanager.h>
#include <wx/string.h>
#pragma warning(pop)
/// \addtogroup wxExtend
/// @{
///
/// Updates perspective captions with matching captions from panes.
///
/// \param[in ] mgr wxAUI manager
/// \param[inout] perspective Perspective string to update captions in
///
/// \returns
/// - \c true when update succeeded
/// - \c false otherwise
///
bool WXEXTEND_API wxAuiManagerUpdatePerspectiveCaptions(wxAuiManager& mgr, wxString& perspective);
/// @}

View File

@@ -1,112 +1,107 @@
/*
SPDX-License-Identifier: GPL-3.0-or-later
Copyright © 2015-2022 Amebis
Copyright © 2016 GÉANT
*/
#pragma once
#include "../common.h"
#include "../aui/framemanager.h"
#include <codeanalysis\warnings.h>
#pragma warning(push)
#pragma warning(disable: WXWIDGETS_CODE_ANALYSIS_WARNINGS)
#include <wx/persist.h>
#include <wx/aui/framemanager.h>
#pragma warning(pop)
/// \addtogroup wxExtend
/// @{
///
/// `wxPersistentAuiManager` kind for persistent storage
///
#define wxPERSIST_AUIMGR_KIND "AuiManager"
///
/// Name of the persistent storage variable for saving Aui manager state
///
#define wxPERSIST_AUIMGR_PERSPECTIVE "perspective"
///
/// Supports saving/restoring wxAuiManager state
///
class wxPersistentAuiManager : public wxPersistentObject
{
public:
///
/// Constructs a persistent Aui manager object
///
wxPersistentAuiManager(wxAuiManager *mgr) : wxPersistentObject(mgr)
{
}
///
/// \returns `wxT(wxPERSIST_AUIMGR_KIND)`
///
virtual wxString GetKind() const wxOVERRIDE
{
return wxT(wxPERSIST_AUIMGR_KIND);
}
///
/// Returns name of the window
///
virtual wxString GetName() const wxOVERRIDE
{
// Borrow the name of wxAguiManager from its window.
return GetManager()->GetManagedWindow()->GetName();
}
///
/// Saves Aui manager state
///
virtual void Save() const wxOVERRIDE
{
// Save perspective string to configuration.
SaveValue(wxT(wxPERSIST_AUIMGR_PERSPECTIVE), GetManager()->SavePerspective());
}
///
/// Restores Aui manager state
///
virtual bool Restore() wxOVERRIDE
{
// Load perspective string from configuration.
wxString persp;
if (!RestoreValue(wxT(wxPERSIST_AUIMGR_PERSPECTIVE), &persp))
return false;
// Update captions (see http://trac.wxwidgets.org/ticket/12528).
wxAuiManager* mgr = GetManager();
wxCHECK(wxAuiManagerUpdatePerspectiveCaptions(*mgr, persp), false);
// Restore perspective.
return mgr->LoadPerspective(persp);
}
protected:
/// \cond internal
wxAuiManager *GetManager() const
{
return static_cast<wxAuiManager*>(GetObject());
}
/// \endcond
private:
wxDECLARE_NO_COPY_CLASS(wxPersistentAuiManager);
};
///
/// wxAuiManager's instantiation of wxCreatePersistentObject template
///
inline wxPersistentObject *wxCreatePersistentObject(wxAuiManager *mgr)
{
return new wxPersistentAuiManager(mgr);
}
/// @}
/*
SPDX-License-Identifier: GPL-3.0-or-later
Copyright © 2015-2022 Amebis
Copyright © 2016 GÉANT
*/
#pragma once
#include "../common.h"
#include <codeanalysis\warnings.h>
#pragma warning(push)
#pragma warning(disable: WXWIDGETS_CODE_ANALYSIS_WARNINGS)
#include <wx/persist.h>
#include <wx/aui/framemanager.h>
#pragma warning(pop)
/// \addtogroup wxExtend
/// @{
///
/// `wxPersistentAuiManager` kind for persistent storage
///
#define wxPERSIST_AUIMGR_KIND "AuiManager"
///
/// Name of the persistent storage variable for saving Aui manager state
///
#define wxPERSIST_AUIMGR_PERSPECTIVE "perspective"
///
/// Supports saving/restoring wxAuiManager state
///
class wxPersistentAuiManager : public wxPersistentObject
{
public:
///
/// Constructs a persistent Aui manager object
///
wxPersistentAuiManager(wxAuiManager *mgr) : wxPersistentObject(mgr)
{
}
///
/// \returns `wxT(wxPERSIST_AUIMGR_KIND)`
///
virtual wxString GetKind() const wxOVERRIDE
{
return wxT(wxPERSIST_AUIMGR_KIND);
}
///
/// Returns name of the window
///
virtual wxString GetName() const wxOVERRIDE
{
// Borrow the name of wxAguiManager from its window.
return GetManager()->GetManagedWindow()->GetName();
}
///
/// Saves Aui manager state
///
virtual void Save() const wxOVERRIDE
{
// Save perspective string to configuration.
SaveValue(wxT(wxPERSIST_AUIMGR_PERSPECTIVE), GetManager()->SavePerspective());
}
///
/// Restores Aui manager state
///
virtual bool Restore() wxOVERRIDE
{
// Load perspective string from configuration.
wxString persp;
if (!RestoreValue(wxT(wxPERSIST_AUIMGR_PERSPECTIVE), &persp))
return false;
// Restore perspective.
wxAuiManager* mgr = GetManager();
return mgr->LoadPerspective(persp);
}
protected:
/// \cond internal
wxAuiManager *GetManager() const
{
return static_cast<wxAuiManager*>(GetObject());
}
/// \endcond
private:
wxDECLARE_NO_COPY_CLASS(wxPersistentAuiManager);
};
///
/// wxAuiManager's instantiation of wxCreatePersistentObject template
///
inline wxPersistentObject *wxCreatePersistentObject(wxAuiManager *mgr)
{
return new wxPersistentAuiManager(mgr);
}
/// @}