~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/graphics/delete.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>delete</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE> 2002</DATE>
 
8
  <SHORT_DESCRIPTION name="delete"> 
 
9
   delete  a graphic entity and its children.
 
10
  </SHORT_DESCRIPTION>
 
11
  <CALLING_SEQUENCE>
 
12
    <CALLING_SEQUENCE_ITEM>delete(h) </CALLING_SEQUENCE_ITEM>
 
13
    <CALLING_SEQUENCE_ITEM>delete(h,&quot;callback&quot;) </CALLING_SEQUENCE_ITEM>
 
14
    <CALLING_SEQUENCE_ITEM>delete() </CALLING_SEQUENCE_ITEM>
 
15
    <CALLING_SEQUENCE_ITEM>delete(&quot;all&quot;) </CALLING_SEQUENCE_ITEM>
 
16
  </CALLING_SEQUENCE>
 
17
  <PARAM>
 
18
    <PARAM_INDENT>
 
19
      <PARAM_ITEM>
 
20
        <PARAM_NAME>h</PARAM_NAME>
 
21
        <PARAM_DESCRIPTION>
 
22
          <SP>: a handle, the handle of the entity  to delete. <VERB>h</VERB> can be a vector of
 
23
     handles, in which case all objects identified by h(i) will be deleted.</SP>
 
24
        </PARAM_DESCRIPTION>
 
25
      </PARAM_ITEM>
 
26
      <PARAM_ITEM>
 
27
        <PARAM_NAME>&quot;all&quot;  </PARAM_NAME>
 
28
        <PARAM_DESCRIPTION>
 
29
          <SP>: string keyword (optional).</SP>
 
30
        </PARAM_DESCRIPTION>
 
31
      </PARAM_ITEM>
 
32
    </PARAM_INDENT>
 
33
  </PARAM>
 
34
  <DESCRIPTION>
 
35
    <P>
 
36
    This routine can be used to delete a graphics entity identified
 
37
    by the handle given as argument. In this case, All children of 
 
38
    this graphics entity will be deleted. 
 
39
    Without any argument <VERB>delete</VERB> removes the
 
40
    current entity. With <VERB>&quot;all&quot;</VERB> argument it deletes
 
41
    all the entities of the current figure.</P>
 
42
    <P> 
 
43
    The <VERB>&quot;callback&quot;</VERB> argument is not yet handled.</P>
 
44
  </DESCRIPTION>
 
45
  <EXAMPLE>
 
46
<![CDATA[
 
47
 
 
48
  set("figure_style","new") // select entity based graphics  
 
49
  subplot(211);
 
50
  t=1:10;plot2d(t,t.^2),
 
51
  subplot(223);
 
52
  plot3d();
 
53
  subplot(224);
 
54
  plot2d();
 
55
  xfrect(1,0,3,1);
 
56
  a=get("current_axes") 
 
57
  delete(); //delete the graphics object newly created
 
58
  delete(a.children); //delete all children of the current axes
 
59
  delete(a); //delete the axes
 
60
  delete("all"); //delete all the graphics objects of the figure
 
61
 
 
62
 ]]>
 
63
  </EXAMPLE>
 
64
  <SEE_ALSO>
 
65
    <SEE_ALSO_ITEM>
 
66
      <LINK>get</LINK>
 
67
    </SEE_ALSO_ITEM>
 
68
    <SEE_ALSO_ITEM>
 
69
      <LINK>set</LINK>
 
70
    </SEE_ALSO_ITEM>
 
71
    <SEE_ALSO_ITEM>
 
72
      <LINK>copy</LINK>
 
73
    </SEE_ALSO_ITEM>
 
74
    <SEE_ALSO_ITEM>
 
75
      <LINK>move</LINK>
 
76
    </SEE_ALSO_ITEM>
 
77
    <SEE_ALSO_ITEM>
 
78
      <LINK>graphics_entities</LINK>
 
79
    </SEE_ALSO_ITEM>
 
80
  </SEE_ALSO>
 
81
  <AUTHOR> Djalel ABDEMOUCHE</AUTHOR>
 
82
</MAN>