<html> <head> <title>Interface XFolderPicker</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="XFolderPicker-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">ui</a> :: <a href="module-ix.html" class="namechain">dialogs</a> :: </p> </td> </tr> <tr> <td class="title">interface XFolderPicker</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XFolderPicker</strong> ┗ <a href="XExecutableDialog.html">XExecutableDialog</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XExecutableDialog.html">XExecutableDialog</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Specifies an interface for an executable dialog. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Specifies a FolderPicker interface. </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="#setDisplayDirectory">setDisplayDirectory</a></td> <td class="imsum_right">Sets the root directory that the FolderPicker should display. It is not specified which root directory the FolderPicker chooses if the specified root directory doesn't exist. </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayDirectory">getDisplayDirectory</a></td> <td class="imsum_right">Returns the root directory that the FolderPicker is showing. The return value is undefined if the client did not choose a root directory or the previously specified root directory doesn't exist. </td> </tr> <tr> <td class="imsum_left"><a href="#getDirectory">getDirectory</a></td> <td class="imsum_right">Returns the selected directory as url conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#setDescription">setDescription</a></td> <td class="imsum_right">The implementation may optionally show the given text as a description for the user within the dialog, e.g. "Please select a directory". If the client doesn't set a description the dialog may show a default description. </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="setDisplayDirectory" class="membertitle">setDisplayDirectory</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>setDisplayDirectory</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aDirectory )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Sets the root directory that the FolderPicker should display. It is not specified which root directory the FolderPicker chooses if the specified root directory doesn't exist. </dd> <dt><b>Parameter aDirectory</b></dt> <dd>Specifies the root directory in url format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given url is invalid. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayDirectory" class="membertitle">getDisplayDirectory</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">string</td> </tr> <tr> <td valign="top"><b>getDisplayDirectory</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the root directory that the FolderPicker is showing. The return value is undefined if the client did not choose a root directory or the previously specified root directory doesn't exist. </dd> <dt><b>Returns</b></dt> <dd>The directory in url format. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDirectory" class="membertitle">getDirectory</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">string</td> </tr> <tr> <td valign="top"><b>getDirectory</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the selected directory as url conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. </dd> <dt><b>Returns</b></dt> <dd>The selected directory as url if the user did close the dialog with Ok else the returned value is undefined. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setDescription" class="membertitle">setDescription</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>setDescription</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aDescription );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The implementation may optionally show the given text as a description for the user within the dialog, e.g. "Please select a directory". If the client doesn't set a description the dialog may show a default description. </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>
