<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
<MAN>
  <LANGUAGE>eng</LANGUAGE>

  <TITLE>get</TITLE>

  <TYPE>Scilab Function</TYPE>

  <DATE>04 June 1998</DATE>

  <SHORT_DESCRIPTION name="get">Retrieve a property value from a graphics
  entity or an User Interface object.</SHORT_DESCRIPTION>

  <CALLING_SEQUENCE>
    <CALLING_SEQUENCE_ITEM>h=get(prop)</CALLING_SEQUENCE_ITEM>

    <CALLING_SEQUENCE_ITEM>val=get(h,prop)</CALLING_SEQUENCE_ITEM>

    <CALLING_SEQUENCE_ITEM>val=h.prop</CALLING_SEQUENCE_ITEM>

    <CALLING_SEQUENCE_ITEM>val=get(n,prop)</CALLING_SEQUENCE_ITEM>
  </CALLING_SEQUENCE>

  <PARAM>
    <PARAM_INDENT>
      <PARAM_ITEM>
        <PARAM_NAME>h</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: handle, the handle of the entity to retrieve a property.
          <VERB>h</VERB> can be a vector of handles, in which case get returns
          the property's value for all objects identified by h(i).</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>n</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: integer, the handle of the User Interface object to retrieve a
          property.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>prop</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: character string name of the property.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>

      <PARAM_ITEM>
        <PARAM_NAME>val</PARAM_NAME>

        <PARAM_DESCRIPTION>
          <SP>: scilab object value of the property.</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
    </PARAM_INDENT>
  </PARAM>

  <DESCRIPTION>
    <P>This routine can be used to retrieve the value of a specified property
    graphics entity or a GUI object. If the handle is not specified, the
    current object is taken as the default handle. It is also used to return a
    list of all children, parent, or type for the input handle if this one is
    specified. Otherwise, the current axes object is taken as the default
    input.</P>

    <P>Property name are character strings.</P>

    <P>See <LINK>graphics_entities</LINK> for details about properties' names
    and values for graphics entities.</P>

    <P>See <LINK>uicontrol</LINK> for details about properties' names and
    values for User Interface objects.</P>

    <P>For graphics entities handle it is possible to use a dot notation like
    <VERB>h.background</VERB> instead of <VERB>get</VERB>.</P>
  </DESCRIPTION>

  <EXAMPLE><![CDATA[
  // for graphics entities
    clf()
    get("old_style") // check the state of the graphics' style
    set("figure_style","new") //create a figure
    get("figure_style") // check the style of the graphics' figure

    // simple graphics objects  
    subplot(121);
    x=[-.2:0.1:2*%pi]';
    plot2d(x-2,x.^2);
    subplot(122);
    xrect(.2,.7,.5,.2);     
    xrect(.3,.8,.3,.2);
    xfarc(.25,.55,.1,.15,0,64*360);
    xfarc(.55,.55,.1,.15,0,64*360);
    xstring(0.2,.9,"Example <<A CAR>>");
 
    h=get("hdl") //get the object newly created
    h.font_size=3;
 
    f=get("current_figure") //get the current figure 
    f.figure_size
    f.figure_size=[700 500];
    f.children
    f.children(2).type
    f.children(2).children
    f.children(2).children.children.thickness=4; 
 
    a=get("current_axes") //get the current axes
    a.children.type
    a.children.foreground //get the foreground color of a set of graphics objects
    a.children.foreground=9;

  // for  User Interface objects
   h=uicontrol('string', 'Button'); // Opens a window with a  button.
   p=get(h,'position'); // get the geometric aspect of the button
   disp('Button width: ' + string(p(3))); // print the width of the button
   close(); // close figure

 
  ]]></EXAMPLE>

  <SEE_ALSO>
    <SEE_ALSO_ITEM>
      <LINK>uicontrol</LINK>
    </SEE_ALSO_ITEM>

    <SEE_ALSO_ITEM>
      <LINK>set</LINK>
    </SEE_ALSO_ITEM>
  </SEE_ALSO>

  <AUTHOR>Djalel ABDEMOUCHE</AUTHOR>
</MAN>