<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>LV2::Presets< Required >::I< Derived > Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>LV2</b> </li>
<li class="navelem"><a class="el" href="structLV2_1_1Presets.html">Presets</a> </li>
<li class="navelem"><a class="el" href="structLV2_1_1Presets_1_1I.html">I</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>LV2::Presets< Required >::I< Derived > Struct Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="LV2::Presets::I" --><!-- doxytag: inherits="LV2::Extension" -->
<p><code>#include <<a class="el" href="lv2gui_8hpp_source.html">lv2gui.hpp</a>></code></p>
<p>Inherits LV2::Extension< Required >.</p>
<p><a href="structLV2_1_1Presets_1_1I-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structLV2_1_1Presets_1_1I.html#abd3045d9a2a4e735e21afbbe599678ba">preset_added</a> (uint32_t number, char const *name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structLV2_1_1Presets_1_1I.html#a2cbc6f395d13001f60e38303da8c20c8">preset_removed</a> (uint32_t number)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structLV2_1_1Presets_1_1I.html#ad50d33dcf043d2d90285e05cdacfd91a">presets_cleared</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structLV2_1_1Presets_1_1I.html#af68b043b8944883e2dfec58cf15a8277">current_preset_changed</a> (uint32_t number)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structLV2_1_1Presets_1_1I.html#a47811506aa3992c6e4fe9bfe8e15be79">change_preset</a> (uint32_t preset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structLV2_1_1Presets_1_1I.html#a5c4e9b5822d071c07061211dd04a78f1">save_preset</a> (uint32_t preset, char const *name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structLV2_1_1Presets_1_1I.html#aed3194733ec6c61cc1f48a41c8a162ed">host_supports_presets</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<bool Required = true><br/>
template<class Derived><br/>
struct LV2::Presets< Required >::I< Derived ></h3>
<p>This is the type that your plugin or <a class="el" href="classLV2_1_1GUI.html">GUI</a> class will inherit when you use the <a class="el" href="structLV2_1_1Presets.html">Presets</a> mixin. The public and protected members defined here will be available in your plugin class. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a47811506aa3992c6e4fe9bfe8e15be79"></a><!-- doxytag: member="LV2::Presets::I::change_preset" ref="a47811506aa3992c6e4fe9bfe8e15be79" args="(uint32_t preset)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<bool Required = true> </div>
<div class="memtemplate">
template<class Derived> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structLV2_1_1Presets.html">LV2::Presets</a>< Required >::<a class="el" href="structLV2_1_1Presets_1_1I.html">I</a>< Derived >::change_preset </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>preset</em></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>You can call this to request that the host changes the current preset to <code>preset</code>. </p>
</div>
</div>
<a class="anchor" id="af68b043b8944883e2dfec58cf15a8277"></a><!-- doxytag: member="LV2::Presets::I::current_preset_changed" ref="af68b043b8944883e2dfec58cf15a8277" args="(uint32_t number)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<bool Required = true> </div>
<div class="memtemplate">
template<class Derived> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structLV2_1_1Presets.html">LV2::Presets</a>< Required >::<a class="el" href="structLV2_1_1Presets_1_1I.html">I</a>< Derived >::current_preset_changed </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>number</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is called by the host to let the <a class="el" href="classLV2_1_1GUI.html">GUI</a> know that the current preset has changed. If the number is equal to <code>LV2_UI_PRESETS_NOPRESET</code> there is no current preset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>The number of the active preset, or LV2_UI_PRESETS_NOPRESET if there is no active preset. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aed3194733ec6c61cc1f48a41c8a162ed"></a><!-- doxytag: member="LV2::Presets::I::host_supports_presets" ref="aed3194733ec6c61cc1f48a41c8a162ed" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<bool Required = true> </div>
<div class="memtemplate">
template<class Derived> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structLV2_1_1Presets.html">LV2::Presets</a>< Required >::<a class="el" href="structLV2_1_1Presets_1_1I.html">I</a>< Derived >::host_supports_presets </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code> if the host supports the Preset feature, <code>false</code> if it does not. </p>
</div>
</div>
<a class="anchor" id="abd3045d9a2a4e735e21afbbe599678ba"></a><!-- doxytag: member="LV2::Presets::I::preset_added" ref="abd3045d9a2a4e735e21afbbe599678ba" args="(uint32_t number, char const *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<bool Required = true> </div>
<div class="memtemplate">
template<class Derived> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structLV2_1_1Presets.html">LV2::Presets</a>< Required >::<a class="el" href="structLV2_1_1Presets_1_1I.html">I</a>< Derived >::preset_added </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is called by the host to let the <a class="el" href="classLV2_1_1GUI.html">GUI</a> know that a new preset has been added or renamed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>The number of the added preset. </td></tr>
<tr><td class="paramname">name</td><td>The name of the added preset. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2cbc6f395d13001f60e38303da8c20c8"></a><!-- doxytag: member="LV2::Presets::I::preset_removed" ref="a2cbc6f395d13001f60e38303da8c20c8" args="(uint32_t number)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<bool Required = true> </div>
<div class="memtemplate">
template<class Derived> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structLV2_1_1Presets.html">LV2::Presets</a>< Required >::<a class="el" href="structLV2_1_1Presets_1_1I.html">I</a>< Derived >::preset_removed </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>number</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is called by the host to let the <a class="el" href="classLV2_1_1GUI.html">GUI</a> know that a previously existing preset has been removed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>The number of the removed preset. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad50d33dcf043d2d90285e05cdacfd91a"></a><!-- doxytag: member="LV2::Presets::I::presets_cleared" ref="ad50d33dcf043d2d90285e05cdacfd91a" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<bool Required = true> </div>
<div class="memtemplate">
template<class Derived> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structLV2_1_1Presets.html">LV2::Presets</a>< Required >::<a class="el" href="structLV2_1_1Presets_1_1I.html">I</a>< Derived >::presets_cleared </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is called by the host to let the <a class="el" href="classLV2_1_1GUI.html">GUI</a> know that all previously existing presets have been removed. </p>
</div>
</div>
<a class="anchor" id="a5c4e9b5822d071c07061211dd04a78f1"></a><!-- doxytag: member="LV2::Presets::I::save_preset" ref="a5c4e9b5822d071c07061211dd04a78f1" args="(uint32_t preset, char const *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<bool Required = true> </div>
<div class="memtemplate">
template<class Derived> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structLV2_1_1Presets.html">LV2::Presets</a>< Required >::<a class="el" href="structLV2_1_1Presets_1_1I.html">I</a>< Derived >::save_preset </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>preset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>You can call this to request that the host saves the current state of the plugin instance to a preset with the given number and name. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>libraries/lv2gui/<a class="el" href="lv2gui_8hpp_source.html">lv2gui.hpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 8 2011 by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
