|
- <!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=9"/>
- <meta name="generator" content="Doxygen 1.9.1"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>DISTRHO Plugin Framework: TopLevelWidget Class 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 style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">DISTRHO Plugin Framework
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.1 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(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> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="#friends">Friends</a> |
- <a href="classTopLevelWidget-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">TopLevelWidget Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
-
- <p><code>#include <<a class="el" href="TopLevelWidget_8hpp_source.html">TopLevelWidget.hpp</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for TopLevelWidget:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="classTopLevelWidget.png" usemap="#TopLevelWidget_map" alt=""/>
- <map id="TopLevelWidget_map" name="TopLevelWidget_map">
- <area href="classWidget.html" alt="Widget" shape="rect" coords="0,0,235,24"/>
- <area href="classStandaloneWindow.html" alt="StandaloneWindow" shape="rect" coords="0,112,235,136"/>
- <area href="classImageBaseAboutWindow.html" alt="ImageBaseAboutWindow< ImageType >" shape="rect" coords="0,168,235,192"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a3cdeec5e7b144cc48d89e748a37f538e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a3cdeec5e7b144cc48d89e748a37f538e">TopLevelWidget</a> (<a class="el" href="classWindow.html">Window</a> &windowToMapTo)</td></tr>
- <tr class="separator:a3cdeec5e7b144cc48d89e748a37f538e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af60daa3513ca7f7d05575ab3feaee268"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#af60daa3513ca7f7d05575ab3feaee268">~TopLevelWidget</a> () override</td></tr>
- <tr class="separator:af60daa3513ca7f7d05575ab3feaee268"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af5c5c403ba231c14b3a41684bef45648"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApplication.html">Application</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#af5c5c403ba231c14b3a41684bef45648">getApp</a> () const noexcept</td></tr>
- <tr class="separator:af5c5c403ba231c14b3a41684bef45648"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3ceb7af6e9372a139d40a5859dfd0e4d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWindow.html">Window</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a3ceb7af6e9372a139d40a5859dfd0e4d">getWindow</a> () const noexcept</td></tr>
- <tr class="separator:a3ceb7af6e9372a139d40a5859dfd0e4d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4a95eb3bb76704737ef9cf405e800617"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a4a95eb3bb76704737ef9cf405e800617">setWidth</a> (uint width)</td></tr>
- <tr class="separator:a4a95eb3bb76704737ef9cf405e800617"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a607afeaa7fc1bd6cf52ef3138c38360f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a607afeaa7fc1bd6cf52ef3138c38360f">setHeight</a> (uint height)</td></tr>
- <tr class="separator:a607afeaa7fc1bd6cf52ef3138c38360f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a41fa486da289fb082bb840aaaad72a08"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a41fa486da289fb082bb840aaaad72a08">setSize</a> (uint width, uint height)</td></tr>
- <tr class="separator:a41fa486da289fb082bb840aaaad72a08"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a94f526903d739bf2e812fb785fc66aae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a94f526903d739bf2e812fb785fc66aae">setSize</a> (const <a class="el" href="classSize.html">Size</a>< uint > &size)</td></tr>
- <tr class="separator:a94f526903d739bf2e812fb785fc66aae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5b71bc1266aea488b1f85b83744adbfd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a5b71bc1266aea488b1f85b83744adbfd">repaint</a> () noexcept override</td></tr>
- <tr class="separator:a5b71bc1266aea488b1f85b83744adbfd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4a9b2d040ba36825fd95f966bb4d9e36"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a4a9b2d040ba36825fd95f966bb4d9e36">repaint</a> (const <a class="el" href="classRectangle.html">Rectangle</a>< uint > &rect) noexcept</td></tr>
- <tr class="separator:a4a9b2d040ba36825fd95f966bb4d9e36"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1fbfc17e10dbe06cfcf656ebd3438da0"><td class="memItemLeft" align="right" valign="top"><a id="a1fbfc17e10dbe06cfcf656ebd3438da0"></a>
- const void * </td><td class="memItemRight" valign="bottom"><b>getClipboard</b> (size_t &dataSize)</td></tr>
- <tr class="separator:a1fbfc17e10dbe06cfcf656ebd3438da0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a74ed1b7de337a9d4447903644087ef32"><td class="memItemLeft" align="right" valign="top"><a id="a74ed1b7de337a9d4447903644087ef32"></a>
- bool </td><td class="memItemRight" valign="bottom"><b>setClipboard</b> (const char *mimeType, const void *data, size_t dataSize)</td></tr>
- <tr class="separator:a74ed1b7de337a9d4447903644087ef32"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a21314d0829749739ee1c438e691a5f49"><td class="memItemLeft" align="right" valign="top"><a id="a21314d0829749739ee1c438e691a5f49"></a>
- bool </td><td class="memItemRight" valign="bottom"><b>setCursor</b> (MouseCursor cursor)</td></tr>
- <tr class="separator:a21314d0829749739ee1c438e691a5f49"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5569262e4859b2b59832af4fb8409ddc"><td class="memItemLeft" align="right" valign="top"><a id="a5569262e4859b2b59832af4fb8409ddc"></a>
- bool </td><td class="memItemRight" valign="bottom"><b>addIdleCallback</b> (<a class="el" href="structIdleCallback.html">IdleCallback</a> *callback, uint timerFrequencyInMs=0)</td></tr>
- <tr class="separator:a5569262e4859b2b59832af4fb8409ddc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4cf1a5a0ea4f266fde337e9756c82c41"><td class="memItemLeft" align="right" valign="top"><a id="a4cf1a5a0ea4f266fde337e9756c82c41"></a>
- bool </td><td class="memItemRight" valign="bottom"><b>removeIdleCallback</b> (<a class="el" href="structIdleCallback.html">IdleCallback</a> *callback)</td></tr>
- <tr class="separator:a4cf1a5a0ea4f266fde337e9756c82c41"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8f8c6b72513abeb782cdbed5b24c6fb8"><td class="memItemLeft" align="right" valign="top"><a id="a8f8c6b72513abeb782cdbed5b24c6fb8"></a>
- double </td><td class="memItemRight" valign="bottom"><b>getScaleFactor</b> () const noexcept</td></tr>
- <tr class="separator:a8f8c6b72513abeb782cdbed5b24c6fb8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad096c93f5eb7b328707ee1f98c173c12"><td class="memItemLeft" align="right" valign="top"><a id="ad096c93f5eb7b328707ee1f98c173c12"></a>
- void </td><td class="memItemRight" valign="bottom"><b>setGeometryConstraints</b> (uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false, bool resizeNowIfAutoScaling=true)</td></tr>
- <tr class="separator:ad096c93f5eb7b328707ee1f98c173c12"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a608102a97b9b66636d947d029cbc87ac"><td class="memItemLeft" align="right" valign="top"><a id="a608102a97b9b66636d947d029cbc87ac"></a>
- <a class="el" href="classApplication.html">Application</a> & </td><td class="memItemRight" valign="bottom"><b>getParentApp</b> () const noexcept</td></tr>
- <tr class="separator:a608102a97b9b66636d947d029cbc87ac"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5eaf5a87cf735945a40945523b3f1fbb"><td class="memItemLeft" align="right" valign="top"><a id="a5eaf5a87cf735945a40945523b3f1fbb"></a>
- <a class="el" href="classWindow.html">Window</a> & </td><td class="memItemRight" valign="bottom"><b>getParentWindow</b> () const noexcept</td></tr>
- <tr class="separator:a5eaf5a87cf735945a40945523b3f1fbb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classWidget"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classWidget')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classWidget.html">Widget</a></td></tr>
- <tr class="memitem:a714cf798aadb4d615f6f60a355382c02 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a714cf798aadb4d615f6f60a355382c02">~Widget</a> ()</td></tr>
- <tr class="separator:a714cf798aadb4d615f6f60a355382c02 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a234a8ee8a685dc211ad11f492f0dbc71 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a234a8ee8a685dc211ad11f492f0dbc71">isVisible</a> () const noexcept</td></tr>
- <tr class="separator:a234a8ee8a685dc211ad11f492f0dbc71 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a66088a03691f9c643ff335fa826576ba inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a66088a03691f9c643ff335fa826576ba">setVisible</a> (bool visible)</td></tr>
- <tr class="separator:a66088a03691f9c643ff335fa826576ba inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a25ff178539e226b5f30ef0335d060f2b inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a25ff178539e226b5f30ef0335d060f2b">show</a> ()</td></tr>
- <tr class="separator:a25ff178539e226b5f30ef0335d060f2b inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4a2f8eebacdd20db505b838f1a118c6b inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a4a2f8eebacdd20db505b838f1a118c6b">hide</a> ()</td></tr>
- <tr class="separator:a4a2f8eebacdd20db505b838f1a118c6b inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a169c317caf734c6664494a573e427b40 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a169c317caf734c6664494a573e427b40">getWidth</a> () const noexcept</td></tr>
- <tr class="separator:a169c317caf734c6664494a573e427b40 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa20f6dc096a8836706173f31324c4db8 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#aa20f6dc096a8836706173f31324c4db8">getHeight</a> () const noexcept</td></tr>
- <tr class="separator:aa20f6dc096a8836706173f31324c4db8 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9044d42c20ead27dba983b710c94f8d6 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classSize.html">Size</a>< uint > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a9044d42c20ead27dba983b710c94f8d6">getSize</a> () const noexcept</td></tr>
- <tr class="separator:a9044d42c20ead27dba983b710c94f8d6 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aed80a9cbc4a13c01641f35dd3d8688ea inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#aed80a9cbc4a13c01641f35dd3d8688ea">setWidth</a> (uint width) noexcept</td></tr>
- <tr class="separator:aed80a9cbc4a13c01641f35dd3d8688ea inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac6d2e6cbb2ff96f3645493d804af07f7 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ac6d2e6cbb2ff96f3645493d804af07f7">setHeight</a> (uint height) noexcept</td></tr>
- <tr class="separator:ac6d2e6cbb2ff96f3645493d804af07f7 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab4d9e0156e455db3ff23730f82544daa inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ab4d9e0156e455db3ff23730f82544daa">setSize</a> (uint width, uint height) noexcept</td></tr>
- <tr class="separator:ab4d9e0156e455db3ff23730f82544daa inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afce784b204902c0f11e9ed02bc692362 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#afce784b204902c0f11e9ed02bc692362">setSize</a> (const <a class="el" href="classSize.html">Size</a>< uint > &size) noexcept</td></tr>
- <tr class="separator:afce784b204902c0f11e9ed02bc692362 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3ee6b2824e3f3719c1c9b3d070385f49 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a3ee6b2824e3f3719c1c9b3d070385f49">getId</a> () const noexcept</td></tr>
- <tr class="separator:a3ee6b2824e3f3719c1c9b3d070385f49 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a70b07dbf748490e5a8c18fb9d5766c0e inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a70b07dbf748490e5a8c18fb9d5766c0e">getName</a> () const noexcept</td></tr>
- <tr class="separator:a70b07dbf748490e5a8c18fb9d5766c0e inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abfba3652559de84ba1ae9ccbd3d35e31 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#abfba3652559de84ba1ae9ccbd3d35e31">setId</a> (uint id) noexcept</td></tr>
- <tr class="separator:abfba3652559de84ba1ae9ccbd3d35e31 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6303d0445f21a2a95148780b0a0afed6 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a6303d0445f21a2a95148780b0a0afed6">setName</a> (const char *name) noexcept</td></tr>
- <tr class="separator:a6303d0445f21a2a95148780b0a0afed6 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a373419bc6353abf50a502cdbebd736e7 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApplication.html">Application</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a373419bc6353abf50a502cdbebd736e7">getApp</a> () const noexcept</td></tr>
- <tr class="separator:a373419bc6353abf50a502cdbebd736e7 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0ef05695aec704b0eb1eb91c2e8af07d inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWindow.html">Window</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a0ef05695aec704b0eb1eb91c2e8af07d">getWindow</a> () const noexcept</td></tr>
- <tr class="separator:a0ef05695aec704b0eb1eb91c2e8af07d inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae23d09ec0e5f0397a3451b603b407182 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ae23d09ec0e5f0397a3451b603b407182">getGraphicsContext</a> () const noexcept</td></tr>
- <tr class="separator:ae23d09ec0e5f0397a3451b603b407182 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a607b153f7d3187ca60bf21004efc1314 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTopLevelWidget.html">TopLevelWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a607b153f7d3187ca60bf21004efc1314">getTopLevelWidget</a> () const noexcept</td></tr>
- <tr class="separator:a607b153f7d3187ca60bf21004efc1314 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5381d5583ba6e55fe9fed87df95d9605 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top">std::list< <a class="el" href="classSubWidget.html">SubWidget</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a5381d5583ba6e55fe9fed87df95d9605">getChildren</a> () const noexcept</td></tr>
- <tr class="separator:a5381d5583ba6e55fe9fed87df95d9605 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa514fb1c20038ba9793e4409e9b18876 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a id="aa514fb1c20038ba9793e4409e9b18876"></a>
- <a class="el" href="classApplication.html">Application</a> & </td><td class="memItemRight" valign="bottom"><b>getParentApp</b> () const noexcept</td></tr>
- <tr class="separator:aa514fb1c20038ba9793e4409e9b18876 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e0b0b2293bb63b2d84774542cc6a421 inherit pub_methods_classWidget"><td class="memItemLeft" align="right" valign="top"><a id="a0e0b0b2293bb63b2d84774542cc6a421"></a>
- <a class="el" href="classWindow.html">Window</a> & </td><td class="memItemRight" valign="bottom"><b>getParentWindow</b> () const noexcept</td></tr>
- <tr class="separator:a0e0b0b2293bb63b2d84774542cc6a421 inherit pub_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:a7b182e276662bc32aa0fcd7b07dfe4d0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a7b182e276662bc32aa0fcd7b07dfe4d0">onKeyboard</a> (const <a class="el" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a> &) override</td></tr>
- <tr class="separator:a7b182e276662bc32aa0fcd7b07dfe4d0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a567153ae0853e56553c9569dc61ed913"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a567153ae0853e56553c9569dc61ed913">onCharacterInput</a> (const <a class="el" href="structWidget_1_1CharacterInputEvent.html">CharacterInputEvent</a> &) override</td></tr>
- <tr class="separator:a567153ae0853e56553c9569dc61ed913"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8ceccb37de18c8e3b21fbf64ad58981c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a8ceccb37de18c8e3b21fbf64ad58981c">onMouse</a> (const <a class="el" href="structWidget_1_1MouseEvent.html">MouseEvent</a> &) override</td></tr>
- <tr class="separator:a8ceccb37de18c8e3b21fbf64ad58981c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac640eb913196c9edb68e5d52df4a89cb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#ac640eb913196c9edb68e5d52df4a89cb">onMotion</a> (const <a class="el" href="structWidget_1_1MotionEvent.html">MotionEvent</a> &) override</td></tr>
- <tr class="separator:ac640eb913196c9edb68e5d52df4a89cb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a412a6ce96a4ef7f64396e312ad072f9d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTopLevelWidget.html#a412a6ce96a4ef7f64396e312ad072f9d">onScroll</a> (const <a class="el" href="structWidget_1_1ScrollEvent.html">ScrollEvent</a> &) override</td></tr>
- <tr class="separator:a412a6ce96a4ef7f64396e312ad072f9d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_classWidget"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classWidget')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classWidget.html">Widget</a></td></tr>
- <tr class="memitem:ae1554f348fe3b2f9d4c3c5c4f9ec55bd inherit pro_methods_classWidget"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#ae1554f348fe3b2f9d4c3c5c4f9ec55bd">onDisplay</a> ()=0</td></tr>
- <tr class="separator:ae1554f348fe3b2f9d4c3c5c4f9ec55bd inherit pro_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acc0365ec4b9245bdffb8d0285be55dea inherit pro_methods_classWidget"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#acc0365ec4b9245bdffb8d0285be55dea">onResize</a> (const <a class="el" href="structWidget_1_1ResizeEvent.html">ResizeEvent</a> &)</td></tr>
- <tr class="separator:acc0365ec4b9245bdffb8d0285be55dea inherit pro_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3b42652fcb2f95c6f86bdd43a1727507 inherit pro_methods_classWidget"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWidget.html#a3b42652fcb2f95c6f86bdd43a1727507">onSpecial</a> (const SpecialEvent &)</td></tr>
- <tr class="separator:a3b42652fcb2f95c6f86bdd43a1727507 inherit pro_methods_classWidget"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
- Friends</h2></td></tr>
- <tr class="memitem:a553f958a25683445088050a69d3de8e9"><td class="memItemLeft" align="right" valign="top"><a id="a553f958a25683445088050a69d3de8e9"></a>
- class </td><td class="memItemRight" valign="bottom"><b>Window</b></td></tr>
- <tr class="separator:a553f958a25683445088050a69d3de8e9"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Top-Level <a class="el" href="classWidget.html">Widget</a> class.</p>
- <p>This is the only <a class="el" href="classWidget.html">Widget</a> class that is allowed to be used directly on a <a class="el" href="classWindow.html">Window</a>.</p>
- <p>This widget takes the full size of the <a class="el" href="classWindow.html">Window</a> it is mapped to. Sub-widgets can be added on top of this top-level widget, by creating them with this class as parent. Doing so allows for custom position and sizes.</p>
- <p>This class is used as the type for DPF <a class="el" href="classPlugin.html">Plugin</a> UIs. So anything that a plugin <a class="el" href="classUI.html">UI</a> might need that does not belong in a simple <a class="el" href="classWidget.html">Widget</a> will go here. </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a3cdeec5e7b144cc48d89e748a37f538e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3cdeec5e7b144cc48d89e748a37f538e">◆ </a></span>TopLevelWidget()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">TopLevelWidget::TopLevelWidget </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classWindow.html">Window</a> & </td>
- <td class="paramname"><em>windowToMapTo</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Constructor. </p>
-
- </div>
- </div>
- <a id="af60daa3513ca7f7d05575ab3feaee268"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af60daa3513ca7f7d05575ab3feaee268">◆ </a></span>~TopLevelWidget()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">TopLevelWidget::~TopLevelWidget </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Destructor. </p>
-
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="af5c5c403ba231c14b3a41684bef45648"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af5c5c403ba231c14b3a41684bef45648">◆ </a></span>getApp()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classApplication.html">Application</a>& TopLevelWidget::getApp </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the application associated with this top-level widget's window. </p>
-
- </div>
- </div>
- <a id="a3ceb7af6e9372a139d40a5859dfd0e4d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3ceb7af6e9372a139d40a5859dfd0e4d">◆ </a></span>getWindow()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classWindow.html">Window</a>& TopLevelWidget::getWindow </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the window associated with this top-level widget. </p>
-
- </div>
- </div>
- <a id="a4a95eb3bb76704737ef9cf405e800617"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4a95eb3bb76704737ef9cf405e800617">◆ </a></span>setWidth()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void TopLevelWidget::setWidth </td>
- <td>(</td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>width</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set width of this widget's window. </p><dl class="section note"><dt>Note</dt><dd>This will not change the widget's size right away, but be pending on the OS resizing the window </dd></dl>
-
- </div>
- </div>
- <a id="a607afeaa7fc1bd6cf52ef3138c38360f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a607afeaa7fc1bd6cf52ef3138c38360f">◆ </a></span>setHeight()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void TopLevelWidget::setHeight </td>
- <td>(</td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>height</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set height of this widget's window. </p><dl class="section note"><dt>Note</dt><dd>This will not change the widget's size right away, but be pending on the OS resizing the window </dd></dl>
-
- </div>
- </div>
- <a id="a41fa486da289fb082bb840aaaad72a08"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a41fa486da289fb082bb840aaaad72a08">◆ </a></span>setSize() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void TopLevelWidget::setSize </td>
- <td>(</td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>height</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set size of this widget's window, using <em>width</em> and <em>height</em> values. </p><dl class="section note"><dt>Note</dt><dd>This will not change the widget's size right away, but be pending on the OS resizing the window </dd></dl>
-
- </div>
- </div>
- <a id="a94f526903d739bf2e812fb785fc66aae"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a94f526903d739bf2e812fb785fc66aae">◆ </a></span>setSize() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void TopLevelWidget::setSize </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classSize.html">Size</a>< uint > & </td>
- <td class="paramname"><em>size</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set size of this widget's window. </p><dl class="section note"><dt>Note</dt><dd>This will not change the widget's size right away, but be pending on the OS resizing the window </dd></dl>
-
- </div>
- </div>
- <a id="a5b71bc1266aea488b1f85b83744adbfd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5b71bc1266aea488b1f85b83744adbfd">◆ </a></span>repaint() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void TopLevelWidget::repaint </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>TODO document this. </p>
-
- <p>Reimplemented from <a class="el" href="classWidget.html#abe8cfe0aaae71dd011cf9a86e930fd12">Widget</a>.</p>
-
- </div>
- </div>
- <a id="a4a9b2d040ba36825fd95f966bb4d9e36"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4a9b2d040ba36825fd95f966bb4d9e36">◆ </a></span>repaint() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void TopLevelWidget::repaint </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>< uint > & </td>
- <td class="paramname"><em>rect</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>TODO document this. </p>
-
- </div>
- </div>
- <a id="a7b182e276662bc32aa0fcd7b07dfe4d0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7b182e276662bc32aa0fcd7b07dfe4d0">◆ </a></span>onKeyboard()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool TopLevelWidget::onKeyboard </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structWidget_1_1KeyboardEvent.html">KeyboardEvent</a> & </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A function called when a key is pressed or released. </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
-
- <p>Reimplemented from <a class="el" href="classWidget.html#a9fa874aede538b41348f1029524aea11">Widget</a>.</p>
-
- </div>
- </div>
- <a id="a567153ae0853e56553c9569dc61ed913"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a567153ae0853e56553c9569dc61ed913">◆ </a></span>onCharacterInput()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool TopLevelWidget::onCharacterInput </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structWidget_1_1CharacterInputEvent.html">CharacterInputEvent</a> & </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A function called when an UTF-8 character is received. </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
-
- <p>Reimplemented from <a class="el" href="classWidget.html#ad7fb24de24d8809305b04ff3750f0dea">Widget</a>.</p>
-
- </div>
- </div>
- <a id="a8ceccb37de18c8e3b21fbf64ad58981c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8ceccb37de18c8e3b21fbf64ad58981c">◆ </a></span>onMouse()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool TopLevelWidget::onMouse </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structWidget_1_1MouseEvent.html">MouseEvent</a> & </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A function called when a mouse button is pressed or released. </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
-
- <p>Reimplemented from <a class="el" href="classWidget.html#a097ec1d56a06bdc9e0a4e54880def378">Widget</a>.</p>
-
- </div>
- </div>
- <a id="ac640eb913196c9edb68e5d52df4a89cb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac640eb913196c9edb68e5d52df4a89cb">◆ </a></span>onMotion()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool TopLevelWidget::onMotion </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structWidget_1_1MotionEvent.html">MotionEvent</a> & </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A function called when the pointer moves. </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
-
- <p>Reimplemented from <a class="el" href="classWidget.html#a655569fb78a598652e9f24cefa1fe4a5">Widget</a>.</p>
-
- </div>
- </div>
- <a id="a412a6ce96a4ef7f64396e312ad072f9d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a412a6ce96a4ef7f64396e312ad072f9d">◆ </a></span>onScroll()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool TopLevelWidget::onScroll </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structWidget_1_1ScrollEvent.html">ScrollEvent</a> & </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A function called on scrolling (e.g. mouse wheel or track pad). </p><dl class="section return"><dt>Returns</dt><dd>True to stop event propagation, false otherwise. </dd></dl>
-
- <p>Reimplemented from <a class="el" href="classWidget.html#a0d78d28bd4a98c3a016a38091b2d4185">Widget</a>.</p>
-
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>dgl/<a class="el" href="TopLevelWidget_8hpp_source.html">TopLevelWidget.hpp</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
- </small></address>
- </body>
- </html>
|