379 lines
16 KiB
HTML
379 lines
16 KiB
HTML
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>VSTGUI: UI XML Attribute Definitions</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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">VSTGUI<span id="projectnumber"> 4.10</span>
|
|
</div>
|
|
<div id="projectbrief">Graphical User Interface Framework not only for VST plugins</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('uidescription_attributes.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div><div class="header">
|
|
<div class="headertitle"><div class="title">UI XML Attribute Definitions</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><h1><a class="anchor" id="viewclasses"></a>
|
|
View Classes and their attributes</h1>
|
|
<ul>
|
|
<li><a class="el" href="#cview">CView</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#cviewcontainer">CViewContainer</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#ccontrol">CControl</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#conoffbutton">COnOffButton</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#cparamdisplay">CParamDisplay</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#ctextlabel">CTextLabel</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#ctextedit">CTextEdit</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#ctextbutton">CTextButton</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#csegmentbutton">CSegmentButton</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#cknob">CKnob</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#cverticalswitch">CVerticalSwitch</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#chorizontalswitch">CHorizontalSwitch</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#crockerswitch">CRockerSwitch</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#cmoviebitmap">CMovieBitmap</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#ckickbutton">CKickButton</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#cslider">CSlider</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#cvumeter">CVuMeter</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#coptionmenu">COptionMenu</a> <br />
|
|
</li>
|
|
<li><a class="el" href="#uiviewswitchcontainer">UIViewSwitchContainer</a> <br />
|
|
</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="cview"></a>
|
|
CView</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CView" /> </pre><p>Attributes:</p><ul>
|
|
<li><b>origin</b> [Point]</li>
|
|
<li><b>size</b> [Point]</li>
|
|
<li><b>transparent</b> [true/false]</li>
|
|
<li><b>bitmap</b> [bitmap name]</li>
|
|
<li><b>autosize</b> [combination of <em>left</em>, <em>top</em>, <em>right</em>, <em>bottom</em>, <em>row</em>, or <em>column</em> see <a class="el" href="namespace_v_s_t_g_u_i.html#ae791692d48cb67ab011e9601124c5072">VSTGUI::CViewAutosizing</a>]</li>
|
|
<li><b>tooltip</b> [tooltip text]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="cviewcontainer"></a>
|
|
CViewContainer</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CViewContainer" /> </pre><p>Inherites attributes from <a class="el" href="#cview">CView</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>background-color</b> [color]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="ccontrol"></a>
|
|
CControl</h1>
|
|
<p>A CControl is an abstract class and can not be created directly</p>
|
|
<p>Inherites attributes from <a class="el" href="#cview">CView</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>control-tag</b> [tag name]</li>
|
|
<li><b>default-value</b> [float]</li>
|
|
<li><b>min-value</b> [float]</li>
|
|
<li><b>max-value</b> [float]</li>
|
|
<li><b>wheel-inc-value</b> [float]</li>
|
|
<li><b>background-offset</b> [Point]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="conoffbutton"></a>
|
|
COnOffButton</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="COnOffButton" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
</p>
|
|
<h1><a class="anchor" id="cparamdisplay"></a>
|
|
CParamDisplay</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CParamDisplay" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>font</b> [font name]</li>
|
|
<li><b>font-color</b> [color]</li>
|
|
<li><b>back-color</b> [color]</li>
|
|
<li><b>frame-color</b> [color]</li>
|
|
<li><b>frame-width</b> [float]</li>
|
|
<li><b>round-rect-radius</b> [float]</li>
|
|
<li><b>shadow-color</b> [color]</li>
|
|
<li><b>font-antialias</b> [true/false]</li>
|
|
<li><b>style-3D-in</b> [true/false]</li>
|
|
<li><b>style-3D-out</b> [true/false]</li>
|
|
<li><b>style-no-frame</b> [true/false]</li>
|
|
<li><b>style-no-text</b> [true/false]</li>
|
|
<li><b>style-no-draw</b> [true/false]</li>
|
|
<li><b>style-round-rect</b> [true/false]</li>
|
|
<li><b>style-shadow-text</b> [true/false]</li>
|
|
<li><b>text-alignment</b> [left/center/right]</li>
|
|
<li><b>text-rotation</b> [float]</li>
|
|
<li><b>value-precision</b> [integer]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="ctextlabel"></a>
|
|
CTextLabel</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CTextLabel" /> </pre><p>Inherites attributes from <a class="el" href="#cparamdisplay">CParamDisplay</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>title</b> [string]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="ctextedit"></a>
|
|
CTextEdit</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CTextEdit" /> </pre><p>Inherites attributes from <a class="el" href="#cparamdisplay">CParamDisplay</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>title</b> [string]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="cknob"></a>
|
|
CKnob</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CKnob" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>angle-start</b> [float]</li>
|
|
<li><b>angle-range</b> [float]</li>
|
|
<li><b>value-inset</b> [int]</li>
|
|
<li><b>zoom-factor</b> [float]</li>
|
|
<li><b>handle-shadow-color</b> [color]</li>
|
|
<li><b>handle-color</b> [color]</li>
|
|
<li><b>handle-bitmap</b> [bitmap name]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="canimknob"></a>
|
|
CAnimKnob</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CAnimKnob" /> </pre><p>Inherites attributes from <a class="el" href="#cknob">CKnob</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>height-of-one-image</b> [int]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="cverticalswitch"></a>
|
|
CVerticalSwitch</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CVerticalSwitch" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>height-of-one-image</b> [int]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="chorizontalswitch"></a>
|
|
CHorizontalSwitch</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CHorizontalSwitch" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>height-of-one-image</b> [int]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="crockerswitch"></a>
|
|
CRockerSwitch</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CRockerSwitch" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>height-of-one-image</b> [int]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="cmoviebitmap"></a>
|
|
CMovieBitmap</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CMovieBitmap" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>height-of-one-image</b> [int]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="cmoviebutton"></a>
|
|
CMovieButton</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CMovieButton" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>height-of-one-image</b> [int]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="ckickbutton"></a>
|
|
CKickButton</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CKickButton" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>height-of-one-image</b> [int]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="ctextbutton"></a>
|
|
CTextButton</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CTextButton" /> </pre><p>Inherits attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
New style (named) gradients are supported by:</p><ul>
|
|
<li><b>gradient</b> </li>
|
|
<li><b>gradient-highlighted</b> </li>
|
|
</ul>
|
|
<p>Old style (parametric) gradients are supported by:</p><ul>
|
|
<li><b>gradient-start-color</b> </li>
|
|
<li><b>gradient-end-color</b> </li>
|
|
<li><b>gradient-start-color-hightlighted</b> </li>
|
|
<li><b>gradient-end-color-highlighted</b> </li>
|
|
</ul>
|
|
<p>When named gradients are used, the parametric gradient information is discarded.</p>
|
|
<p>Attributes:</p><ul>
|
|
<li><b>title</b> [string]</li>
|
|
<li><b>font</b> [string]</li>
|
|
<li><b>text-alignment</b> [left/right/center]</li>
|
|
<li><b>text-color</b> [color string]</li>
|
|
<li><b>text-color-highlighted</b> [color string]</li>
|
|
<li><b>frame-color</b> [color string]</li>
|
|
<li><b>frame-color-highlighted</b> [color string]</li>
|
|
<li><b>frame-width</b> [float]</li>
|
|
<li><b>round-radius</b> [float]</li>
|
|
<li><b>icon-text-margin</b> [float]</li>
|
|
<li><b>kick-style</b> [true/false]</li>
|
|
<li><b>icon</b> [string]</li>
|
|
<li><b>icon-highlighted</b> [string]</li>
|
|
<li><b>icon-position</b> [left/right/center above text/center below text]</li>
|
|
<li><b>gradient</b> [string]</li>
|
|
<li><b>gradient-highlighted</b> [string]</li>
|
|
<li><b>gradient-start-color</b> [color string]</li>
|
|
<li><b>graident-end-color</b> [color string]</li>
|
|
<li><b>gradient-start-color-hightlighted</b> [color string]</li>
|
|
<li><b>gradient-end-color-highlighted</b> [color string]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="csegmentbutton"></a>
|
|
CSegmentButton</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CSegmentButton" /> </pre><p>Inherits attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
note: a string array is a comma seperated string: "one,two,three".</p>
|
|
<p>Attributes:</p><ul>
|
|
<li><b>font</b> [string]</li>
|
|
<li><b>style</b> [horizontal/vertical]</li>
|
|
<li><b>text-alignment</b> [left/right/center]</li>
|
|
<li><b>text-color</b> [color string]</li>
|
|
<li><b>text-color-highlighted</b> [color string]</li>
|
|
<li><b>frame-color</b> [color string]</li>
|
|
<li><b>frame-color-highlighted</b> [color string]</li>
|
|
<li><b>frame-width</b> [float]</li>
|
|
<li><b>round-radius</b> [float]</li>
|
|
<li><b>icon-text-margin</b> [float]</li>
|
|
<li><b>gradient</b> [string]</li>
|
|
<li><b>gradient-highlighted</b> [string]</li>
|
|
<li><b>segment-names</b> [string array]</li>
|
|
<li><b>truncate-mode</b> [head/tail/none]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="cslider"></a>
|
|
CSlider</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CSlider" /> </pre><p>Inherites attributes from <a class="el" href="#ccontrol">CControl</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>transparent-handle</b> [true/false]</li>
|
|
<li><b>free-click</b> [true/false]</li>
|
|
<li><b>handle-bitmap</b> [bitmap name]</li>
|
|
<li><b>handle-offset</b> [Point]</li>
|
|
<li><b>mode</b> [touch/relative touch/free click]</li>
|
|
<li><b>draw-frame</b> [true/false]</li>
|
|
<li><b>draw-back</b> [true/false]</li>
|
|
<li><b>draw-value</b> [true/false]</li>
|
|
<li><b>draw-value-inverted</b> [true/false]</li>
|
|
<li><b>draw-value-from-center</b> [true/false]</li>
|
|
<li><b>draw-back-color</b> [color string]</li>
|
|
<li><b>draw-value-color</b> [color string]</li>
|
|
<li><b>bitmap-offset</b> [Point]</li>
|
|
<li><b>zoom-factor</b> [float]</li>
|
|
<li><b>orientation</b> [vertical/horizontal]</li>
|
|
<li><b>reverse-orientation</b> [true/false]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="coptionmenu"></a>
|
|
COptionMenu</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="COptionMenu" /> </pre><p>Inherites attributes from <a class="el" href="#cparamdisplay">CParamDisplay</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>menu-popup-style</b> [true/false]</li>
|
|
<li><b>menu-check-style</b> [true/false]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="cvumeter"></a>
|
|
CVuMeter</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="CVuMeter" /> </pre><p>Inherites attributes from <a class="el" href="#cviewcontainer">CViewContainer</a> <br />
|
|
Attributes:</p><ul>
|
|
<li><b>off-bitmap</b> [bitmap name]</li>
|
|
<li><b>num-led</b> [integer]</li>
|
|
<li><b>orientation</b> [vertical/horizontal]</li>
|
|
<li><b>decrease-step-value</b> [float]</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="uiviewswitchcontainer"></a>
|
|
UIViewSwitchContainer</h1>
|
|
<p>Declaration: </p><pre class="fragment"><view class="UIViewSwitchContainer" /> </pre><ul>
|
|
<li><b>template-names</b> [string array]</li>
|
|
<li><b>template-switch-control</b> [tag name]</li>
|
|
<li><b>animation-style</b> [fade/move/push]</li>
|
|
<li><b>animation-time</b> [integer] </li>
|
|
</ul>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="uidescription.html">Creating user interfaces</a></li><li class="navelem"><a class="el" href="uidescription_x_m_l.html">Creating User Interfaces via XML</a></li>
|
|
<li class="footer">Generated on Mon Oct 20 2025 17:24:33 for VSTGUI by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|