1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
|
<?xml version="1.0" encoding="UTF-8"?>
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="findobj">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
<refnamediv>
<refname>findobj</refname>
<refpurpose> find an object with specified property</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
h = findobj(propertyName, propertyValue)
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>propertyName</term>
<listitem>
<para>string character Name of the property to test (case unsensitive).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>propertyValue</term>
<listitem>
<para>string character specify the value the tested propoerty should be equal to (case sensitive).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>h</term>
<listitem>
<para>handle of the found object.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
This routine is currently used to find objects knowing their 'tag'
property. It returns handle of the first found object which property
<emphasis role="italic">propertyName</emphasis> is equal to <emphasis role="italic">propertyValue</emphasis>. If such an object does not exist, the
function returns an empty matrix.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
// Create a figure
h=figure();
// Put a text in the figure
uicontrol(h, "style","text", ...
"string","This is a figure", ...
"position",[50 70 100 100], ...
"fontsize",15, ...
"tag","Alabel");
// Find the object which "tag" value is "Alabel"
lab=findobj("tag","Alabel");
disp("The text of the label is """+lab.string+"""");
// Close the figure
close();
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="uicontrol">uicontrol</link>
</member>
<member>
<link linkend="uimenu">uimenu</link>
</member>
<member>
<link linkend="set">set</link>
</member>
<member>
<link linkend="get">get</link>
</member>
</simplelist>
</refsection>
<refsection>
<title>Authors</title>
<para>Bertrand Guiheneuf</para>
<para>V.C.</para>
</refsection>
</refentry>
|