DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

299 lines
14KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: CairoBaseWidget&lt; BaseWidget &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pro-methods">Protected Member Functions</a> &#124;
  65. <a href="classCairoBaseWidget-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">CairoBaseWidget&lt; BaseWidget &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><code>#include &lt;<a class="el" href="Cairo_8hpp_source.html">Cairo.hpp</a>&gt;</code></p>
  71. <div class="dynheader">
  72. Inheritance diagram for CairoBaseWidget&lt; BaseWidget &gt;:</div>
  73. <div class="dyncontent">
  74. <div class="center">
  75. <img src="classCairoBaseWidget.png" alt=""/>
  76. </div></div>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79. Public Member Functions</h2></td></tr>
  80. <tr class="memitem:a264d5e3f7de6dd5c9f9b492f5577420f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoBaseWidget.html#a264d5e3f7de6dd5c9f9b492f5577420f">CairoBaseWidget</a> (<a class="el" href="classWidget.html">Widget</a> *const parentGroupWidget)</td></tr>
  81. <tr class="separator:a264d5e3f7de6dd5c9f9b492f5577420f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a07039d9207f923b0bf7f62a96f168f70"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoBaseWidget.html#a07039d9207f923b0bf7f62a96f168f70">CairoBaseWidget</a> (<a class="el" href="classWindow.html">Window</a> &amp;windowToMapTo)</td></tr>
  83. <tr class="separator:a07039d9207f923b0bf7f62a96f168f70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a2342ae5da3def6ce0b9713a9bf49e203"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoBaseWidget.html#a2342ae5da3def6ce0b9713a9bf49e203">CairoBaseWidget</a> (<a class="el" href="classApplication.html">Application</a> &amp;app)</td></tr>
  85. <tr class="separator:a2342ae5da3def6ce0b9713a9bf49e203"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:af5544cdc62910eb3c25670a5130baeb2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoBaseWidget.html#af5544cdc62910eb3c25670a5130baeb2">CairoBaseWidget</a> (<a class="el" href="classApplication.html">Application</a> &amp;app, <a class="el" href="classWindow.html">Window</a> &amp;parentWindow)</td></tr>
  87. <tr class="separator:af5544cdc62910eb3c25670a5130baeb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ab13e7888614ab01ef4a74175b9c487fa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoBaseWidget.html#ab13e7888614ab01ef4a74175b9c487fa">~CairoBaseWidget</a> () override</td></tr>
  89. <tr class="separator:ab13e7888614ab01ef4a74175b9c487fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table><table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  92. Protected Member Functions</h2></td></tr>
  93. <tr class="memitem:a2d59f5625d6e948ccbf7a9d2b3b00adf"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCairoBaseWidget.html#a2d59f5625d6e948ccbf7a9d2b3b00adf">onCairoDisplay</a> (const <a class="el" href="structCairoGraphicsContext.html">CairoGraphicsContext</a> &amp;context)=0</td></tr>
  94. <tr class="separator:a2d59f5625d6e948ccbf7a9d2b3b00adf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table>
  96. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  97. <div class="textblock"><h3>template&lt;class BaseWidget&gt;<br />
  98. class CairoBaseWidget&lt; BaseWidget &gt;</h3>
  99. <p>CairoWidget, handy class that takes graphics context during onDisplay and passes it in a new function. </p>
  100. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  101. <a id="a264d5e3f7de6dd5c9f9b492f5577420f"></a>
  102. <h2 class="memtitle"><span class="permalink"><a href="#a264d5e3f7de6dd5c9f9b492f5577420f">&#9670;&nbsp;</a></span>CairoBaseWidget() <span class="overload">[1/4]</span></h2>
  103. <div class="memitem">
  104. <div class="memproto">
  105. <div class="memtemplate">
  106. template&lt;class BaseWidget &gt; </div>
  107. <table class="mlabels">
  108. <tr>
  109. <td class="mlabels-left">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname"><a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a>&lt; BaseWidget &gt;::<a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a> </td>
  113. <td>(</td>
  114. <td class="paramtype"><a class="el" href="classWidget.html">Widget</a> *const&#160;</td>
  115. <td class="paramname"><em>parentGroupWidget</em></td><td>)</td>
  116. <td></td>
  117. </tr>
  118. </table>
  119. </td>
  120. <td class="mlabels-right">
  121. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  122. </tr>
  123. </table>
  124. </div><div class="memdoc">
  125. <p>Constructor for a CairoSubWidget. </p>
  126. </div>
  127. </div>
  128. <a id="a07039d9207f923b0bf7f62a96f168f70"></a>
  129. <h2 class="memtitle"><span class="permalink"><a href="#a07039d9207f923b0bf7f62a96f168f70">&#9670;&nbsp;</a></span>CairoBaseWidget() <span class="overload">[2/4]</span></h2>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <div class="memtemplate">
  133. template&lt;class BaseWidget &gt; </div>
  134. <table class="mlabels">
  135. <tr>
  136. <td class="mlabels-left">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname"><a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a>&lt; BaseWidget &gt;::<a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a> </td>
  140. <td>(</td>
  141. <td class="paramtype"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td>
  142. <td class="paramname"><em>windowToMapTo</em></td><td>)</td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </td>
  147. <td class="mlabels-right">
  148. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. <p>Constructor for a CairoTopLevelWidget. </p>
  153. </div>
  154. </div>
  155. <a id="a2342ae5da3def6ce0b9713a9bf49e203"></a>
  156. <h2 class="memtitle"><span class="permalink"><a href="#a2342ae5da3def6ce0b9713a9bf49e203">&#9670;&nbsp;</a></span>CairoBaseWidget() <span class="overload">[3/4]</span></h2>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <div class="memtemplate">
  160. template&lt;class BaseWidget &gt; </div>
  161. <table class="mlabels">
  162. <tr>
  163. <td class="mlabels-left">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname"><a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a>&lt; BaseWidget &gt;::<a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a> </td>
  167. <td>(</td>
  168. <td class="paramtype"><a class="el" href="classApplication.html">Application</a> &amp;&#160;</td>
  169. <td class="paramname"><em>app</em></td><td>)</td>
  170. <td></td>
  171. </tr>
  172. </table>
  173. </td>
  174. <td class="mlabels-right">
  175. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Constructor for a CairoStandaloneWindow without parent window. </p>
  180. </div>
  181. </div>
  182. <a id="af5544cdc62910eb3c25670a5130baeb2"></a>
  183. <h2 class="memtitle"><span class="permalink"><a href="#af5544cdc62910eb3c25670a5130baeb2">&#9670;&nbsp;</a></span>CairoBaseWidget() <span class="overload">[4/4]</span></h2>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <div class="memtemplate">
  187. template&lt;class BaseWidget &gt; </div>
  188. <table class="mlabels">
  189. <tr>
  190. <td class="mlabels-left">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname"><a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a>&lt; BaseWidget &gt;::<a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a> </td>
  194. <td>(</td>
  195. <td class="paramtype"><a class="el" href="classApplication.html">Application</a> &amp;&#160;</td>
  196. <td class="paramname"><em>app</em>, </td>
  197. </tr>
  198. <tr>
  199. <td class="paramkey"></td>
  200. <td></td>
  201. <td class="paramtype"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td>
  202. <td class="paramname"><em>parentWindow</em>&#160;</td>
  203. </tr>
  204. <tr>
  205. <td></td>
  206. <td>)</td>
  207. <td></td><td></td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Constructor for a CairoStandaloneWindow with parent window. </p>
  217. </div>
  218. </div>
  219. <a id="ab13e7888614ab01ef4a74175b9c487fa"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#ab13e7888614ab01ef4a74175b9c487fa">&#9670;&nbsp;</a></span>~CairoBaseWidget()</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <div class="memtemplate">
  224. template&lt;class BaseWidget &gt; </div>
  225. <table class="mlabels">
  226. <tr>
  227. <td class="mlabels-left">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname"><a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a>&lt; BaseWidget &gt;::~<a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a> </td>
  231. <td>(</td>
  232. <td class="paramname"></td><td>)</td>
  233. <td></td>
  234. </tr>
  235. </table>
  236. </td>
  237. <td class="mlabels-right">
  238. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Destructor. </p>
  243. </div>
  244. </div>
  245. <h2 class="groupheader">Member Function Documentation</h2>
  246. <a id="a2d59f5625d6e948ccbf7a9d2b3b00adf"></a>
  247. <h2 class="memtitle"><span class="permalink"><a href="#a2d59f5625d6e948ccbf7a9d2b3b00adf">&#9670;&nbsp;</a></span>onCairoDisplay()</h2>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <div class="memtemplate">
  251. template&lt;class BaseWidget &gt; </div>
  252. <table class="mlabels">
  253. <tr>
  254. <td class="mlabels-left">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">virtual void <a class="el" href="classCairoBaseWidget.html">CairoBaseWidget</a>&lt; BaseWidget &gt;::onCairoDisplay </td>
  258. <td>(</td>
  259. <td class="paramtype">const <a class="el" href="structCairoGraphicsContext.html">CairoGraphicsContext</a> &amp;&#160;</td>
  260. <td class="paramname"><em>context</em></td><td>)</td>
  261. <td></td>
  262. </tr>
  263. </table>
  264. </td>
  265. <td class="mlabels-right">
  266. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  267. </tr>
  268. </table>
  269. </div><div class="memdoc">
  270. <p>New virtual onDisplay function. </p><dl class="section see"><dt>See also</dt><dd>onDisplay </dd></dl>
  271. </div>
  272. </div>
  273. <hr/>The documentation for this class was generated from the following file:<ul>
  274. <li>dgl/<a class="el" href="Cairo_8hpp_source.html">Cairo.hpp</a></li>
  275. </ul>
  276. </div><!-- contents -->
  277. <!-- start footer part -->
  278. <hr class="footer"/><address class="footer"><small>
  279. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
  280. </small></address>
  281. </body>
  282. </html>