73 lines
2.7 KiB
Text
73 lines
2.7 KiB
Text
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
|
|
module com { module sun { module star { module configuration { module backend {
|
|
|
|
|
|
/**
|
|
is a HierarchyBrowser, that browses a configuration database
|
|
stored in the local file system.
|
|
|
|
@see com::sun::star::configuration::backend::LocalSingleBackend
|
|
|
|
@since OOo 1.1.2
|
|
*/
|
|
published service LocalHierarchyBrowser
|
|
{
|
|
|
|
/** allows browsing a configuration hierarchy for components.
|
|
|
|
<p> Either a schema repository or a layer directory can be browsed.
|
|
Components can be retrieved either as component names or as
|
|
file URLs.
|
|
</p>
|
|
|
|
<p> The following additional arguments are supported for
|
|
com::sun::star::task::XJob::execute():<BR/>
|
|
|
|
<dl>
|
|
<dt><code>SchemaDataUrl</code> : `string`</dt>
|
|
<dd>Base directory to search for schema files.
|
|
If this is specified, schema files will be browsed,
|
|
so argument <code>LayerDataUrl</code> should not be specified.
|
|
</dd>
|
|
<dt><code>LayerDataUrl</code> : `string`</dt>
|
|
<dd>Base directory to search for layer files.
|
|
If this is specified, layer files will be browsed,
|
|
so argument <code>SchemaDataUrl</code> should not be specified.
|
|
</dd>
|
|
<dt><code>FetchComponentNames</code> : `boolean`</dt>
|
|
<dd><ul><li>if `TRUE` components will be returned as component names,</li>
|
|
<li>if `FALSE` components will be returned as fileURLs,</li>
|
|
<li>if this argument is not provided, the default is to
|
|
retrieve names when browsing schemas and URLs when
|
|
browsing layers.</li>
|
|
</dd>
|
|
</dl>
|
|
</p>
|
|
*/
|
|
service HierarchyBrowser ;
|
|
|
|
} ;
|
|
|
|
|
|
} ; } ; } ; } ; } ;
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|