<html>
<head>
<link rel="stylesheet" href="page.css" type="text/css">
<title>fox-toolkit.org - Documentation</title>
</head>
<body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000>
<font face='verdana,sans-serif' size=2 >
<!---- TOPIC TITLE WITH LOGO--->
<table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a>
<br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table>
<p>
<!--- TOPIC TITLE WITH LOGO --->
<!-- Generated by Doxygen 1.3.3 -->
<h1>FX::FXSpring Class Reference</h1>The spring widgets, when properly embedded side by side in a horizontal frame or vertical frame widget, behave like a set of connected springs of various lengths (hence the name!).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="FXSpring_8h-source.html">FXSpring.h</a>></code>
<p>
<p>Inheritance diagram for FX::FXSpring:
<p><center><img src="classFX_1_1FXSpring.png" usemap="#FX::FXSpring_map" border="0" alt=""></center>
<map name="FX::FXSpring_map">
<area href="classFX_1_1FXPacker.html" alt="FX::FXPacker" shape="rect" coords="0,280,110,304">
<area href="classFX_1_1FXComposite.html" alt="FX::FXComposite" shape="rect" coords="0,224,110,248">
<area href="classFX_1_1FXWindow.html" alt="FX::FXWindow" shape="rect" coords="0,168,110,192">
<area href="classFX_1_1FXDrawable.html" alt="FX::FXDrawable" shape="rect" coords="0,112,110,136">
<area href="classFX_1_1FXId.html" alt="FX::FXId" shape="rect" coords="0,56,110,80">
<area href="classFX_1_1FXObject.html" alt="FX::FXObject" shape="rect" coords="0,0,110,24">
</map>
<a href="classFX_1_1FXSpring-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXSpring.html#a0">FXSpring</a> (<a class="el" href="classFX_1_1FXComposite.html">FXComposite</a> *p, FXuint opts=0, FXint relw=0, FXint relh=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_SPACING, FXint pr=DEFAULT_SPACING, FXint pt=DEFAULT_SPACING, FXint pb=DEFAULT_SPACING, FXint hs=DEFAULT_SPACING, FXint vs=DEFAULT_SPACING)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual FXint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXSpring.html#a1">getDefaultWidth</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual FXint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXSpring.html#a2">getDefaultHeight</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXSpring.html#a3">setRelativeWidth</a> (FXint relw)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>FXint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXSpring.html#a4">getRelativeWidth</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXSpring.html#a5">setRelativeHeight</a> (FXint relh)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>FXint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXSpring.html#a6">getRelativeHeight</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXSpring.html#a7">save</a> (<a class="el" href="classFX_1_1FXStream.html">FXStream</a> &store) const</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXSpring.html#a8">load</a> (<a class="el" href="classFX_1_1FXStream.html">FXStream</a> &store)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The spring widgets, when properly embedded side by side in a horizontal frame or vertical frame widget, behave like a set of connected springs of various lengths (hence the name!).
<p>
The parameters relw (or relh) determines the length of the spring. The actual length is not really important; the only thing that counts is the relative length of one spring widget to that of another, although the length does determine the default size. The special value zero may be given for relw (or relh) to cause the spring to calculate its default width (height) normally, just like the Packer base class does. In a typical scenario, either the relative width or height is set to zero, an the flag LAYOUT_FILL_X or LAYOUT_FILL_Y is passed. When placed inside a horizontal frame, the LAYOUT_FILL_X together with the relative widths of the springs will cause a fixed width-ratio between the springs. You also can mix normal controls and springs together in a horizontal or vertical frames to provide arbitrary stretchable spacing between widgets; in this case, the springs do not need to have any children. Since the spring widget is derived from the packer layout manager, it provides the same layout behavior as packer.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="FX::FXSpring::FXSpring"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FX::FXSpring::FXSpring </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classFX_1_1FXComposite.html">FXComposite</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXuint </td>
<td class="mdname" nowrap> <em>opts</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>relw</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>relh</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>x</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>y</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>w</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>h</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>pl</em> = DEFAULT_SPACING, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>pr</em> = DEFAULT_SPACING, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>pt</em> = DEFAULT_SPACING, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>pb</em> = DEFAULT_SPACING, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>hs</em> = DEFAULT_SPACING, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FXint </td>
<td class="mdname" nowrap> <em>vs</em> = DEFAULT_SPACING</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct packer layout manager.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a1" doxytag="FX::FXSpring::getDefaultWidth"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual FXint FX::FXSpring::getDefaultWidth </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return default width.
<p>
<p>
Reimplemented from <a class="el" href="classFX_1_1FXPacker.html#a1">FX::FXPacker</a>. </td>
</tr>
</table>
<a name="a2" doxytag="FX::FXSpring::getDefaultHeight"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual FXint FX::FXSpring::getDefaultHeight </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return default height.
<p>
<p>
Reimplemented from <a class="el" href="classFX_1_1FXPacker.html#a2">FX::FXPacker</a>. </td>
</tr>
</table>
<a name="a3" doxytag="FX::FXSpring::setRelativeWidth"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void FX::FXSpring::setRelativeWidth </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">FXint </td>
<td class="mdname1" valign="top" nowrap> <em>relw</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Change relative width.
<p>
</td>
</tr>
</table>
<a name="a4" doxytag="FX::FXSpring::getRelativeWidth"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FXint FX::FXSpring::getRelativeWidth </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return relative width.
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="FX::FXSpring::setRelativeHeight"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void FX::FXSpring::setRelativeHeight </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">FXint </td>
<td class="mdname1" valign="top" nowrap> <em>relh</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Change relative height.
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="FX::FXSpring::getRelativeHeight"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FXint FX::FXSpring::getRelativeHeight </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return relative height.
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="FX::FXSpring::save"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void FX::FXSpring::save </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classFX_1_1FXStream.html">FXStream</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>store</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Save to stream.
<p>
<p>
Reimplemented from <a class="el" href="classFX_1_1FXPacker.html#a29">FX::FXPacker</a>. </td>
</tr>
</table>
<a name="a8" doxytag="FX::FXSpring::load"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void FX::FXSpring::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classFX_1_1FXStream.html">FXStream</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>store</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Load from stream.
<p>
<p>
Reimplemented from <a class="el" href="classFX_1_1FXPacker.html#a30">FX::FXPacker</a>. </td>
</tr>
</table>
</font>
<!--- COPYRIGHT -->
<p>
<table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right>
<img src='../art/line.gif' width=100% height=1><font size=-1>
Copyright © 1997-2004 Jeroen van der Zijp</font>
</td></tr></table>
</p>
<!--- COPYRIGHT -->
</body>
</html>
