nephele
/
haiku-website
0
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
haiku-website/static/legacy-docs/bebook/BParameterWeb.html

58 lines
14 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Be Book - Classes And Methods - The Media Kit</title><link rel="stylesheet" href="be_book.css" type="text/css" media="all" /><link rel="shortcut icon" type="image/vnd.microsoft.icon" href="./images/favicon.ico" /><!--[if IE]>
<link rel="stylesheet" type="text/css" href="be_book_ie.css" />
<![endif]--><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><meta name="keywords" content="Access, BeOS, BeBook, API" /><link rel="start" href="index.html" title="The Be Book" /><link rel="up" href="TheMediaKit.html" title="The Media Kit" /><link rel="prev" href="BParameterGroup.html" title="BParameterGroup" /><link rel="next" href="BSmallBuffer.html" title="BSmallBuffer" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="BParameterGroup.html" title="BParameterGroup"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a accesskey="u" href="TheMediaKit.html" title="The Media Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a accesskey="n" href="BSmallBuffer.html" title="BSmallBuffer"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="headerTR"><div id="navigpeople"><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div><div class="navigboxed" id="navigindex"><a accesskey="i" href="ClassIndex.html" title="Index">I</a></div><div class="navigboxed" id="naviglang" title="English">en</div></div><div id="headerTC">The Be Book - Classes And Methods - The Media Kit</div></div><div id="headerB">Prev: <a href="BParameterGroup.html">BParameterGroup</a>  Up: <a href="TheMediaKit.html">The Media Kit</a>  Next: <a href="BSmallBuffer.html">BSmallBuffer</a></div><hr /></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h2 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb"></a>BParameterWeb</h2></div></div></div><a id="id1167613" class="indexterm"></a><div class="classheader"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td><table width="100%" border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Derived From:</td><td>–</td></tr><tr><td>Mix-in Classes:</td><td>–</td></tr><tr><td>Declared In:</td><td><code class="filename">media/ParameterWeb.h</code></td></tr><tr><td>Library:</td><td><code class="filename">libmedia.so</code></td></tr><tr><td>Allocation:</td><td>Constructor only</td></tr></tbody></table></td><td>
<a class="link overview" href="BParameterWeb_Overview.html" title="BParameterWeb">Class Overview</a>
<div class="toc"><ul><li><span class="section"><a href="BParameterWeb.html#BParameterWeb_ConstructorDestructor">Constructor and Destructor</a></span></li><li><span class="section"><a href="BParameterWeb.html#BParameterWeb_MemberFunctions">Member Functions</a></span></li></ul></div>
</td></tr></tbody></table></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_ConstructorDestructor"></a>Constructor and Destructor</h3></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_Constructor"></a>BParameterWeb()</h4></div></div></div><code class="constructorsynopsis cpp"><span class="methodname">BParameterWeb</span>();</code><p>The <code class="classname">BParameterWeb</code> constructor. You'll
usually create one <code class="classname">BParameterWeb</code>
object per
<a class="link" href="BControllable.html" title="BControllable"><code class="classname">BControllable</code></a>
node; to attach a <code class="classname">BParameterWeb</code> to a
<a class="link" href="BControllable.html" title="BControllable"><code class="classname">BControllable</code></a>
node, you should call
<a class="link" href="BControllable.html#BControllable_SetParameterWeb" title="SetParameterWeb(), Web()"><code class="methodname">BControllable::SetParameterWeb()</code></a>.</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_Destructor"></a>~BParameterWeb()</h4></div></div></div><code class="destructorsynopsis cpp"><span class="methodname">~BParameterWeb</span>();</code><p>Once you've called
<a class="link" href="BControllable.html#BControllable_SetParameterWeb" title="SetParameterWeb(), Web()"><code class="methodname">BControllable::SetParameterWeb()</code></a>,
the node takes responsibility for the parameter web object and you shouldn't delete it.</p><p>If you don't call
<a class="link" href="BControllable.html#BControllable_SetParameterWeb" title="SetParameterWeb(), Web()"><code class="methodname">BControllable::SetParameterWeb()</code></a>,
then delete the <code class="classname">BParameterWeb</code> object when you're done with it.</p></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_MemberFunctions"></a>Member Functions</h3></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_CountGroups"></a>CountGroups()</h4></div></div></div><code class="methodsynopsis cpp"><span class="type">int32 </span><span class="methodname">CountGroups</span>();</code><p>Returns the number of
<a class="link" href="BParameterGroup.html" title="BParameterGroup"><code class="classname">BParameterGroup</code></a>
objects that are currently attached to the <code class="classname">BParameterWeb</code>.</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_CountParameters"></a>CountParameters()</h4></div></div></div><code class="methodsynopsis cpp"><span class="type">int32 </span><span class="methodname">CountParameters</span>();</code><p>Returns the number of
<a class="link" href="BParameter.html" title="BParameter"><code class="classname">BParameter</code></a>s
in the entire web, including those in all
<a class="link" href="BParameterGroup.html" title="BParameterGroup"><code class="classname">BParameterGroup</code></a>s
attached to it.</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_GroupAt"></a>GroupAt()</h4></div></div></div><code class="methodsynopsis cpp"><span class="type"><span class="classname">BParameterGroup</span>* </span><span class="methodname">GroupAt</span>(<span class="methodparam"><span class="type">int32 </span><span class="parameter">index</span></span>);</code><p>Returns the
<a class="link" href="BParameterGroup.html" title="BParameterGroup"><code class="classname">BParameterGroup</code></a>
located at the specified <code class="parameter">index</code> within the
list of groups contained by the <code class="classname">BParameterWeb</code>.</p><p>The first group is numbered 0, so the maximum legal value for <code class="parameter">index</code> is
<a class="link" href="BParameterGroup.html#BParameterGroup_CountGroups" title="CountGroups()"><code class="methodname">CountGroups()</code></a>-1.
If the specified <code class="parameter">index</code> is outside that range, <code class="constant">NULL</code> is
returned.</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_MakeGroup"></a>MakeGroup()</h4></div></div></div><code class="methodsynopsis cpp"><span class="type"><span class="classname">BParameterGroup</span>* </span><span class="methodname">MakeGroup</span>(<span class="methodparam"><span class="modifier">const </span><span class="type">char* </span><span class="parameter">name</span></span>);</code><p>Creates a new
<a class="link" href="BParameterGroup.html" title="BParameterGroup"><code class="classname">BParameterGroup</code></a>
object to be used for grouping parameters within the <code class="classname">BParameterWeb</code>,
and attaches it to the <code class="classname">BParameterWeb</code>.</p><p>All
<a class="link" href="BParameter.html" title="BParameter"><code class="classname">BParameter</code></a>s
created in the group will belong to that group, and, by
recursion, to the web itself.</p><div class="admonition note"><div class="title">Note</div><div class="graphic"><img class="icon" alt="Note" width="32" src="./images/admonitions/Info_32.png" /><div class="text"><p>You can nest
<a class="link" href="BParameterGroup.html" title="BParameterGroup"><code class="classname">BParameterGroup</code></a>s
if you want to; however,
<a class="link" href="BParameter.html" title="BParameter"><code class="classname">BParameter</code></a>s
can't be shared among multiple groups.</p></div></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_Node"></a>Node()</h4></div></div></div><code class="methodsynopsis cpp"><span class="type">media_node </span><span class="methodname">Node</span>();</code><p>Returns the
<a class="link" href="TheMediaKit_DefinedTypes.html#media_node" title="media_node"><span class="type">media_node</span></a>
for the
<a class="link" href="BControllable.html" title="BControllable"><code class="classname">BControllable</code></a>
node that owns this <code class="classname">BParameterWeb</code> object.</p><p>If the <code class="classname">BParameterWeb</code> hasn't been attached to a
<a class="link" href="BControllable.html" title="BControllable"><code class="classname">BControllable</code></a>
node yet, <span class="code"><span class="type">media_node</span>::<code class="varname">null</code></span>
is returned.</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BParameterWeb_ParameterAt"></a>ParameterAt()</h4></div></div></div><code class="methodsynopsis cpp"><span class="type"><span class="classname">BParameter</span>* </span><span class="methodname">ParameterAt</span>(<span class="methodparam"><span class="type">int32 </span><span class="parameter">index</span></span>);</code><p>Returns the
<a class="link" href="BParameter.html" title="BParameter"><code class="classname">BParameter</code></a>
at the specified <code class="parameter">index</code> within the entire
<code class="classname">BParameterWeb</code>, including those in all attached groups. The first
parameter is numbered 0, so the maximum legal value for <code class="parameter">index</code> is
<a class="link" href="BParameterGroup.html#BParameterGroup_CountParameters" title="CountParameters()"><code class="methodname">CountParameters()</code></a>-1.
If the specified <code class="parameter">index</code> is outside that range, <code class="constant">NULL</code>
is returned.</p></div></div></div><div id="footer"><hr /><div id="footerT">Prev: <a href="BParameterGroup.html">BParameterGroup</a>  Up: <a href="TheMediaKit.html">The Media Kit</a>  Next: <a href="BSmallBuffer.html">BSmallBuffer</a> </div><div id="footerB"><div id="footerBL"><a href="BParameterGroup.html" title="BParameterGroup"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a href="TheMediaKit.html" title="The Media Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a href="BSmallBuffer.html" title="BSmallBuffer"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="footerBR"><div><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div></div><div id="footerBC"><a href="http://www.access-company.com/home.html" title="ACCESS Co."><img alt="Access Company" src="./images/access_logo.png" /></a></div></div></div><div id="licenseFooter"><div id="licenseFooterBL"><a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/" title="Creative Commons License"><img alt="Creative Commons License" style="border-width:0" src="https://licensebuttons.net/l/by-nc-nd/3.0/88x31.png" /></a></div><div id="licenseFooterBR"><a href="./LegalNotice.html">Legal Notice</a></div><div id="licenseFooterBC"><span id="licenseText">This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/">Creative
Commons Attribution-Non commercial-No Derivative Works 3.0 License</a>.</span></div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink