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

service SetElement

Included Services - Summary
HierarchyElement

is the basic service for accessing information about an element in the hierarchy.

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

provides access to the containing set object. (details)

::com::sun::star::lang::XComponent

allows controlling or observing the lifetime of the object. (details)

XTemplateInstance

provides information about the type of the element. (details)

Included Services - Details
HierarchyElement
Description
is the basic service for accessing information about an element in the hierarchy.
Exported Interfaces - Details
::com::sun::star::container::XChild
Description
provides access to the containing set object.

In this service, this interface is mandatory

com::sun::star::container::XChild::getParent() returns `NULL`, if the object is currently not contained in a container.

An implementation may also support com::sun::star::container::XChild::setParent(). If it does, changing the parent has the effect of first removing the object from its old parent (if any) and then inserting it into the new parent (unless that is `NULL`) under the same name. The new parent must be part of the same hierarchy as the old one. The name of the object must have been set before.

::com::sun::star::lang::XComponent
Description
allows controlling or observing the lifetime of the object.

Clients may dispose of the object using com::sun::star::lang::XComponent::dispose(), only if the object is currently not contained in a container ( com::sun::star::container::XChild::getParent() returns `NULL`).

Clients may register a com::sun::star::lang::XEventListener to be notified, if the object is removed from its container by an outside source.

XTemplateInstance
Description
provides information about the type of the element.

Set elements have a predetermined structure (their type), that is described by and can be generated from a template.

If the object was created using interface com::sun::star::lang::XSingleServiceFactory on an implementation of SetUpdate, this interface describes the same template as interface XTemplateContainer on that SetUpdate.

If the object was created using interface com::sun::star::lang::XMultiServiceFactory on an implementation of SetUpdate, this interface describes the template whose name was used as a service identifier for the factory method.

Otherwise, the semantics of the information provided about the template depends on the implementation.

See also
XTemplateContainer

 
Top of Page