Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: configuration ::

service SimpleSetAccess
Description
provides access to a dynamic, homogeneous, nonhierarchical set of values or objects.

Also provides information about the template for elements. Allows normalizing externally generated names.

Sets are dynamic containers.

The number and names of contained elements is not fixed in advance, but all elements have to be of one predetermined type.


Exported Interfaces - Summary
::com::sun::star::container::XNameAccess

is the basic service for accessing child and descendent nodes. (details)

XTemplateContainer

provides additional information about the element type. [optional] (details)

::com::sun::star::util::XStringEscape

allows normalizing and denormalizing external names. [optional] (details)

::com::sun::star::container::XContainer

allows attaching listeners to this node to monitor changes to the set. [optional] (details)

Exported Interfaces - Details
::com::sun::star::container::XNameAccess
Description
is the basic service for accessing child and descendent nodes.

External names from foreign namespaces should be normalized using ::com::sun::star::util::XStringEscape::escapeString(), if available, before using them as element names.

XTemplateContainer
Usage Restrictions
optional
Description
provides additional information about the element type. [optional]

All set elements, if they are not just simple values, but whole trees, must have a predetermined structure (their type) that is described by and can be generated from a template. The semantics of the information provided about the template depends on the implementation.

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.

::com::sun::star::util::XStringEscape
Usage Restrictions
optional
Description
allows normalizing and denormalizing external names. [optional]

Elements of a set 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.

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.

::com::sun::star::container::XContainer
Usage Restrictions
optional
Description
allows attaching listeners to this node to monitor changes to the set. [optional]

This interface may be missing if the implementation does not support notifications.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.