LibreOffice: DefinitionContent Service Reference

LibreOffice LibreOffice 7.5 SDK API Reference

Loading...
Searching...
No Matches
Included Services | Exported Interfaces | List of all members
DefinitionContent Service Reference

defines the basic functionality for an object in the hierarchy of sub documents of an OfficeDatabaseDocument. More...

Inheritance diagram for DefinitionContent:

## Included Services
service | ::com::sun::star::ucb::Content
| provides the functionality for treating the object as part of a hierarchy of objects.

## Exported Interfaces
interface | ::com::sun::star::container::XHierarchicalName
| provides access to the complete name of the content within its hierarchy
Exported Interfaces inherited from Content
interface | com::sun::star::ucb::XContent
| provides access to the identity and the type of the content and allows the registration of listeners for ContentEvents.
interface | com::sun::star::lang::XComponent
| must be implemented to make it possible to resolve cyclic object references.
interface | com::sun::star::ucb::XCommandProcessor
| enables the caller to let the content execute commands.
interface | com::sun::star::ucb::XCommandProcessor2
| is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier() to avoid resource leaks.
interface | com::sun::star::beans::XPropertiesChangeNotifier
| notifies changes of property values to listeners registered for those properties.
interface | com::sun::star::beans::XPropertyContainer
| can be used to add new properties to the content and to remove properties from the content dynamically.
interface | com::sun::star::beans::XPropertySetInfoChangeNotifier
| can be used to notify properties removed from or added to the content's property set.
interface | com::sun::star::ucb::XCommandInfoChangeNotifier
| can be used to notify commands removed from or added to the content's command set.
interface | com::sun::star::ucb::XContentCreator
| creates new contents (i.e.
interface | com::sun::star::container::XChild
| provides access to the parent content of this content.

## Additional Inherited Members
Public Member Functions inherited from XContent
com::sun::star::ucb::XContentIdentifier | getIdentifier ()
| returns the identifier of the content.
string | getContentType ()
| returns a type string, which is unique for that type of content (e.g.
void | addContentEventListener ([in] com::sun::star::ucb::XContentEventListener Listener)
| adds a listener for content events.
void | removeContentEventListener ([in] com::sun::star::ucb::XContentEventListener Listener)
| removes a listener for content events.
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object.
void | acquire ()
| increases the reference counter by one.
void | release ()
| decreases the reference counter by one.
Public Member Functions inherited from XComponent
void | dispose ()
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references.
void | addEventListener ([in] XEventListener xListener)
| adds an event listener to the object.
void | removeEventListener ([in] XEventListener aListener)
| removes an event listener from the listener list.
Public Member Functions inherited from XCommandProcessor
long | createCommandIdentifier ()
| creates a unique identifier for a command.
any | execute ([in] Command aCommand, [in] long CommandId, [in] XCommandEnvironment Environment) raises ( com::sun::star::uno::Exception, CommandAbortedException )
| executes a command.
void | abort ([in] long CommandId)
| ends the command associated with the given id.
Public Member Functions inherited from XPropertiesChangeNotifier
void | addPropertiesChangeListener ([in] sequence< string > PropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener Listener)
| adds an XPropertiesChangeListener to the specified properties with the specified names.
void | removePropertiesChangeListener ([in] sequence< string > PropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener Listener)
| removes an XPropertiesChangeListener from the listener list.
Public Member Functions inherited from XPropertyContainer
void | addProperty ([in] string Name, [in] short Attributes, [in] any DefaultValue) raises ( com::sun::star::beans::PropertyExistException, com::sun::star::beans::IllegalTypeException, com::sun::star::lang::IllegalArgumentException )
| adds a property to the object.
void | removeProperty ([in] string Name) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::NotRemoveableException )
| removes a property from the object.
Public Member Functions inherited from XHierarchicalName
string | getHierarchicalName ()
string | composeHierarchicalName ([in] string aRelativeName) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException )
| builds the hierarchical name of an object, given a relative name
Protected Member Functions inherited from XCommandProcessor2
void | releaseCommandIdentifier ([in] long CommandId)
| releases a command identifier obtained through XCommandProcessor::createCommandIdentifier() when it is no longer used.
Protected Member Functions inherited from XPropertiesChangeNotifier
void | addPropertiesChangeListener ([in] sequence< string > PropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener Listener)
| adds an XPropertiesChangeListener to the specified properties with the specified names.
void | removePropertiesChangeListener ([in] sequence< string > PropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener Listener)
| removes an XPropertiesChangeListener from the listener list.
Protected Member Functions inherited from XPropertyContainer
void | addProperty ([in] string Name, [in] short Attributes, [in] any DefaultValue) raises ( com::sun::star::beans::PropertyExistException, com::sun::star::beans::IllegalTypeException, com::sun::star::lang::IllegalArgumentException )
| adds a property to the object.
void | removeProperty ([in] string Name) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::NotRemoveableException )
| removes a property from the object.
Protected Member Functions inherited from XPropertySetInfoChangeNotifier
void | addPropertySetInfoChangeListener ([in] XPropertySetInfoChangeListener Listener)
| registers a listener for PropertySetInfoChangeEvents.
void | removePropertySetInfoChangeListener ([in] XPropertySetInfoChangeListener Listener)
| removes a listener for PropertySetInfoChangeEvents.
Protected Member Functions inherited from XCommandInfoChangeNotifier
void | addCommandInfoChangeListener ([in] XCommandInfoChangeListener Listener)
| registers a listener for CommandInfoChangeEvents.
void | removeCommandInfoChangeListener ([in] XCommandInfoChangeListener Listener)
| removes a listener for CommandInfoChangeEvents.
Protected Member Functions inherited from XContentCreator
sequence< com::sun::star::ucb::ContentInfo > | queryCreatableContentsInfo ()
| returns a list with information about the creatable contents.
com::sun::star::ucb::XContent | createNewContent ([in] com::sun::star::ucb::ContentInfo Info)
| creates a new content of given type.
Protected Member Functions inherited from XChild
com::sun::star::uno::XInterface | getParent ()
| grants access to the object containing this content.
void | setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException )
| sets the parent to this object.

## Detailed Description

defines the basic functionality for an object in the hierarchy of sub documents of an OfficeDatabaseDocument.

See also
  DocumentDefinition
  DocumentContainer

## Exported Interfaces

## ◆ ::com::sun::star::ucb::Content

service ::com::sun::star::ucb::Content

provides the functionality for treating the object as part of a hierarchy of objects.

The following commands are commonly supported by the com::sun::star::ucb::XCommandProcessor implementation of a `DefinitionContent`:

- getPropertyValues
- setPropertyValues
- getPropertySetInfo

Additional commands might be supported by derived services.

## Exported Interfaces

## ◆ ::com::sun::star::container::XHierarchicalName

interface ::com::sun::star::container::XHierarchicalName

provides access to the complete name of the content within its hierarchy

Since
  OOo 3.3

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

- com/sun/star/sdb/DefinitionContent.idl