DISTRHO
/
DISTRHO-Ports-Extra
mirror of https://github.com/DISTRHO/DISTRHO-Ports-Extra


			
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>protoplug: Class juce.Component</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<a href="http://osar.fr">
<div class=osarlogo> </div>
</a>
<br/>
<a href="http://osar.fr/protoplug">
<h1>protoplug</h1>
</a>
	<span class="proto_subtitle">Lua API reference</span>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Methods">Methods</a></li>
</ul>


<h2>Classes</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
  <li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li>
  <li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li>
  <li><a href="../classes/juce.Colour.html">juce.Colour</a></li>
  <li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li>
  <li><strong>juce.Component</strong></li>
  <li><a href="../classes/juce.FillType.html">juce.FillType</a></li>
  <li><a href="../classes/juce.Font.html">juce.Font</a></li>
  <li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li>
  <li><a href="../classes/juce.Image.html">juce.Image</a></li>
  <li><a href="../classes/juce.Justification.html">juce.Justification</a></li>
  <li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li>
  <li><a href="../classes/juce.Line.html">juce.Line</a></li>
  <li><a href="../classes/juce.Path.html">juce.Path</a></li>
  <li><a href="../classes/juce.Point.html">juce.Point</a></li>
  <li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li>
  <li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li>
  <li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li>
</ul>
<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
  <li><a href="../modules/plugin.html">plugin</a></li>
  <li><a href="../modules/script.html">script</a></li>
  <li><a href="../modules/midi.html">midi</a></li>
  <li><a href="../modules/gui.html">gui</a></li>
  <li><a href="../modules/polyGen.html">polyGen</a></li>
  <li><a href="../modules/stereoFx.html">stereoFx</a></li>
</ul>
<h2>Examples</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
  <li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li>
  <li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li>
  <li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li>
  <li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li>
  <li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li>
</ul>

</div>

<div id="content">

<h1>Class <code>juce.Component</code></h1>
<p>JUCE Component.</p>
<p> Is a pointer to a <a href="http://www.juce.com/api/classComponent.html">JUCE Component</a></p>

<p> As of now, components can't be created by protoplug scripts. This is mainly
 for accessing the custom GUI component using <a href="../modules/gui.html#getComponent">gui.getComponent</a>.</p>


<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#juce.Component:repaint"><span class="proto_prefix">juce.Component</span>:repaint ()</a></td>
	<td class="summary">Request total repaint.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#juce.Component:repaint"><span class="proto_prefix">juce.Component</span>:repaint (area)</a></td>
	<td class="summary">Request partial repaint.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#juce.Component:repaint"><span class="proto_prefix">juce.Component</span>:repaint (x, y, width, height)</a></td>
	<td class="summary">Request partial repaint.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#juce.Component:createComponentSnapshot"><span class="wrapman"><span class="proto_prefix">juce.Component</span>:createComponentSnapshot<br> (areaToGrab[, clipImageToComponentBounds=true[, scaleFactor=1]])</span></a></td>
	<td class="summary">Create component snapshot.</td>
	</tr>
</table>

<br/>
<br/>


    <h2><a name="Methods"></a>Methods</h2>
    <dl class="function">
    <dt>
    <a name = "juce.Component:repaint"></a>
    <strong><span class="proto_prefix">juce.Component</span>:repaint ()</strong>
    </dt>
    <dd>
    Request total repaint.
 Tell the operating system that the component is "dirty" and needs to be redrawn.
 The component's paint method will be called asynchronously (<a href="../modules/gui.html#paint">gui.paint</a>)

    </ul>


</dd>
    <dt>
    <a name = "juce.Component:repaint"></a>
    <strong><span class="proto_prefix">juce.Component</span>:repaint (area)</strong>
    </dt>
    <dd>
    Request partial repaint.
 Tell the operating system that a portion of the component is "dirty" and needs to be redrawn.
 The component's paint method will be called asynchronously (<a href="../modules/gui.html#paint">gui.paint</a>). The dirty region will be accessible
 with Graphics.getClipBounds().

    </ul>

    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">area</span>
            <span class="types"><span class="type">juce.Rectangle_int</span></span>
         the region needing the be redrawn
        </li>
    </ul>


</dd>
    <dt>
    <a name = "juce.Component:repaint"></a>
    <strong><span class="proto_prefix">juce.Component</span>:repaint (x, y, width, height)</strong>
    </dt>
    <dd>
    Request partial repaint.
 Tell the operating system that a portion of the component is "dirty" and needs to be redrawn.
 The component's paint method will be called asynchronously (<a href="../modules/gui.html#paint">gui.paint</a>). The dirty region will be accessible
 with Graphics.getClipBounds().

    </ul>

    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">x</span>
         the region needing the be redrawn
        </li>
        <li><span class="parameter">y</span>
         the region needing the be redrawn
        </li>
        <li><span class="parameter">width</span>
         the region needing the be redrawn
        </li>
        <li><span class="parameter">height</span>
         the region needing the be redrawn
        </li>
    </ul>


</dd>
    <dt>
    <a name = "juce.Component:createComponentSnapshot"></a>
    <strong><span class="wrapman"><span class="proto_prefix">juce.Component</span>:createComponentSnapshot<br> (areaToGrab[, clipImageToComponentBounds=true[, scaleFactor=1]])</span></strong>
    </dt>
    <dd>
    Create component snapshot.
 Paint the component into a virtual buffer and return it as an image.

    </ul>

    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">areaToGrab</span>
            <span class="types"><span class="type">juce.Rectangle_int</span></span>
         the region to the be drawn
        </li>
        <li><span class="parameter">clipImageToComponentBounds</span>


         (<em>default</em> true)
        </li>
        <li><span class="parameter">scaleFactor</span>


         (<em>default</em> 1)
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

           <span class="types"><a class="type" href="../classes/juce.Image.html#">juce.Image</a></span>


    </ol>


</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>