← Back to branch summary

~ubuntu-branches/ubuntu/karmic/scilab/karmic

« back to all changes in this revision

Viewing changes to man/tksci/get.cat

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2002-03-21 16:57:43 UTC
  • Revision ID: james.westby@ubuntu.com-20020321165743-e9mv12c1tb1plztg
Tags: upstream-2.6
Import upstream version 2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/tksci/get.cat
 
1
get             Fractales Group             Scilab Function             get
 
2
NAME
 
3
   get - Retrieve a property value from an User Interface object.
 
4
  
 
5
CALLING SEQUENCE
 
6
   val=get(h,prop)
 
7
  
 
8
PARAMETERS
 
9
 o    h : integer the handle of the object to retrieve a property
 
10
      
 
11
 o    Bprop : character string name of the property
 
12
      
 
13
 o    val : scilab object value of the property
 
14
      
 
15
DESCRIPTION
 
16
   This routine can be used to retrieve a specified property from a GUI
 
17
  object.  Property name are character strings like 'style', 'position'
 
18
  .... This routine returns the value associated to the specified property.
 
19
  Obviously, the type of the returned object depends on the property one
 
20
  aims at querying. For example, the 'style' property which represents the
 
21
  kind of Object the UI control is (ie button, label, list, ..... ) will be
 
22
  represented as a string. On the contrary, the 'position' property, which 
 
23
  represents the geometrical aspect of the UI control, will be coded as  a
 
24
  [1,4] vector. 
 
25
  
 
26
EXAMPLE
 
27
 h=uicontrol('string', 'Button');
 
28
 // Opens a window with a  button.
 
29
 p=get(h,'position');
 
30
 // get the geometric qspect of the button
 
31
 disp('Button width: ' + string(p(3)));
 
32
 // print the width of the button
 
33
 close();
 
34
 // close figure
 
35
SEE ALSO
 
36
   uicontrol, uimenu, set
 
37
  
 
38
AUTHOR
 
39
   Bertrand Guiheneuf
 
40