wxExtend/auimanager_8h_source.html

198 lines
21 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wxExtend: include/wxex/persist/auimanager.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">wxExtend
</div>
<div id="projectbrief">Additional templates and function helpers for wxWidgets</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_2fafa5ce03815a2bdea8d271fa718211.html">wxex</a></li><li class="navelem"><a class="el" href="dir_6d69d241b042cee0e67e7676a2fe434a.html">persist</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">auimanager.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> SPDX-License-Identifier: GPL-3.0-or-later</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright © 2015-2022 Amebis</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright © 2016 GÉANT</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">*/</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../common.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;../aui/framemanager.h&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &lt;codeanalysis\warnings.h&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#pragma warning(push)</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#pragma warning(disable: WXWIDGETS_CODE_ANALYSIS_WARNINGS)</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &lt;wx/persist.h&gt;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;wx/aui/framemanager.h&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#pragma warning(pop)</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="group__wx_extend.html#ga7788ec0b170f698bd985a50acc9125ec"> 27</a></span><span class="preprocessor">#define wxPERSIST_AUIMGR_KIND &quot;AuiManager&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="group__wx_extend.html#ga12bc8d4a3e2d373c79dd90f1cad5fc8a"> 32</a></span><span class="preprocessor">#define wxPERSIST_AUIMGR_PERSPECTIVE &quot;perspective&quot;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="foldopen" id="foldopen00037" data-start="{" data-end="};">
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classwx_persistent_aui_manager.html"> 37</a></span><span class="keyword">class </span><a class="code hl_class" href="classwx_persistent_aui_manager.html">wxPersistentAuiManager</a> : <span class="keyword">public</span> wxPersistentObject</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>{</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="}">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classwx_persistent_aui_manager.html#a266f1e8b0d8963e7abed395d6c7c2362"> 43</a></span> <a class="code hl_function" href="classwx_persistent_aui_manager.html#a266f1e8b0d8963e7abed395d6c7c2362">wxPersistentAuiManager</a>(wxAuiManager *mgr) : wxPersistentObject(mgr)</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> }</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="foldopen" id="foldopen00050" data-start="{" data-end="}">
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classwx_persistent_aui_manager.html#a125e1f0e1707f61f601d5afcd6b6aa39"> 50</a></span> <span class="keyword">virtual</span> wxString <a class="code hl_function" href="classwx_persistent_aui_manager.html#a125e1f0e1707f61f601d5afcd6b6aa39">GetKind</a>() const wxOVERRIDE</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">return</span> wxT(<a class="code hl_define" href="group__wx_extend.html#ga7788ec0b170f698bd985a50acc9125ec">wxPERSIST_AUIMGR_KIND</a>);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> }</div>
</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="foldopen" id="foldopen00058" data-start="{" data-end="}">
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classwx_persistent_aui_manager.html#a3ee0a6da9642d85707842e215511d767"> 58</a></span> <span class="keyword">virtual</span> wxString <a class="code hl_function" href="classwx_persistent_aui_manager.html#a3ee0a6da9642d85707842e215511d767">GetName</a>() const wxOVERRIDE</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// Borrow the name of wxAguiManager from its window.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordflow">return</span> GetManager()-&gt;GetManagedWindow()-&gt;GetName();</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="foldopen" id="foldopen00067" data-start="{" data-end="}">
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classwx_persistent_aui_manager.html#a8f71e0e2189c2007ac2ae7f7e2c2a752"> 67</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classwx_persistent_aui_manager.html#a8f71e0e2189c2007ac2ae7f7e2c2a752">Save</a>() const wxOVERRIDE</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> {</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// Save perspective string to configuration.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> SaveValue(wxT(<a class="code hl_define" href="group__wx_extend.html#ga12bc8d4a3e2d373c79dd90f1cad5fc8a">wxPERSIST_AUIMGR_PERSPECTIVE</a>), GetManager()-&gt;SavePerspective());</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="foldopen" id="foldopen00076" data-start="{" data-end="}">
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classwx_persistent_aui_manager.html#adc240ccc521959d4f6d5391aa60a6f98"> 76</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classwx_persistent_aui_manager.html#adc240ccc521959d4f6d5391aa60a6f98">Restore</a>() wxOVERRIDE</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// Load perspective string from configuration.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> wxString persp;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keywordflow">if</span> (!RestoreValue(wxT(<a class="code hl_define" href="group__wx_extend.html#ga12bc8d4a3e2d373c79dd90f1cad5fc8a">wxPERSIST_AUIMGR_PERSPECTIVE</a>), &amp;persp))</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// Update captions (see http://trac.wxwidgets.org/ticket/12528).</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> wxAuiManager* mgr = GetManager();</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> wxCHECK(<a class="code hl_function" href="group__wx_extend.html#gaa4d1c55a5ab605bc8f40a01ae470930b">wxAuiManagerUpdatePerspectiveCaptions</a>(*mgr, persp), <span class="keyword">false</span>);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// Restore perspective.</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">return</span> mgr-&gt;LoadPerspective(persp);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> }</div>
</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> wxAuiManager *GetManager()<span class="keyword"> const</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>wxAuiManager*<span class="keyword">&gt;</span>(GetObject());</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> }</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> wxDECLARE_NO_COPY_CLASS(<a class="code hl_class" href="classwx_persistent_aui_manager.html">wxPersistentAuiManager</a>);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>};</div>
</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="foldopen" id="foldopen00107" data-start="{" data-end="}">
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="group__wx_extend.html#ga13bc393d7bfdc9edfd95fadc802dc983"> 107</a></span><span class="keyword">inline</span> wxPersistentObject *<a class="code hl_function" href="group__wx_extend.html#ga13bc393d7bfdc9edfd95fadc802dc983">wxCreatePersistentObject</a>(wxAuiManager *mgr)</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>{</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code hl_class" href="classwx_persistent_aui_manager.html">wxPersistentAuiManager</a>(mgr);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>}</div>
</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="ttc" id="aclasswx_persistent_aui_manager_html"><div class="ttname"><a href="classwx_persistent_aui_manager.html">wxPersistentAuiManager</a></div><div class="ttdoc">Supports saving/restoring wxAuiManager state.</div><div class="ttdef"><b>Definition</b> auimanager.h:38</div></div>
<div class="ttc" id="aclasswx_persistent_aui_manager_html_a125e1f0e1707f61f601d5afcd6b6aa39"><div class="ttname"><a href="classwx_persistent_aui_manager.html#a125e1f0e1707f61f601d5afcd6b6aa39">wxPersistentAuiManager::GetKind</a></div><div class="ttdeci">virtual wxString GetKind() const wxOVERRIDE</div><div class="ttdef"><b>Definition</b> auimanager.h:50</div></div>
<div class="ttc" id="aclasswx_persistent_aui_manager_html_a266f1e8b0d8963e7abed395d6c7c2362"><div class="ttname"><a href="classwx_persistent_aui_manager.html#a266f1e8b0d8963e7abed395d6c7c2362">wxPersistentAuiManager::wxPersistentAuiManager</a></div><div class="ttdeci">wxPersistentAuiManager(wxAuiManager *mgr)</div><div class="ttdoc">Constructs a persistent Aui manager object.</div><div class="ttdef"><b>Definition</b> auimanager.h:43</div></div>
<div class="ttc" id="aclasswx_persistent_aui_manager_html_a3ee0a6da9642d85707842e215511d767"><div class="ttname"><a href="classwx_persistent_aui_manager.html#a3ee0a6da9642d85707842e215511d767">wxPersistentAuiManager::GetName</a></div><div class="ttdeci">virtual wxString GetName() const wxOVERRIDE</div><div class="ttdoc">Returns name of the window.</div><div class="ttdef"><b>Definition</b> auimanager.h:58</div></div>
<div class="ttc" id="aclasswx_persistent_aui_manager_html_a8f71e0e2189c2007ac2ae7f7e2c2a752"><div class="ttname"><a href="classwx_persistent_aui_manager.html#a8f71e0e2189c2007ac2ae7f7e2c2a752">wxPersistentAuiManager::Save</a></div><div class="ttdeci">virtual void Save() const wxOVERRIDE</div><div class="ttdoc">Saves Aui manager state.</div><div class="ttdef"><b>Definition</b> auimanager.h:67</div></div>
<div class="ttc" id="aclasswx_persistent_aui_manager_html_adc240ccc521959d4f6d5391aa60a6f98"><div class="ttname"><a href="classwx_persistent_aui_manager.html#adc240ccc521959d4f6d5391aa60a6f98">wxPersistentAuiManager::Restore</a></div><div class="ttdeci">virtual bool Restore() wxOVERRIDE</div><div class="ttdoc">Restores Aui manager state.</div><div class="ttdef"><b>Definition</b> auimanager.h:76</div></div>
<div class="ttc" id="agroup__wx_extend_html_ga12bc8d4a3e2d373c79dd90f1cad5fc8a"><div class="ttname"><a href="group__wx_extend.html#ga12bc8d4a3e2d373c79dd90f1cad5fc8a">wxPERSIST_AUIMGR_PERSPECTIVE</a></div><div class="ttdeci">#define wxPERSIST_AUIMGR_PERSPECTIVE</div><div class="ttdoc">Name of the persistent storage variable for saving Aui manager state.</div><div class="ttdef"><b>Definition</b> auimanager.h:32</div></div>
<div class="ttc" id="agroup__wx_extend_html_ga13bc393d7bfdc9edfd95fadc802dc983"><div class="ttname"><a href="group__wx_extend.html#ga13bc393d7bfdc9edfd95fadc802dc983">wxCreatePersistentObject</a></div><div class="ttdeci">wxPersistentObject * wxCreatePersistentObject(wxAuiManager *mgr)</div><div class="ttdoc">wxAuiManager's instantiation of wxCreatePersistentObject template</div><div class="ttdef"><b>Definition</b> auimanager.h:107</div></div>
<div class="ttc" id="agroup__wx_extend_html_ga7788ec0b170f698bd985a50acc9125ec"><div class="ttname"><a href="group__wx_extend.html#ga7788ec0b170f698bd985a50acc9125ec">wxPERSIST_AUIMGR_KIND</a></div><div class="ttdeci">#define wxPERSIST_AUIMGR_KIND</div><div class="ttdoc">wxPersistentAuiManager kind for persistent storage</div><div class="ttdef"><b>Definition</b> auimanager.h:27</div></div>
<div class="ttc" id="agroup__wx_extend_html_gaa4d1c55a5ab605bc8f40a01ae470930b"><div class="ttname"><a href="group__wx_extend.html#gaa4d1c55a5ab605bc8f40a01ae470930b">wxAuiManagerUpdatePerspectiveCaptions</a></div><div class="ttdeci">bool WXEXTEND_API wxAuiManagerUpdatePerspectiveCaptions(wxAuiManager &amp;mgr, wxString &amp;perspective)</div><div class="ttdoc">Updates perspective captions with matching captions from panes.</div><div class="ttdef"><b>Definition</b> framemanager.cpp:10</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 11 2024 14:56:54 for wxExtend by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>