<html>
<head>
<title>Service Frame</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="Frame-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="#ServicesSummary" class="navisub">Services' Summary</a></td>
<td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td>
<td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td>
<td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td>
<td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td>
<td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></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">service Frame</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>represents the environment for a desktop component
</dd>
<dd><p>
Frames are the anchors for the office components and they are the component's link
to the outside world. They create a skeleton for the whole office API infrastructure
by building frame hierarchies. These hierarchies contains all currently loaded
documents and make it possible to walk during these trees.
A special service <a href="Desktop.html">Desktop</a> can(!) combine different of such trees
to a global one which life time will be controlled by it.
</p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="Desktop.html">Desktop</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/Creating_Frames_Manually#Frame_Creation">OfficeDev - Creating Frames Manually - Frame Creation</a></dd>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Frames#Linking_Components_and_Windows">OfficeDev - Frames - Linking Components and Windows</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Included Services - Summary</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../xml/module-ix.html">xml</a>::<a href="../xml/UserDefinedAttributesSupplier.html">UserDefinedAttributesSupplier</a></td>
<td class="imsum_right"><p>contains user defined attributes.
(<a href="#UserDefinedAttributesSupplier">details</a>)</p>
</td>
</tr>
</table>
<a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="XFrame.html">XFrame</a></td>
<td class="imsum_right"><p>allows the component to be loaded and accessed
within the frame; it is the main connection to the
environment of the component.
</p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XDispatchProvider.html">XDispatchProvider</a></td>
<td class="imsum_right"><p>provides access to dispatchers for the frame.
(<a href="#XDispatchProvider">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XDispatchInformationProvider.html">XDispatchInformationProvider</a></td>
<td class="imsum_right"><p>provides information about supported commands
(<a href="#XDispatchInformationProvider">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XDispatchProviderInterception.html">XDispatchProviderInterception</a></td>
<td class="imsum_right"><p>supports interception mechanism for dispatched URLs
(<a href="#XDispatchProviderInterception">details</a>)</p>
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XFramesSupplier.html">XFramesSupplier</a></td>
<td class="imsum_right"><p>provides access to sub frames within this frame
</p>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XStatusIndicatorFactory.html">XStatusIndicatorFactory</a></td>
<td class="imsum_right"><p>supplies access to ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XStatusIndicator.html">XStatusIndicator</a> objects
for the component within the frame to show progresses
(<a href="#XStatusIndicatorFactory">details</a>)</p>
</td>
</tr>
</table>
<a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Properties' Summary</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#Title">Title</a></td>
<td class="imsum_right">if possible it sets/gets the UI title on/from the frame container window
</td>
</tr>
<tr>
<td class="imsum_left"><a href="XDispatchRecorderSupplier.html">XDispatchRecorderSupplier</a><br>
<a href="#RecorderSupplier">RecorderSupplier</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>provides access to the dispatch recorder of the frame
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a><br>
<a href="#LayoutManager">LayoutManager</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>provides access to the <a href="LayoutManager.html">LayoutManager</a> of the frame.
</td>
</tr>
</table>
<a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Included Services - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="UserDefinedAttributesSupplier" class="membertitle">::com::sun::star::<a href="../xml/module-ix.html">xml</a>::<a href="../xml/UserDefinedAttributesSupplier.html">UserDefinedAttributesSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains user defined attributes.
</dd>
<dt><b>See also</b></dt>
<dd>::com::sun::star::<a href="../xml/module-ix.html">xml</a>::<a href="../xml/UserDefinedAttributesSupplier.html">UserDefinedAttributesSupplier</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces - Details</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XFrame" class="membertitle"><a href="XFrame.html">XFrame</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>allows the component to be loaded and accessed
within the frame; it is the main connection to the
environment of the component.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XDispatchProvider" class="membertitle"><a href="XDispatchProvider.html">XDispatchProvider</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to dispatchers for the frame.
</dd>
<dd><p>
What kind of URLs a frame accepts in the calls to <a href="XDispatchProvider.html">XDispatchProvider</a>::<a href="XDispatchProvider.html#queryDispatch">queryDispatch()</a>,
and how the returned dispatcher handles dispatches is completely implementation dependent
(though of course the restrictions of <a href="XDispatchProvider.html">XDispatchProvider</a> must be met).
Frame implementations may (optionally) support special targets in the call to
<a href="XDispatchProvider.html">XDispatchProvider</a>::<a href="XDispatchProvider.html#queryDispatch">queryDispatch()</a>.
Such special targets are passed as target frame name. They may, in addition,
require special frame search flags (see <a href="FrameSearchFlag.html">FrameSearchFlag</a>), or,
in opposite, limit the set of allowed flags.<br>
Common special targets include:
<ul>
<li><b>_blank</b><br> is used to create a new frame when dispatching the URL.</li>
<li><b>_default</b><br> is used to recycle empty or create a new frame when dispatching the URL.</li>
<li><b>_self</b><br> forces the frame to dispatch the URL into itself. ("" means the same)</li>
<li><b>_parent</b><br> dispatches the URL into the parent frame.</li>
<li><b>_top</b><br> dispatches the URL into the top level frame, the frame where this is invoked belongs to.</li>
</ul>
</p>
</dd>
<dt><b>See also</b></dt>
<dd><a href="XDispatch.html">XDispatch</a>, <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#findFrame">findFrame()</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XDispatchInformationProvider" class="membertitle"><a href="XDispatchInformationProvider.html">XDispatchInformationProvider</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>provides information about supported commands
</dd>
<dt><b>Since </b></dt>
<dd>OOo 2.0 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XDispatchProviderInterception" class="membertitle"><a href="XDispatchProviderInterception.html">XDispatchProviderInterception</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>supports interception mechanism for dispatched URLs
</dd>
<dd><p>
Registered objects can intercept, suppress or reroute dispatched URLs.
If they support another interface too (<a href="XInterceptorInfo.html">XInterceptorInfo</a>)
it's possible to perform it by directly calling of right interceptor without
using list of all registered ones.
</p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XFramesSupplier" class="membertitle"><a href="XFramesSupplier.html">XFramesSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to sub frames within this frame
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr/>
<tr>
<td class="imdetail"><a name="XStatusIndicatorFactory" class="membertitle">::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XStatusIndicatorFactory.html">XStatusIndicatorFactory</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>supplies access to ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XStatusIndicator.html">XStatusIndicator</a> objects
for the component within the frame to show progresses
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Properties' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="Title" class="membertitle">Title</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>Title</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>if possible it sets/gets the UI title on/from the frame container window
</dd>
<dd><p>
It depends from the type of the frame container window. If it is a system
task window all will be OK. Otherwise the title can't be set.
Setting/getting of the pure value of this property must be possible in every
case. Only showing on the UI can be fail.
</p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="RecorderSupplier" class="membertitle">RecorderSupplier</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><a href="XDispatchRecorderSupplier.html">XDispatchRecorderSupplier</a> <b>RecorderSupplier</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>provides access to the dispatch recorder of the frame
</dd>
<dd><p>
Such recorder can be used to record dispatch requests.
The supplier contains a dispatch recorder and provide the functionality
to use it for any dispatch object from outside which supports the interface
<a href="XDispatch.html">XDispatch</a>. A supplier is available only, if recording was enabled.
That means: if someone wishes to enable recoding on a frame he must set
a supplier with a recorder object inside of it. Every user of dispatches
has to check then if such supplier is available at this frame property.
If value of this property is <b>NULL</b> he must call <a href="XDispatch.html">XDispatch</a>::<a href="XDispatch.html#dispatch">dispatch()</a>
on the original dispatch object. If it's a valid value he must use the supplier
by calling his method <a href="XDispatchRecorderSupplier.html">XDispatchRecorderSupplier</a>::<a href="XDispatchRecorderSupplier.html#dispatchAndRecord">dispatchAndRecord()</a>
with the original dispatch object as argument.
</p>
<p>
Note:<br>
It's not recommended to cache an already gotten supplier. Because there exist
no possibility to check for enabled/disabled recording then.
</p>
</dd>
<dt><b>Since </b></dt>
<dd>OOo 1.1.2 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="LayoutManager" class="membertitle">LayoutManager</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a> <b>LayoutManager</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>provides access to the <a href="LayoutManager.html">LayoutManager</a> of the frame.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>
