<html> <head> <title>Constants' Group FrameSearchFlag</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="navimainnone">Use</td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Handling_Documents#Target_Frame" 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="#Constants" class="navisub">Constants</a></td> <td class="navisub"><a href="#ConstantDetails" class="navisub">Constants' 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">constants group FrameSearchFlag</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>these types describe the algorithm to be used to search a frame </dd> <dd><p> Such flags will be used on methods <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#findFrame">findFrame()</a>, <a href="XDispatchProvider.html">XDispatchProvider</a>::<a href="XDispatchProvider.html#queryDispatch">queryDispatch()</a> or <a href="XComponentLoader.html">XComponentLoader</a>::<a href="XComponentLoader.html#loadComponentFromURL">loadComponentFromURL()</a> if no special target frame name (e.g. "_blank", "_self") is used. </p> </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#findFrame">findFrame()</a>, <a href="XDispatchProvider.html">XDispatchProvider</a>::<a href="XDispatchProvider.html#queryDispatch">queryDispatch()</a>, <a href="XComponentLoader.html">XComponentLoader</a>::<a href="XComponentLoader.html#loadComponentFromURL">loadComponentFromURL()</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/Handling_Documents#Target_Frame">OfficeDev - Handling Documents - Loading Documents - Target Frame</a></dd> </dl> </td> </tr> </table> <hr> <a name="Constants"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constants</td> </tr> <tr> <td class="imsum_left"><a href="#AUTO">AUTO</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b>no longer supported </td> </tr> <tr> <td class="imsum_left"><a href="#PARENT">PARENT</a></td> <td class="imsum_right">allows search on the parent frames </td> </tr> <tr> <td class="imsum_left"><a href="#SELF">SELF</a></td> <td class="imsum_right">includes the start frame himself </td> </tr> <tr> <td class="imsum_left"><a href="#CHILDREN">CHILDREN</a></td> <td class="imsum_right">includes all child frames of the start frame </td> </tr> <tr> <td class="imsum_left"><a href="#CREATE">CREATE</a></td> <td class="imsum_right">frame will be created if not found </td> </tr> <tr> <td class="imsum_left"><a href="#SIBLINGS">SIBLINGS</a></td> <td class="imsum_right">includes the direct siblings of the start frame </td> </tr> <tr> <td class="imsum_left"><a href="#TASKS">TASKS</a></td> <td class="imsum_right">allow the search outside the current sub task tree of the whole possible frame tree </td> </tr> <tr> <td class="imsum_left"><a href="#ALL">ALL</a></td> <td class="imsum_right">includes all frames except frames in other tasks sub trees but doesn't create any new frame </td> </tr> <tr> <td class="imsum_left"><a href="#GLOBAL">GLOBAL</a></td> <td class="imsum_right">searches in the whole hierarchy of frames but doesn't create any new frame </td> </tr> </table> <a name="ConstantDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Constants' Details</td> </tr> <tr> <td class="imdetail"><a name="AUTO" class="membertitle">AUTO</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>AUTO</b> = 0;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Description</b></dt> <dd>no longer supported </dd> <dd><p> Using of this flag will do nothing. Use right combination of other flags instead of this one. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PARENT" class="membertitle">PARENT</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>PARENT</b> = 1;<hr> <dl> <dt><b>Description</b></dt> <dd>allows search on the parent frames </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SELF" class="membertitle">SELF</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>SELF</b> = 2;<hr> <dl> <dt><b>Description</b></dt> <dd>includes the start frame himself </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CHILDREN" class="membertitle">CHILDREN</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>CHILDREN</b> = 4;<hr> <dl> <dt><b>Description</b></dt> <dd>includes all child frames of the start frame </dd> <dd><p> Note: That means all direct children and of course her children too. Search doesn't stop at the next level inside the tree! </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CREATE" class="membertitle">CREATE</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>CREATE</b> = 8;<hr> <dl> <dt><b>Description</b></dt> <dd>frame will be created if not found </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SIBLINGS" class="membertitle">SIBLINGS</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>SIBLINGS</b> = 16;<hr> <dl> <dt><b>Description</b></dt> <dd>includes the direct siblings of the start frame </dd> <dd><p> Normally it's interpreted as search on the direct children of the parent only. But in combination with e.g. the CHILDREN flag it can include all children of it too. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TASKS" class="membertitle">TASKS</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>TASKS</b> = 32;<hr> <dl> <dt><b>Description</b></dt> <dd>allow the search outside the current sub task tree of the whole possible frame tree </dd> <dd><p> If this flag isn't present, any search from bottom to top has to stop, if a top frame will be reached. It doesn't influence a search from top to bottom. But it can be used at the root of the frame tree to search on direct children of it only. Because the direct children of the root node are the root's of the task sub trees, which are top frames too. Instead of using the CHILDREN flag there, it's possible so to suppress a deeper search so. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ALL" class="membertitle">ALL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>ALL</b> = 23;<hr> <dl> <dt><b>Description</b></dt> <dd>includes all frames except frames in other tasks sub trees but doesn't create any new frame </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="GLOBAL" class="membertitle">GLOBAL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>GLOBAL</b> = 55;<hr> <dl> <dt><b>Description</b></dt> <dd>searches in the whole hierarchy of frames but doesn't create any new frame </dd> </dl> </td> </tr> </table> </td> </tr> </table> <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>
