pascal/lazarus-ccr
1
0
Fork 0
Code Issues Releases Activity
Files
9769ec83c581287798a6673777cf73ba33e2bd3d
lazarus-ccr/components/nvidia-widgets/doc/nvwidgets/uicontext.dobutton.html

66 lines
4.5 KiB
HTML
Raw Normal View History

added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>UIContext.doButton</title>
<link rel="stylesheet" href="../fpdoc.css" type="text/css">
</head>
<body>
<table class="bar" width="100%" border="0" cellpadding="4" cellspacing="0">
<tr>
<td><b>[<a href="../nvwidgets/index.html">Overview</a>][<a href="../nvwidgets/index-2.html">Constants</a>][<a href="../nvwidgets/index-3.html">Types</a>][<a href="../nvwidgets/index-4.html">Classes</a>][<a href="../nvwidgets/index-5.html">Procedures and functions</a>][<a href="../nvwidgets/index-8.html">Index</a>]</b></td>
<td align="right"><span class="bartitle">Reference for unit 'nvWidgets' (<a href="../index.html">#nvidia-widgets</a>)</span></td>
</tr>
</table>
<h1>UIContext.doButton</h1>
<p>UI method for rendering and processing a push button</p>
<h2>Declaration</h2>
<p>Source position: line 0</p>
<table cellpadding="0" cellspacing="0">
<tr>
<td><p><tt><span class="code"> <span class="kw">function</span> <a href="../nvwidgets/uicontext.html">UIContext</a><span class="sym">.</span>doButton<span class="sym">(</span></span></tt></p></td>
</tr>
<tr>
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
<td><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">const </span>r<span class="sym">: </span><a href="../nvwidgets/rect.html">Rect</a><span class="sym">;</span><span class="cmt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//optionally provides a location and size for the button</span></span></tt></p></td>
added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
</tr>
<tr>
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
<td><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">const </span>Text<span class="sym">: </span><span class="sym">;</span><span class="cmt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//text to display on the button</span></span></tt></p></td>
added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
</tr>
<tr>
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
<td><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">var </span>state<span class="sym">: </span>Boolean<span class="sym">;</span><span class="cmt"> //whether the button is depressed</span></span></tt></p></td>
added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
</tr>
<tr>
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
<td><p><tt><span class="code">&nbsp;&nbsp;style<span class="sym">: </span>Integer <span class="sym">=</span> <span class="num">0</span></span><span class="cmt"> &nbsp;//optional style flag to modify the look (default = 0)</span></span></tt></p></td>
added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
</tr>
<tr>
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
<td><p><tt><span class="code"><span class="sym">):</span>Boolean<span class="sym">;</span><span class="cmt"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //Boolean result</span><br><br><span class="kw">function</span> <a href="../nvwidgets/uicontext.html">UIContext</a><span class="sym">.</span>doButton<span class="sym">(</span></span></tt></p></td>
added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
</tr>
<tr>
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
<td><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">const </span>r<span class="sym">: </span><a href="../nvwidgets/rect.html">Rect</a><span class="sym">;</span><span class="cmt"> &nbsp;&nbsp;&nbsp;&nbsp;//optionally provides a location and size for the button</span></span></tt></p></td>
added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
</tr>
<tr>
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
<td><p><tt><span class="code">&nbsp;&nbsp;<span class="kw">const </span>Text<span class="sym">: </span><span class="cmt"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //text to display on the button</span></span></tt></p></td>
added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
</tr>
<tr>
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
<td><p><tt><span class="code"><span class="sym">):</span>Integer<span class="sym">;</span><span class="cmt"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//Integer result</span></span></tt></p></td>
added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
</tr>
</table>
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
renamed bmp images to png (only type supported) added all images to widget documentation fixed some spelling / formatting errors git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2226 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-04 15:57:09 +00:00
<h2>Description</h2>
<p>The button method does only take a text and state variable. This variable is modified if the button is pressed or depressed. When a state change occurs the method function returns <var>True</var>.</p>
<img alt="" src="../images/button.png">
doc: doButton / doLabel code example git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2231 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-06 19:35:19 +00:00
<p>Example code how to implement a button</p>
<pre>none<span class="sym">.</span>Rect<span class="sym">(</span><span class="num">0</span><span class="sym">,</span> <span class="num">0</span><span class="sym">)</span><span class="sym">;</span>
ui<span class="sym">.</span>beginGroup<span class="sym">(</span>GroupFlags_GrowDownFromRight<span class="sym">)</span><span class="sym">;</span>
<span class="kw">if</span> ui<span class="sym">.</span>doButton<span class="sym">(</span>none<span class="sym">,</span> <span class="str">'Apply'</span><span class="sym">)</span> <span class="kw">then</span>
<span class="kw">begin</span>
<span class="cmt">//code to apply your changes</span>
<span class="kw">end</span><span class="sym">;</span>
ui<span class="sym">.</span>endGroup<span class="sym">;</span>
</pre>
added html documentation moved nvwidgets.png to separate folder added css file for nicer formatting git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@2216 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2012-01-02 14:52:12 +00:00
</body>
</html>
Reference in New Issue Copy Permalink