1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_LocalHierarchyBrowser_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_configuration_backend_LocalHierarchyBrowser_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_HierarchyBrowser_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/configuration/backend/HierarchyBrowser.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir//============================================================================= 35*cdf0e10cSrcweir 36*cdf0e10cSrcweirmodule com { module sun { module star { module configuration { module backend { 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir//============================================================================= 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir/** 41*cdf0e10cSrcweir is a <type>HierarchyBrowser</type>, that browses a configuration database 42*cdf0e10cSrcweir stored in the local file system. 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir @see com::sun::star::configuration::backend::LocalSingleBackend 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir @since OOo 1.1.2 47*cdf0e10cSrcweir*/ 48*cdf0e10cSrcweirpublished service LocalHierarchyBrowser 49*cdf0e10cSrcweir{ 50*cdf0e10cSrcweir //------------------------------------------------------------------------- 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir /** allows browsing a configuration hierarchy for components. 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir <p> Either a schema repository or a layer directory can be browsed. 55*cdf0e10cSrcweir Components can be retrieved either as component names or as 56*cdf0e10cSrcweir file URLs. 57*cdf0e10cSrcweir </p> 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir <p> The following additional arguments are supported for 60*cdf0e10cSrcweir <member scope="com::sun::star::task">XJob::execute()</member>:<BR/> 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir <dl> 63*cdf0e10cSrcweir <dt><code>SchemaDataUrl</code> : <atom>string</atom></dt> 64*cdf0e10cSrcweir <dd>Base directory to search for schema files. 65*cdf0e10cSrcweir If this is specified, schema files will be browsed, 66*cdf0e10cSrcweir so argument <code>LayerDataUrl</code> should not be specified. 67*cdf0e10cSrcweir </dd> 68*cdf0e10cSrcweir <dt><code>LayerDataUrl</code> : <atom>string</atom></dt> 69*cdf0e10cSrcweir <dd>Base directory to search for layer files. 70*cdf0e10cSrcweir If this is specified, layer files will be browsed, 71*cdf0e10cSrcweir so argument <code>SchemaDataUrl</code> should not be specified. 72*cdf0e10cSrcweir </dd> 73*cdf0e10cSrcweir <dt><code>FetchComponentNames</code> : <atom>boolean</atom></dt> 74*cdf0e10cSrcweir <dd><ul><li>if <TRUE/> components will be returned as component names,</li> 75*cdf0e10cSrcweir <li>if <FALSE/> components will be returned as fileURLs,</li> 76*cdf0e10cSrcweir <li>if this argument is not provided, the default is to 77*cdf0e10cSrcweir retrieve names when browsing schemas and URLs when 78*cdf0e10cSrcweir browsing layers.</li> 79*cdf0e10cSrcweir </dd> 80*cdf0e10cSrcweir </dl> 81*cdf0e10cSrcweir </p> 82*cdf0e10cSrcweir */ 83*cdf0e10cSrcweir service HierarchyBrowser ; 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir //------------------------------------------------------------------------- 86*cdf0e10cSrcweir} ; 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir//============================================================================= 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir} ; } ; } ; } ; } ; 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir#endif 93