Amebis/wxExtend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
wxExtend/classwx_app_bar.html

700 lines
41 KiB
HTML
Raw Blame History

<!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">
<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.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wxExtend: wxAppBar&lt; W &gt; Class Template Reference</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>
<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.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classwx_app_bar-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">wxAppBar&lt; W &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__wx_extend.html">WxExtend</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Dockable application bar template.
<a href="classwx_app_bar.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="appbar_8h_source.html">wxex/appbar.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for wxAppBar&lt; W &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classwx_app_bar.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a679ca2856889f23ea3373bfa6e41e831"><td class="memItemLeft" align="right" valign="top"><a id="a679ca2856889f23ea3373bfa6e41e831" name="a679ca2856889f23ea3373bfa6e41e831"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>wxAppBar</b> ()</td></tr>
<tr class="memdesc:a679ca2856889f23ea3373bfa6e41e831"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates new application bar. <br /></td></tr>
<tr class="separator:a679ca2856889f23ea3373bfa6e41e831"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a521931479c266038782c368daca9acc9"><td class="memItemLeft" align="right" valign="top"><a id="a521931479c266038782c368daca9acc9" name="a521931479c266038782c368daca9acc9"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~wxAppBar</b> ()</td></tr>
<tr class="memdesc:a521931479c266038782c368daca9acc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a521931479c266038782c368daca9acc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Application bar general management</div></td></tr>
<tr class="memitem:a40b3039c0f7a672d16c1187c8878ded6"><td class="memItemLeft" align="right" valign="top"><a id="a40b3039c0f7a672d16c1187c8878ded6" name="a40b3039c0f7a672d16c1187c8878ded6"></a>
<a class="el" href="group__wx_extend.html#gacab6afd4179e836abf89f1a500879f5c">wxAppBarState</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetState</b> () const</td></tr>
<tr class="memdesc:a40b3039c0f7a672d16c1187c8878ded6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns current state of the application bar. <br /></td></tr>
<tr class="separator:a40b3039c0f7a672d16c1187c8878ded6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a154d1f7a4e04ab2f61adcf205abd4961"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#a154d1f7a4e04ab2f61adcf205abd4961">IsAlwaysOnTop</a> () const</td></tr>
<tr class="memdesc:a154d1f7a4e04ab2f61adcf205abd4961"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether application bar is displayed always on top. <a href="classwx_app_bar.html#a154d1f7a4e04ab2f61adcf205abd4961">More...</a><br /></td></tr>
<tr class="separator:a154d1f7a4e04ab2f61adcf205abd4961"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae80d0867b83e54c429771e403cd9519a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#ae80d0867b83e54c429771e403cd9519a">SetAlwaysOnTop</a> (bool alwaysOnTop=true)</td></tr>
<tr class="memdesc:ae80d0867b83e54c429771e403cd9519a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether application bar is displayed always on top. <a href="classwx_app_bar.html#ae80d0867b83e54c429771e403cd9519a">More...</a><br /></td></tr>
<tr class="separator:ae80d0867b83e54c429771e403cd9519a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10e2e6f46f8c90dcd76f27b02dd4fe45"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#a10e2e6f46f8c90dcd76f27b02dd4fe45">IsAutoHide</a> () const</td></tr>
<tr class="memdesc:a10e2e6f46f8c90dcd76f27b02dd4fe45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if application bar is configured for auto-hide. <a href="classwx_app_bar.html#a10e2e6f46f8c90dcd76f27b02dd4fe45">More...</a><br /></td></tr>
<tr class="separator:a10e2e6f46f8c90dcd76f27b02dd4fe45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdbcdafcaf2331734313b2276c6bc640"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#abdbcdafcaf2331734313b2276c6bc640">SetAutoHide</a> (bool autoHide=true)</td></tr>
<tr class="memdesc:abdbcdafcaf2331734313b2276c6bc640"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether application bar is displayed always on top. <a href="classwx_app_bar.html#abdbcdafcaf2331734313b2276c6bc640">More...</a><br /></td></tr>
<tr class="separator:abdbcdafcaf2331734313b2276c6bc640"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b7f72142e0240b4b33bebdc6d19b361"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#a8b7f72142e0240b4b33bebdc6d19b361">GetAllowSizing</a> () const</td></tr>
<tr class="memdesc:a8b7f72142e0240b4b33bebdc6d19b361"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if sizing of the application bar is allowed. <a href="classwx_app_bar.html#a8b7f72142e0240b4b33bebdc6d19b361">More...</a><br /></td></tr>
<tr class="separator:a8b7f72142e0240b4b33bebdc6d19b361"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac75f7994f00fc8e4938f2b0faf3dd6d6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#ac75f7994f00fc8e4938f2b0faf3dd6d6">SetAllowSizing</a> (bool allow=true)</td></tr>
<tr class="memdesc:ac75f7994f00fc8e4938f2b0faf3dd6d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether resizing of the application bar is allowed. <a href="classwx_app_bar.html#ac75f7994f00fc8e4938f2b0faf3dd6d6">More...</a><br /></td></tr>
<tr class="separator:ac75f7994f00fc8e4938f2b0faf3dd6d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebe0b7c841cf979c9612f528be878b95"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#aebe0b7c841cf979c9612f528be878b95">GetAutoHidden</a> () const</td></tr>
<tr class="memdesc:aebe0b7c841cf979c9612f528be878b95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if application bar is auto-hidden right now. <a href="classwx_app_bar.html#aebe0b7c841cf979c9612f528be878b95">More...</a><br /></td></tr>
<tr class="separator:aebe0b7c841cf979c9612f528be878b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a808e8d6fed0fda0f17f423fdce48fa91"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#a808e8d6fed0fda0f17f423fdce48fa91">MinimiseToEdge</a> (<a class="el" href="group__wx_extend.html#gacab6afd4179e836abf89f1a500879f5c">wxAppBarState</a> edge, wxWindow *wnd=NULL)</td></tr>
<tr class="memdesc:a808e8d6fed0fda0f17f423fdce48fa91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimize application bar to the edge of the desktop. <a href="classwx_app_bar.html#a808e8d6fed0fda0f17f423fdce48fa91">More...</a><br /></td></tr>
<tr class="separator:a808e8d6fed0fda0f17f423fdce48fa91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f86c392151d776d5cf6a3dfffcc233c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#a7f86c392151d776d5cf6a3dfffcc233c">MaximiseFromEdge</a> (const RECT *rect=NULL)</td></tr>
<tr class="memdesc:a7f86c392151d776d5cf6a3dfffcc233c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore application bar from the edge of the desktop. <a href="classwx_app_bar.html#a7f86c392151d776d5cf6a3dfffcc233c">More...</a><br /></td></tr>
<tr class="separator:a7f86c392151d776d5cf6a3dfffcc233c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e7b1019bff7b513fef79d3b1328e377"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#a4e7b1019bff7b513fef79d3b1328e377">MaximiseFromEdge</a> (wxWindow *wnd)</td></tr>
<tr class="memdesc:a4e7b1019bff7b513fef79d3b1328e377"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore application bar from the edge of the desktop. <a href="classwx_app_bar.html#a4e7b1019bff7b513fef79d3b1328e377">More...</a><br /></td></tr>
<tr class="separator:a4e7b1019bff7b513fef79d3b1328e377"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcff0806eb953c6693e570b3f1eeafae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#afcff0806eb953c6693e570b3f1eeafae">ShowAutoHideAppBar</a> (bool show=true)</td></tr>
<tr class="memdesc:afcff0806eb953c6693e570b3f1eeafae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shows or hides auto-hide application bar. <a href="classwx_app_bar.html#afcff0806eb953c6693e570b3f1eeafae">More...</a><br /></td></tr>
<tr class="separator:afcff0806eb953c6693e570b3f1eeafae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e7a125895744ca83db85cebf2c18775"><td class="memItemLeft" align="right" valign="top"><a id="a8e7a125895744ca83db85cebf2c18775" name="a8e7a125895744ca83db85cebf2c18775"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>HideAutoHideAppBar</b> ()</td></tr>
<tr class="memdesc:a8e7a125895744ca83db85cebf2c18775"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hides auto-hide application bar. <br /></td></tr>
<tr class="separator:a8e7a125895744ca83db85cebf2c18775"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Notification handlers</div></td></tr>
<tr class="memitem:ad5ffb287a3823720f271607f4d6aa07d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#ad5ffb287a3823720f271607f4d6aa07d">OnChangeState</a> (<a class="el" href="group__wx_extend.html#gacab6afd4179e836abf89f1a500879f5c">wxAppBarState</a> stateNew)</td></tr>
<tr class="memdesc:ad5ffb287a3823720f271607f4d6aa07d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notification handler when the new state of the application bar is proposed. <a href="classwx_app_bar.html#ad5ffb287a3823720f271607f4d6aa07d">More...</a><br /></td></tr>
<tr class="separator:ad5ffb287a3823720f271607f4d6aa07d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5a7f89951072e7f5611d3fc1e264ade"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#ae5a7f89951072e7f5611d3fc1e264ade">OnChangeTaskBarState</a> (UINT_PTR state)</td></tr>
<tr class="memdesc:ae5a7f89951072e7f5611d3fc1e264ade"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notification handler when the Windows' taskbar state changes. <a href="classwx_app_bar.html#ae5a7f89951072e7f5611d3fc1e264ade">More...</a><br /></td></tr>
<tr class="separator:ae5a7f89951072e7f5611d3fc1e264ade"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63dab2382ef1642156e633fd56172de0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#a63dab2382ef1642156e633fd56172de0">OnWindowsArrange</a> (bool beginning)</td></tr>
<tr class="memdesc:a63dab2382ef1642156e633fd56172de0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notification handler when desktop windows are being arranged (cascaded, tiled, ...) <a href="classwx_app_bar.html#a63dab2382ef1642156e633fd56172de0">More...</a><br /></td></tr>
<tr class="separator:a63dab2382ef1642156e633fd56172de0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1a5b59877322c86a33b2ea12a126d6f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_app_bar.html#ac1a5b59877322c86a33b2ea12a126d6f">OnAutoHideDenied</a> ()</td></tr>
<tr class="memdesc:ac1a5b59877322c86a33b2ea12a126d6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when application bar was forced from auto-hide to normal docking. <a href="classwx_app_bar.html#ac1a5b59877322c86a33b2ea12a126d6f">More...</a><br /></td></tr>
<tr class="separator:ac1a5b59877322c86a33b2ea12a126d6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a96a0e58d3c64712e0a93dcd80414d3fa"><td class="memItemLeft" align="right" valign="top"><a id="a96a0e58d3c64712e0a93dcd80414d3fa" name="a96a0e58d3c64712e0a93dcd80414d3fa"></a>
<a class="el" href="group__wx_extend.html#gacab6afd4179e836abf89f1a500879f5c">wxAppBarState</a>&#160;</td><td class="memItemRight" valign="bottom"><b>m_state</b></td></tr>
<tr class="memdesc:a96a0e58d3c64712e0a93dcd80414d3fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current state of the application bar. <br /></td></tr>
<tr class="separator:a96a0e58d3c64712e0a93dcd80414d3fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6e7cac049c1394f9dcedfd3d554c078"><td class="memItemLeft" align="right" valign="top"><a id="ac6e7cac049c1394f9dcedfd3d554c078" name="ac6e7cac049c1394f9dcedfd3d554c078"></a>
<a class="el" href="group__wx_extend.html#gacab6afd4179e836abf89f1a500879f5c">wxAppBarState</a>&#160;</td><td class="memItemRight" valign="bottom"><b>m_stateDesired</b></td></tr>
<tr class="memdesc:ac6e7cac049c1394f9dcedfd3d554c078"><td class="mdescLeft">&#160;</td><td class="mdescRight">Desired state of the application bar while moving/resizing. <br /></td></tr>
<tr class="separator:ac6e7cac049c1394f9dcedfd3d554c078"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7de8d3fef326880f83aa63ca07c3a7f3"><td class="memItemLeft" align="right" valign="top"><a id="a7de8d3fef326880f83aa63ca07c3a7f3" name="a7de8d3fef326880f83aa63ca07c3a7f3"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>m_flags</b></td></tr>
<tr class="memdesc:a7de8d3fef326880f83aa63ca07c3a7f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags describing application bar's behaviour. <br /></td></tr>
<tr class="separator:a7de8d3fef326880f83aa63ca07c3a7f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c5fba27197133ba1247816a7b8abac9"><td class="memItemLeft" align="right" valign="top"><a id="a6c5fba27197133ba1247816a7b8abac9" name="a6c5fba27197133ba1247816a7b8abac9"></a>
SIZE&#160;</td><td class="memItemRight" valign="bottom"><b>m_sizeFloat</b></td></tr>
<tr class="memdesc:a6c5fba27197133ba1247816a7b8abac9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Window size when floating (we need it to restore floating size, when we undock) <br /></td></tr>
<tr class="separator:a6c5fba27197133ba1247816a7b8abac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca33c43e6370549d922000ead6814955"><td class="memItemLeft" align="right" valign="top"><a id="aca33c43e6370549d922000ead6814955" name="aca33c43e6370549d922000ead6814955"></a>
SIZE&#160;</td><td class="memItemRight" valign="bottom"><b>m_sizeDocked</b></td></tr>
<tr class="memdesc:aca33c43e6370549d922000ead6814955"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the window when docked (height when <a class="el" href="group__wx_extend.html#ggacab6afd4179e836abf89f1a500879f5ca6705777b712ee811e76fb07162081d63" title="Application bar is docked at the top edge of the desktop.">wxAppBarState::TOP</a> or <a class="el" href="group__wx_extend.html#ggacab6afd4179e836abf89f1a500879f5ca1fabf63de5c96c78e2a40805bcdeb73b" title="Application bar is docked at the bottom edge of the desktop.">wxAppBarState::BOTTOM</a>, width when <a class="el" href="group__wx_extend.html#ggacab6afd4179e836abf89f1a500879f5ca684d325a7303f52e64011467ff5c5758" title="Application bar is docked at the left edge of the desktop.">wxAppBarState::LEFT</a> or <a class="el" href="group__wx_extend.html#ggacab6afd4179e836abf89f1a500879f5ca21507b40c80068eda19865706fdc2403" title="Application bar is docked at the right edge of the desktop.">wxAppBarState::RIGHT</a>) <br /></td></tr>
<tr class="separator:aca33c43e6370549d922000ead6814955"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac59056e7fd5f0dd50082f87b19f987f6"><td class="memItemLeft" align="right" valign="top"><a id="ac59056e7fd5f0dd50082f87b19f987f6" name="ac59056e7fd5f0dd50082f87b19f987f6"></a>
SIZE&#160;</td><td class="memItemRight" valign="bottom"><b>m_sizeMin</b></td></tr>
<tr class="memdesc:ac59056e7fd5f0dd50082f87b19f987f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum window size. <br /></td></tr>
<tr class="separator:ac59056e7fd5f0dd50082f87b19f987f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50f6ac6aebf9e462145c0af70d3cbcef"><td class="memItemLeft" align="right" valign="top"><a id="a50f6ac6aebf9e462145c0af70d3cbcef" name="a50f6ac6aebf9e462145c0af70d3cbcef"></a>
UINT_PTR&#160;</td><td class="memItemRight" valign="bottom"><b>m_stateTaskBar</b></td></tr>
<tr class="memdesc:a50f6ac6aebf9e462145c0af70d3cbcef"><td class="mdescLeft">&#160;</td><td class="mdescRight">TaskBar's current state. <br /></td></tr>
<tr class="separator:a50f6ac6aebf9e462145c0af70d3cbcef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0283c72da37448e33bb1aa83598da38b"><td class="memItemLeft" align="right" valign="top"><a id="a0283c72da37448e33bb1aa83598da38b" name="a0283c72da37448e33bb1aa83598da38b"></a>
UINT_PTR&#160;</td><td class="memItemRight" valign="bottom"><b>m_timerID</b></td></tr>
<tr class="memdesc:a0283c72da37448e33bb1aa83598da38b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Application bar's timer id. <br /></td></tr>
<tr class="separator:a0283c72da37448e33bb1aa83598da38b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a455ccfb06e546f341dc320c19828896e"><td class="memItemLeft" align="right" valign="top"><a id="a455ccfb06e546f341dc320c19828896e" name="a455ccfb06e546f341dc320c19828896e"></a>
ITaskbarList *&#160;</td><td class="memItemRight" valign="bottom"><b>m_taskbarList</b></td></tr>
<tr class="memdesc:a455ccfb06e546f341dc320c19828896e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Windows's taskbar list interface. <br /></td></tr>
<tr class="separator:a455ccfb06e546f341dc320c19828896e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class W&gt;<br />
class wxAppBar&lt; W &gt;</div><p >Dockable application bar template. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a8b7f72142e0240b4b33bebdc6d19b361" name="a8b7f72142e0240b4b33bebdc6d19b361"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b7f72142e0240b4b33bebdc6d19b361">&#9670;&nbsp;</a></span>GetAllowSizing()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::GetAllowSizing</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if sizing of the application bar is allowed. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> if sizing of the application bar is allowed</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a id="aebe0b7c841cf979c9612f528be878b95" name="aebe0b7c841cf979c9612f528be878b95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebe0b7c841cf979c9612f528be878b95">&#9670;&nbsp;</a></span>GetAutoHidden()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::GetAutoHidden</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if application bar is auto-hidden right now. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> if application bar is auto-hidden right now</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a154d1f7a4e04ab2f61adcf205abd4961" name="a154d1f7a4e04ab2f61adcf205abd4961"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a154d1f7a4e04ab2f61adcf205abd4961">&#9670;&nbsp;</a></span>IsAlwaysOnTop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::IsAlwaysOnTop</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether application bar is displayed always on top. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> when application bar is always on top</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a10e2e6f46f8c90dcd76f27b02dd4fe45" name="a10e2e6f46f8c90dcd76f27b02dd4fe45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10e2e6f46f8c90dcd76f27b02dd4fe45">&#9670;&nbsp;</a></span>IsAutoHide()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::IsAutoHide</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns if application bar is configured for auto-hide. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>true</code> if application bar is configured for auto-hide</li>
<li><code>false</code> otherwise </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a7f86c392151d776d5cf6a3dfffcc233c" name="a7f86c392151d776d5cf6a3dfffcc233c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f86c392151d776d5cf6a3dfffcc233c">&#9670;&nbsp;</a></span>MaximiseFromEdge() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::MaximiseFromEdge </td>
<td>(</td>
<td class="paramtype">const RECT *&#160;</td>
<td class="paramname"><em>rect</em> = <code>NULL</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Restore application bar from the edge of the desktop. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>The desired coordinates of the restored window. If NULL internally saved coordinates are used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4e7b1019bff7b513fef79d3b1328e377" name="a4e7b1019bff7b513fef79d3b1328e377"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e7b1019bff7b513fef79d3b1328e377">&#9670;&nbsp;</a></span>MaximiseFromEdge() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::MaximiseFromEdge </td>
<td>(</td>
<td class="paramtype">wxWindow *&#160;</td>
<td class="paramname"><em>wnd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Restore application bar from the edge of the desktop. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">wnd</td><td>When the undocked and docked window is different, this parameter denotes the undocked version. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a808e8d6fed0fda0f17f423fdce48fa91" name="a808e8d6fed0fda0f17f423fdce48fa91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a808e8d6fed0fda0f17f423fdce48fa91">&#9670;&nbsp;</a></span>MinimiseToEdge()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::MinimiseToEdge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__wx_extend.html#gacab6afd4179e836abf89f1a500879f5c">wxAppBarState</a>&#160;</td>
<td class="paramname"><em>edge</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wxWindow *&#160;</td>
<td class="paramname"><em>wnd</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Minimize application bar to the edge of the desktop. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">edge</td><td>The edge at which to dock. Must be either of: <a class="el" href="group__wx_extend.html#ggacab6afd4179e836abf89f1a500879f5ca684d325a7303f52e64011467ff5c5758" title="Application bar is docked at the left edge of the desktop.">wxAppBarState::LEFT</a>, <a class="el" href="group__wx_extend.html#ggacab6afd4179e836abf89f1a500879f5ca6705777b712ee811e76fb07162081d63" title="Application bar is docked at the top edge of the desktop.">wxAppBarState::TOP</a>, <a class="el" href="group__wx_extend.html#ggacab6afd4179e836abf89f1a500879f5ca21507b40c80068eda19865706fdc2403" title="Application bar is docked at the right edge of the desktop.">wxAppBarState::RIGHT</a>, or <a class="el" href="group__wx_extend.html#ggacab6afd4179e836abf89f1a500879f5ca1fabf63de5c96c78e2a40805bcdeb73b" title="Application bar is docked at the bottom edge of the desktop.">wxAppBarState::BOTTOM</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">wnd</td><td>When the undocked and docked window is different, this parameter denotes the undocked version. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac1a5b59877322c86a33b2ea12a126d6f" name="ac1a5b59877322c86a33b2ea12a126d6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1a5b59877322c86a33b2ea12a126d6f">&#9670;&nbsp;</a></span>OnAutoHideDenied()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::OnAutoHideDenied</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when application bar was forced from auto-hide to normal docking. </p>
<p >Default implementation displays a warning dialog. </p>
</div>
</div>
<a id="ad5ffb287a3823720f271607f4d6aa07d" name="ad5ffb287a3823720f271607f4d6aa07d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5ffb287a3823720f271607f4d6aa07d">&#9670;&nbsp;</a></span>OnChangeState()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::OnChangeState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__wx_extend.html#gacab6afd4179e836abf89f1a500879f5c">wxAppBarState</a>&#160;</td>
<td class="paramname"><em>stateNew</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Notification handler when the new state of the application bar is proposed. </p>
<p >Derived classes can implement their own. However, overriden virtual method should call the parent's implementation too.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stateNew</td><td>New state about to take effect. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae5a7f89951072e7f5611d3fc1e264ade" name="ae5a7f89951072e7f5611d3fc1e264ade"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5a7f89951072e7f5611d3fc1e264ade">&#9670;&nbsp;</a></span>OnChangeTaskBarState()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::OnChangeTaskBarState </td>
<td>(</td>
<td class="paramtype">UINT_PTR&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Notification handler when the Windows' taskbar state changes. </p>
<p >Derived classes can implement their own. However, overriden virtual method should call the parent's implementation too.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>New taskbar state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a63dab2382ef1642156e633fd56172de0" name="a63dab2382ef1642156e633fd56172de0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63dab2382ef1642156e633fd56172de0">&#9670;&nbsp;</a></span>OnWindowsArrange()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::OnWindowsArrange </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>beginning</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Notification handler when desktop windows are being arranged (cascaded, tiled, ...) </p>
<p >Derived classes can implement their own. However, overriden virtual method should call the parent's implementation too.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">beginning</td><td><code>true</code> when windows arrangement starts and <code>false</code> when arrangement ends. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac75f7994f00fc8e4938f2b0faf3dd6d6" name="ac75f7994f00fc8e4938f2b0faf3dd6d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac75f7994f00fc8e4938f2b0faf3dd6d6">&#9670;&nbsp;</a></span>SetAllowSizing()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::SetAllowSizing </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>allow</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether resizing of the application bar is allowed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">allow</td><td>Logical variable to control whether resizing is to be enabled (<code>true</code>) or disabled (<code>false</code>). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae80d0867b83e54c429771e403cd9519a" name="ae80d0867b83e54c429771e403cd9519a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae80d0867b83e54c429771e403cd9519a">&#9670;&nbsp;</a></span>SetAlwaysOnTop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::SetAlwaysOnTop </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>alwaysOnTop</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether application bar is displayed always on top. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">alwaysOnTop</td><td>Logical variable to control whether always-on-top behaviour is to be enabled (<code>true</code>) or disabled (<code>false</code>). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abdbcdafcaf2331734313b2276c6bc640" name="abdbcdafcaf2331734313b2276c6bc640"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdbcdafcaf2331734313b2276c6bc640">&#9670;&nbsp;</a></span>SetAutoHide()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::SetAutoHide </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>autoHide</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether application bar is displayed always on top. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">autoHide</td><td>Logical variable to control whether auto-hide behaviour is to be enabled (<code>true</code>) or disabled (<code>false</code>). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afcff0806eb953c6693e570b3f1eeafae" name="afcff0806eb953c6693e570b3f1eeafae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcff0806eb953c6693e570b3f1eeafae">&#9670;&nbsp;</a></span>ShowAutoHideAppBar()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classwx_app_bar.html">wxAppBar</a>&lt; W &gt;::ShowAutoHideAppBar </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>show</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows or hides auto-hide application bar. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">show</td><td>Logical variable to control whether application bar is be shown (<code>true</code>) or hidden (<code>false</code>). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/wxex/<a class="el" href="appbar_8h_source.html">appbar.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Feb 17 2022 12:50:26 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.9.3
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink