source: MML/trunk/machine/SOLEIL/common/toolbox/GUILayout/layoutHelp/Function reference1_1.html @ 17

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

To have a stable version on the server.

  • Property svn:executable set to *
File size: 14.5 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.Panel</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 reference.html"><IMG SRC="Images/leftarrow.png" BORDER="0" ALT="previous page"/></A><A HREF="Function reference1_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>1.1: uiextras.Panel&nbsp;<a href="Function reference.html#1"><img src="Images/uparrow.png" border="0" align="top" alt="Go back up one level"/></a></h2>
23     
24             
25             <img src="Images/bigicon_Panel.png" align="left"/>
26             <br clear="all"/>
27             <p>Arrange a single element inside a standard panel</p>
28                          <dl>
29                 <dt><code class="OUTARG">obj</code><code class="FUNCTION"> = uiextras.Panel(</code><code class="FUNCTION">&nbsp;)</code></dt>
30                 <dd>creates a standard <a href="matlab:doc uipanel"><code class="FUNCTION">uipanel</code></a> object but with automatic management
31                 of the contained widget or layout. The properties available are largely
32                 the same as the builtin <a href="matlab:doc uipanel"><code class="FUNCTION">uipanel</code></a> object. Where more than one child is
33                 added, the currently visible child is determined using the SelectedChild property.</dd>
34                 
35                 <dt><code class="OUTARG">obj</code><code class="FUNCTION"> = uiextras.Panel(</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>
36                 <dd>also sets one or more property values.</dd>
37                 
38             </dl>
39             
40                   
41             <h3>uiextras.Panel properties</h3>
42                 <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>BorderType&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[ none | etchedin | etchedout | beveledin | beveledout | line ]</value></td><td valign="top" class="PROPERTYTABLE"><description>Type of border around the uipanel area.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>BorderWidth&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>positive integer</value></td><td valign="top" class="PROPERTYTABLE"><description>Width of the panel border.</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>FontAngle&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[ normal | italic | oblique ]</value></td><td valign="top" class="PROPERTYTABLE"><description>Title font angle.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>FontName&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>string</value></td><td valign="top" class="PROPERTYTABLE"><description>Title font name (e.g. Arial, Helvetica etc).</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>FontSize&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>positive integer</value></td><td valign="top" class="PROPERTYTABLE"><description>Title font size.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>FontUnits&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[ inches | centimeters | normalized | points | pixels ]</value></td><td valign="top" class="PROPERTYTABLE"><description>Title font units for measuring size.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>FontWeight&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[ light | normal | demi | bold ]</value></td><td valign="top" class="PROPERTYTABLE"><description>Title font weight.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>ForegroundColor&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>Title font color and/or color of 2-D border line.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>HighlightColor&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>3-D frame highlight color.</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>SelectedChild&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>positive integer or empty</value></td><td valign="top" class="PROPERTYTABLE"><description>Which child is visible.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>ShadowColor&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>3-D frame shadow color.</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>Title&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>string</value></td><td valign="top" class="PROPERTYTABLE"><description>Title string.</description></td></tr><tr><td valign="top" class="PROPERTYTABLE"><code>TitlePosition&nbsp;</code></td><td valign="top" class="PROPERTYTABLE"><value>[ lefttop | centertop | righttop | leftbottom | centerbottom | rightbottom ]</value></td><td valign="top" class="PROPERTYTABLE"><description>Location of title string in relation to the panel.</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>                 
43             
44             <h3>For example:</h3>
45                     <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>();
46<!--&gt;&gt; -->p = <a href="uiextras.Panel.html"><code class="FUNCTION">uiextras.Panel</code></a>( <code class="STRING">'Parent'</code>, f, <code class="STRING">'Title'</code>, <code class="STRING">'A Panel'</code>, <code class="STRING">'Padding'</code>, 5 );
47<!--&gt;&gt; --><a href="matlab:doc uicontrol"><code class="FUNCTION">uicontrol</code></a>( <code class="STRING">'Parent'</code>, p, <code class="STRING">'Background'</code>, <code class="STRING">'r'</code> )</font></pre>
48                     <p style="background-color: #ddddee; margin-left: 20px; margin-right: 20px"><font color="#000022">
49                         <center><img src="Images/Panel.png"/></center>
50                     </font></p>
51                 
52                     <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>();
53<!--&gt;&gt; -->p = <a href="uiextras.Panel.html"><code class="FUNCTION">uiextras.Panel</code></a>( <code class="STRING">'Parent'</code>, f, <code class="STRING">'Title'</code>, <code class="STRING">'A Panel'</code>, <code class="STRING">'TitlePosition'</code>, 'CenterTop');
54<!--&gt;&gt; -->b = <a href="uiextras.HBox.html"><code class="FUNCTION">uiextras.HBox</code></a>( <code class="STRING">'Parent'</code>, p, <code class="STRING">'Spacing'</code>, 5, <code class="STRING">'Padding'</code>, 5  );
55<!--&gt;&gt; --><a href="matlab:doc uicontrol"><code class="FUNCTION">uicontrol</code></a>( 'Style', 'listbox', <code class="STRING">'Parent'</code>, b, <code class="STRING">'String'</code>, {<code class="STRING">'Item 1'</code>,<code class="STRING">'Item 2'</code>} );
56<!--&gt;&gt; --><a href="matlab:doc uicontrol"><code class="FUNCTION">uicontrol</code></a>( <code class="STRING">'Parent'</code>, b, <code class="STRING">'Background'</code>, <code class="STRING">'b'</code> );
57<!--&gt;&gt; --><a href="matlab:doc set"><code class="FUNCTION">set</code></a>( b, <code class="STRING">'Sizes'</code>, [100 -1] );</font></pre>         
58                     <p style="background-color: #ddddee; margin-left: 20px; margin-right: 20px"><font color="#000022">
59                         <center><img src="Images/Panel2.png"/></center>
60                     </font></p>
61                 
62             
63             <br/><b>See also:</b><ul><li><code class="FUNCTION"><a href="uiextras.BoxPanel.html">uiextras.BoxPanel</a></code> - for creating a more boxy panel</li><li><code class="FUNCTION"><a href="uiextras.TabPanel.html">uiextras.TabPanel</a></code> - for a panel with tabs for selecting the visible child</li><li><code class="FUNCTION"><a href="uiextras.HBox.html">uiextras.HBox</a></code> - for creating a horizontal arrangement within a panel</li></ul>
64     
65     
66      <br clear="ALL"/>
67      <table class="footer" width="100%" border="0" cellspacing="0" cellpadding="0">
68         <tr>
69            <td width="18" height="15" bgcolor="#e4f0f8" align="left"><a href="Function reference.html"><img src="images/leftarrow.png" border="0" alt="previous page"/></a></td>
70            <td width="40%" height="15" bgcolor="#e4f0f8" align="left"><a href="Function reference.html"><font face="arial" bgcolor="#e4f0f8" size="normal" underline="0" color="#000000">Function reference</font></a></td>
71            <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>
72            <td width="40%" height="15" bgcolor="#e4f0f8" align="right"><a href="Function reference1_2.html"><font face="arial" bgcolor="#e4f0f8" size="normal" underline="0" color="#000000">uiextras.CardPanel</font></a></td>
73            <td width="18" height="15" bgcolor="#e4f0f8" align="right"><a href="Function reference1_2.html"><img src="images/rightarrow.png" border="0" alt="next page"/></a></td>
74         </tr>
75      </table>
76      <font face="Arial" bgcolor="#e4f0f8" size="normal" underline="0" color="#000000">&copy; 2011 The MathWorks Ltd</font>
77      <TT>&#149; </TT><a href="matlab: helpview([matlabroot,'/license.txt'])">Terms of Use</a>
78      <TT>&#149; </TT><a href="matlab: helpview([matlabroot,'/patents.txt'])">Patents</a>
79      <TT>&#149; </TT><a href="matlab: helpview([matlabroot,'/trademarks.txt'])">Trademarks</a>
80   
81   </body>
82</html>
83       
Note: See TracBrowser for help on using the repository browser.