Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 3502

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XFramesSupplier</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XFramesSupplier-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">frame</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XFramesSupplier</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XFramesSupplier</strong>
&#x2517 <a href="XFrame.html">XFrame</a>
   &#x2517 ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XFrame.html">XFrame</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>a frame object can be considered to be an "anchor" object where a component
 can be attached to.

 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to sub frames of current one

 </dd>
<dt><b>See also</b></dt>
<dd><a href="XFrames.html">XFrames</a></dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Component/Frames#XFramesSupplier">OfficeDev - Component - Frames - XFramesSupplier</a></dd>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Creating_Frames_Manually#Setting_Components_into_Frame_Hierarchies">OfficeDev - Creating Frames Manually - Setting Components into Frame Hierarchies</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFrames">getFrames</a></td>
<td class="imsum_right">provides access to this container and to all other <a href="XFramesSupplier.html">XFramesSupplier</a>
 which are available from this node of frame tree

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getActiveFrame">getActiveFrame</a></td>
<td class="imsum_right">gets the current active frame of this container
 (not of any other available supplier)

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setActiveFrame">setActiveFrame</a></td>
<td class="imsum_right">is called on activation of a direct sub-frame.

 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getFrames" class="membertitle">getFrames</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="XFrames.html">XFrames</a></td>
</tr>
<tr>
<td valign="top"><b>getFrames</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides access to this container and to all other <a href="XFramesSupplier.html">XFramesSupplier</a>
 which are available from this node of frame tree

 </dd>
<dt><b>Returns</b></dt>
<dd>the collection of frames which is represented by
 a <a href="FramesContainer.html">FramesContainer</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getActiveFrame" class="membertitle">getActiveFrame</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="XFrame.html">XFrame</a></td>
</tr>
<tr>
<td valign="top"><b>getActiveFrame</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets the current active frame of this container
 (not of any other available supplier)

 </dd>
<dd><p>
 This may be the frame itself. The active frame is defined as
 the frame which contains (recursively) the window with the focus.
 If no window within the frame contains the focus, this method
 returns the last frame which had the focus. If no containing
 window ever had the focus, the first frame within this frame is
 returned.
 </p>

 </dd>
<dt><b>Returns</b></dt>
<dd>the <a href="Frame.html">Frame</a> which is active within this frame.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setActiveFrame" class="membertitle">setActiveFrame</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setActiveFrame</b>(</td>
<td valign="top">[in] <a href="XFrame.html">XFrame</a></td>
<td valign="bottom">&nbsp;Frame );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>is called on activation of a direct sub-frame.

 </dd>
<dd><p>
 This method is only allowed to be called by a sub-frame according to
 <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#activate">activate()</a> or <a href="XFramesSupplier.html">XFramesSupplier</a>::<a href="XFramesSupplier.html#setActiveFrame">setActiveFrame()</a>.
 After this call <a href="XFramesSupplier.html">XFramesSupplier</a>::<a href="XFramesSupplier.html#getActiveFrame">getActiveFrame()</a> will return the
 frame specified by <var>Frame</var>.
 </p>

 <p>
 In general this method first calls the method <a href="XFramesSupplier.html">XFramesSupplier</a>::<a href="XFramesSupplier.html#setActiveFrame">setActiveFrame()</a>
 at the creator frame with <var>this</var> as the current argument. Then it broadcasts
 the <a href="FrameActionEvent.html">FrameActionEvent</a> <b>FrameAction::FRAME_ACTIVATED</b>.
 </p>

 <p>
 Note: Given parameter <var>Frame</var> must already exist inside the container
 (e.g., inserted by using <a href="XFrames.html">XFrames</a>::<a href="XFrames.html#append">append()</a>)
 </p>

 </dd>
<dt><b>Parameter Frame</b></dt>
<dd>the new active child frame inside this container
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>