LibreOffice
LibreOffice 7.4 SDK API Reference
Included Services | Exported Interfaces | List of all members
GroupAccess Service Referencepublished

provides access to a predefined heterogeneous group of values and nested trees as part of a hierarchy. More...

import"GroupAccess.idl";

Inheritance diagram for GroupAccess:
HierarchyAccess PropertyHierarchy XPropertyState XMultiPropertyStates XInterface XInterface XMultiHierarchicalPropertySet XHierarchicalPropertySet XMultiPropertySet XPropertySet XMultiPropertyStates XPropertyState XPropertySetInfo XExactName XContainer XHierarchicalNameAccess XNameAccess ConfigurationAccess GroupUpdate ConfigurationUpdateAccess ConfigurationUpdateAccess

Included Services

service HierarchyAccess
 is the basic service for accessing child and descendent nodes using a view of the tree as a container of values and structuring elements. More...
 
service PropertyHierarchy
 is the basic service for accessing child and descendent nodes using a view of the tree as a hierarchy of properties and subproperties. More...
 

Exported Interfaces

interface com::sun::star::beans::XPropertyState
 provides access to the state of child elements of an implementation. More...
 
interface com::sun::star::beans::XMultiPropertyStates
 provides access to the states of multiple child elements of an implementation. More...
 
- Exported Interfaces inherited from HierarchyAccess
interface com::sun::star::container::XNameAccess
 allows access to immediate children of this node. More...
 
interface com::sun::star::container::XHierarchicalNameAccess
 allows access to all descendants of this node More...
 
interface com::sun::star::container::XContainer
 allows attaching listeners to this node to monitor changes to immediate child nodes. More...
 
interface com::sun::star::beans::XExactName
 provides support for inexact names. More...
 
interface com::sun::star::beans::XPropertySetInfo
 provides information about immediate children of this node. More...
 
interface com::sun::star::beans::XPropertyState
 provides access to the state of child elements of an implementation. More...
 
interface com::sun::star::beans::XMultiPropertyStates
 provides access to the states of multiple child elements of an implementation. More...
 
- Exported Interfaces inherited from PropertyHierarchy
interface com::sun::star::beans::XPropertySet
 provides access to and information about the immediate properties of an implementation. More...
 
interface com::sun::star::beans::XMultiPropertySet
 provides access to and information about the immediate properties of an implementation. More...
 
interface com::sun::star::beans::XHierarchicalPropertySet
 provides access to and information about the whole hierarchy of properties and subproperties of an implementation. More...
 
interface com::sun::star::beans::XMultiHierarchicalPropertySet
 provides access to and information about the whole hierarchy of properties and subproperties of an implementation. More...
 

Additional Inherited Members

- Public Member Functions inherited from XNameAccess
any getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 
sequence< string > getElementNames ()
 
boolean hasByName ([in] string aName)
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XHierarchicalNameAccess
any getByHierarchicalName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException )
 
boolean hasByHierarchicalName ([in] string aName)
 
- Public Member Functions inherited from XContainer
void addContainerListener ([in] com::sun::star::container::XContainerListener xListener)
 adds the specified listener to receive events when elements are inserted or removed. More...
 
void removeContainerListener ([in] com::sun::star::container::XContainerListener xListener)
 removes the specified listener so it does not receive any events from this container. More...
 
- Public Member Functions inherited from XExactName
string getExactName ([in] string aApproximateName)
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Public Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the values to the properties with the specified names. More...
 
sequence< any > getPropertyValues ([in] sequence< string > aPropertyNames)
 
void addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 adds an XPropertiesChangeListener to the specified property with the specified names. More...
 
void removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
 removes an XPropertiesChangeListener from the listener list. More...
 
void firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 fires a sequence of PropertyChangeEvents to the specified listener. More...
 
- Public Member Functions inherited from XHierarchicalPropertySet
com::sun::star::beans::XHierarchicalPropertySetInfo getHierarchicalPropertySetInfo ()
 retrieve information about the hierarchy of properties More...
 
