source: MML/trunk/machine/SOLEIL/common/toolbox/GUILayout/layoutHelp/Function reference3_1.html @ 4

Last change on this file since 4 was 4, checked in by zhangj, 10 years ago

Initial import--MML version from SOLEIL@2013

File size: 11.2 KB
Line 
1<html xmlns:saxon="http://icl.com/saxon">
2   <head>
3      <link rel="stylesheet" type="text/css" href="doc.css"/>
4      <link rel="stylesheet" type="text/css" href=""/>
5      <meta author="The MathWorks Ltd."/>
6      <meta copyright="2011 The MathWorks Ltd."/>
7      <title>uiextras.Grid</title>
8   </head>
9
10   
11    <body>
12      <table class="header" width="100%" border="0" cellspacing="0" cellpadding="0">
13         <tr>
14            <td bgcolor="#e4f0f8"><A href="Function reference.html"><font face="Arial" bgcolor="#e4f0f8" size="+0" underline="0" color="#000000"><b>Function reference</b></font></A></td>
15            <td width="36" bgcolor="#e4f0f8"><A HREF="Function reference2_6.html"><IMG SRC="Images/leftarrow.png" BORDER="0" ALT="previous page"/></A><A HREF="Function reference3_2.html"><IMG SRC="Images/rightarrow.png" BORDER="0" ALT="next page"/></A></td>
16         </tr>
17      </table>
18   
19
20      <br clear="all"/>
21         
22      <h2>3.1: uiextras.Grid&nbsp;<a href="Function reference.html#3"><img src="Images/uparrow.png" border="0" align="top" alt="Go back up one level"/></a></h2>
23     
24                 
25             <img src="Images/bigicon_Grid.png" align="left"/>
26             <br clear="all"/>
27           <p>Arrange elements in a two dimensional grid</p>
28                        <dl>
29                 <dt><code class="OUTARG">obj</code><code class="FUNCTION"> = uiextras.Grid(</code><code class="FUNCTION">&nbsp;)</code></dt>
30                 <dd>creates a new new grid layout with all properties set to defaults. The number of rows and
31                 columns to use is determined from the number of elements in the
32                 RowSizes and ColumnSizes properties respectively. Child elements are
33                 arranged down column one first, then column two etc. If there are insufficient
34                 columns then a new one is added.
35             The output is a new layout object that can be used as the parent for other user-interface components.</dd>
36                 
37                 <dt><code class="OUTARG">obj</code><code class="FUNCTION"> = uiextras.Grid(</code><code class="INARG">&nbsp;prop</code><code class="FUNCTION">,</code><code class="INARG">&nbsp;value</code><code class="FUNCTION">,</code><code class="INARG">&nbsp;...</code><code class="FUNCTION">&nbsp;)</code></dt>
38                 <dd>also sets one or more property values.</dd>
39                 
40             </dl>
41             
42                   
43             <h3>uiextras.Grid properties</h3>
44                 <center><table frame="box" rules="all" class="PROPERTYTABLE"><tr><th class="PROPERTYTABLE">Property</th><th class="PROPERTYTABLE">Value</th><th class="PROPERTYTABLE">Description</th></tr><tr><td valign="top" class="PROPERTYTABLE"><code>BackgroundColor&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value><a href="matlab:doc colorspec"><code class="FUNCTION">colorspec</code></a></value></td><td valign="top" class="PROPERTYTABLE"><description>The color to use for exposed areas of the layout background. This can be an RGB triple (e.g. [0 0 1]) or a colour name (e.g. 'b').</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>BeingDeleted&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[ on | off ]</value></td><td valign="top" class="PROPERTYTABLE"><description>is the object in the process of being deleted.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Children&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>handle array</value></td><td valign="top" class="PROPERTYTABLE"><description>List of child objects within this layout (note that this can only be set to permutations of itself).</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>DeleteFcn&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value><a href="matlab:doc function_handle"><code class="FUNCTION">function_handle</code></a></value></td><td valign="top" class="PROPERTYTABLE"><description>Function to call when the layout is being deleted</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Enable&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[ on | off ]</value></td><td valign="top" class="PROPERTYTABLE"><description>Is interaction with this layout enabled? Note that changing the enable property will cause all children contained to also be enabled/disabled, however since they can be individually re-enabled the state of this property does not reflect the state of the children. See the <a href="EnableExample.html">enable example</a> for more details.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Padding&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>positive integer</value></td><td valign="top" class="PROPERTYTABLE"><description>Number of pixels of extra space around the outside of the layout.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Parent&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>handle</value></td><td valign="top" class="PROPERTYTABLE"><description>The handle of the parent figure or container.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Position&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[x y w h]</value></td><td valign="top" class="PROPERTYTABLE"><description>The position (x,y) and size (w,h) of the layout.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>RowSizes&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>double vector</value></td><td valign="top" class="PROPERTYTABLE"><description>The size of each of the rows. Positive entries indicate fixed sizes in pixels, negative values indicate relative weights for resizing.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>ColumnSizes&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>double vector</value></td><td valign="top" class="PROPERTYTABLE"><description>The size of each of the columns. Positive entries indicate fixed sizes in pixels, negative values indicate relative weights for resizing.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Spacing&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>positive integer</value></td><td valign="top" class="PROPERTYTABLE"><description>Number of pixels of extra space to leave between elements in the layout.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Tag&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>string</value></td><td valign="top" class="PROPERTYTABLE"><description>A string that can be used to identify this object later.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Type&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>string</value></td><td valign="top" class="PROPERTYTABLE"><description>the object type (class).</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Units&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[ inches | centimeters | normalized | points | pixels | characters ]</value></td><td valign="top" class="PROPERTYTABLE"><description>The units of measurement for position the layout within its parent.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>Visible&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[ on | off ]</value></td><td valign="top" class="PROPERTYTABLE"><description>Is the object visible on screen.</description></td></tr></table></center>                 
45             
46             <h3>For example:</h3>
47                     <pre style="background-color: #eeeeff; margin-left: 20px; margin-right: 20px"><font color="#000011"><!--&gt;&gt; -->f = <a href="matlab:doc figure"><code class="FUNCTION">figure</code></a>();
48<!--&gt;&gt; -->g = <a href="uiextras.Grid.html"><code class="FUNCTION">uiextras.Grid</code></a>( <code class="STRING">'Parent'</code>, f, <code class="STRING">'Spacing'</code>, 5 );
49<!--&gt;&gt; --><a href="matlab:doc uicontrol"><code class="FUNCTION">uicontrol</code></a>( <code class="STRING">'Parent'</code>, g, <code class="STRING">'Background'</code>, <code class="STRING">'r'</code> )
50<!--&gt;&gt; --><a href="matlab:doc uicontrol"><code class="FUNCTION">uicontrol</code></a>( <code class="STRING">'Parent'</code>, g, <code class="STRING">'Background'</code>, <code class="STRING">'b'</code> )
51<!--&gt;&gt; --><a href="matlab:doc uicontrol"><code class="FUNCTION">uicontrol</code></a>( <code class="STRING">'Parent'</code>, g, <code class="STRING">'Background'</code>, <code class="STRING">'g'</code> )
52<!--&gt;&gt; --><a href="uiextras.Empty.html"><code class="FUNCTION">uiextras.Empty</code></a>( <code class="STRING">'Parent'</code>, g )
53<!--&gt;&gt; --><a href="matlab:doc uicontrol"><code class="FUNCTION">uicontrol</code></a>( <code class="STRING">'Parent'</code>, g, <code class="STRING">'Background'</code>, <code class="STRING">'c'</code> )
54<!--&gt;&gt; --><a href="matlab:doc uicontrol"><code class="FUNCTION">uicontrol</code></a>( <code class="STRING">'Parent'</code>, g, <code class="STRING">'Background'</code>, <code class="STRING">'y'</code> )
55<!--&gt;&gt; --><a href="matlab:doc set"><code class="FUNCTION">set</code></a>( g, <code class="STRING">'ColumnSizes'</code>, [-1 100 -2], <code class="STRING">'RowSizes'</code>, [-1 100] );</font></pre>         
56                     <p style="background-color: #ddddee; margin-left: 20px; margin-right: 20px"><font color="#000022">
57                         <center><img src="Images/Grid.png"/></center>
58                     </font></p>
59                 
60             
61             <br/><b>See also:</b><ul><li><code class="FUNCTION"><a href="uiextras.GridFlex.html">uiextras.GridFlex</a></code> - for creating a grid arrangement with draggable dividers</li></ul>
62
63       
64     
65      <br clear="ALL"/>
66      <table class="footer" width="100%" border="0" cellspacing="0" cellpadding="0">
67         <tr>
68            <td width="18" height="15" bgcolor="#e4f0f8" align="left"><a href="Function reference2_6.html"><img src="images/leftarrow.png" border="0" alt="previous page"/></a></td>
69            <td width="40%" height="15" bgcolor="#e4f0f8" align="left"><a href="Function reference2_6.html"><font face="arial" bgcolor="#e4f0f8" size="normal" underline="0" color="#000000">uiextras.VButtonBox</font></a></td>
70            <td width="20%" height="15" bgcolor="#e4f0f8" align="center"><a href="index.html"><font face="arial" bgcolor="#e4f0f8" size="normal" underline="0" color="#000000">[Top]</font></a></td>
71            <td width="40%" height="15" bgcolor="#e4f0f8" align="right"><a href="Function reference3_2.html"><font face="arial" bgcolor="#e4f0f8" size="normal" underline="0" color="#000000">uiextras.GridFlex</font></a></td>
72            <td width="18" height="15" bgcolor="#e4f0f8" align="right"><a href="Function reference3_2.html"><img src="images/rightarrow.png" border="0" alt="next page"/></a></td>
73         </tr>
74      </table>
75      <font face="Arial" bgcolor="#e4f0f8" size="normal" underline="0" color="#000000">&copy; 2011 The MathWorks Ltd</font>
76      <TT>&#149; </TT><a href="matlab: helpview([matlabroot,'/license.txt'])">Terms of Use</a>
77      <TT>&#149; </TT><a href="matlab: helpview([matlabroot,'/patents.txt'])">Patents</a>
78      <TT>&#149; </TT><a href="matlab: helpview([matlabroot,'/trademarks.txt'])">Trademarks</a>
79   
80   </body>
81</html>
82       
Note: See TracBrowser for help on using the repository browser.