|
- <!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: Window 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="#nested-classes">Classes</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="#friends">Friends</a> |
- <a href="classWindow-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">Window Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
-
- <p><code>#include <<a class="el" href="Window_8hpp_source.html">Window.hpp</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for Window:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="classWindow.png" usemap="#Window_map" alt=""/>
- <map id="Window_map" name="Window_map">
- <area href="classStandaloneWindow.html" alt="StandaloneWindow" shape="rect" coords="0,56,235,80"/>
- <area href="classImageBaseAboutWindow.html" alt="ImageBaseAboutWindow< ImageType >" shape="rect" coords="0,112,235,136"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
- Classes</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structWindow_1_1ScopedGraphicsContext.html">ScopedGraphicsContext</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><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:a2f6257937261fcb3e627752dfb248d47"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a2f6257937261fcb3e627752dfb248d47">Window</a> (<a class="el" href="classApplication.html">Application</a> &app)</td></tr>
- <tr class="separator:a2f6257937261fcb3e627752dfb248d47"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a647ec84da28005ecf0501825af77adec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a647ec84da28005ecf0501825af77adec">Window</a> (<a class="el" href="classApplication.html">Application</a> &app, <a class="el" href="classWindow.html">Window</a> &transientParentWindow)</td></tr>
- <tr class="separator:a647ec84da28005ecf0501825af77adec"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2cd48e2c2d816439cf38faf5c7a9736f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a2cd48e2c2d816439cf38faf5c7a9736f">Window</a> (<a class="el" href="classApplication.html">Application</a> &app, uintptr_t parentWindowHandle, double scaleFactor, bool resizable)</td></tr>
- <tr class="separator:a2cd48e2c2d816439cf38faf5c7a9736f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ada557b4543c122a0de22c876c55504ae"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#ada557b4543c122a0de22c876c55504ae">Window</a> (<a class="el" href="classApplication.html">Application</a> &app, uintptr_t parentWindowHandle, uint width, uint height, double scaleFactor, bool resizable)</td></tr>
- <tr class="separator:ada557b4543c122a0de22c876c55504ae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a62b4a97b3c2e492f1d9a46092011e2d9"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a62b4a97b3c2e492f1d9a46092011e2d9">~Window</a> ()</td></tr>
- <tr class="separator:a62b4a97b3c2e492f1d9a46092011e2d9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afb840ed25c1fe17bed66d80adfc420ab"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#afb840ed25c1fe17bed66d80adfc420ab">isEmbed</a> () const noexcept</td></tr>
- <tr class="separator:afb840ed25c1fe17bed66d80adfc420ab"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6be53a737e7dfcc74167962437e93b8f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a6be53a737e7dfcc74167962437e93b8f">isVisible</a> () const noexcept</td></tr>
- <tr class="separator:a6be53a737e7dfcc74167962437e93b8f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a118e0356bb6fcf081955f2bd97686036"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a118e0356bb6fcf081955f2bd97686036">setVisible</a> (bool visible)</td></tr>
- <tr class="separator:a118e0356bb6fcf081955f2bd97686036"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8f986e19a11c4c97ed8e6ad3d0e648b7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a8f986e19a11c4c97ed8e6ad3d0e648b7">show</a> ()</td></tr>
- <tr class="separator:a8f986e19a11c4c97ed8e6ad3d0e648b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4626829d3cb9d01285f739d2bbc69b74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a4626829d3cb9d01285f739d2bbc69b74">hide</a> ()</td></tr>
- <tr class="separator:a4626829d3cb9d01285f739d2bbc69b74"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a35055c04498121d39741bfcd5082705b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a35055c04498121d39741bfcd5082705b">close</a> ()</td></tr>
- <tr class="separator:a35055c04498121d39741bfcd5082705b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1b888a7e6a5562968a253b915ccb7825"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a1b888a7e6a5562968a253b915ccb7825">isResizable</a> () const noexcept</td></tr>
- <tr class="separator:a1b888a7e6a5562968a253b915ccb7825"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a10f6ff4b0f3e714298a4ac612edcdd7e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a10f6ff4b0f3e714298a4ac612edcdd7e">setResizable</a> (bool resizable)</td></tr>
- <tr class="separator:a10f6ff4b0f3e714298a4ac612edcdd7e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a200f3e517effa7973e1c42c72ca55f9f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a200f3e517effa7973e1c42c72ca55f9f">getOffsetX</a> () const noexcept</td></tr>
- <tr class="separator:a200f3e517effa7973e1c42c72ca55f9f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a948304155a8403b92db8feeae1a76f46"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a948304155a8403b92db8feeae1a76f46">getOffsetY</a> () const noexcept</td></tr>
- <tr class="separator:a948304155a8403b92db8feeae1a76f46"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a58f66fcfd4c902954594e99d4bfa0b6a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPoint.html">Point</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a58f66fcfd4c902954594e99d4bfa0b6a">getOffset</a> () const noexcept</td></tr>
- <tr class="separator:a58f66fcfd4c902954594e99d4bfa0b6a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a486cf7a5f89c39e1cac3a01633f170db"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a486cf7a5f89c39e1cac3a01633f170db">setOffsetX</a> (int x)</td></tr>
- <tr class="separator:a486cf7a5f89c39e1cac3a01633f170db"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac570a2c8f35ea4962c8f23c8435cdbfc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#ac570a2c8f35ea4962c8f23c8435cdbfc">setOffsetY</a> (int y)</td></tr>
- <tr class="separator:ac570a2c8f35ea4962c8f23c8435cdbfc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5d79613d3223395806d7d09ad65d5c4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a5d79613d3223395806d7d09ad65d5c4d">setOffset</a> (int x, int y)</td></tr>
- <tr class="separator:a5d79613d3223395806d7d09ad65d5c4d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae02f210d981b2ac5efd6207864789758"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#ae02f210d981b2ac5efd6207864789758">setOffset</a> (const <a class="el" href="classPoint.html">Point</a>< int > &offset)</td></tr>
- <tr class="separator:ae02f210d981b2ac5efd6207864789758"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab19430997dd1b3d7bf9bd3640d73b007"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#ab19430997dd1b3d7bf9bd3640d73b007">getWidth</a> () const noexcept</td></tr>
- <tr class="separator:ab19430997dd1b3d7bf9bd3640d73b007"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5d53bcba43455f8f77cfcbac61ec6c8e"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a5d53bcba43455f8f77cfcbac61ec6c8e">getHeight</a> () const noexcept</td></tr>
- <tr class="separator:a5d53bcba43455f8f77cfcbac61ec6c8e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acd158570648b07967a4af011d6223eea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSize.html">Size</a>< uint > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#acd158570648b07967a4af011d6223eea">getSize</a> () const noexcept</td></tr>
- <tr class="separator:acd158570648b07967a4af011d6223eea"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acfc9a6f22176e204009acbb387d3861c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#acfc9a6f22176e204009acbb387d3861c">setWidth</a> (uint width)</td></tr>
- <tr class="separator:acfc9a6f22176e204009acbb387d3861c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a13f314cfd5c9048ec8ea0b88b611f54d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a13f314cfd5c9048ec8ea0b88b611f54d">setHeight</a> (uint height)</td></tr>
- <tr class="separator:a13f314cfd5c9048ec8ea0b88b611f54d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a89bd0c91920029ddcb21b8975e8b47d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a89bd0c91920029ddcb21b8975e8b47d9">setSize</a> (uint width, uint height)</td></tr>
- <tr class="separator:a89bd0c91920029ddcb21b8975e8b47d9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9408b98401ce2fab132c196283248d1a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a9408b98401ce2fab132c196283248d1a">setSize</a> (const <a class="el" href="classSize.html">Size</a>< uint > &size)</td></tr>
- <tr class="separator:a9408b98401ce2fab132c196283248d1a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af437e6afd9104708f30ab769d9afce7a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#af437e6afd9104708f30ab769d9afce7a">getTitle</a> () const noexcept</td></tr>
- <tr class="separator:af437e6afd9104708f30ab769d9afce7a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab2f1b80c5dfcafd2cbdf6b85b756fdbd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#ab2f1b80c5dfcafd2cbdf6b85b756fdbd">setTitle</a> (const char *title)</td></tr>
- <tr class="separator:ab2f1b80c5dfcafd2cbdf6b85b756fdbd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab5cbe1298a28a1860319198a4c843183"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#ab5cbe1298a28a1860319198a4c843183">isIgnoringKeyRepeat</a> () const noexcept</td></tr>
- <tr class="separator:ab5cbe1298a28a1860319198a4c843183"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a36a04e5f5ecc6ee5228f9da6df43e865"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a36a04e5f5ecc6ee5228f9da6df43e865">setIgnoringKeyRepeat</a> (bool ignore) noexcept</td></tr>
- <tr class="separator:a36a04e5f5ecc6ee5228f9da6df43e865"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac8244e75f9fdb4fe886b226959f568f9"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#ac8244e75f9fdb4fe886b226959f568f9">getClipboard</a> (size_t &dataSize)</td></tr>
- <tr class="separator:ac8244e75f9fdb4fe886b226959f568f9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a88bf8d28d58fbe390359bd220137311e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a88bf8d28d58fbe390359bd220137311e">setClipboard</a> (const char *mimeType, const void *data, size_t dataSize)</td></tr>
- <tr class="separator:a88bf8d28d58fbe390359bd220137311e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aabcbd667b0c4dd4665d13beb940fa700"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#aabcbd667b0c4dd4665d13beb940fa700">setCursor</a> (MouseCursor cursor)</td></tr>
- <tr class="separator:aabcbd667b0c4dd4665d13beb940fa700"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad17a7f53a62673982f4861cdc27fd54e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#ad17a7f53a62673982f4861cdc27fd54e">addIdleCallback</a> (<a class="el" href="structIdleCallback.html">IdleCallback</a> *callback, uint timerFrequencyInMs=0)</td></tr>
- <tr class="separator:ad17a7f53a62673982f4861cdc27fd54e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5c5c4f53c53cb081b39a40d5ce9afd65"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a5c5c4f53c53cb081b39a40d5ce9afd65">removeIdleCallback</a> (<a class="el" href="structIdleCallback.html">IdleCallback</a> *callback)</td></tr>
- <tr class="separator:a5c5c4f53c53cb081b39a40d5ce9afd65"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a92600b2e0715646b80474fccbcadf336"><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="classWindow.html#a92600b2e0715646b80474fccbcadf336">getApp</a> () const noexcept</td></tr>
- <tr class="separator:a92600b2e0715646b80474fccbcadf336"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa73a74df08f29d576e18cf1d61ea9897"><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="classWindow.html#aa73a74df08f29d576e18cf1d61ea9897">getGraphicsContext</a> () const noexcept</td></tr>
- <tr class="separator:aa73a74df08f29d576e18cf1d61ea9897"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a01a9277a2e19766947f9a99b43147bfd"><td class="memItemLeft" align="right" valign="top">uintptr_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a01a9277a2e19766947f9a99b43147bfd">getNativeWindowHandle</a> () const noexcept</td></tr>
- <tr class="separator:a01a9277a2e19766947f9a99b43147bfd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a77774c8ce4b01113fcd525079f9b8787"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a77774c8ce4b01113fcd525079f9b8787">getScaleFactor</a> () const noexcept</td></tr>
- <tr class="separator:a77774c8ce4b01113fcd525079f9b8787"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a03985e4ca2c9b4fcf572b5029e8c0115"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a03985e4ca2c9b4fcf572b5029e8c0115">focus</a> ()</td></tr>
- <tr class="separator:a03985e4ca2c9b4fcf572b5029e8c0115"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a56ed4c181deb56c7fcec2b2cfe7295bd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a56ed4c181deb56c7fcec2b2cfe7295bd">openFileBrowser</a> (const DGL_NAMESPACE::FileBrowserOptions &options=<a class="el" href="structFileBrowserOptions.html">FileBrowserOptions</a>())</td></tr>
- <tr class="separator:a56ed4c181deb56c7fcec2b2cfe7295bd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a729ab39a1ac99d81b289e08a42582ade"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a729ab39a1ac99d81b289e08a42582ade">repaint</a> () noexcept</td></tr>
- <tr class="separator:a729ab39a1ac99d81b289e08a42582ade"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a33f9518b6f3209cd8201106260c9e42c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a33f9518b6f3209cd8201106260c9e42c">repaint</a> (const <a class="el" href="classRectangle.html">Rectangle</a>< uint > &rect) noexcept</td></tr>
- <tr class="separator:a33f9518b6f3209cd8201106260c9e42c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abc7044d06bab27a7dadf06b9f42b2c95"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#abc7044d06bab27a7dadf06b9f42b2c95">renderToPicture</a> (const char *filename)</td></tr>
- <tr class="separator:abc7044d06bab27a7dadf06b9f42b2c95"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a00108f3d1c5831d02b0c67cd4f226e4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a00108f3d1c5831d02b0c67cd4f226e4d">runAsModal</a> (bool blockWait=false)</td></tr>
- <tr class="separator:a00108f3d1c5831d02b0c67cd4f226e4d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a540fbc63288c019f420123644acc6a11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSize.html">Size</a>< uint > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a540fbc63288c019f420123644acc6a11">getGeometryConstraints</a> (bool &keepAspectRatio)</td></tr>
- <tr class="separator:a540fbc63288c019f420123644acc6a11"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa3824e300206b15241df8c8c78785d73"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#aa3824e300206b15241df8c8c78785d73">setGeometryConstraints</a> (uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false, bool resizeNowIfAutoScaling=true)</td></tr>
- <tr class="separator:aa3824e300206b15241df8c8c78785d73"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab3fd6ca05bdbd2df01665192cde2ff34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#ab3fd6ca05bdbd2df01665192cde2ff34">setTransientParent</a> (uintptr_t transientParentWindowHandle)</td></tr>
- <tr class="separator:ab3fd6ca05bdbd2df01665192cde2ff34"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e1895a4e93ee0d7c34a9b10953c968e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a0e1895a4e93ee0d7c34a9b10953c968e">getIgnoringKeyRepeat</a> () const noexcept</td></tr>
- <tr class="separator:a0e1895a4e93ee0d7c34a9b10953c968e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9b94fea3236d1d49e3fbd53a8d9cc70b"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a9b94fea3236d1d49e3fbd53a8d9cc70b">getScaling</a> () const noexcept</td></tr>
- <tr class="separator:a9b94fea3236d1d49e3fbd53a8d9cc70b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:addce529703b96ff6742428c8bd8c4cba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#addce529703b96ff6742428c8bd8c4cba">exec</a> (bool blockWait=false)</td></tr>
- <tr class="separator:addce529703b96ff6742428c8bd8c4cba"><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:a6071a51d8fd2c150bcfc240ba43f7b2b"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structClipboardDataOffer.html">ClipboardDataOffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a6071a51d8fd2c150bcfc240ba43f7b2b">getClipboardDataOfferTypes</a> ()</td></tr>
- <tr class="separator:a6071a51d8fd2c150bcfc240ba43f7b2b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0d6c68dee413b400e599f715f2e3b5e7"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a0d6c68dee413b400e599f715f2e3b5e7">onClipboardDataOffer</a> ()</td></tr>
- <tr class="separator:a0d6c68dee413b400e599f715f2e3b5e7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a979cfd2bc52650f07b789217d6c6f570"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a979cfd2bc52650f07b789217d6c6f570">onClose</a> ()</td></tr>
- <tr class="separator:a979cfd2bc52650f07b789217d6c6f570"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a754415613248bd3b5068d76c4cfe3704"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a754415613248bd3b5068d76c4cfe3704">onFocus</a> (bool <a class="el" href="classWindow.html#a03985e4ca2c9b4fcf572b5029e8c0115">focus</a>, CrossingMode mode)</td></tr>
- <tr class="separator:a754415613248bd3b5068d76c4cfe3704"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a04207502372d42d0d17604b104c1d8d6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a04207502372d42d0d17604b104c1d8d6">onReshape</a> (uint width, uint height)</td></tr>
- <tr class="separator:a04207502372d42d0d17604b104c1d8d6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a306742ddc21c7c41f59b41e5761a38c7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a306742ddc21c7c41f59b41e5761a38c7">onScaleFactorChanged</a> (double scaleFactor)</td></tr>
- <tr class="separator:a306742ddc21c7c41f59b41e5761a38c7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a887287be0807b58aa701139c802939a3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a887287be0807b58aa701139c802939a3">onFileSelected</a> (const char *filename)</td></tr>
- <tr class="separator:a887287be0807b58aa701139c802939a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6ec017881675f860ae746dad6c021b63"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWindow.html#a6ec017881675f860ae746dad6c021b63">fileBrowserSelected</a> (const char *filename)</td></tr>
- <tr class="separator:a6ec017881675f860ae746dad6c021b63"><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:a23f25bcc02a0e94c2f5a4188496b04d0"><td class="memItemLeft" align="right" valign="top"><a id="a23f25bcc02a0e94c2f5a4188496b04d0"></a>
- class </td><td class="memItemRight" valign="bottom"><b>Application</b></td></tr>
- <tr class="separator:a23f25bcc02a0e94c2f5a4188496b04d0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3b7e31e35ce2ea5bf70607f346496352"><td class="memItemLeft" align="right" valign="top"><a id="a3b7e31e35ce2ea5bf70607f346496352"></a>
- class </td><td class="memItemRight" valign="bottom"><b>TopLevelWidget</b></td></tr>
- <tr class="separator:a3b7e31e35ce2ea5bf70607f346496352"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae5ac3e5f1ea74ab1efb29bf36b527ef9"><td class="memItemLeft" align="right" valign="top"><a id="ae5ac3e5f1ea74ab1efb29bf36b527ef9"></a>
- class </td><td class="memItemRight" valign="bottom"><b>DISTRHO_NAMESPACE::PluginWindow</b></td></tr>
- <tr class="separator:ae5ac3e5f1ea74ab1efb29bf36b527ef9"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>DGL <a class="el" href="classWindow.html">Window</a> class.</p>
- <p>This is the where all OS-related events initially happen, before being propagated to any widgets.</p>
- <p>A <a class="el" href="classWindow.html">Window</a> MUST have an <a class="el" href="classApplication.html">Application</a> instance tied to it. It is not possible to swap <a class="el" href="classApplication.html">Application</a> instances from within the lifetime of a <a class="el" href="classWindow.html">Window</a>. But it is possible to completely change the Widgets that a <a class="el" href="classWindow.html">Window</a> contains during its lifetime.</p>
- <p>Typically the event handling functions as following: <a class="el" href="classApplication.html">Application</a> -> <a class="el" href="classWindow.html">Window</a> -> Top-Level-Widget -> SubWidgets</p>
- <p>Please note that, unlike many other graphical toolkits out there, DGL makes a clear distinction between a <a class="el" href="classWindow.html">Window</a> and a <a class="el" href="classWidget.html">Widget</a>. You cannot directly draw in a <a class="el" href="classWindow.html">Window</a>, you need to create a <a class="el" href="classWidget.html">Widget</a> for that.</p>
- <p>Also, a <a class="el" href="classWindow.html">Window</a> MUST have a single top-level <a class="el" href="classWidget.html">Widget</a>. The <a class="el" href="classWindow.html">Window</a> will take care of global screen positioning and resizing, everything else is sent for widgets to handle.</p>
- <p>... </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a2f6257937261fcb3e627752dfb248d47"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2f6257937261fcb3e627752dfb248d47">◆ </a></span>Window() <span class="overload">[1/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Window::Window </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classApplication.html">Application</a> & </td>
- <td class="paramname"><em>app</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 for a regular, standalone window. </p>
-
- </div>
- </div>
- <a id="a647ec84da28005ecf0501825af77adec"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a647ec84da28005ecf0501825af77adec">◆ </a></span>Window() <span class="overload">[2/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Window::Window </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classApplication.html">Application</a> & </td>
- <td class="paramname"><em>app</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="classWindow.html">Window</a> & </td>
- <td class="paramname"><em>transientParentWindow</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</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 for a modal window, by having another window as its transient parent. The <a class="el" href="classApplication.html">Application</a> instance must be the same between the 2 windows. </p>
-
- </div>
- </div>
- <a id="a2cd48e2c2d816439cf38faf5c7a9736f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2cd48e2c2d816439cf38faf5c7a9736f">◆ </a></span>Window() <span class="overload">[3/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Window::Window </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classApplication.html">Application</a> & </td>
- <td class="paramname"><em>app</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uintptr_t </td>
- <td class="paramname"><em>parentWindowHandle</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>scaleFactor</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>resizable</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</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 for an embed <a class="el" href="classWindow.html">Window</a> without known size, typically used in modules or plugins that run inside another host. </p>
-
- </div>
- </div>
- <a id="ada557b4543c122a0de22c876c55504ae"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ada557b4543c122a0de22c876c55504ae">◆ </a></span>Window() <span class="overload">[4/4]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Window::Window </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classApplication.html">Application</a> & </td>
- <td class="paramname"><em>app</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uintptr_t </td>
- <td class="paramname"><em>parentWindowHandle</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></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 class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>scaleFactor</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>resizable</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</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 for an embed <a class="el" href="classWindow.html">Window</a> with known size, typically used in modules or plugins that run inside another host. </p>
-
- </div>
- </div>
- <a id="a62b4a97b3c2e492f1d9a46092011e2d9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a62b4a97b3c2e492f1d9a46092011e2d9">◆ </a></span>~Window()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual Window::~Window </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Destructor. </p>
-
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="afb840ed25c1fe17bed66d80adfc420ab"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afb840ed25c1fe17bed66d80adfc420ab">◆ </a></span>isEmbed()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::isEmbed </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>Whether this <a class="el" href="classWindow.html">Window</a> is embed into another (usually not DGL-controlled) <a class="el" href="classWindow.html">Window</a>. </p>
-
- </div>
- </div>
- <a id="a6be53a737e7dfcc74167962437e93b8f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6be53a737e7dfcc74167962437e93b8f">◆ </a></span>isVisible()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::isVisible </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>Check if this window is visible / mapped. Invisible windows do not receive events except resize. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWindow.html#a118e0356bb6fcf081955f2bd97686036">setVisible(bool)</a> </dd></dl>
-
- </div>
- </div>
- <a id="a118e0356bb6fcf081955f2bd97686036"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a118e0356bb6fcf081955f2bd97686036">◆ </a></span>setVisible()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setVisible </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>visible</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set window visible (or not) according to <em>visible</em>. Only valid for standalones, embed windows are always visible. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWindow.html#a6be53a737e7dfcc74167962437e93b8f">isVisible()</a>, <a class="el" href="classWindow.html#a4626829d3cb9d01285f739d2bbc69b74">hide()</a>, <a class="el" href="classWindow.html#a8f986e19a11c4c97ed8e6ad3d0e648b7">show()</a> </dd></dl>
-
- </div>
- </div>
- <a id="a8f986e19a11c4c97ed8e6ad3d0e648b7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8f986e19a11c4c97ed8e6ad3d0e648b7">◆ </a></span>show()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::show </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Show window. This is the same as calling setVisible(true). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWindow.html#a6be53a737e7dfcc74167962437e93b8f">isVisible()</a>, <a class="el" href="classWindow.html#a118e0356bb6fcf081955f2bd97686036">setVisible(bool)</a> </dd></dl>
-
- </div>
- </div>
- <a id="a4626829d3cb9d01285f739d2bbc69b74"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4626829d3cb9d01285f739d2bbc69b74">◆ </a></span>hide()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::hide </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Hide window. This is the same as calling setVisible(false). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWindow.html#a6be53a737e7dfcc74167962437e93b8f">isVisible()</a>, <a class="el" href="classWindow.html#a118e0356bb6fcf081955f2bd97686036">setVisible(bool)</a> </dd></dl>
-
- </div>
- </div>
- <a id="a35055c04498121d39741bfcd5082705b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a35055c04498121d39741bfcd5082705b">◆ </a></span>close()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::close </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Hide window and notify application of a window close event. The application event-loop will stop when all windows have been closed. For standalone windows only, has no effect if window is embed. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWindow.html#afb840ed25c1fe17bed66d80adfc420ab">isEmbed()</a></dd></dl>
- <dl class="section note"><dt>Note</dt><dd>It is possible to hide the window while not stopping the event-loop. A closed window is always hidden, but the reverse is not always true. </dd></dl>
-
- </div>
- </div>
- <a id="a1b888a7e6a5562968a253b915ccb7825"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1b888a7e6a5562968a253b915ccb7825">◆ </a></span>isResizable()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::isResizable </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>Check if this window is resizable (by the user or window manager). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWindow.html#a10f6ff4b0f3e714298a4ac612edcdd7e">setResizable</a> </dd></dl>
-
- </div>
- </div>
- <a id="a10f6ff4b0f3e714298a4ac612edcdd7e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a10f6ff4b0f3e714298a4ac612edcdd7e">◆ </a></span>setResizable()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setResizable </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>resizable</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set window as resizable (by the user or window manager). It is always possible to resize a window programmatically, which is not the same as the user being allowed to it. </p><dl class="section note"><dt>Note</dt><dd>This function does nothing for plugins, where the resizable state is set via macro. </dd></dl>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PluginMacros.html#gabadb9d9ba7f479df39b3963ee60b7a4b">DISTRHO_UI_USER_RESIZABLE</a> </dd></dl>
-
- </div>
- </div>
- <a id="a200f3e517effa7973e1c42c72ca55f9f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a200f3e517effa7973e1c42c72ca55f9f">◆ </a></span>getOffsetX()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int Window::getOffsetX </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 X offset, typically 0. </p>
-
- </div>
- </div>
- <a id="a948304155a8403b92db8feeae1a76f46"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a948304155a8403b92db8feeae1a76f46">◆ </a></span>getOffsetY()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int Window::getOffsetY </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 Y offset, typically 0. </p>
-
- </div>
- </div>
- <a id="a58f66fcfd4c902954594e99d4bfa0b6a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a58f66fcfd4c902954594e99d4bfa0b6a">◆ </a></span>getOffset()</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="classPoint.html">Point</a><int> Window::getOffset </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 offset. </p>
-
- </div>
- </div>
- <a id="a486cf7a5f89c39e1cac3a01633f170db"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a486cf7a5f89c39e1cac3a01633f170db">◆ </a></span>setOffsetX()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setOffsetX </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>x</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set X offset. </p>
-
- </div>
- </div>
- <a id="ac570a2c8f35ea4962c8f23c8435cdbfc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac570a2c8f35ea4962c8f23c8435cdbfc">◆ </a></span>setOffsetY()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setOffsetY </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set Y offset. </p>
-
- </div>
- </div>
- <a id="a5d79613d3223395806d7d09ad65d5c4d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5d79613d3223395806d7d09ad65d5c4d">◆ </a></span>setOffset() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setOffset </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set offset using <em>x</em> and <em>y</em> values. </p>
-
- </div>
- </div>
- <a id="ae02f210d981b2ac5efd6207864789758"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae02f210d981b2ac5efd6207864789758">◆ </a></span>setOffset() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setOffset </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classPoint.html">Point</a>< int > & </td>
- <td class="paramname"><em>offset</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set offset. </p>
-
- </div>
- </div>
- <a id="ab19430997dd1b3d7bf9bd3640d73b007"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab19430997dd1b3d7bf9bd3640d73b007">◆ </a></span>getWidth()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint Window::getWidth </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 width. </p>
-
- </div>
- </div>
- <a id="a5d53bcba43455f8f77cfcbac61ec6c8e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5d53bcba43455f8f77cfcbac61ec6c8e">◆ </a></span>getHeight()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint Window::getHeight </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 height. </p>
-
- </div>
- </div>
- <a id="acd158570648b07967a4af011d6223eea"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acd158570648b07967a4af011d6223eea">◆ </a></span>getSize()</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="classSize.html">Size</a><uint> Window::getSize </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 size. </p>
-
- </div>
- </div>
- <a id="acfc9a6f22176e204009acbb387d3861c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acfc9a6f22176e204009acbb387d3861c">◆ </a></span>setWidth()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::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. </p>
-
- </div>
- </div>
- <a id="a13f314cfd5c9048ec8ea0b88b611f54d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a13f314cfd5c9048ec8ea0b88b611f54d">◆ </a></span>setHeight()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::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. </p>
-
- </div>
- </div>
- <a id="a89bd0c91920029ddcb21b8975e8b47d9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a89bd0c91920029ddcb21b8975e8b47d9">◆ </a></span>setSize() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::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 using <em>width</em> and <em>height</em> values. </p>
-
- </div>
- </div>
- <a id="a9408b98401ce2fab132c196283248d1a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9408b98401ce2fab132c196283248d1a">◆ </a></span>setSize() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::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. </p>
-
- </div>
- </div>
- <a id="af437e6afd9104708f30ab769d9afce7a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af437e6afd9104708f30ab769d9afce7a">◆ </a></span>getTitle()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const char* Window::getTitle </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 title of the window previously set with <a class="el" href="classWindow.html#ab2f1b80c5dfcafd2cbdf6b85b756fdbd">setTitle()</a>. </p>
-
- </div>
- </div>
- <a id="ab2f1b80c5dfcafd2cbdf6b85b756fdbd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab2f1b80c5dfcafd2cbdf6b85b756fdbd">◆ </a></span>setTitle()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setTitle </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>title</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the title of the window, typically displayed in the title bar or in window switchers.</p>
- <p>This only makes sense for non-embedded windows. </p>
-
- </div>
- </div>
- <a id="ab5cbe1298a28a1860319198a4c843183"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab5cbe1298a28a1860319198a4c843183">◆ </a></span>isIgnoringKeyRepeat()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::isIgnoringKeyRepeat </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>Check if key repeat events are ignored. </p>
-
- </div>
- </div>
- <a id="a36a04e5f5ecc6ee5228f9da6df43e865"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a36a04e5f5ecc6ee5228f9da6df43e865">◆ </a></span>setIgnoringKeyRepeat()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setIgnoringKeyRepeat </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>ignore</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>Set to ignore (or not) key repeat events according to <em>ignore</em>. </p>
-
- </div>
- </div>
- <a id="ac8244e75f9fdb4fe886b226959f568f9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac8244e75f9fdb4fe886b226959f568f9">◆ </a></span>getClipboard()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const void* Window::getClipboard </td>
- <td>(</td>
- <td class="paramtype">size_t & </td>
- <td class="paramname"><em>dataSize</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the clipboard contents.</p>
- <p>This gets the system clipboard contents, which may have been set with <a class="el" href="classWindow.html#a88bf8d28d58fbe390359bd220137311e">setClipboard()</a> or copied from another application.</p>
- <p>Returns the clipboard contents, or null.</p>
- <dl class="section note"><dt>Note</dt><dd>By default only "text/plain" mimetype is supported and returned. Override onClipboardDataOffer for supporting other types. </dd></dl>
-
- </div>
- </div>
- <a id="a88bf8d28d58fbe390359bd220137311e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a88bf8d28d58fbe390359bd220137311e">◆ </a></span>setClipboard()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::setClipboard </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>mimeType</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>dataSize</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the clipboard contents.</p>
- <p>This sets the system clipboard contents, which can be retrieved with <a class="el" href="classWindow.html#ac8244e75f9fdb4fe886b226959f568f9">getClipboard()</a> or pasted into other applications.</p>
- <p>If using a string, the use of a null terminator is required (and must be part of dataSize).<br />
- The MIME type of the data "text/plain" is assumed if null is used. </p>
-
- </div>
- </div>
- <a id="aabcbd667b0c4dd4665d13beb940fa700"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aabcbd667b0c4dd4665d13beb940fa700">◆ </a></span>setCursor()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::setCursor </td>
- <td>(</td>
- <td class="paramtype">MouseCursor </td>
- <td class="paramname"><em>cursor</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the mouse cursor.</p>
- <p>This changes the system cursor that is displayed when the pointer is inside the window. May fail if setting the cursor is not supported on this system, for example if compiled on X11 without Xcursor support. </p>
-
- </div>
- </div>
- <a id="ad17a7f53a62673982f4861cdc27fd54e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad17a7f53a62673982f4861cdc27fd54e">◆ </a></span>addIdleCallback()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::addIdleCallback </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structIdleCallback.html">IdleCallback</a> * </td>
- <td class="paramname"><em>callback</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>timerFrequencyInMs</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add a callback function to be triggered on every idle cycle or on a specific timer frequency. You can add more than one, and remove them at anytime with <a class="el" href="classWindow.html#a5c5c4f53c53cb081b39a40d5ce9afd65">removeIdleCallback()</a>. This can be used to perform some action at a regular interval with relatively low frequency.</p>
- <p>If providing a timer frequency, there are a few things to note:</p><ol type="1">
- <li>There is a platform-specific limit to the number of supported timers, and overhead associated with each, so you should create only a few timers and perform several tasks in one if necessary.</li>
- <li>This timer frequency is not guaranteed to have a resolution better than 10ms (the maximum timer resolution on Windows) and may be rounded up if it is too short. On X11 and MacOS, a resolution of about 1ms can usually be relied on. </li>
- </ol>
-
- </div>
- </div>
- <a id="a5c5c4f53c53cb081b39a40d5ce9afd65"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5c5c4f53c53cb081b39a40d5ce9afd65">◆ </a></span>removeIdleCallback()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::removeIdleCallback </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structIdleCallback.html">IdleCallback</a> * </td>
- <td class="paramname"><em>callback</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove an idle callback previously added via <a class="el" href="classWindow.html#ad17a7f53a62673982f4861cdc27fd54e">addIdleCallback()</a>. </p>
-
- </div>
- </div>
- <a id="a92600b2e0715646b80474fccbcadf336"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a92600b2e0715646b80474fccbcadf336">◆ </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>& Window::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 window. </p>
-
- </div>
- </div>
- <a id="aa73a74df08f29d576e18cf1d61ea9897"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa73a74df08f29d576e18cf1d61ea9897">◆ </a></span>getGraphicsContext()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const <a class="el" href="structGraphicsContext.html">GraphicsContext</a>& Window::getGraphicsContext </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 graphics context associated with this window. <a class="el" href="structGraphicsContext.html">GraphicsContext</a> is an empty struct and needs to be casted into a different type in order to be usable, for example <a class="el" href="structGraphicsContext.html">GraphicsContext</a>. </p><dl class="section see"><dt>See also</dt><dd>CairoSubWidget, CairoTopLevelWidget </dd></dl>
-
- </div>
- </div>
- <a id="a01a9277a2e19766947f9a99b43147bfd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a01a9277a2e19766947f9a99b43147bfd">◆ </a></span>getNativeWindowHandle()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uintptr_t Window::getNativeWindowHandle </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 "native" window handle. Returned value depends on the platform:</p><ul>
- <li>HaikuOS: This is a pointer to a <code>BView</code>.</li>
- <li>MacOS: This is a pointer to an <code>NSView*</code>.</li>
- <li>Windows: This is a <code>HWND</code>.</li>
- <li>Everything else: This is an [X11] <code><a class="el" href="classWindow.html">Window</a></code>. </li>
- </ul>
-
- </div>
- </div>
- <a id="a77774c8ce4b01113fcd525079f9b8787"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a77774c8ce4b01113fcd525079f9b8787">◆ </a></span>getScaleFactor()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">double Window::getScaleFactor </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 scale factor requested for this window. This is purely informational, and up to developers to choose what to do with it.</p>
- <p>If you do not want to deal with this yourself, consider using <a class="el" href="classWindow.html#aa3824e300206b15241df8c8c78785d73">setGeometryConstraints()</a> where you can specify to automatically scale the window contents. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWindow.html#aa3824e300206b15241df8c8c78785d73">setGeometryConstraints</a> </dd></dl>
-
- </div>
- </div>
- <a id="a03985e4ca2c9b4fcf572b5029e8c0115"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a03985e4ca2c9b4fcf572b5029e8c0115">◆ </a></span>focus()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::focus </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Grab the keyboard input focus. </p>
-
- </div>
- </div>
- <a id="a56ed4c181deb56c7fcec2b2cfe7295bd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a56ed4c181deb56c7fcec2b2cfe7295bd">◆ </a></span>openFileBrowser()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::openFileBrowser </td>
- <td>(</td>
- <td class="paramtype">const DGL_NAMESPACE::FileBrowserOptions & </td>
- <td class="paramname"><em>options</em> = <code><a class="el" href="structFileBrowserOptions.html">FileBrowserOptions</a>()</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Open a file browser dialog with this window as transient parent. A few options can be specified to setup the dialog.</p>
- <p>If a path is selected, <a class="el" href="classWindow.html#a887287be0807b58aa701139c802939a3">onFileSelected()</a> will be called with the user chosen path. If the user cancels or does not pick a file, <a class="el" href="classWindow.html#a887287be0807b58aa701139c802939a3">onFileSelected()</a> will be called with nullptr as filename.</p>
- <p>This function does not block the event loop. </p>
-
- </div>
- </div>
- <a id="a729ab39a1ac99d81b289e08a42582ade"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a729ab39a1ac99d81b289e08a42582ade">◆ </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 Window::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">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Request repaint of this window, for the entire area. </p>
-
- </div>
- </div>
- <a id="a33f9518b6f3209cd8201106260c9e42c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a33f9518b6f3209cd8201106260c9e42c">◆ </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 Window::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>Request partial repaint of this window, with bounds according to <em>rect</em>. </p>
-
- </div>
- </div>
- <a id="abc7044d06bab27a7dadf06b9f42b2c95"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abc7044d06bab27a7dadf06b9f42b2c95">◆ </a></span>renderToPicture()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::renderToPicture </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>filename</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Render this window's content into a picture file, specified by <em>filename</em>. <a class="el" href="classWindow.html">Window</a> must be visible and on screen. Written picture format is PPM. </p>
-
- </div>
- </div>
- <a id="a00108f3d1c5831d02b0c67cd4f226e4d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a00108f3d1c5831d02b0c67cd4f226e4d">◆ </a></span>runAsModal()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::runAsModal </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>blockWait</em> = <code>false</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Run this window as a modal, blocking input events from the parent. Only valid for windows that have been created with another window as parent (as passed in the constructor). Can optionally block-wait, but such option is only available if the application is running as standalone. </p>
-
- </div>
- </div>
- <a id="a540fbc63288c019f420123644acc6a11"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a540fbc63288c019f420123644acc6a11">◆ </a></span>getGeometryConstraints()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classSize.html">Size</a><uint> Window::getGeometryConstraints </td>
- <td>(</td>
- <td class="paramtype">bool & </td>
- <td class="paramname"><em>keepAspectRatio</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the geometry constraints set for the <a class="el" href="classWindow.html">Window</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classWindow.html#aa3824e300206b15241df8c8c78785d73">setGeometryConstraints</a> </dd></dl>
-
- </div>
- </div>
- <a id="aa3824e300206b15241df8c8c78785d73"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa3824e300206b15241df8c8c78785d73">◆ </a></span>setGeometryConstraints()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setGeometryConstraints </td>
- <td>(</td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>minimumWidth</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>minimumHeight</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>keepAspectRatio</em> = <code>false</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>automaticallyScale</em> = <code>false</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>resizeNowIfAutoScaling</em> = <code>true</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set geometry constraints for the <a class="el" href="classWindow.html">Window</a> when resized by the user, and optionally scale contents automatically. </p>
-
- </div>
- </div>
- <a id="ab3fd6ca05bdbd2df01665192cde2ff34"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab3fd6ca05bdbd2df01665192cde2ff34">◆ </a></span>setTransientParent()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void Window::setTransientParent </td>
- <td>(</td>
- <td class="paramtype">uintptr_t </td>
- <td class="paramname"><em>transientParentWindowHandle</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the transient parent of the window.</p>
- <p>Set this for transient children like dialogs, to have them properly associated with their parent window. This should be not be called for embed windows, or after making the window visible. </p>
-
- </div>
- </div>
- <a id="a0e1895a4e93ee0d7c34a9b10953c968e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0e1895a4e93ee0d7c34a9b10953c968e">◆ </a></span>getIgnoringKeyRepeat()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool Window::getIgnoringKeyRepeat </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">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>DEPRECATED Use <a class="el" href="classWindow.html#ab5cbe1298a28a1860319198a4c843183">isIgnoringKeyRepeat()</a>. </p>
-
- </div>
- </div>
- <a id="a9b94fea3236d1d49e3fbd53a8d9cc70b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9b94fea3236d1d49e3fbd53a8d9cc70b">◆ </a></span>getScaling()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">double Window::getScaling </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">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>DEPRECATED Use <a class="el" href="classWindow.html#a77774c8ce4b01113fcd525079f9b8787">getScaleFactor()</a>. </p>
-
- </div>
- </div>
- <a id="addce529703b96ff6742428c8bd8c4cba"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#addce529703b96ff6742428c8bd8c4cba">◆ </a></span>exec()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void Window::exec </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>blockWait</em> = <code>false</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>DEPRECATED Use <a class="el" href="classWindow.html#a00108f3d1c5831d02b0c67cd4f226e4d">runAsModal(bool)</a>. </p>
-
- </div>
- </div>
- <a id="a6071a51d8fd2c150bcfc240ba43f7b2b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6071a51d8fd2c150bcfc240ba43f7b2b">◆ </a></span>getClipboardDataOfferTypes()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">std::vector<<a class="el" href="structClipboardDataOffer.html">ClipboardDataOffer</a>> Window::getClipboardDataOfferTypes </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the types available for the data in a clipboard. Must only be called within the context of onClipboardDataOffer. </p>
-
- </div>
- </div>
- <a id="a0d6c68dee413b400e599f715f2e3b5e7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0d6c68dee413b400e599f715f2e3b5e7">◆ </a></span>onClipboardDataOffer()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual uint32_t Window::onClipboardDataOffer </td>
- <td>(</td>
- <td class="paramname"></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>A function called when clipboard has data present, possibly with several datatypes. While handling this event, the data types can be investigated with <a class="el" href="classWindow.html#a6071a51d8fd2c150bcfc240ba43f7b2b">getClipboardDataOfferTypes()</a> to decide whether to accept the offer.</p>
- <p>Reimplement and return a non-zero id to accept the clipboard data offer for a particular type. Applications must ignore any type they do not recognize.</p>
- <p>The default implementation accepts the "text/plain" mimetype. </p>
-
- </div>
- </div>
- <a id="a979cfd2bc52650f07b789217d6c6f570"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a979cfd2bc52650f07b789217d6c6f570">◆ </a></span>onClose()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool Window::onClose </td>
- <td>(</td>
- <td class="paramname"></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>A function called when the window is attempted to be closed. Returning true closes the window, which is the default behaviour. Override this method and return false to prevent the window from being closed by the user.</p>
- <p>This method is not used for embed windows, and not even made available in DISTRHO_NAMESPACE::UI. For embed windows, closing is handled by the host/parent process and we have no control over it. As such, a close action on embed windows will always succeed and cannot be cancelled.</p>
- <p>NOTE: This currently does not work under macOS. </p>
-
- </div>
- </div>
- <a id="a754415613248bd3b5068d76c4cfe3704"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a754415613248bd3b5068d76c4cfe3704">◆ </a></span>onFocus()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void Window::onFocus </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>focus</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">CrossingMode </td>
- <td class="paramname"><em>mode</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</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>A function called when the window gains or loses the keyboard focus. The default implementation does nothing. </p>
-
- </div>
- </div>
- <a id="a04207502372d42d0d17604b104c1d8d6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a04207502372d42d0d17604b104c1d8d6">◆ </a></span>onReshape()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void Window::onReshape </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>
- </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>A function called when the window is resized. If there is a top-level widget associated with this window, its size will be set right after this function. The default implementation sets up drawing context where necessary. </p>
-
- </div>
- </div>
- <a id="a306742ddc21c7c41f59b41e5761a38c7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a306742ddc21c7c41f59b41e5761a38c7">◆ </a></span>onScaleFactorChanged()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void Window::onScaleFactorChanged </td>
- <td>(</td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>scaleFactor</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>A function called when scale factor requested for this window changes. The default implementation does nothing. WARNING function needs a proper name </p>
-
- </div>
- </div>
- <a id="a887287be0807b58aa701139c802939a3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a887287be0807b58aa701139c802939a3">◆ </a></span>onFileSelected()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void Window::onFileSelected </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>filename</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>A function called when a path is selected by the user, as triggered by <a class="el" href="classWindow.html#a56ed4c181deb56c7fcec2b2cfe7295bd">openFileBrowser()</a>. This action happens after the user confirms the action, so the file browser dialog will be closed at this point. The default implementation does nothing. </p>
-
- </div>
- </div>
- <a id="a6ec017881675f860ae746dad6c021b63"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6ec017881675f860ae746dad6c021b63">◆ </a></span>fileBrowserSelected()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void Window::fileBrowserSelected </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>filename</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>DEPRECATED Use <a class="el" href="classWindow.html#a887287be0807b58aa701139c802939a3">onFileSelected()</a>. </p>
-
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>dgl/<a class="el" href="Window_8hpp_source.html">Window.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>
|