void setHierarchicalPropertyValue ([in] string aHierarchicalPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified nested name. More...
 
any getHierarchicalPropertyValue ([in] string aHierarchicalPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 
- Public Member Functions inherited from XMultiHierarchicalPropertySet
com::sun::star::beans::XHierarchicalPropertySetInfo getHierarchicalPropertySetInfo ()
 retrieve information about the hierarchy of properties More...
 
void setHierarchicalPropertyValues ([in] sequence< string > aHierarchicalPropertyNames, [in] sequence< any > Values) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the values of the properties with the specified nested names. More...
 
sequence< any > getHierarchicalPropertyValues ([in] sequence< string > aPropertyNames) raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::lang::WrappedTargetException )
 
- Protected Member Functions inherited from XPropertySetInfo
sequence< com::sun::star::beans::PropertygetProperties ()
 
com::sun::star::beans::Property getPropertyByName ([in] string aName) raises ( com::sun::star::beans::UnknownPropertyException )
 
boolean hasPropertyByName ([in] string Name)
 
- Protected Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 Sets the property to default value. More...
 
any getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
- Protected Member Functions inherited from XMultiPropertyStates
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setAllPropertiesToDefault ()
 sets all properties to their default values. More...
 
void setPropertiesToDefault ([in] sequence< string > aPropertyNames) raises ( com::sun::star::beans::UnknownPropertyException )
 sets the specified properties to their default values. More...
 
sequence< any > getPropertyDefaults ([in] sequence< string > aPropertyNames) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 

Detailed Description

provides access to a predefined heterogeneous group of values and nested trees as part of a hierarchy.

Provides access to, and information about, its children and descendants viewed either as properties or as contained elements.

Groups are static collections within the hierarchy.

The number and names of contained elements are fixed in advance and each child may have a different type.

This service subsumes two alternate ways of accessing child and descendent elements. These strongly overlap, supporting the basic identity xGroup.getPropertyValue( aName ) == xGroup.getByName( aName ).

See also
com::sun::star::configuration::GroupElement Child objects of this service generally implement service GroupElement.
com::sun::star::configuration::SetAccess A complementary service providing for dynamic homogeneous sets of elements.

Exported Interfaces

◆ HierarchyAccess

service HierarchyAccess

is the basic service for accessing child and descendent nodes using a view of the tree as a container of values and structuring elements.

◆ PropertyHierarchy

is the basic service for accessing child and descendent nodes using a view of the tree as a hierarchy of properties and subproperties.

This view is meaningful only for a static fragment of the hierarchy Object's properties may change, but not which properties they have. Therefore, dynamic elements of the hierarchy (see SetAccess) do not implement service PropertyHierarchy.

If such elements occur as properties or subproperties of an implementation, it is not specified whether direct subproperty access using com::sun::star::beans::XHierarchicalPropertySet or com::sun::star::beans::XMultiHierarchicalPropertySet can be used to access descendants of such elements.

Similarly, information about such descendants may not be available from the com::sun::star::beans::XHierarchicalPropertySetInfo the implementation provides.

If an implementation is part of a read-only view of the hierarchy, all properties and subproperties will be reported as having attribute com::sun::star::beans::PropertyAttribute::READONLY set, and attempts to change property values will fail.

Exported Interfaces

◆ com::sun::star::beans::XMultiPropertyStates

provides access to the states of multiple child elements of an implementation.

[optional]

This interface should be present, if the hierarchy supports default values for simple (non-object) properties and the group contains such properties.

For properties that are objects themselves, the semantic documented for service HierarchyAccess applies.

◆ com::sun::star::beans::XPropertyState

provides access to the state of child elements of an implementation.

[optional]

This interface should be present, if the hierarchy supports default values for simple (non-object) properties and the group contains such properties.

For properties that are objects themselves, the semantic documented for service HierarchyAccess applies.


The documentation for this service was generated from the following file: