93 lines
3.4 KiB
Text
93 lines
3.4 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 {
|
|
|
|
/** provides access to a dynamic, homogeneous, nonhierarchical set of values
|
|
or objects.
|
|
|
|
<p>Also provides information about the template for elements.
|
|
Allows normalizing externally generated names.
|
|
</p>
|
|
|
|
<p><em>Sets</em> are dynamic containers.</p>
|
|
|
|
<p>The number and names of contained elements is not fixed in advance,
|
|
but all elements have to be of one predetermined type.
|
|
</p>
|
|
*/
|
|
published service SimpleSetAccess
|
|
{
|
|
/** is the basic service for accessing child and descendent nodes.
|
|
|
|
<p>External names from foreign namespaces should be normalized using
|
|
com::sun::star::util::XStringEscape::escapeString(),
|
|
if available, before using them as element names.
|
|
</p>
|
|
*/
|
|
interface com::sun::star::container::XNameAccess;
|
|
|
|
/** provides additional information about the element type. [optional]
|
|
|
|
<p>All set elements, if they are not just simple values, but whole trees,
|
|
must have a predetermined structure (their <em>type</em>)
|
|
that is described by and can be generated from a <em>template</em>.
|
|
The semantics of the information provided about the template depends on the
|
|
implementation.
|
|
</p>
|
|
|
|
<p>This interface may be missing, if the implementation can support only
|
|
one predefined type or if the elements are of a simple type and
|
|
no further information is available. In the latter case,
|
|
com::sun::star::container::XElementAccess::getElementType()
|
|
provides all the information there is about the element's type.
|
|
</p>
|
|
*/
|
|
[optional] interface com::sun::star::configuration::XTemplateContainer;
|
|
|
|
/** allows normalizing and denormalizing external names. [optional]
|
|
|
|
<p>Elements of a <em>set</em> often correspond to external entities,
|
|
for example, files, web pages, and people whose names obey different rules and
|
|
restrictions than names that are valid in the hierarchical naming scheme.
|
|
</p>
|
|
|
|
<p>This interface may be missing if there are no naming restrictions,
|
|
if the implementation handles any such conversions internally,
|
|
or if clients must enforce such restrictions themselves. In the last case,
|
|
the naming scheme documentation must fully document any restrictions.
|
|
</p>
|
|
*/
|
|
[optional] interface com::sun::star::util::XStringEscape;
|
|
|
|
/** allows attaching listeners to this node to monitor changes to the set. [optional]
|
|
|
|
<p>This interface may be missing if the implementation does not support
|
|
notifications.
|
|
</p>
|
|
*/
|
|
[optional] interface com::sun::star::container::XContainer;
|
|
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|